avodeploy 0.4

data/lib/avocado/task/remote_task_execution_environment.rb

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

data/lib/avocado/task/task.rb

@@ -0,0 +1,84 @@
+=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 Task
+
+		attr_accessor :name
+		attr_accessor :scope
+		attr_accessor :visibility
+		attr_accessor :block
+		attr_accessor :desc
+
+		# Creates a new task from a task block in the deployment configuration process
+		# 
+		# @param name [Symbol] name of the task
+		# @param options [Hash] command options
+		# @param block [Block] code block of the task
+		# @return [Task] the task instance
+		def self.from_task_block(name, options, &block)
+			instance = self.new
+
+			instance.name = name
+			instance.block = block
+
+			instance.scope = :local
+
+			if options.has_key?(:scope) && options[:scope] == :remote
+				instance.scope = :remote
+			end
+
+			instance.visibility = :public
+
+			if options.has_key?(:visibility) && options[:visibility] == :private
+				instance.visibility = :private
+			end
+
+			if options.has_key?(:desc)
+				instance.desc = options[:desc]
+			end
+
+			instance
+		end
+
+		# Runs the code of a task
+		#
+		# @param env [TaskExecutionEnvironment] the environment to invoke the task in
+		# @return [mixed] result of the code block
+		def invoke(env)
+			raise ArgumentError 'env must be a valid TaskExecutionEnvironment' unless env.kind_of?(Avocado::TaskExecutionEnvironment)
+
+			avo = Avocado::Deployment.instance
+
+			avo.log.debug "Running task #{@name}"
+
+			env.instance_eval(&@block)
+		end
+
+		# Prettyprints a command using a table
+		def pretty_print
+			puts Terminal::Table.new :title => 'Task overview', :rows => [
+				['Name', @name.to_s],
+				['Description', @desc.to_s],
+				['Scope', @scope.to_s],
+				['Visibility', @visibility.to_s],
+			]
+		end
+
+	end
+end

data/lib/avocado/task/task_dependency.rb

@@ -0,0 +1,25 @@
+=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 TaskDependency
+		attr_accessor :task_name
+		attr_accessor :dependent_task_name
+		attr_accessor :type
+	end
+end

data/lib/avocado/task/task_execution_environment.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
+
+module Avocado
+	class TaskExecutionEnvironment
+
+		# Initialized the environment
+		#
+		# @param config [Hash] deployment configuration
+		def initialize(config)
+			# @todo check
+			@config = config
+		end
+
+		# Assigns the scm provider
+		#
+		# @param scm_provider [ScmProvider] the scm provider to assign
+		def scm_provider=(scm_provider)
+			@scm = scm_provider
+		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, system_name)
+			begin
+				utils.each do |util|
+					if command("command -v #{util} >/dev/null 2>&1 || exit 1;").retval == 1
+						msg = "command line utility '#{util}' is not installed #{system_name}"
+
+						raise RuntimeError, msg
+					end
+				end
+			rescue Exception => e
+				handle_abort e
+			end
+		end
+
+		# Returns the logger instance
+		# 
+		# @return [Logger] log instance
+		def log
+			Avocado::Deployment.instance.log
+		end
+
+		# Sets a configuration item
+		#
+		# @param key [Symbol] configuration key
+		# @param value [mixed] configuration value
+		def set(key, value)
+			@config[key] = value
+		end
+
+		# Returns a configuration item if set
+		#
+		# @param key [Symbol] configuration key
+		# @return [mixed] configuration value
+		def get(key)
+			@config[key]
+		end
+
+		# Shorthand for exception handling
+		# 
+		# @param e [Exception] the exception to handle
+		def handle_abort(e)
+			Avocado::Deployment.instance.handle_abort(e)
+		end
+
+	end
+end

data/lib/avocado/task/task_manager.rb

@@ -0,0 +1,183 @@
+=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 TaskManager
+
+		attr_reader :dependencies
+		attr_reader :chains
+
+		# Initializes the task manager
+		def initialize
+			@chains = []
+			@remote_env = nil
+			@local_env = nil
+		end
+
+		# Adds a task to the task manager
+		#
+		# @param name [Symbol] task name
+		# @param options [Hash] task options
+		# @param block [Block] code of the task
+		def add_task(name, options, &block)
+			position = :after
+			standalone = true
+
+			if options.has_key?(:before)
+				position = :before
+			end
+
+			key = name
+
+			if options.has_key?(:before)
+				key = options[:before]
+				standalone = false
+			elsif options.has_key?(:after)
+				key = options[:after]
+				standalone = false
+			end
+
+			if standalone == false
+				idx = find_chain_index_containing(key)
+
+				@chains[idx].delete(name)
+				@chains[idx].insert_at(position, key, [ name, Avocado::Task.from_task_block(name, options, &block) ])
+
+			else
+				chain = {}
+				chain[name] = Avocado::Task.from_task_block(name, options, &block)
+				@chains << chain
+			end
+		end
+
+		# Finds a task by its name
+		#
+		# @param name [Symbol] name of the task
+		# @return [Task] the task if found
+		def task_by_name(name)
+			name = name.to_sym if name.is_a?(String)
+
+			cidx = find_chain_index_containing(name)
+			@chains[cidx][name]
+		end
+
+		# Finds the chain containing a specifc task
+		#
+		# @param name [Symbol] task name
+		# @param [Integer] chain index
+		def find_chain_index_containing(name)
+			@chains.each_with_index do |chain, idx|
+				if chain.has_key?(name)
+					return idx
+				end
+			end
+
+			raise RuntimeError, "could not find a chain containing task #{name}"
+		end
+
+		# Invokes a task without dependencies
+		#
+		# @param task_name [Symbol] the task name
+		def invoke_task_oneshot(task_name)
+			task_name = task_name.to_sym if task_name.is_a?(String)
+			
+			cidx = find_chain_index_containing(task_name)
+
+			begin
+				invoke_task(@chains[cidx][task_name])
+			rescue Exception => e
+				Avocado::Deployment.instance.handle_abort(e)
+			end
+		end
+
+		# Invokes the task chain, that contains the requested task
+		# 
+		# @param task_name [Symbol] the task name 
+		def invoke_task_chain_containing(task_name)
+			task_name = task_name.to_sym if task_name.is_a?(String)
+
+			cidx = find_chain_index_containing(task_name)
+
+			begin
+				@chains[cidx].each_pair do |name, task|
+					invoke_task(task)
+				end
+			rescue Exception => e
+				Avocado::Deployment.instance.handle_abort(e)
+			end
+		end
+
+		# Executes a task for all defined targets
+		#
+		# @param task [Task] the task to start
+		# @param env [RemoteTaskExecutionEnvironment] the environment
+		def execute_for_each_target(task, env)
+			raise ArgumentError, 'task must be a task' unless task.kind_of?(Avocado::Task)
+			raise ArgumentError, 'env must be a RemoteTaskExecutionEnvironment' unless env.kind_of?(Avocado::RemoteTaskExecutionEnvironment)
+
+			avo = Avocado::Deployment.instance
+
+			avo.config.targets.each_pair do |key, target|
+				avo.log.info "invoking task #{task.name} for target #{target.name}..."
+
+				env.config.merge!(target.config)
+
+				env.establish_connection
+
+				task.invoke(env)
+			end
+		end
+
+		# Invokes a task
+		#
+		# @param task [Task] the task
+		def invoke_task(task)
+			raise ArgumentError, 'task must be a task' unless task.kind_of?(Avocado::Task)
+
+			avo = Avocado::Deployment.instance
+			env = nil
+
+			if task.scope == :remote
+				if @remote_env.nil?
+					@remote_env = Avocado::RemoteTaskExecutionEnvironment.new(avo.config.config)
+				end
+
+				env = @remote_env
+			elsif task.scope == :local
+				if @local_env.nil?
+					@local_env = Avocado::LocalTaskExecutionEnvironment.new(avo.config.config)
+				end
+
+				env = @local_env
+			else
+				raise RuntimeError, 'scope must either be remote or local'
+			end
+
+			scm_provider = ScmProvider.new(env, avo.config.get(:scm))
+			env.scm_provider = scm_provider
+
+			# if remote task -> execute for each target
+			if task.scope == :remote
+				execute_for_each_target(task, env)
+			else
+				task.invoke(env)
+			end
+		end
+
+	end
+end