avodeploy 0.4 → 0.4.1

data/lib/avodeploy/scm_provider/scm_provider.rb

@@ -0,0 +1,70 @@
+=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
+
+module AvoDeploy
+	module ScmProvider
+		# scm provider facade
+		class ScmProvider
+
+			# Initializes the scm provider
+			#
+			# @param env [TaskExecutionEnvironment] env for the commands to be executed in
+			# @param scm [Symbol] the scm provider to user
+			def initialize(env, scm)
+				raise ArgumentError, 'env must be a TaskExecutionEnvironment' unless env.is_a?(AvoDeploy::Task::TaskExecutionEnvironment)
+
+				@env = env
+				@real_provider = nil
+
+				if scm == :git
+					@real_provider = GitScmProvider.new(env)
+				end
+			end
+
+			# Checks out repository code from a system and switches to the given branch
+			#
+			# @param url [String] the repository location
+			# @param local_dir [String] path to the working copy
+			# @param branch [String] the branch to check out
+			def checkout_from_remote(url, local_dir, branch)
+				@real_provider.checkout_from_remote(url, local_dir, branch)
+			end
+
+			# Returns the current revision of the working copy
+			#
+			# @return [String] the current revision of the working copy
+			def scm_files
+				@real_provider.scm_files
+			end
+
+			# Returns scm files to be executed in the deployment process
+			#
+			# @return [Array] array of scm control files
+			def cli_utils
+				@real_provider.cli_utils
+			end
+
+			# Returns the scm tools that have to be installed on specific systems
+			#
+			# @return [Array] array of utilities
+			def revision
+				@real_provider.revision
+			end
+		end
+	end
+end

data/lib/{avocado → avodeploy}/skel/manifest_template.rb.erb

@@ -1,4 +1,4 @@
-Avocado::Deployment.configure do
+AvoDeploy::Deployment.configure do
 	
 	# AVOCADO
 	# The flexible and easy to use deployment framework for web applications

data/lib/{avocado → avodeploy}/strategy/base.rb

@@ -16,7 +16,7 @@
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 =end
 
-Avocado::Deployment.configure do
+AvoDeploy::Deployment.configure do
 	
 	task :deploy, visibility: :public do
 		# stub for cli calls

data/lib/avodeploy/strategy/local_copy.rb

@@ -0,0 +1,101 @@
+=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
+
+	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
+
+end

data/lib/{avocado → avodeploy}/target.rb

@@ -16,7 +16,7 @@
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 =end
 
-module Avocado
+module AvoDeploy
 	class Target
 
 		attr_reader :name
@@ -29,6 +29,7 @@ module Avocado
 		def initialize(name, config)
 			@name = name
 			@config = default_config.merge(config)
+			@config[:name] = name
 		end
 
 		private
@@ -37,6 +38,7 @@ module Avocado
 			# @return [Hash] config defaults
 			def default_config
 				{
+					:name => '',
 					:host => nil,
 					:user => 'root',
 					:auth => :pubkey,

data/lib/avodeploy/task/local_task_execution_environment.rb

@@ -0,0 +1,127 @@
+=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
+
+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
+end

data/lib/avodeploy/task/remote_task_execution_environment.rb

@@ -0,0 +1,114 @@
+=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
+
+module AvoDeploy
+	module Task
+		class RemoteTaskExecutionEnvironment < TaskExecutionEnvironment
+
+			attr_accessor :config
+
+			# Creates a connection between the local and the remote system over ssh
+			def establish_connection
+				AvoDeploy::Deployment.instance.log.info "connecting to #{get(:user)}@#{get(:host)}..."
+
+				begin
+					@session = ::Net::SSH.start(get(:host), get(:user))
+				rescue ::Net::SSH::AuthenticationFailed => e
+					handle_abort e
+				end
+			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, 'remotely')
+			end
+
+			# Executes a command via ssh
+			# 
+			# @param ssh [Net::SSH::Connection::Session] ssh session
+			# @param command [String] the command to execute
+			def ssh_exec!(ssh, command)
+			  stdout_data = ""
+			  stderr_data = ""
+			  exit_code = nil
+			  exit_signal = nil
+			  ssh.open_channel do |channel|
+			    channel.exec(command) do |ch, success|
+			      unless success
+			        abort "FAILED: couldn't execute command (ssh.channel.exec)"
+			      end
+			      channel.on_data do |ch,data|
+			        stdout_data+=data
+			      end
+
+			      channel.on_extended_data do |ch,type,data|
+			        stderr_data+=data
+			      end
+
+			      channel.on_request("exit-status") do |ch,data|
+			        exit_code = data.read_long
+			      end
+
+			      channel.on_request("exit-signal") do |ch, data|
+			        exit_signal = data.read_long
+			      end
+			    end
+			  end
+			  ssh.loop
+
+				result = AvoDeploy::CommandExecutionResult.new
+				result.stdin = command
+				result.stdout = stdout_data
+				result.stderr = stderr_data
+				result.retval = exit_code
+
+			  result
+			end
+
+			# Executes a command on the remote system
+			#
+			# @param cmd [String] the command to execute
+			# @return [CommandExecutionResult] result of the command exection
+			def command(cmd)
+				AvoDeploy::Deployment.instance.log.info "Executing [" + cmd.yellow + "] on remote " + get(:name).to_s.cyan
+
+				result = AvoDeploy::CommandExecutionResult.new
+
+				begin
+					result = ssh_exec!(@session, cmd)
+					
+					if result.stdout.nil? == false && result.stdout.empty? == false
+						AvoDeploy::Deployment.instance.log.debug "Stdout@#{get(:host)}: ".cyan + result.stdout.green
+					end
+
+					if result.stderr.nil? == false && result.stderr.empty? == false
+						AvoDeploy::Deployment.instance.log.debug "Stderr@#{get(:host)}: ".cyan + result.stderr.red
+					end
+				rescue Exception => e
+					handle_abort e
+				end
+
+				result
+			end
+
+		end
+	end
+end