avodeploy 0.4

data/lib/avocado/scm_provider/git_scm_provider.rb

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

@@ -0,0 +1,68 @@
+=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/skel/manifest_template.rb.erb

@@ -0,0 +1,117 @@
+Avocado::Deployment.configure do
+	
+	# AVOCADO
+	# The flexible and easy to use deployment framework for web applications
+	# 
+	# Welcome to your deployment manifest. Here you can configure the
+	# whole deployment process of your application to various target systems.
+	# This is a example file that has been created by `avo install`.
+	# While you are presented with the common configuration options for
+	# most common use cases, there are plenty more available and you might want
+	# to check them out. Because of the fact, that, currently, there is no
+	# official documentation, you have to lookup all the configuration options
+	# right in the applications' source code. But don't be afraid, you'll find
+	# them all in one place. Just take a look in the `config.rb` file at the
+	# method called `setup_config_defaults`.
+	#
+
+	# =============== GENERAL PROJECT CONFIGURATION ==================
+	# Set your project name here. This is not used right now but may
+	# be used for various purposes in future releases.
+	# 
+	set :project_name, 'myproject'
+
+	# ===================== SCM CONFIGURATION ========================
+	# Configure the version control software you use for your project.
+	# Currently the only supported provider is Git, but this will change
+	# in the future.
+	# 
+	# Valid options:
+	#	:git
+	# 
+	set :scm, :git
+
+	# This is your repository url in the following format:
+	#	username@host:repository
+	# 
+	set :repo_url, 'foo@github.com:foo/myproject.git'
+
+	# Specify the branch you'd like to deploy here. By default this is
+	# set to :master but could be every branch you wish. If your branch
+	# name contains special characters like slashes, just use a
+	# string rather than a symbol.
+	#
+	# Examples:
+	#	:master
+	#	:develop
+	#	'feature/AVO-123_manifest'
+	#
+	set :branch, :master
+
+	# ==================== DEPLOYMENT STRATEGY =======================
+	# Set your deployment strategy here. Currently only `local_copy`
+	# is implemented. The additional configuration values depend on
+	# the selected strategy.
+	#
+	# `local_copy`: Files are checked out of version control into a
+	# 			    local directory, eventually preprocess and then
+	#				packed (tarball), uploaded (via scp) and unpacked
+	#				on the target system.
+	#
+	# Valid options:
+	#	: local_copy
+	#
+	set :strategy, :local_copy
+
+	# Files to be ignored for the deployment process. Those files will
+	# not be overwritten on the target system
+	#
+	set :ignore_files, [ '.htaccess' ]
+
+	# ================= ADDITIONAL TASK DEFINITION ====================
+	# Avocado consists of a task system. Every step that is done while
+	# the deployment process is represented as a task definition.
+	# Due to the fact that most of the tasks depend on each other
+	# tasks can be related into a chain of tasks. When you call a task
+	# from the CLI utility, the whole chain for this task will be executed.
+	# This is a powerful tool for you to customize the deployment process
+	# for your needs. A full list of which tasks are defined and where you
+	# can hook on to do this or that can be found in the definition of each
+	# strategy in the `strategy/` directory.
+	#
+	# A basic task definition can look like that:
+	#
+	#	task :do_that do
+	#		command "echo 'foo'"
+	#	end
+	#
+	# This task has no relations and therefore has to be called directly via
+	# the CLI interface. When you call `avo start staging do_that` this task
+	# would execute the command `echo 'foo'` LOCALLY, because no `scope` is defined.
+	# Take a look at the following code to see a fully featured example in action.
+	# 
+	# task :install_composer, before: :create_deployment_tarball, scope: :local, desc: "installs the composer" do
+	# 	command "php composer.phar install"
+	# end 
+
+	# ==================== STAGES CONFIGURATION =======================
+	<% stages.each do |stage| %>
+	setup_stage :<%= stage %>, desc: "Configuration for <%= stage %>" do
+		# In this section you can overwrite every configuration choice
+		# you have made above. You can define additional tasks, that
+		# are only usable within the current scope or change the
+		# repository url or branch for your current needs.
+		#
+
+		# ============== TARGET SYSTEM CONFIGURATION =================
+		# Files are transmitted over SCP. Therefore you must configure 
+		# your target systems' SSH access credentials.
+		#
+
+		# Currently only pubkey-auth is supported
+		#
+		target :web, host: 'my.host.tld', user: 'deploy', auth: :pubkey, deploy_dir: '/var/www/staging/'
+	end
+	<% end %>
+	
+end

data/lib/avocado/strategy/base.rb

@@ -0,0 +1,29 @@
+=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 :deploy, visibility: :public do
+		# stub for cli calls
+	end
+
+	task :check_ssh_connection, before: :deploy, scope: :remote, visibility: :private do
+		log.info "checking ssh connection"
+	end
+
+end

data/lib/avocado/strategy/local_copy.rb

@@ -0,0 +1,99 @@
+=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/target.rb

@@ -0,0 +1,49 @@
+=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 Target
+
+		attr_reader :name
+		attr_reader :config
+
+		# Initializes the deployment target
+		# 
+		# @param name [Symbol] target name
+		# @param config [Hash] target config
+		def initialize(name, config)
+			@name = name
+			@config = default_config.merge(config)
+		end
+
+		private
+			# Sets up the config defaults
+			#
+			# @return [Hash] config defaults
+			def default_config
+				{
+					:host => nil,
+					:user => 'root',
+					:auth => :pubkey,
+					:deploy_dir => '/var/www/',
+					:log_file => '/var/www/deploy.log',
+				}
+			end
+
+	end
+end

data/lib/avocado/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 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