capistrano-former03 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7eba37d16b1b4df52e00489a08c7ad68efc13791
-  data.tar.gz: 52f7671a60e5f716fda3bea283479531128a9fb0
+  metadata.gz: 9826b5d4e73dfdac22b474e4bb8bbbd6e875fe6d
+  data.tar.gz: 7f32d7bdc321264751b5cc5b34943b6100a0a615
 SHA512:
-  metadata.gz: 2bf1dbc9f96973cb0353885c22b9944b784dbb7324ab0cc70e39b9b0c5926f6f5ba5c8dd9dfd716fb1eb9cc365a49e215ac89716be481c53d85d297f2d5ce72d
-  data.tar.gz: 6a3c9678ee37e3bf600db9fe2d763c4f5ae073a40124b1433f34a78f0116db0c67dabeb15a5b315c615c7b689ac04bbd6837baa92a2672dad112c2103342ffac
+  metadata.gz: cf00abf2fdbc8797c71903c1498bd8ac965365d5a82d9e6b072675fbd0080b6aa6957578a31485f345afbd9921698c42bb0c79139d154843d9166c06c0905f6f
+  data.tar.gz: 8c254a94b18da059f25237de1f6046e6a9eb6c04279ad946c8efd68032878e74c407043fb096c1a4b6a84dee3a1ece7c739d14f7de69ed217460941d8d1556bf

data/lib/capistrano/former03.rb

@@ -2,6 +2,9 @@ require 'capistrano/former03/version'
 require 'capistrano/former03/deploy_command'
 require 'capistrano/former03/symlink'
 require 'capistrano/former03/rsync'
+require 'capistrano/former03/assets'
+require 'capistrano/former03/mysql'
+require 'capistrano/former03/backup'
 load File.expand_path('../tasks/former03.rake', __FILE__)
 
 module Capistrano

data/lib/capistrano/former03/assets.rb

@@ -0,0 +1,102 @@
+require 'date'
+
+module Capistrano
+  module Former03
+    class Assets
+      def initialize
+      end
+
+      def task
+        @task
+      end
+
+      def asset_paths
+          ret_val = fetch(:linked_dirs, [])
+          ret_val += fetch(:linked_files, []).map{|path| File.dirname path}
+          ret_val.uniq
+      end
+
+      def include_paths
+          asset_paths.map do |path|
+            path.split('/').first
+          end.uniq
+      end
+
+      def sync_includes
+        paths = []
+
+        # Add parent dirs
+        asset_paths.each do |p|
+          dir = p
+          paths += ["'/#{p}/***'"]
+          while true
+            dir = File.dirname(dir)
+            break if dir == '.'
+            paths += ["'/#{dir}/'"]
+          end
+        end
+        paths.reverse.map{|p| ['--include', p]}.flatten
+      end
+
+      def sync(t)
+         @task = t
+        if fetch(:assets_source, nil).nil?
+          fail 'No asset source given'
+        end
+
+        if fetch(:stage) == :production
+          fail 'No asset syncing in stage :production'
+        end
+
+        include_opts = sync_includes
+
+        shared_dir = self.shared_dir
+        task.on release_roles :all do
+          rsync = Capistrano::Former03::Rsync.new(
+            :rsync_path    => fetch(:deploy_rsync_path),
+            :src_path      => fetch(:assets_source),
+            :dest_path     => shared_dir,
+            :rsync_options => [
+              '-v',
+              *include_opts,
+              '--exclude', "'/**'",
+            ]
+          )
+          execute(*rsync.command)
+        end
+      end
+
+      def shared_dir
+        deploy_path.join('shared')
+      end
+
+      def backup(t)
+        @task = t
+        shared_dir = self.shared_dir
+        include_paths = self.include_paths
+        task.on release_roles :all do
+          output_dir = fetch(:backup_dest_path)
+
+          # test for backup dir
+          execute "test -d \"#{output_dir}\" || mkdir -p \"#{output_dir}\""
+
+          if include_paths.length < 1
+            fail "No assets found to backup"
+          end
+
+          existing_dirs = capture(:ls, '-xtr', shared_dir).split
+          exclude_dirs = existing_dirs - include_paths
+
+          # destination dir
+          output = File.join(output_dir, 'assets.tar.gz')
+
+          # build exclude options
+          exclude_opts = exclude_dirs.map {|d| ['--exclude', d] }.flatten
+
+          # compress asset
+          execute(:tar, '-C', shared_dir, '-czf', output, '.', *exclude_opts)
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/former03/backup.rb

@@ -0,0 +1,56 @@
+require 'date'
+
+module Capistrano
+  module Former03
+    class Backup
+      def initialize
+      end
+
+      def cleanup(t)
+        # minimum age in days to keep backups
+        backup_min_age = fetch(:backup_min_age, 7)
+        # minimum backup count to keep
+        backup_min_count = fetch(:backup_min_count, 5)
+
+        on release_roles :all do
+          backup_dir_path = fetch(:backup_dir_path)
+          backups = capture(:ls, '-xtr', backup_dir_path).split
+          count = 0
+
+          # Loop through existing backups
+          backups.reverse.each do |backup|
+            count += 1
+            created = DateTime.strptime(backup, '%Y%m%d%H%M%S')
+            age = (DateTime.now - created)
+
+            # If backup is older and count is higher than minimums
+            if age.to_i > backup_min_age and count > backup_min_count
+              execute 'rm', '-rf', File.join(backup_dir_path, backup)
+            end
+          end
+        end
+      end
+
+      def prepare(t)
+        t.set(:backup_dir_path, File.join(t.fetch(:deploy_to), t.fetch(:backup_dir, 'backups')))
+        on release_roles :all do
+          # set destination path
+          t.set(
+            :backup_dest_path,
+            File.join(
+              fetch(:backup_dir_path),
+              fetch(:release_timestamp,'not_time')
+            )
+          )
+          # ensure directories
+          [fetch(:backup_dir_path)].each do |dir|
+            if not test("test -d #{dir}")
+              execute :mkdir, dir
+              execute :chmod, '0700', dir
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/former03/mysql.rb

@@ -0,0 +1,149 @@
+require 'tempfile'
+
+module Capistrano
+  module Former03
+    class Namespace
+      def initialize(hash)
+        hash.each do |key, value|
+          singleton_class.send(:define_method, key) { value }
+        end
+      end
+
+      def get_binding
+        binding
+      end
+    end
+
+    class MySQL
+      def initialize
+      end
+
+      def task
+        if @task.nil?
+          fail "No object handle"
+        end
+        @task
+      end
+
+      def sync(t)
+        @task = t
+        src_stage = :production
+        dst_stage = fetch(:stage)
+
+        if src_stage == dst_stage
+          fail "Source stage (#{src_stage}) is equal to destination stage (#{dst_stage})"
+        end
+
+        src_database = config(src_stage)[:database]
+        dst_database = config(dst_stage)[:database]
+        src_cnf = mysql_cnf_upload(:src, src_stage)
+        dst_cnf = mysql_cnf_upload(:dst, dst_stage)
+
+        @task.on release_roles :all do
+
+          # remove all tables on dest
+          tables = capture "mysql --defaults-file=#{dst_cnf} -e'SHOW TABLES;' #{dst_database}"
+          tables = tables.split
+          if tables.length > 1
+            tables = tables[1..-1].map{|name| "`#{name}`"}.join(',')
+            execute "mysql --defaults-file=#{dst_cnf} -e'DROP TABLES #{tables};' #{dst_database}"
+          end
+
+          # sync production to stage
+          execute "mysqldump --defaults-file=#{src_cnf} #{src_database} | mysql --defaults-file=#{dst_cnf} #{dst_database}"
+
+          # remove credentials
+          execute "rm #{src_cnf}"
+          execute "rm #{dst_cnf}"
+        end
+      end
+
+      def config(stage=nil)
+        @config ||= task.fetch(:mysql_connections)
+        stage ||= task.fetch(:stage)
+        @config[stage]
+      end
+
+
+      def deploy_to
+        @task.fetch(:deploy_to)
+      end
+
+      def cnf_path(name)
+        File.join(deploy_to, 'shared', ".my.cnf_#{name}")
+      end
+
+      def mysql_cnf_upload(name, stage=nil)
+        dest = cnf_path(name)
+        src = Tempfile.new('my.cnf')
+        src.write(mysql_cnf(stage))
+        src.flush
+        @task.on release_roles :all do
+          upload!(src.path, dest)
+          execute "chmod 600 #{dest}"
+        end
+
+        # remove tempfile
+        src.delete
+
+        dest
+      end
+
+      def mysql_cnf(stage=nil)
+        c=config(stage)
+        output = "[client]\n"
+        output +="user=#{c[:username]}\n" if c.has_key?(:username)
+        output +="password=#{c[:password]}\n" if c.has_key?(:password)
+        output +="host=#{c[:host]}\n" if c.has_key?(:host)
+        output +="port=#{c[:port]}\n" if c.has_key?(:port)
+      end
+
+      def backup(t)
+        @task = t
+        cnf = mysql_cnf_upload(:backup)
+        database = config[:database]
+        # run backup
+        @task.on release_roles :all do
+          output_dir = fetch(:backup_dest_path)
+
+          # test for backup dir
+          execute "test -d \"#{output_dir}\" || mkdir -p \"#{output_dir}\""
+
+          # backup mysqldb
+          output = File.join(output_dir, 'mysql.sql.gz')
+          execute "mysqldump --defaults-file=#{cnf} #{database} | gzip > #{output}"
+          execute "chmod 600 #{output}"
+
+          # remove credentials
+          execute "rm #{cnf}"
+        end
+      end
+
+      def templates(t)
+        @task = t
+        fetch(:mysql_templates, []).each do |c|
+
+          dest = File.join(fetch(:local_stage_path), c[:destination])
+
+          puts("Evaluting template '#{c[:template]}' to '#{dest}'")
+
+          # Read template
+          erb = ERB.new(
+            File.read(c[:template]),
+            nil,
+            '-',
+          )
+
+          File.open(dest, 'w') do |file|
+            namespace = Namespace.new({
+              config: config(),
+              stage: fetch(:stage),
+            })
+            file.write(erb.result(namespace.get_binding)) 
+          end
+          File.exist?(c[:destination])
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/former03/rsync.rb

@@ -107,7 +107,12 @@ module Capistrano
         options += fetch(:rsync_options)
 
         # Add remote options if needed
-        options += remote_options 
+        options += remote_options
+
+        # Add supplied options
+        if not @rsync_options.nil?
+          options += @rsync_options
+        end
 
         # Add source and destination
         options += [src_path, dest_path]

data/lib/capistrano/former03/templates/deploy.rb.erb

@@ -22,6 +22,40 @@ set :application, '<MY_APP_NAME>'
 #  'wwwroot/public_writable_dir' => '777',
 #}
 
+# Set mysql connnections settings
+#set :mysql_connections, {
+#    :production => {
+#        :host     => 'host1',
+#        :port     => 3306,
+#        :database => 'dbname',
+#        :username => 'user1',
+#        :password => 'password',
+#    },
+#    :staging => {
+#        :host     => 'host1',
+#        :port     => 3306,
+#        :database => 'dbname',
+#        :username => 'user1',
+#        :password => 'password',
+#    },
+#}
+
+# Create files from database settings
+#set :mysql_templates, [
+#    {
+#        :destination => 'wwwroot/wp-database.php',
+#        :template    => 'config/wp-database.php.erb',
+#    }
+#]
+# Enable mysql templates
+#before 'former03:local:fix_rights', 'former03:mysql:templates'
+
+# Create mysqldump before deploy
+#before 'former03:remote:release', 'former03:mysql:backup'
+
+# Perform asset backup before deploy
+#before 'former03:remote:release', 'former03:assets:backup'
+
 # Execute custom task after local stage (example default task)
 =begin
 namespace :custom do

data/lib/capistrano/former03/templates/stage.rb.erb

@@ -16,6 +16,19 @@ set :ssh_options, {
 }
 =end
 
+# Sync database from production
+# * use in non production stages only
+# * performs mysqldump backup
+#before 'former03:remote:release', 'former03:mysql:sync'
+
+# Sync asstes from production
+# * use in non production stages only
+# * no backup is performed
+=begin
+set(:assets_source, '/path/to/productions/shared/')
+before 'former03:remote:release', 'former03:assets:sync'
+=end
+
 # Destination directory for deployment
 set :deploy_to, '<DESTDIR>'
 

data/lib/capistrano/former03/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Former03
-    VERSION = '0.0.4'
+    VERSION = '0.0.5'
   end
 end

data/lib/capistrano/tasks/former03.rake

@@ -19,6 +19,9 @@ namespace :former03 do
   set :relative_symlinks, true
   set :current_path_real_dir, false
 
+  set :mysql_connections, {}
+  set :mysql_templates, []
+
   set :ensure_file_mode, nil
   set :ensure_dir_mode, nil
   set :ensure_path_mode, {}
@@ -169,6 +172,21 @@ namespace :former03 do
 
   namespace :remote do
 
+    desc 'Cleanup remote backup'
+    task :backup_cleanup => :backup_prepare do
+      @backup.cleanup self
+    end
+
+    desc 'Prepare remote backup'
+    task :backup_prepare => :"deploy:new_release_path" do
+      @backup ||= Capistrano::Former03::Backup.new
+      @backup.prepare self
+    end
+
+    desc 'Do a remote backup'
+    task :backup => :backup_cleanup do
+    end
+
     desc 'Check the deployment hosts'
     task :check => [
       :mkdir_stage,
@@ -277,4 +295,41 @@ namespace :former03 do
       end
     end
   end
+
+  namespace :assets do
+    task :prepare do
+      @assets ||= Capistrano::Former03::Assets.new
+    end
+
+    desc 'Create a backup of assets'
+    task :backup => [:prepare, :'former03:remote:backup'] do
+      @assets.backup(self)
+    end
+
+    desc 'Sync production assets to my stage'
+    task :sync => [:prepare] do
+      @assets.sync(self)
+    end
+  end
+
+  namespace :mysql do
+    task :prepare do
+      @mysql ||= Capistrano::Former03::MySQL.new
+    end
+
+    desc 'Sync production database to my stage'
+    task :sync => [:backup, :prepare] do
+      @mysql.sync(self)
+    end
+
+    desc 'Create a mysqldump of the remote databases'
+    task :backup => [:prepare, :'former03:remote:backup'] do
+      @mysql.backup(self)
+    end
+
+    desc 'Create mysql files from templates'
+    task :templates => :prepare do
+      @mysql.templates(self)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-former03
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Christian Simon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2015-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -96,8 +96,11 @@ files:
 - bin/f03capinstall
 - capistrano-former03.gemspec
 - lib/capistrano/former03.rb
+- lib/capistrano/former03/assets.rb
+- lib/capistrano/former03/backup.rb
 - lib/capistrano/former03/deploy_command.rb
 - lib/capistrano/former03/install.rb
+- lib/capistrano/former03/mysql.rb
 - lib/capistrano/former03/rsync.rb
 - lib/capistrano/former03/symlink.rb
 - lib/capistrano/former03/templates/Capfile