snapback 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  data.tar.gz: 1a664b28c0d9ab5bc744ee05541062e603d3e637
-  metadata.gz: de56065c29b02b45a8ab80b1f06922c2ad5349b3
-SHA512: 
-  data.tar.gz: d82b6e0c7f95d7f83251da16087b9ca15c8ba0deb3a9762eca97d85944802074b4f4e8a32cff1f7f9e6b246f137a41642dfd6a5cb4d91b94278278a0572006ab
-  metadata.gz: f264844f630a2f7973c99ec5dd7c912af64bae519523110f287888ca260b00407cb56021c7677527a88ade801b5751fc4d97f40a9cafa6821e833aa7e3a151fd
+---
+SHA1:
+  metadata.gz: 143e6d3560aafaca95946154237916b3b02dca1c
+  data.tar.gz: 41ffc96d8acc093da21be2818ac50a824f84f1ff
+SHA512:
+  metadata.gz: 80faaf5da96a475a10dc9922798e39576138848cfbcabb704ad8a6039db35d2d27cb6d9c20d0b3aa6be2602f3436c42175a3303948190c834668a1a8b3bb5f8e
+  data.tar.gz: 671d610a7cd87dcaf4df7dd7700b261e71dd6c39e0b9ab3d611f52cfca9497b360eabe802dbcbed5e64fe0d73b57fe03b5ab9a5c3b4dd1d73502f31e8e836156

data/README.md

@@ -1,8 +1,8 @@
 # Snapback
 
-Version 0.1 Alpha
+Version 0.0.3
 
-Create MySQL snapshots for easy development rollback.
+Create MySQL snapshots for easy development rollback. Only recommended for use on virtual machines, not recommended for production environments.
 
 ## Project Details
 
@@ -53,8 +53,8 @@ The gem should also automatically install the following gems:
 You must then enable multiple tablespaces.
 Add a line to the [mysqld] section of your MySQL my.cnf:
 
-[mysqld]
-innodb_file_per_table=ON
+    [mysqld]
+    innodb_file_per_table
 
 ### Configuration
 
@@ -72,11 +72,6 @@ Restart AppArmor and MySQL
     service apparmor restart
     service mysql restart
 
-### Usage
-
-Only recommended for use on virtual machines.
-Not recommended for production environments.
-
 ## Setup
 
 To start using this application, you must run this once:
@@ -144,7 +139,7 @@ E.g.: Stop using the database "camera"
 
 If you're getting an error message similar to following:
 
-    File descriptor ? (/home/?/.snapback.yml) leaked on lvcreate invocation.
+    File descriptor ? (~/.snapback.yml) leaked on lvcreate invocation.
 
 You can circumvent this error by adding the following environmental variable before your command:
 
@@ -152,7 +147,7 @@ You can circumvent this error by adding the following environmental variable bef
 
 For example:
 
-    sudo LVM_SUPPRESS_FD_WARNINGS=1 sudo snapback snapshot camera --size 100M
+    sudo LVM_SUPPRESS_FD_WARNINGS=1 snapback create camera --size 100M
 
 ## Licence
 

data/bin/snapback

@@ -1,82 +1,66 @@
 #!/usr/bin/env ruby
+require 'gli'
+require 'colorize'
+require 'snapback'
 
-require 'rubygems'
-require 'yaml'
-require 'optparse'
-require 'pp'
+include GLI::App
 
-require 'snapback/options'
-require 'snapback/transaction'
-require 'snapback/database'
-require 'snapback/dsl'
+require 'snapback/cli/install'
+require 'snapback/cli/create'
+require 'snapback/cli/drop'
+require 'snapback/cli/snapshot'
+require 'snapback/cli/commit'
+require 'snapback/cli/rollback'
+require 'snapback/cli/mount'
+require 'snapback/cli/unmount'
 
-begin
-  # Ensure user is root
-  if Process.uid != 0 then
-    raise "Must run as root"
-  end
-rescue
-  $stderr.puts "#{$!.to_s.red}"
-  exit
-end
+program_desc 'Create database snapshots using logical volume management (LVM)'
 
-begin
-  $options = Snapback::Options.parse(ARGV)
+version Snapback::VERSION
 
-  case $options[:command]
-  when "install"
-    require "snapback/app/install"
-    Snapback::App::Install.instance.go
+desc 'Show debugging messages'
+switch [:q,:quiet]
 
-    puts ""
-    exit
-  end
+desc 'Location of the snapback configuration file'
+flag :config, :default_value =>  '~/.snapback.yml'
+
+pre do |global,command,options,args|
+  # Pre logic here
+  # Return true to proceed; false to abort and not call the
+  # chosen command
+  # Use skips_pre before a command to skip this block
+  # on that command only
 
-  begin
-    # Read confirmation options
-    $config = YAML.load_file($options[:config])
-  rescue
-    raise "Could not load configuration file: #{$options[:config]}"
+  # Check the user is running as root  
+  if Process.uid != 0 then
+    raise "You must run snapback as #{"root".colorize(:red)}"
   end
 
-  # Connect to MySQL
-  $database = Snapback::Database.instance
-  $database.hostname = $config['mysql']['hostname']
-  $database.username = $config['mysql']['username']
-  $database.password = $config['mysql']['password']
-  $database.connect
+  # Normalise the configuration filename
+  global[:config] = File.expand_path(global[:config])
 
-  case $options[:command]
-  when "create"
-    require "snapback/app/create"
-    Snapback::App::Create.instance.go
-  when "snapshot"
-    require "snapback/app/snapshot"
-    Snapback::App::Snapshot.instance.go
-  when "commit"
-    require "snapback/app/commit"
-    Snapback::App::Commit.instance.go
-  when "rollback"
-    require "snapback/app/rollback"
-    Snapback::App::Rollback.instance.go
-  when "drop"
-    require "snapback/app/drop"
-    Snapback::App::Drop.instance.go
-  when "mount"
-    require "snapback/app/mount"
-    Snapback::App::Mount.instance.go
-  when "unmount"
-    require "snapback/app/unmount"
-    Snapback::App::Unmount.instance.go
+  if global[:quiet] then
+    Snapback.set_quiet
+  else
+    Snapback.set_verbose
   end
-rescue
-  puts ""
-  $stderr.puts "#{$!.to_s.red}"
-  puts "Use -v (--verbose) to view entire process".red if !$options[:verbose]
-  puts "Rolling back".red
-  puts ""
 
-  Snapback::Transaction.instance.do_rollback
+  # Annouce the function
+  puts "Snapback is about to #{command.name.to_s.colorize(:green)}" if Snapback.verbose?
+
+  true
+end
+
+post do |global,command,options,args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
 end
 
-puts ""
+exit run(ARGV)

data/lib/snapback.rb

@@ -0,0 +1,130 @@
+require 'colorize'
+require 'open4'
+
+require 'snapback/transaction'
+require 'snapback/filesystem'
+
+# Command
+
+module Snapback
+  @@verbose = false
+
+  def self.set_quiet
+    @@verbose = true
+  end
+
+  def self.set_verbose
+    @@verbose = false
+  end
+
+  def self.quiet?
+    @@verbose == true
+  end
+
+  def self.verbose?
+    @@verbose == false
+  end
+end
+
+def run_command description, command = "", &block
+  if Snapback.verbose?
+    print "#{description}".to_s.ljust(72)
+    STDOUT.flush
+  end
+
+  begin
+    if block_given? then
+      result = block.call
+
+      if result then
+        return_ok
+      else
+        return_no
+      end
+    else
+      err = ""
+      status = Open4::popen4(command) do |pid, stdin, stdout, stderr|
+        err = stderr.read
+      end
+
+      if status != 0 then
+        raise err
+      end
+
+      return_ok
+    end
+  rescue Exception => e 
+    return_failed
+    raise $! # rethrow
+  end
+
+  return result
+end
+
+# Output status
+
+def return_ok
+  return nil if Snapback.quiet?
+  puts "[#{"  OK  ".colorize(:green)}]"
+end
+
+def return_no
+  return nil if Snapback.quiet?
+  puts "[#{"  NO  ".colorize(:red)}]"
+end
+
+def return_failed
+  return nil if Snapback.quiet?
+  puts "[#{"FAILED".colorize(:red)}]"
+end
+
+# Ask
+
+def ask_int question, max
+  number = nil
+
+  while true
+    print "#{question}: "
+
+    number = $stdin.gets.chomp
+
+    if !Integer(number) then
+      puts "The value you entered is not a number."
+      puts ""
+      next
+    end
+
+    number = number.to_i
+
+    if number < 1 || number > max then
+      puts "Please enter a number between 1 and #{max}."
+      puts ""
+      next
+    end
+
+    break
+  end
+
+  number
+end
+
+def ask_string question
+  print "#{question}: "
+  $stdin.gets.chomp
+end
+
+def ask_confirm question
+  while true
+    print "#{question} [Y/N]: "
+
+    confirmed = $stdin.gets.chomp.upcase
+
+    if confirmed.eql? 'Y' then
+      return true
+    elsif confirmed.eql? 'N' then
+      return false
+    else
+      puts "Please enter either Y or N."
+    end
+  end
+end

data/lib/snapback/cli/commit.rb

@@ -0,0 +1,72 @@
+require 'snapback/configuration_loader'
+require 'snapback/mysql/service_control'
+
+desc 'Commit the working copy of the database'
+arg_name 'database [, ...]'
+command :commit do |c|
+  c.action do |global_options,options,args|
+    # Ensure all flags and switches are present
+    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_database_prefix}-#{database}"
+        lv_path = "/dev/#{vg_name}/#{lv_name}"
+
+        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
+
+        # Commit LVM
+        run_command "Commit logical volume" do
+          exec "lvremove -f #{lv_path}"
+        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/cli/create.rb

@@ -0,0 +1,157 @@
+desc 'Create a new snapback compliant database'
+arg_name 'database [, ...]'
+command :create do |c|
+
+  c.desc 'Disk size of database to create'
+  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
+
+        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}"
+
+        database_exists = run_command "Checking database exists: #{database}" do
+          mysql_client.database_exists?(database)
+        end
+
+        if !database_exists then
+          run_command "Creating database: #{database}" do
+            mysql_client.database_create(database)
+          end
+
+          revert do
+            run_command "Dropping database: #{database}" do
+              mysql_client.db_drop(database)
+            end
+          end
+        end
+
+        lv_available = run_command "Checking logical volume name is available" do
+          !File.exists?(lv_path)
+        end
+
+        if !lv_available then
+          raise "Logical volume #{lv_path.colorize(:red)} already 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
+
+        # Logical volume management
+        run_command "Create logical volume",
+          "lvcreate -L #{options[:s]} -n #{lv_name} #{vg_name}"
+
+        revert do
+          run_command "Removing logical volume",
+            "lvremove -f #{vg_name}/#{lv_name}"
+        end
+
+        run_command "Format logical volume filesystem",
+          "mkfs.ext4 #{lv_path}"
+
+        # Create a new directory for where the MySQL database can be mounted
+        # mkdir /mnt/mysql/{dbName};
+
+        mount_diectory_exists = run_command "Checking mount directory: #{mount_database_directory}" do
+          File.directory? mount_database_directory
+        end
+
+        if !mount_diectory_exists then
+          run_command "Make mount directory",
+            "mkdir #{mount_database_directory}"
+
+          revert do
+            run_command "Removing mount directory",
+              "rm -rf #{$mount_database_directory}"
+          end
+        end
+
+        run_command "Changing permissions of mount directory",
+          "chmod 0777 #{mount_database_directory}"
+
+        # Mount the new logical volume
+        run_command "Mounting logical volume",
+          "mount #{lv_path} #{mount_database_directory}"
+
+        revert do
+          run_command "Unmounting logical volume",
+            "umount #{mount_database_directory}"
+        end
+
+        # Move the contents of the database to the new logical volume
+        Snapback::Filesystem.move_mysql_files(mysql_database_directory, mount_database_directory)
+
+        revert do
+          Snapback::Filesystem.move_mysql_files(mount_database_directory, mysql_database_directory)
+        end
+
+        # Remove the folder in the MySQL data directory
+        
+        run_command "Remove mysql database directory",
+          "rm -rf #{mysql_database_directory}"
+
+        revert do
+          run_command "Re-creating MySQL database directory",
+            "mkdir #{mysql_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