avodeploy 0.4 → 0.4.1

data/lib/avocado/Gemfile

@@ -1,9 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'awesome_print'
-gem 'table_print'
-
-gem 'net-ssh'
-gem 'net-scp'
-
-gem 'thor'

data/lib/avocado/scm_provider/git_scm_provider.rb

@@ -1,71 +0,0 @@
-=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 Avocado
-	class GitScmProvider
-
-		# Initializes the provider
-		#
-		# @param env [TaskExecutionEnvironment] Environment for the commands to be executed in
-		def initialize(env)
-			raise ArgumentError, "env must be a TaskExecutionEnvironment" unless env.kind_of?(TaskExecutionEnvironment)
-
-			@env = env
-		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)
-			res = @env.command("git clone #{url} #{local_dir}")
-			raise RuntimeError, "Could not clone from git url #{url}" unless res.retval == 0
-
-			@env.chdir(local_dir)
-			res = @env.command("git checkout #{branch}")
-			@env.chdir('../')
-			
-			raise RuntimeError, "could not switch to branch #{branch}" unless res.retval == 0
-		end
-
-		# Returns the current revision of the working copy
-		#
-		# @return [String] the current revision of the working copy
-		def revision
-			res = @env.command("git rev-parse HEAD")
-
-			res.stdout.gsub("\n", "")
-		end
-
-		# Returns scm files to be executed in the deployment process
-		#
-		# @return [Array] array of scm control files
-		def scm_files
-			[ '.git', '.gitignore' ]
-		end
-
-		# Returns the scm tools that have to be installed on specific systems
-		#
-		# @return [Array] array of utilities
-		def cli_utils
-			[ 'git' ]
-		end
-
-	end
-end

data/lib/avocado/scm_provider/scm_provider.rb

@@ -1,68 +0,0 @@
-=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 Avocado
-	# 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?(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

data/lib/avocado/strategy/local_copy.rb

@@ -1,99 +0,0 @@
-=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
-
-Avocado::Deployment.configure do
-
-	task :check_local_tools, before: :deploy, scope: :local, visibility: :private do
-		check_util_availability [ 'tar' ].concat(@scm.cli_utils)
-	end
-
-	task :check_remote_system, before: :deploy, scope: :remote, visibility: :private do
-		check_util_availability [ 'tar' ]
-	end
-
-	task :check_temp_existance, visibility: :private, after: :deploy, scope: :local 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, visibility: :private, after: :check_temp_existance, scope: :local do
-		command "mkdir .avocado-tmp/"
-		chdir(".avocado-tmp/")
-	end
-
-	task :checkout_from_scm, visibility: :private, after: :switch_to_temp_dir, scope: :local do
-		@scm.checkout_from_remote(get(:repo_url), 'working-copy', get(:branch))
-	end
-
-	task :get_scm_info, visibility: :private, after: :checkout_from_scm, scope: :local do
-		chdir("working-copy/")
-
-		set(:revision, @scm.revision)
-		
-		chdir("../")
-	end
-
-	task :delete_ignored_files, visibility: :private, after: :get_scm_info, scope: :local do
-		if get(:ignore_files).concat(@scm.scm_files).size > 0
-			chdir("working-copy/")
-			command "rm -rfv #{get(:ignore_files).concat(@scm.scm_files).join(' ')}"
-			chdir("../")
-		end
-	end
-
-	task :create_revision_file, visibility: :private, after: :delete_ignored_files, scope: :local do
-		chdir("working-copy/")
-		command "echo '#{get(:revision)}' > REVISION"
-		chdir("../")
-	end
-
-	task :create_deployment_tarball, visibility: :private, after: :create_revision_file, scope: :local do
-		chdir("working-copy/")
-		command "tar cvfz ../deploy.tar.gz ."
-		chdir("../")
-	end
-
-	task :upload, visibility: :private, after: :create_deployment_tarball, scope: :local do
-		targets.each_pair do |key, target|
-			copy_to_target(target, 'deploy.tar.gz', '/tmp/deploy.tar.gz')
-		end
-	end
-
-	task :create_deploy_dir, visibility: :private, after: :upload, scope: :remote do
-		command "if [ ! -d '#{get(:deploy_dir)}' ]; then mkdir -p #{get(:deploy_dir)}; fi"
-	end
-
-	task :unpack, visibility: :private, after: :create_deploy_dir, scope: :remote do
-		command "tar xvfz /tmp/deploy.tar.gz -C #{get(:deploy_dir)}/"
-	end
-
-	task :cleanup_remote, visibility: :private, after: :unpack, scope: :remote do
-		command "rm /tmp/deploy.tar.gz"
-	end 
-
-	task :log_deployment, visibility: :private, 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, visibility: :private, after: :cleanup_remote, scope: :local do
-		chdir("../")
-		command "rm -rf .avocado-tmp"
-	end
-
-end

data/lib/avocado/task/local_task_execution_environment.rb

@@ -1,127 +0,0 @@
-=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 Avocado
-	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
-			Avocado::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 = Avocado::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
-			          Avocado::Deployment.instance.handle_abort(e)
-			        end
-
-			        #log.info "\r#{name}: #{percentage}%"
-		 		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 = Avocado::Deployment.instance.log
-
-			log.info "Executing [" + cmd.yellow + "] " + "locally".cyan
-
-			result = Avocado::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

data/lib/avocado/task/remote_task_execution_environment.rb

@@ -1,112 +0,0 @@
-=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 Avocado
-	class RemoteTaskExecutionEnvironment < TaskExecutionEnvironment
-
-		attr_accessor :config
-
-		# Creates a connection between the local and the remote system over ssh
-		def establish_connection
-			Avocado::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 = Avocado::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)
-			Avocado::Deployment.instance.log.info "Executing [" + cmd.yellow + "] on remote " + get(:ssh_host).cyan
-
-			result = Avocado::CommandExecutionResult.new
-
-			begin
-				result = ssh_exec!(@session, cmd)
-				
-				if result.stdout.nil? == false && result.stdout.empty? == false
-					Avocado::Deployment.instance.log.debug "Stdout@#{get(:host)}: ".cyan + result.stdout.green
-				end
-
-				if result.stderr.nil? == false && result.stderr.empty? == false
-					Avocado::Deployment.instance.log.debug "Stderr@#{get(:host)}: ".cyan + result.stderr.red
-				end
-			rescue Exception => e
-				handle_abort e
-			end
-
-			result
-		end
-
-	end
-end