snapback 0.0.1 → 0.0.3

data/lib/snapback/cli/snapshot.rb

@@ -0,0 +1,155 @@
+desc 'Take a database snapshot'
+arg_name 'database [, ...]'
+command :snapshot do |c|
+
+  c.desc 'Disk size of changes expected'
+  c.flag [:s, :size]
+
+  c.action do |global_options,options,args|
+    help_now!('parameter -s for size is required') if options[:s].nil?
+    help_now!('database(s) required') if args.empty?
+
+    # Load the configuration
+    config = Snapback::ConfigurationLoader.factory global_options[:config]
+
+    # Connect to MySQL
+    mysql_client = config.mysql_client
+
+    args.each do |database|
+
+      # Start the transaction
+      Snapback::Transaction.new do
+
+        run_command "Selecting database: #{database}" do
+          mysql_client.database_select(database)
+        end
+
+        vg_name = config.lvm_volume_group
+        lv_name = "#{config.lvm_database_prefix}-#{database}"
+        lv_path = "/dev/#{vg_name}/#{lv_name}"
+
+        mount_database_directory  = config.filesystem_mount_directory(database)
+        mysql_database_directory  = "#{mysql_client.get_data_directory}/#{database}"
+
+        # Check
+
+        lv_available = run_command "Checking logical volume name is available" do
+          !File.exists?("/dev/#{vg_name}/#{config.lvm_snapshot_prefix}-#{database}")
+        end
+
+        if !lv_available then
+          raise "Logical volume #{lv_path.colorize(:red)} already exist"
+        end
+
+        # Drop tablespaces
+        tables = run_command "Getting list of tables in database" do
+          mysql_client.database_tables
+        end
+
+        tables.each do |table|
+          table = table.to_s
+          run_command "Changing table engine to MyISAM: #{table}" do
+            mysql_client.table_set_engine(table, "MyISAM")
+          end
+        end
+
+        # Flush
+        run_command "Flush tables with read lock" do
+          mysql_client.flush_tables
+        end
+
+        # Stop MySQL
+        run_command "Stop MySQL server" do
+          Snapback::MySQL::ServiceControl.stop
+        end
+
+        revert do
+          run_command "Start MySQL server" do
+            Snapback::MySQL::ServiceControl.start
+          end
+        end
+
+        # Unlink
+        run_command "Unlinking mysql data directory",
+          "unlink #{mysql_database_directory}"
+
+        revert do
+          run_command "Linking mysql data directory",
+            "ln -s #{mount_database_directory} #{mysql_database_directory}"
+        end
+
+        # Unmount
+        run_command "Unmounting logical volume",
+          "umount #{mount_database_directory}"
+
+        revert do
+          run_command "Mounting logical volume",
+            "mount #{lv_path} #{mount_database_directory}"
+        end
+
+        # Deactivate
+        run_command "De-activating logical volume",
+          "lvchange -an #{lv_path}"
+
+        revert do
+          run_command "Re-activating logical volume",
+            "lvchange -ay #{lv_path}"
+        end
+        
+        # Branch the logical volume with a snapshot
+        run_command "Snapshoting to #{config.lvm_snapshot_prefix}-#{database}",
+          "lvcreate -L #{options[:s]} -s -n #{config.lvm_snapshot_prefix}-#{database} #{lv_path}"
+
+        revert do
+          run_command "Removing the snapshot",
+            "lvremove -f /dev/#{vg_name}/#{config.lvm_snapshot_prefix}-#{database}"
+        end
+
+        # Active the master drive
+        run_command "Activating logical volume",
+          "lvchange -ay #{lv_path}"
+
+        revert do
+          run_command "Deactivating logical volume",
+            "lvchange -an #{lv_path}"
+        end
+
+        # Mount the master drive
+        run_command "Mounting logical volume",
+          "mount #{lv_path} #{mount_database_directory}"
+
+        revert do
+          run_command "Unmounting logical volume",
+            "umount #{mount_database_directory}"
+        end
+
+        # Symbolic-link the MySQL data directory to the new logical volume
+        run_command "Linking mysql data directory",
+          "ln -s #{mount_database_directory} #{mysql_database_directory}"
+
+        revert do
+          run_command "Unlinking mysql data directory",
+            "unlink #{mysql_database_directory}"
+        end
+
+        # Change the permissions & ownership to MySQL
+        run_command "Changing owner to mysql: #{mysql_database_directory}",
+          "chown -R mysql:mysql #{mysql_database_directory}"
+
+        run_command "Changing owner to mysql: #{mount_database_directory}",
+          "chown -R mysql:mysql #{mount_database_directory}"
+
+        # Start MySQL
+        run_command "Starting MySQL server" do
+          Snapback::MySQL::ServiceControl.start
+        end
+
+        revert do
+          run_command "Stopping MySQL server" do
+            Snapback::MySQL::ServiceControl.stop
+          end
+        end
+      end
+    end
+  end
+end

data/lib/snapback/cli/unmount.rb

@@ -0,0 +1,86 @@
+desc 'Unmount an existing database'
+arg_name 'database [, ...]'
+command :unmount do |c|
+  c.action do |global_options,options,args|
+    help_now!('database(s) required') if args.empty?
+
+    # Load the configuration
+    config = Snapback::ConfigurationLoader.factory global_options[:config]
+
+    # Connect to MySQL
+    mysql_client = config.mysql_client
+
+    # For each database
+    args.each do |database|
+
+      # Start the transaction
+      Snapback::Transaction.new do
+        run_command "Selecting database: #{database}" do
+          mysql_client.database_select(database)
+        end
+
+        vg_name = config.lvm_volume_group
+        lv_name = config.lvm_logical_database database
+        lv_path = "/dev/#{vg_name}/#{lv_name}"
+
+        mount_database_directory  = config.filesystem_mount_directory(database)
+        mysql_database_directory  = "#{mysql_client.get_data_directory}/#{database}"
+
+        lv_exists = run_command "Checking logical volume exists" do
+          File.exists?(lv_path)
+        end
+
+        if !lv_exists then
+          raise "Logical volume #{lv_path.colorize(:red)} does not exist"
+        end
+
+        # Flush
+        run_command "Flush tables with read lock" do
+          mysql_client.flush_tables
+        end
+
+        # Stop MySQL
+        run_command "Stop MySQL server" do
+          Snapback::MySQL::ServiceControl.stop
+        end
+
+        revert do
+          run_command "Start MySQL server" do
+            Snapback::MySQL::ServiceControl.start
+          end
+        end
+
+        # Unlink
+        run_command "Unlinking data directory",
+          "unlink #{mysql_database_directory}"
+
+        revert do
+          run_command "Re-linking data directory" do
+            "ln -s #{mount_database_directory} #{mysql_database_directory}"
+          end
+        end
+
+        # Unmount
+        run_command "Unmounting directory",
+          "unmount #{mount_database_directory}"
+
+        revert do
+          run_command "Re-mounting data directory" do
+            "mount #{lv_path} #{mount_database_directory}"
+          end
+        end
+
+        # Start MySQL
+        run_command "Start MySQL server" do
+          Snapback::MySQL::ServiceControl.start
+        end
+
+        revert do
+          run_command "Stop MySQL server" do
+            Snapback::MySQL::ServiceControl.stop
+          end
+        end
+      end
+    end
+  end
+end

data/lib/snapback/configuration/Configuration_0_0_3.rb

@@ -0,0 +1,99 @@
+require 'snapback/mysql/client_control'
+
+module Snapback
+  module Configuration
+    class Configuration_0_0_3
+
+      def initialize(yaml)
+        @@yaml = yaml
+      end
+
+      def version
+        @@yaml['version']
+      end
+
+      def lvm_volume_group
+        begin
+          @@yaml['lvm']['volume_group']
+        rescue
+          nil
+        end
+      end
+
+      def lvm_logical_database(database)
+        begin
+          "#{@@yaml['lvm']['database_prefix']}-#{database}"
+        rescue
+          "snapback-database-#{database}"
+        end
+      end
+
+      def lvm_logical_snapshot(database)
+        begin
+          "#{@@yaml['lvm']['snapshot_prefix']}-#{database}"
+        rescue
+          "snapback-snapshot-#{database}"
+        end
+      end
+      
+      def lvm_database_prefix
+        begin
+          @@yaml['lvm']['database_prefix']
+        rescue
+          nil
+        end
+      end
+
+      def lvm_snapshot_prefix
+        begin
+          @@yaml['lvm']['snapshot_prefix']
+        rescue
+          nil
+        end
+      end
+
+      def mysql_client
+        client = Snapback::MySQL::ClientControl.instance
+
+        client.hostname = mysql_hostname
+        client.username = mysql_username
+        client.password = mysql_password
+        client.connect
+
+        client
+      end
+
+      def mysql_hostname
+        begin
+          @@yaml['mysql']['hostname']
+        rescue
+          nil
+        end
+      end
+      
+      def mysql_username
+        begin
+          @@yaml['mysql']['username']
+        rescue
+          nil
+        end
+      end
+
+      def mysql_password
+        begin
+          @@yaml['mysql']['password']
+        rescue
+          nil
+        end
+      end
+
+      def filesystem_mount_directory(database)
+        begin
+          "#{@@yaml['filesystem']['mount']}/#{database}"
+        rescue
+          "/mnt/snapback-#{database}"
+        end
+      end
+    end
+  end
+end

data/lib/snapback/configuration_loader.rb

@@ -0,0 +1,24 @@
+require 'snapback/configuration/configuration_0_0_3'
+
+module Snapback
+  class ConfigurationLoader
+    def initialize(options={}) #:nodoc:
+    end
+
+    def self.factory filename
+      begin
+        # Read confirmation options
+        configuration = YAML.load_file filename
+      rescue
+        raise "Could not load configuration file: #{filename}"
+      end
+
+      case configuration['version']
+      when "0.0.3"
+        ::Snapback::Configuration::Configuration_0_0_3.new configuration
+      else
+        raise "Unknown configuration version: #{configuration['version']}"
+      end
+    end
+  end
+end

data/lib/snapback/filesystem.rb

@@ -0,0 +1,39 @@
+module Snapback
+  class Filesystem
+
+    LOCKED_FILES = ['.', '..', 'lost+found']
+
+    def self.mount(device, directory)
+      # If it's already mounted, don't worry
+      mount_status = Open4::popen4("mountpoint -q #{directory}") do |pid, stdin, stdout, stderr|
+      end
+
+      if mount_status == 0 then
+        return true
+      end
+
+      `mount #{device} #{directory}`
+    end
+
+    def self.unmount(directory)
+      # If it's already unmounted, don't worry
+      mount_status = Open4::popen4("mountpoint -q #{directory}") do |pid, stdin, stdout, stderr|
+      end
+
+      if mount_status != 0 then
+        return true
+      end
+
+      `umount #{directory}`
+    end
+
+    def self.move_mysql_files(from_directory, to_directory)
+      Dir.foreach(from_directory) do |filename|
+        if !LOCKED_FILES.include?(filename) then
+          run_command "Moving #{from_directory}/#{filename} to #{to_directory}",
+            "mv #{from_directory}/#{filename} #{to_directory}"
+        end
+      end
+    end
+  end
+end

data/lib/snapback/mysql/client_control.rb

@@ -0,0 +1,125 @@
+require 'singleton'
+require 'mysql'
+
+module Snapback
+  module MySQL
+    class ClientControl
+      include Singleton
+
+      attr_accessor :hostname, :username, :password
+
+      # Connection
+
+      @connection = nil
+
+      @hostname = ""
+      @username = ""
+      @password = ""
+
+      def connect
+        @connection = Mysql.new @hostname, @username, @password
+      end
+
+      # Maintenance
+
+      def flush_tables
+        @connection.query "FLUSH TABLES WITH READ LOCK"
+        true
+      end
+
+      def unlock_tables
+        @connection.query "UNLOCK TABLES"
+        true
+      end
+
+      # Configuration
+
+      def get_data_directory
+        rs = @connection.query "SHOW VARIABLES LIKE 'datadir'"
+        rs.each_hash do |row|
+          return row['Value'].gsub(/\/$/, '')
+        end
+      end
+
+      def has_innodb_file_per_table?
+        rs = @connection.query "SHOW VARIABLES LIKE 'innodb_file_per_table'"
+        rs.each_hash do |row|
+          return row['Value'] == "ON"
+        end
+      end
+
+      def set_innodb_file_per_table(on)
+        rs = @connection.prepare "SET GLOBAL innodb_file_per_table = ?"
+        rs.execute(on ? 'ON' : 'OFF')
+      end
+
+      # Database
+
+      def database_exists?(database)
+        @connection.list_dbs(database).size == 1
+      end
+
+      def database_create(database)
+        begin
+          @connection.query "CREATE DATABASE `#{Mysql.escape_string database}`"
+          true
+        rescue
+          false
+        end
+      end
+
+      def database_select(database)
+        @connection.select_db(database)
+      end
+
+      def database_tables
+        @connection.query "SHOW TABLES"
+      end
+
+      # Tables
+
+      def table_drop(table)
+        begin
+          @connection.query "DROP TABLE `#{Mysql.escape_string table}`"
+          true
+        rescue
+          false
+        end
+      end
+
+      def table_optimize(table)
+        begin
+          @connection.query "ALTER TABLE `#{Mysql.escape_string table}` IMPORT TABLESPACE"
+        rescue
+          # If this fails, it's usually just because the table is not InnoDB, so ignore errors
+        end
+
+        begin
+          @connection.query "OPTIMIZE TABLE `#{Mysql.escape_string table}`"
+          true
+        rescue
+          false
+        end
+      end
+
+      def table_set_engine(table, engine)
+        begin
+          @connection.query "ALTER TABLE `#{Mysql.escape_string table}` ENGINE = #{Mysql.escape_string engine};"
+          true
+        rescue
+          false
+        end
+      end
+
+      # Tablespace
+      def tablespace_discard(table)
+        begin
+          @connection.query "ALTER TABLE `#{Mysql.escape_string table}` DISCARD TABLESPACE"
+          true
+        rescue
+          false
+        end
+      end
+    end
+  end
+end