capistrano-database 0.0.1 → 0.0.2

data/capistrano-database.gemspec

@@ -1,8 +1,8 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Wael M. Nasreddine"]
-  gem.email         = ["wael.nasreddine@gmail.com"]
+  gem.authors       = ['Wael M. Nasreddine']
+  gem.email         = ['wael.nasreddine@gmail.com']
   gem.description   = 'Capistrano recipes for database server management'
   gem.summary       = gem.description
   gem.homepage      = 'http://technogate.github.com/contao'
@@ -11,12 +11,12 @@ Gem::Specification.new do |gem|
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "capistrano-database"
-  gem.require_paths = ["lib"]
-  gem.version       = '0.0.1'
+  gem.name          = 'capistrano-database'
+  gem.require_paths = ['lib']
+  gem.version       = '0.0.2'
 
   # Runtime dependencies
   gem.add_dependency 'rake'
-  gem.add_dependency 'capistrano'
   gem.add_dependency 'activesupport'
+  gem.add_dependency 'capistrano-utils'
 end

data/lib/capistrano/ext/database.rb

@@ -0,0 +1,149 @@
+require 'capistrano/ext/helpers'
+require 'capistrano/ext/mysql'
+
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "capistrano/ext/database requires Capistrano 2"
+end
+
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :db do
+    desc 'Backup the database'
+    task :backup, :roles => :db do
+      set :latest_backup,
+        "#{fetch :backup_path}/#{fetch :db_database_name}_#{Time.now.strftime('%d-%m-%Y_%H-%M-%S')}.sql"
+      transaction do
+        find_and_execute_db_task :backup
+      end
+    end
+
+    desc 'Export the database'
+    task :export, :roles => :db do
+      transaction do
+        backup
+        download_backup
+      end
+    end
+
+    desc 'Import the database'
+    task :import, :roles => :db do
+      transaction do
+        backup
+        backup_skiped_tables  if exists_and_not_empty? :skip_tables_on_import
+        find_and_execute_db_task :import
+        restore_skiped_tables if exists_and_not_empty? :skip_tables_on_import
+      end
+    end
+
+    [:credentials, :root_credentials].each do |method|
+      desc "[internal] Print the database server #{method}"
+      task "print_#{method}", :roles => :app do
+        logger.trace format_credentials(fetch "db_#{method}".to_sym)
+      end
+
+      desc "[internal] Load the database server #{method}"
+      task method, :roles => :app do
+        unless exists?("db_#{method}".to_sym)
+          if remote_file_exists?(fetch("db_#{method}_file".to_sym), use_sudo: method == :root_credentials)
+            send "read_#{method}"
+          else
+            send "generate_#{method}"
+          end
+        end
+      end
+
+      desc "[internal] Read the database server #{method}"
+      task "read_#{method}", :roles => :app do
+        read(fetch("db_#{method}_file".to_sym), use_sudo: method == :root_credentials).tap do |content|
+          set "db_#{method}".to_sym, {
+            hostname: match_from_content(content, 'host'),
+            port:     match_from_content(content, 'port'),
+            username: match_from_content(content, 'user'),
+            password: match_from_content(content, 'pass'),
+          }
+        end
+      end
+
+      desc "[internal] Generate the database server #{method}"
+      task "generate_#{method}", :roles => :app do
+        set "db_#{method}".to_sym, {
+          hostname: ask('What is the hostname used to access the database',
+                        default: 'localhost',
+                        validate: /.+/),
+          port:     ask('What is the port used to access the database',
+                        default: '',
+                        validate: /\A[0-9]*\Z/),
+          username: ask('What is the username used to access the database',
+                        default: (method == :credentials) ? fetch(:db_username) : 'root',
+                        validate: /.+/),
+          password: ask('What is the password used to access the database',
+                        default: gen_pass(8),
+                        validate: /.+/,
+                        echo: false),
+        }
+      end
+
+      desc "[internal] Write the database server #{method}"
+      task "write_#{method}", :roles => :app do
+        on_rollback { run "rm -f #{fetch("db_#{method}_file".to_sym)}" }
+
+        write format_credentials(fetch "db_#{method}".to_sym),
+          fetch("db_#{method}_file".to_sym),
+          use_sudo: method == :root_credentials
+      end
+    end
+
+    desc '[internal] Create the database user'
+    task :create_db_user, :roles => :db do
+      transaction do
+        find_and_execute_db_task :create_db_user
+      end
+    end
+
+    desc '[internal] Create the database'
+    task :create_database, :roles => :db do
+      transaction do
+        find_and_execute_db_task :create_database
+      end
+    end
+
+    desc '[internal] Download the db backup file'
+    task :download_backup, :roles => :db do
+      fn = "#{random_tmp_file}.sql.bz2"
+      on_rollback { `rm -f #{fn}` }
+      download "#{fetch :latest_backup}.bz2", fn
+      logger.important "The backup has been downloaded to #{fn}"
+    end
+
+    desc '[internal] Backup skiped tables'
+    task :backup_skiped_tables, :roles => :db do
+      set :backuped_skiped_tables_file, random_tmp_file
+      on_rollback { run "rm -f #{fetch :backuped_skiped_tables_file}" }
+      find_and_execute_db_task :backup_skiped_tables
+    end
+
+    desc '[internal] Restore skiped tables'
+    task :restore_skiped_tables, :roles => :db do
+      on_rollback { run "rm -f #{fetch :backuped_skiped_tables_file}" }
+      find_and_execute_db_task :restore_skiped_tables
+      run "rm -f #{fetch :backuped_skiped_tables_file}"
+    end
+  end
+
+  # Internal Dependencies
+  before 'db:print_credentials',      'db:credentials'
+  before 'db:print_root_credentials', 'db:root_credentials'
+  before 'db:create_db_user',         'db:root_credentials'
+  before 'db:create_db_user',         'db:credentials'
+  before 'db:create_database',        'db:credentials'
+  before 'db:backup',                 'db:credentials'
+  before 'db:import',                 'db:credentials'
+
+  ['credentials', 'root_credentials'].each do |method|
+    after "db:generate_#{method}", "db:write_#{method}"
+  end
+
+  # External Dependencies
+  before 'deploy:server:setup', 'db:create_db_user'
+  after 'deploy:server:setup', 'db:create_database'
+  before 'db:write_credentials', 'deploy:setup_if_needed'
+end

data/lib/capistrano/ext/mysql.rb

@@ -0,0 +1,135 @@
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "capistrano/ext/database requires Capistrano 2"
+end
+
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :db do
+    namespace :mysql do
+      desc '[internal] Create the database user'
+      task :create_db_user, :roles => :db do
+        auth  = fetch :db_credentials
+        sauth = fetch :db_root_credentials
+
+        script_file = write(<<-EOS)
+          CREATE USER '#{auth[:username]}'@'%' IDENTIFIED BY '#{auth[:password]}';
+          GRANT ALL ON `#{fetch :application}\_%`.* TO '#{auth[:username]}'@'%';
+          FLUSH PRIVILEGES;
+        EOS
+
+        begin
+          run <<-CMD
+            mysql \
+              --host='#{sauth[:hostname]}' \
+              --user='#{sauth[:username]}' \
+              --password='#{sauth[:password]}' \
+              --default-character-set=utf8 < \
+              #{script_file}; \
+            rm -f #{script_file}
+          CMD
+        rescue Capistrano::CommandError
+          logger.important 'ERROR: Could not create the user used to access the database.'
+        end
+      end
+
+      desc '[internal] Create the database'
+      task :create_database, :roles => :db do
+        auth = fetch :db_credentials
+
+        begin
+          run <<-CMD
+            mysqladmin \
+              --host='#{auth[:hostname]}' \
+              --user='#{auth[:username]}' \
+              --password='#{auth[:password]}' \
+              create '#{fetch :db_database_name}'
+          CMD
+        rescue Capistrano::CommandError
+          logger.info 'ERROR: Could not create the database'
+        end
+      end
+
+      desc '[internal] Backup mysql database'
+      task :backup, :roles => :db do
+        latest_backup = fetch :latest_backup
+        on_rollback { run "rm -f #{latest_backup}" }
+        auth  = fetch :db_credentials
+
+        begin
+          run <<-CMD
+            #{try_sudo} mysqldump \
+              --host='#{auth[:hostname]}' \
+              --user='#{auth[:username]}' \
+              --password='#{auth[:password]}' \
+              --default-character-set=utf8 \
+              '#{fetch :db_database_name}' > \
+              '#{latest_backup}' &&
+            #{try_sudo} bzip2 -9 '#{latest_backup}'
+          CMD
+        rescue Capistrano::CommandError
+          abort 'Not able to backup the database'
+        end
+      end
+
+      desc '[internal] Import a dump to the mysql database'
+      task :import, :roles => :db do
+        tmp_file = write File.read(arguments)
+        auth = fetch :db_credentials
+
+        begin
+          run <<-CMD
+            #{try_sudo} mysql \
+              --host='#{auth[:hostname]}' \
+              --user='#{auth[:username]}' \
+              --password='#{auth[:password]}' \
+              --default-character-set=utf8 \
+              '#{fetch :db_database_name}' < \
+              '#{tmp_file}' &&
+            rm -f '#{tmp_file}'
+          CMD
+        rescue Capistrano::CommandError
+          abort 'Failed to import the database'
+        end
+      end
+
+      desc '[internal] Backup skiped tables from the mysql database'
+      task :backup_skiped_tables, :roles => :db do
+        auth = fetch :db_credentials
+
+        fetch(:skip_tables_on_import, []).each do |t|
+          begin
+            run <<-CMD
+              #{try_sudo} mysqldump \
+                --host='#{auth[:hostname]}' \
+                --user='#{auth[:username]}' \
+                --password='#{auth[:password]}' \
+                --default-character-set=utf8 \
+                '#{fetch :db_database_name}' '#{t}' >> \
+                '#{fetch :backuped_skiped_tables_file}'
+            CMD
+          rescue Capistrano::CommandError
+            logger.info "WARNING: It seems the database does not have the table '#{t}', skipping it."
+          end
+        end
+
+        desc '[internal] Restore skiped tables to the mysql database'
+        task :restore_skiped_tables, :roles => :db do
+          auth = fetch :db_credentials
+
+          begin
+            run <<-CMD
+              mysql \
+                --host='#{auth[:hostname]}' \
+                --user='#{auth[:username]}' \
+                --password='#{auth[:password]}' \
+                --default-character-set=utf8 \
+                '#{fetch :db_database_name}' < \
+                #{fetch :backuped_skiped_tables_file}
+            CMD
+          rescue
+            abort 'ERROR: I could not restore the tables defined in skip_tables_on_import'
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-database
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-30 00:00:00.000000000 Z
+date: 2012-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -28,7 +28,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: capistrano
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -44,7 +44,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: capistrano-utils
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -72,6 +72,8 @@ files:
 - README.md
 - Rakefile
 - capistrano-database.gemspec
+- lib/capistrano/ext/database.rb
+- lib/capistrano/ext/mysql.rb
 homepage: http://technogate.github.com/contao
 licenses: []
 post_install_message: 
@@ -92,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3886834970779781815
+      hash: -1917011579952684110
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23