avodeploy 0.4 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7cde73940dc504b3d8883a9e69eed79a18a1dd3c
-  data.tar.gz: 075bbf48d99116872d20bca1d55d9a29645993b8
+  metadata.gz: 35c82df62a686a9bb6e446bb38a53f862e52e563
+  data.tar.gz: 86b4cd123a894fa73837bc191d7f97635ccebc68
 SHA512:
-  metadata.gz: 6a125e629b4bae2b3b74a250c84db64bcaab5ce21164101da61db1680ec9ce646e3d1bd5969f03db3bae9f2136b791096db600cbec0a3879c3b1b3d4833a80bf
-  data.tar.gz: 2999443441647174bdb0431bbfe0cd23e395ef99ebd11fcfc9fc8771f321490d34d0a7bed260571fd361202b734c815bb8705f96d9345cba6e046ef57839ba66
+  metadata.gz: 0c919f8c31d1787f4c77ecd9a01afda0d0cd8e8f139874d62cd3fa6af6d2ffb842e619cacbee5b1fed06877a0ddbe975dda333257ac7eb3a9d0ada2773b58464
+  data.tar.gz: 84bacc8363fdb08d6acb6a9477923315cdcce8d994dfbf91e09a8d0a3542afa01c9b4d34e652ea6a8ddb71215baace5ea9fd473270a28a2fe93e63a5ec02c232

data/CHANGELOG

@@ -0,0 +1,14 @@
+0.4.1
+* local_copy strategy now checks, if one or more target systems are specified
+* avo now raises an error if no valid stage is selected (avo [stage] deploy does not complain if the stage does not exist #7)
+* Added `default` stage (useful in some cases)
+* `avo ... -d` now raises exceptions directly
+* Renamed Avocado's root module to `AvoDeploy` for gem naming convention compatibility
+* Avocado's APIs can now be used by requiring 'avodeploy'
+* Removed Avocado::Task::Task.pretty_print
+* Tasks and ScmProviders are now organized in submodules
+* terminal-table gem now fix at version 1.4.5
+* Removed awesome_print dependency
+* Remote code execution: target name will now be displayed
+* local_copy strategy: `Avofile` is now excluded by default
+* Tasks: Default directory is now the working copy (Task usability - chdir #5)

data/README.md

@@ -1,16 +1,13 @@
 ### Avocado
 Avocado is a deployment framework for web applications written in Ruby.
 
-The current release is 0.4.
+The current release is 0.4.1.
 
 ### Licensing
 Avocado is licensed under the GPLv2. For more Information have a look into the LICENSE file.
 
-### Limitations
-Avocado does currently only work if you use Git for as version control system and SSH to deploy. Furthermore, the only implemented authentication method for both SSH and Git is public key authentication.
-
 ### Getting started
-Be sure that you have installed Ruby 2.1 or higher and RubyGems. Then the Installation is as easy as
+Be sure that you have installed Ruby 2.0 or higher and RubyGems. Then the Installation is as easy as
 
 ```
 $ gem install avodeploy
@@ -27,6 +24,12 @@ $ avo install
 
 to let Avocado place a deployment manifest file, called `Avofile`, in your project root folder. Then just open up the file in your editor of choice to customize your deployment process. The file is fully commented, giving you a basic understanding of how Avocado helps you to get your deployments done.
 
+### Limitations
+Avocado does currently only work if you use Git for as version control system and SSH to deploy. Furthermore, the only implemented authentication method for both SSH and Git is public key authentication.
+
+### Changelog
+There is a [CHANGELOG](CHANGELOG) file that contains all the changes throughout every version.
+
 ### Need more documentation?
 I'm currently creating documents that both the end user and developers might find helpful.
 

data/avodeploy.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'avocado/version'
+require 'avodeploy/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "avodeploy"
-  spec.version       = Avocado::VERSION
+  spec.version       = AvoDeploy::VERSION
   spec.authors       = ["David Prandzioch"]
   spec.email         = ["dprandzioch@me.com"]
   spec.summary       = %q{Avocado is a flexible deployment framework for web applications.}
@@ -21,8 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
 
-  spec.add_dependency "awesome_print", "~> 1.2.0"
-  spec.add_dependency "terminal-table"
+  spec.add_dependency "terminal-table", "~> 1.4.5"
   spec.add_dependency "net-ssh", "~> 2.9.1"
   spec.add_dependency "net-scp", "~> 1.2.1"
   spec.add_dependency "thor", "~> 0.19.1"

data/bin/avo

@@ -18,15 +18,10 @@
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 =end
 
-require 'awesome_print'
-require 'terminal-table'
-require 'open3'
-require 'net/ssh'
-require 'net/scp'
 require 'thor'
 
 THIS_FILE = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
-require File.join(File.dirname(THIS_FILE), '../lib/avocado/bootstrap.rb')
+require File.join(File.dirname(THIS_FILE), '../lib/avodeploy.rb')
 
 class AvocadoCli < Thor
 
@@ -45,7 +40,7 @@ class AvocadoCli < Thor
 		right task chain for your needs.
 	LONGDESC
 	def start(stage, task)
-		instance = Avocado::Bootstrap.run(stage, options[:verbose], options[:debug])
+		instance = AvoDeploy::Bootstrap.run(stage, options[:verbose], options[:debug])
 		
 		if options[:nodeps]
 			instance.task_manager.invoke_task_oneshot(task)
@@ -64,14 +59,21 @@ class AvocadoCli < Thor
 			stage = :default
 		end
 
-		instance = Avocado::Bootstrap.run(stage, options[:verbose], options[:debug])
-		instance.task_manager.task_by_name(name).pretty_print
+		instance = AvoDeploy::Bootstrap.run(stage, options[:verbose], options[:debug])
+		task = instance.task_manager.task_by_name(name)
+
+		puts Terminal::Table.new :title => 'Task overview', :rows => [
+				['Name', task.name],
+				['Description', task.desc],
+				['Scope', task.scope],
+				['Visibility', task.visibility],
+			]
 	end
 
 	desc "chains [STAGE]", "List all chains for the current stage"
 	method_options :stage => :string
 	def chains(stage)
-		instance = Avocado::Bootstrap.run(stage, options[:verbose], options[:debug])
+		instance = AvoDeploy::Bootstrap.run(stage, options[:verbose], options[:debug])
 		
 		instance.task_manager.chains.each do |chain|
 			rows = []
@@ -94,7 +96,7 @@ class AvocadoCli < Thor
 
 	desc "stages", "List all stages"
 	def stages
-		instance = Avocado::Bootstrap.run(:default, options[:verbose], options[:debug])
+		instance = AvoDeploy::Bootstrap.run(:default, options[:verbose], options[:debug])
 
 		puts Terminal::Table.new :title => "Stages list", 
 								 :headings => ['Title', 'Description'], 
@@ -120,7 +122,7 @@ class AvocadoCli < Thor
 		}
 
 		require 'erb'
-		renderer = ERB.new(File.new(File.dirname(THIS_FILE) + '/../lib/avocado/skel/manifest_template.rb.erb').read)
+		renderer = ERB.new(File.new(File.dirname(THIS_FILE) + '/../lib/avodeploy/skel/manifest_template.rb.erb').read)
 		output = renderer.result(binding)
 
 		File.write(Dir.pwd.concat('/Avofile'), output)

data/lib/avodeploy.rb

@@ -0,0 +1,29 @@
+require 'terminal-table'
+require 'open3'
+require 'net/ssh'
+require 'net/scp'
+
+require 'avodeploy/core_ext/string_colors.rb'
+require 'avodeploy/core_ext/hash_insert_at.rb'
+
+require 'avodeploy/task/task.rb'
+require 'avodeploy/task/task_dependency.rb'
+require 'avodeploy/task/task_manager.rb'
+require 'avodeploy/task/task_execution_environment.rb'
+require 'avodeploy/task/local_task_execution_environment.rb'
+require 'avodeploy/task/remote_task_execution_environment.rb'
+
+require 'avodeploy/scm_provider/scm_provider.rb'
+require 'avodeploy/scm_provider/git_scm_provider.rb'
+
+require 'avodeploy/multi_io.rb'
+require 'avodeploy/command_execution_result.rb'
+require 'avodeploy/target.rb'
+require 'avodeploy/config.rb'
+require 'avodeploy/deployment.rb'
+require 'avodeploy/bootstrap.rb'
+
+module AvoDeploy
+  LIBNAME = 'avodeploy'
+  LIBDIR = File.expand_path("../#{LIBNAME}", __FILE__)
+end

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

@@ -16,48 +16,34 @@
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 =end
 
-module Avocado
+module AvoDeploy
 	class Bootstrap
 		# Runs the avocado bootstrap
 		#
 		# @param stage [Symbol] the stage to bootstrap
 		# @param verbose [Boolean] run in verbose mode
 		# @param debug [Boolean] run in boolean mode
-		def self.run(stage, verbose = false, debug = false)
+		def self.run(stage = :default, verbose = false, debug = false)
 			if stage.is_a?(String)
 				stage = stage.to_sym
 			end
 
-			require File.join(File.dirname(__FILE__), 'core_ext/string_colors.rb')
-			require File.join(File.dirname(__FILE__), 'core_ext/hash_insert_at.rb')
-
-			require File.join(File.dirname(__FILE__), 'task/task.rb')
-			require File.join(File.dirname(__FILE__), 'task/task_dependency.rb')
-			require File.join(File.dirname(__FILE__), 'task/task_manager.rb')
-			require File.join(File.dirname(__FILE__), 'task/task_execution_environment.rb')
-			require File.join(File.dirname(__FILE__), 'task/local_task_execution_environment.rb')
-			require File.join(File.dirname(__FILE__), 'task/remote_task_execution_environment.rb')
-
-			require File.join(File.dirname(__FILE__), 'scm_provider/scm_provider.rb')
-			require File.join(File.dirname(__FILE__), 'scm_provider/git_scm_provider.rb')
-
-			require File.join(File.dirname(__FILE__), 'multi_io.rb')
-			require File.join(File.dirname(__FILE__), 'command_execution_result.rb')
-			require File.join(File.dirname(__FILE__), 'target.rb')
-			require File.join(File.dirname(__FILE__), 'config.rb')
-			require File.join(File.dirname(__FILE__), 'deployment.rb')
-
 			begin
 				# defaults
-				Avocado::Deployment.configure do
+				AvoDeploy::Deployment.configure do
 					set :stage, stage
+
+					setup_stage :default do
+						# a default stage is needed for some use cases,
+						# especially if you don't know which stages were defined by the user
+					end
 				end
 
 				if File.exist?(Dir.pwd.concat('/Avofile')) == false
 					raise RuntimeError, 'Could not find Avofile. Run `avo install` first.'
 				end
 
-				instance = Avocado::Deployment.instance
+				instance = AvoDeploy::Deployment.instance
 
 				# load user config initially to determine strategy
 				begin
@@ -67,6 +53,11 @@ module Avocado
 					# error not neccessary because dependencies are not loaded
 				end
 
+				# requested stage was not found
+				if instance.config.loaded_stage.nil?
+					raise ArgumentError, 'The requested stage does not exist.'
+				end
+
 				if debug
 					instance.log.level = Logger::DEBUG
 				elsif verbose
@@ -78,22 +69,25 @@ module Avocado
 				instance.log.debug "Loading deployment strategy #{instance.config.get(:strategy).to_s}..."
 
 				# load strategy
-				# @todo pruefen
-				require File.join(File.dirname(__FILE__), "strategy/base.rb")
-				require File.join(File.dirname(__FILE__), "strategy/#{instance.config.get(:strategy).to_s}.rb")
-
+				# @todo check
+				require "avodeploy/strategy/base.rb"
+				require "avodeploy/strategy/#{instance.config.get(:strategy).to_s}.rb"
 
 				instance.log.debug "Loading user configuration..."
 
 				# override again by user config to allow manipulation of tasks
 				load File.join(Dir.pwd, 'Avofile')
 			rescue Exception => e
-				Avocado::Deployment.instance.log.error e.message.red
-				
+				if debug
+					raise e
+				else 
+					AvoDeploy::Deployment.instance.log.error e.message.red
+				end
+
 				Kernel.exit(true)
 			end
 
-			Avocado::Deployment.instance
+			AvoDeploy::Deployment.instance
 		end
 	end
 end

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

@@ -16,7 +16,7 @@
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 =end
 
-module Avocado
+module AvoDeploy
 	class CommandExecutionResult
 		attr_accessor :stdin
 		attr_accessor :stdout

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

@@ -16,18 +16,20 @@
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 =end
 
-module Avocado
+module AvoDeploy
 	class Config
 
 		attr_reader :config
 		attr_reader :stages
 		attr_reader :targets
+		attr_reader :loaded_stage
 
 		# Intializes the config object
 		def initialize
 			@config = setup_config_defaults
 			@stages = {}
 			@targets = {}
+			@loaded_stage = nil
 		end
 
 		# Sets a configuration item
@@ -54,7 +56,7 @@ module Avocado
 		# @param options [Hash] task options
 		# @param block [Block] the code to be executed when the task is started 
 		def task(name, options = {}, &block)
-			Avocado::Deployment.instance.task_manager.add_task(name, options, &block)
+			AvoDeploy::Deployment.instance.task_manager.add_task(name, options, &block)
 		end
 
 		# Defines a stage
@@ -64,11 +66,13 @@ module Avocado
 		# @param block [Block] the stage configuration 
 		def setup_stage(name, options = {}, &block)
 			if options.has_key?(:desc)
-				stages[name] =  options[:desc]
+				stages[name] = options[:desc]
 			end
 
 			if name == get(:stage)
 				instance_eval(&block)
+
+				@loaded_stage = name
 			end
 		end
 
@@ -77,7 +81,7 @@ module Avocado
 		# @param name [Symbol] the deployment targets' name
 		# @param options [Hash] target options
 		def target(name, options = {})
-			@targets[name] = Avocado::Target.new(name, options)
+			@targets[name] = AvoDeploy::Target.new(name, options)
 		end
 
 		# Merges the configuration with another config hash

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

@@ -16,7 +16,7 @@
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 =end
 
-module Avocado
+module AvoDeploy
 	class Deployment
 
 		attr_accessor :config
@@ -27,8 +27,8 @@ module Avocado
 		# Initializes the deployment
 		def initialize
 			@stages = {}
-			@task_manager = Avocado::TaskManager.new
-			@config = Avocado::Config.new
+			@task_manager = AvoDeploy::Task::TaskManager.new
+			@config = AvoDeploy::Config.new
 
 			@log = ::Logger.new(STDOUT)
 		end

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

@@ -16,7 +16,7 @@
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 =end
 
-module Avocado
+module AvoDeploy
 	class MultiIO
     # Initializes the MultiIO with various target
     #

data/lib/avodeploy/scm_provider/git_scm_provider.rb

@@ -0,0 +1,73 @@
+=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
+		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?(AvoDeploy::Task::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
+end