avodeploy 0.4.2 → 0.5

data/lib/avodeploy/strategy/base.rb

@@ -17,13 +17,13 @@
 =end
 
 AvoDeploy::Deployment.configure do
-	
-	task :deploy, visibility: :public do
-		# stub for cli calls
-	end
 
-	task :check_ssh_connection, before: :deploy, scope: :remote, visibility: :private do
-		log.info "checking ssh connection"
-	end
+  task :deploy, visibility: :public do
+    # stub for cli calls
+  end
+
+  task :check_ssh_connection, before: :deploy, scope: :remote, visibility: :private do
+    log.info 'checking ssh connection'
+  end
 
 end

data/lib/avodeploy/strategy/local_copy.rb

@@ -18,84 +18,104 @@
 
 AvoDeploy::Deployment.configure do
 
-	task :check_targets, before: :deploy do
-		raise RuntimeError, 'No target systems are configured' if targets.empty?
-	end
-
-	task :check_local_tools, before: :deploy do
-		check_util_availability [ 'tar' ].concat(@scm.cli_utils)
-	end
-
-	task :check_remote_system, before: :deploy do
-		check_util_availability [ 'tar' ]
-	end
-
-	task :check_temp_existance, after: :deploy do
-		if File.exist?('.avocado-tmp')
-			raise RuntimeError, 'The avocado tmp directory (.avocado-tmp) does already exist. That may indicate that another deployment is already running.'
-		end
-	end
-
-	task :switch_to_temp_dir, after: :check_temp_existance do
-		command "mkdir .avocado-tmp/"
-		chdir ".avocado-tmp/"
-	end
-
-	task :checkout_from_scm, after: :switch_to_temp_dir do
-		@scm.checkout_from_remote(get(:repo_url), 'working-copy', get(:branch))
-	end
-
-	task :chdir_to_working_copy, after: :checkout_from_scm do
-		chdir "working-copy/"
-	end
-
-	task :get_scm_info, after: :chdir_to_working_copy do
-		set :revision, @scm.revision
-	end
-
-	task :delete_ignored_files, after: :get_scm_info do
-		files_to_delete = [ 'Avofile' ].concat(get(:ignore_files)).concat(@scm.scm_files)
-
-		command "rm -rfv #{files_to_delete.join(' ')}"
-	end
-
-	task :create_revision_file, after: :delete_ignored_files do
-		command "echo '#{get(:revision)}' > REVISION"
-	end
-
-	task :create_deployment_tarball, after: :create_revision_file do
-		command "tar cvfz ../deploy.tar.gz ."
-	end
-
-	task :switch_to_parent_dir, after: :create_deployment_tarball do
-		chdir "../"
-	end
-
-	task :upload, after: :switch_to_parent_dir do
-		targets.each_pair do |key, target|
-			copy_to_target(target, 'deploy.tar.gz', '/tmp/deploy.tar.gz')
-		end
-	end
-
-	task :create_deploy_dir, after: :upload, scope: :remote do
-		command "if [ ! -d '#{get(:deploy_dir)}' ]; then mkdir -p #{get(:deploy_dir)}; fi"
-	end
-
-	task :unpack, after: :create_deploy_dir, scope: :remote do
-		command "tar xvfz /tmp/deploy.tar.gz -C #{get(:deploy_dir)}/"
-	end
-
-	task :cleanup_remote, after: :unpack, scope: :remote do
-		command "rm /tmp/deploy.tar.gz"
-	end 
-
-	task :log_deployment, after: :cleanup_remote, scope: :remote do
-		command "echo '[#{Time.now.strftime('%Y-%m-%d %H-%M-%S')}] revision #{get(:revision)} deployed by #{ENV['USER']}' >> #{get(:log_file)}"
-	end
-
-	task :cleanup_local, after: :cleanup_remote do
-		chdir "../"
-		command "rm -rf .avocado-tmp"
-	end
+  inherit_strategy :base
+
+  task :check_targets, before: :deploy do
+    raise RuntimeError, 'No target systems are configured' if targets.empty?
+  end
+
+  task :check_local_tools, before: :deploy do
+    check_util_availability ['tar'].concat(@scm.cli_utils)
+  end
+
+  task :check_remote_system, before: :deploy, scope: :remote do
+    res = command 'uname -a'
+
+    if res.stdout.include?('Linux') == false
+      raise RuntimeError, 'Only linux target systems are supported right now.'
+    end
+
+    check_util_availability ['tar']
+  end
+
+  task :check_temp_existance, after: :deploy do
+    if File.exist?('.avocado-tmp')
+      raise RuntimeError, 'The avocado tmp directory (.avocado-tmp) does already exist. That may indicate that another deployment is already running.'
+    end
+  end
+
+  task :switch_to_temp_dir, after: :check_temp_existance do
+    command 'mkdir .avocado-tmp/'
+    chdir '.avocado-tmp/'
+  end
+
+  task :checkout_from_scm, after: :switch_to_temp_dir do
+    tag = nil
+
+    if @options.nil? == false && @options[:tag].nil? == false
+      tag = @options[:tag]
+    end
+
+    if get(:force_tag) && tag.nil?
+      raise RuntimeError, 'Deployment requires a tag but none was submitted'
+    end
+
+    @scm.checkout_from_remote(get(:repo_url), 'working-copy', get(:branch), tag)
+  end
+
+  task :chdir_to_working_copy, after: :checkout_from_scm do
+    chdir 'working-copy/'
+  end
+
+  task :get_scm_info, after: :chdir_to_working_copy do
+    set :revision, @scm.revision
+  end
+
+  task :create_revision_file, after: :get_scm_info do
+    command "echo '#{get(:revision)}' > REVISION"
+  end
+
+  task :create_deployment_tarball, after: :create_revision_file do
+    files_to_delete = ['Avofile'].concat(get(:ignore_files)).concat(@scm.scm_files)
+
+    exclude_param = ''
+
+    files_to_delete.each do |file|
+      exclude_param += " --exclude='^#{file}$'"
+    end
+
+    command "tar cfz ../deploy.tar.gz #{exclude_param} ."
+  end
+
+  task :switch_to_parent_dir, after: :create_deployment_tarball do
+    chdir '../'
+  end
+
+  task :upload, after: :switch_to_parent_dir do
+    targets.each_pair do |key, target|
+      copy_to_target(target, 'deploy.tar.gz', '/tmp/deploy.tar.gz')
+    end
+  end
+
+  task :create_deploy_dir, after: :upload, scope: :remote do
+    command "if [ ! -d '#{get(:deploy_dir)}' ]; then mkdir -p #{get(:deploy_dir)}; fi"
+  end
+
+  task :unpack, after: :create_deploy_dir, scope: :remote do
+    command "tar xvfz /tmp/deploy.tar.gz -C #{get(:deploy_dir)}/"
+  end
+
+  task :cleanup_remote, after: :unpack, scope: :remote do
+    command 'rm /tmp/deploy.tar.gz'
+  end
+
+  task :log_deployment, after: :cleanup_remote, scope: :remote do
+    command "echo '[#{Time.now.strftime('%Y-%m-%d %H-%M-%S')}] revision #{get(:revision)} deployed by #{ENV['USER']}' >> #{get(:log_file)}"
+  end
+
+  task :cleanup_local, after: :cleanup_remote do
+    chdir '../'
+    command 'rm -rf .avocado-tmp'
+  end
 
 end

data/lib/avodeploy/strategy/local_copy_partial.rb

@@ -0,0 +1,86 @@
+=begin
+  AVOCADO
+  The flexible and easy to use deployment framework for web applications
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License Version 2
+  as published by the Free Software Foundation.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+=end
+
+AvoDeploy::Deployment.configure do
+
+  inherit_strategy :local_copy
+
+  task :get_deployed_revision, after: :chdir_to_working_copy, scope: :remote do
+    res = command "cat #{get(:deploy_dir)}/REVISION"
+
+    if get(:deployed_revisions).nil?
+      deployed_revisions = {}
+    else
+      deployed_revisions = get(:deployed_revisions)
+    end
+
+    revision = nil
+
+    if res.retval == 0
+      # file exists
+      revision = res.stdout.lines.first.strip
+    end
+
+    deployed_revisions[get(:name)] = revision
+    set(:deployed_revisions, deployed_revisions)
+  end
+
+  task :create_deployment_tarball, after: :create_revision_file do
+    new_revision = get(:revision)
+
+    get(:deployed_revisions).each_pair do |target_name, deployed_revision|
+      # determine, which files to exclude
+      files_to_delete = ['Avofile'].concat(get(:ignore_files)).concat(@scm.scm_files)
+
+      exclude_param = ''
+
+      files_to_delete.each do |file|
+        exclude_param += " --exclude='^#{file}$'"
+      end
+
+      # create deployment archive
+      if deployed_revision.nil?
+        # create full deployment archive
+        command "tar -czvf ../deploy_#{target_name.to_s}.tar.gz #{exclude_param} ."
+      else
+        # create partial deployment archive
+        diff_files = @scm.diff_files_between_revisions(deployed_revision, new_revision)
+
+        # always include the revision file
+        # UPDATE: not longer needed because REVISION is in the unknown_files array anyway 
+        #diff_files << 'REVISION'
+
+        # include unknown files
+        unknown_files = @scm.unknown_files_in_workdir
+
+        File.open("../files_#{target_name.to_s}.txt", 'w') do |f|
+          f << diff_files.concat(unknown_files).join("\n")
+        end
+
+        command "tar cvfz ../deploy_#{target_name.to_s}.tar.gz -T ../files_#{target_name.to_s}.txt #{exclude_param}"
+      end
+    end
+  end
+
+  task :upload, after: :switch_to_parent_dir do
+    targets.each_pair do |key, target|
+      copy_to_target(target, "deploy_#{target.name.to_s}.tar.gz", '/tmp/deploy.tar.gz')
+    end
+  end
+
+end

data/lib/avodeploy/target.rb

@@ -17,35 +17,36 @@
 =end
 
 module AvoDeploy
-	class Target
-
-		attr_reader :name
-		attr_reader :config
-
-		# Initializes the deployment target
-		# 
-		# @param name [Symbol] target name
-		# @param config [Hash] target config
-		def initialize(name, config)
-			@name = name
-			@config = default_config.merge(config)
-			@config[:name] = name
-		end
-
-		private
-			# Sets up the config defaults
-			#
-			# @return [Hash] config defaults
-			def default_config
-				{
-					:name => '',
-					:host => nil,
-					:user => 'root',
-					:auth => :pubkey,
-					:deploy_dir => '/var/www/',
-					:log_file => '/var/www/deploy.log',
-				}
-			end
-
-	end
+  class Target
+
+    attr_reader :name
+    attr_reader :config
+
+    # Initializes the deployment target
+    #
+    # @param name [Symbol] target name
+    # @param config [Hash] target config
+    def initialize(name, config)
+      @name = name
+      @config = default_config.merge(config)
+      @config[:name] = name
+    end
+
+    private
+    # Sets up the config defaults
+    #
+    # @return [Hash] config defaults
+    def default_config
+      {
+          :name => '',
+          :host => nil,
+          :port => 22,
+          :user => 'root',
+          :auth => :pubkey,
+          :deploy_dir => '/var/www/',
+          :log_file => '/var/www/deploy.log',
+      }
+    end
+
+  end
 end

data/lib/avodeploy/task/local_task_execution_environment.rb

@@ -17,111 +17,116 @@
 =end
 
 module AvoDeploy
-	module Task
-		class LocalTaskExecutionEnvironment < TaskExecutionEnvironment
-
-			# Initialized the environment
-			#
-			# @param config [Hash] deployment configuration
-			def initialize(config)
-				super
-
-				@dir = Dir.pwd
-			end
-
-			# Checks, if all utilities are available for the deployment process
-			# to be executed
-			#
-			# @param utils [Array] array with utilities to check
-			def check_util_availability(utils)
-				super(utils, 'locally')
-			end
-
-			# Changes the directory for commands to be executed in
-			#
-			# @param dir [String] the directory to change to
-			def chdir(dir)
-				log.debug "changing directory [#{dir.yellow}] " + "locally".cyan
-
-				Dir.chdir(dir)
-				@dir = Dir.pwd
-			end
-
-			# Returns the current working directory
-			#
-			# @return [String] current working directory
-			def cwd
-				@dir
-			end
-
-			# Returns all target systems to deploy to
-			#
-			# @return [Hash] hash of target systems
-			def targets
-				AvoDeploy::Deployment.instance.config.targets
-			end
-
-			# Copies a file to a remote system (= target)
-			#
-			# @param target [Target] the target system to deploy to
-			# @param file [String] the local file to upload
-			# @param remote [String] path on the remote system 
-			def copy_to_target(target, file, remote)
-				log = AvoDeploy::Deployment.instance.log
-
-				log.info "started upload of file #{file} to #{target.name}"
-
-			    Net::SSH.start(
-			        target.config[:host],
-			        target.config[:user]
-			    ) do |session|
-			      session.scp.upload!(file, remote, :recursive => true) do |ch, name, sent, total|
-				        percentage = 0
-
-				        begin
-				          percentage = (sent.to_f * 100 / total.to_f).to_i
-				        rescue Exception => e
-				          AvoDeploy::Deployment.instance.handle_abort(e)
-				        end
-			 		end
-				end
-
-				log.info "upload completed"
-			end
-
-			# Executes a command locally in the current directory
-			#
-			# @param cmd [String] the command to execute
-			# @return [CommandExecutionResult] result of the command exection
-			def command(cmd)
-				log = AvoDeploy::Deployment.instance.log
-
-				log.info "Executing [" + cmd.yellow + "] " + "locally".cyan
-
-				result = AvoDeploy::CommandExecutionResult.new
-
-				begin
-					stdout, stderr, status = ::Open3.capture3(cmd, :chdir => cwd())
-
-					result.stdin = cmd
-					result.stdout = stdout
-					result.stderr = stderr
-					result.retval = status.exitstatus
-
-					if result.stdout.nil? == false && result.stdout.empty? == false
-						log.debug "Stdout: " + result.stdout.green
-					end
-
-					if result.stderr.nil? == false && result.stderr.empty? == false
-						log.debug "Stderr: " + result.stderr.red
-					end
-				rescue Exception => e
-					handle_abort e
-				end
-
-				result
-			end
-
-		end
-	end
+  module Task
+    class LocalTaskExecutionEnvironment < TaskExecutionEnvironment
+
+      # Initialized the environment
+      #
+      # @param config [Hash] deployment configuration
+      def initialize(config)
+        super
+
+        @dir = Dir.pwd
+      end
+
+      # Checks, if all utilities are available for the deployment process
+      # to be executed
+      #
+      # @param utils [Array] array with utilities to check
+      def check_util_availability(utils)
+        super(utils, 'locally')
+      end
+
+      # Changes the directory for commands to be executed in
+      #
+      # @param dir [String] the directory to change to
+      def chdir(dir)
+        log.debug "changing directory [#{dir.yellow}] " + "locally".cyan
+
+        Dir.chdir(dir)
+        @dir = Dir.pwd
+      end
+
+      # Returns the current working directory
+      #
+      # @return [String] current working directory
+      def cwd
+        @dir
+      end
+
+      # Returns all target systems to deploy to
+      #
+      # @return [Hash] hash of target systems
+      def targets
+        AvoDeploy::Deployment.instance.config.targets
+      end
+
+      # Copies a file to a remote system (= target)
+      #
+      # @param target [Target] the target system to deploy to
+      # @param file [String] the local file to upload
+      # @param remote [String] path on the remote system
+      def copy_to_target(target, file, remote)
+        log = AvoDeploy::Deployment.instance.log
+
+        log.info "started upload of file #{file} to #{target.name}"
+
+        Net::SSH.start(
+            target.config[:host],
+            target.config[:user],
+            {
+              :port => target.config[:port]
+            }
+        ) do |session|
+          session.scp.upload!(file, remote, :recursive => true) do |ch, name, sent, total|
+            percentage = 0
+
+            begin
+              percentage = (sent.to_f * 100 / total.to_f).to_i
+            rescue Exception => e
+              AvoDeploy::Deployment.instance.handle_abort(e)
+            end
+          end
+        end
+
+        log.info "upload completed"
+      end
+
+      # Executes a command locally in the current directory
+      #
+      # @param cmd [String] the command to execute
+      # @return [CommandExecutionResult] result of the command exection
+      def command(cmd)
+        log = AvoDeploy::Deployment.instance.log
+
+        log.info "Executing [" + cmd.yellow + "] " + "locally".cyan
+
+        result = AvoDeploy::CommandExecutionResult.new
+
+        begin
+          stdout, stderr, status = ::Open3.capture3(cmd, :chdir => cwd())
+
+          result.stdin = cmd
+          result.stdout = stdout
+          result.stderr = stderr
+          result.retval = status.exitstatus
+
+          if result.stdout.nil? == false && result.stdout.empty? == false
+            log.debug 'Stdout: ' + result.stdout.green
+          end
+
+          if result.stderr.nil? == false && result.stderr.empty? == false
+            log.debug 'Stderr: ' + result.stderr.red
+          end
+
+          log.debug 'Retval: ' + result.retval.to_s
+        rescue Exception => e
+          handle_abort e
+        end
+
+        result
+      end
+
+    end
+  end
 end