avodeploy 0.4 → 0.4.1

data/lib/avodeploy/task/task.rb

@@ -0,0 +1,76 @@
+=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 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?(TaskExecutionEnvironment)
+
+				avo = AvoDeploy::Deployment.instance
+
+				avo.log.debug "Running task #{@name}"
+
+				env.instance_eval(&@block)
+			end
+
+		end
+	end
+end

data/lib/{avocado → avodeploy}/task/task_dependency.rb

@@ -16,10 +16,12 @@
   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
+module AvoDeploy
+  module Task
+  	class TaskDependency
+  		attr_accessor :task_name
+  		attr_accessor :dependent_task_name
+  		attr_accessor :type
+  	end
+  end
 end

data/lib/avodeploy/task/task_execution_environment.rb

@@ -0,0 +1,88 @@
+=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 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
+				AvoDeploy::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)
+				AvoDeploy::Deployment.instance.handle_abort(e)
+			end
+
+		end
+	end
+end

data/lib/avodeploy/task/task_manager.rb

@@ -0,0 +1,185 @@
+=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 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, Task.from_task_block(name, options, &block) ])
+
+				else
+					chain = {}
+					chain[name] = 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
+					AvoDeploy::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
+					AvoDeploy::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?(Task)
+				raise ArgumentError, 'env must be a RemoteTaskExecutionEnvironment' unless env.kind_of?(RemoteTaskExecutionEnvironment)
+
+				avo = AvoDeploy::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?(Task)
+
+				avo = AvoDeploy::Deployment.instance
+				env = nil
+
+				if task.scope == :remote
+					if @remote_env.nil?
+						@remote_env = RemoteTaskExecutionEnvironment.new(avo.config.config)
+					end
+
+					env = @remote_env
+				elsif task.scope == :local
+					if @local_env.nil?
+						@local_env = LocalTaskExecutionEnvironment.new(avo.config.config)
+					end
+
+					env = @local_env
+				else
+					raise RuntimeError, 'scope must either be remote or local'
+				end
+
+				scm_provider = AvoDeploy::ScmProvider::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
+end

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

@@ -16,6 +16,6 @@
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 =end
 
-module Avocado
-  VERSION = "0.4"
+module AvoDeploy
+  VERSION = "0.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avodeploy
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: 0.4.1
 platform: ruby
 authors:
 - David Prandzioch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,33 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.4.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
-- !ruby/object:Gem::Dependency
-  name: terminal-table
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.5
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
@@ -116,33 +102,34 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - avodeploy.gemspec
 - bin/avo
-- lib/avocado/Gemfile
-- lib/avocado/bootstrap.rb
-- lib/avocado/command_execution_result.rb
-- lib/avocado/config.rb
-- lib/avocado/core_ext/hash_insert_at.rb
-- lib/avocado/core_ext/string_colors.rb
-- lib/avocado/deployment.rb
-- lib/avocado/multi_io.rb
-- lib/avocado/scm_provider/git_scm_provider.rb
-- lib/avocado/scm_provider/scm_provider.rb
-- lib/avocado/skel/manifest_template.rb.erb
-- lib/avocado/strategy/base.rb
-- lib/avocado/strategy/local_copy.rb
-- lib/avocado/target.rb
-- lib/avocado/task/local_task_execution_environment.rb
-- lib/avocado/task/remote_task_execution_environment.rb
-- lib/avocado/task/task.rb
-- lib/avocado/task/task_dependency.rb
-- lib/avocado/task/task_execution_environment.rb
-- lib/avocado/task/task_manager.rb
-- lib/avocado/version.rb
+- lib/avodeploy.rb
+- lib/avodeploy/bootstrap.rb
+- lib/avodeploy/command_execution_result.rb
+- lib/avodeploy/config.rb
+- lib/avodeploy/core_ext/hash_insert_at.rb
+- lib/avodeploy/core_ext/string_colors.rb
+- lib/avodeploy/deployment.rb
+- lib/avodeploy/multi_io.rb
+- lib/avodeploy/scm_provider/git_scm_provider.rb
+- lib/avodeploy/scm_provider/scm_provider.rb
+- lib/avodeploy/skel/manifest_template.rb.erb
+- lib/avodeploy/strategy/base.rb
+- lib/avodeploy/strategy/local_copy.rb
+- lib/avodeploy/target.rb
+- lib/avodeploy/task/local_task_execution_environment.rb
+- lib/avodeploy/task/remote_task_execution_environment.rb
+- lib/avodeploy/task/task.rb
+- lib/avodeploy/task/task_dependency.rb
+- lib/avodeploy/task/task_execution_environment.rb
+- lib/avodeploy/task/task_manager.rb
+- lib/avodeploy/version.rb
 homepage: http://dprandzioch.github.io/avocado/
 licenses:
 - GPLv2