avodeploy 0.4.2 → 0.5

data/lib/avodeploy/scm_provider/git_scm_provider.rb

@@ -17,57 +17,78 @@
 =end
 
 module AvoDeploy
-	module ScmProvider
-		class GitScmProvider
+  module ScmProvider
+    class GitScmProvider < ScmProvider
 
-			# 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)
+      # Initializes the provider
+      #
+      # @param env [TaskExecutionEnvironment] Environment for the commands to be executed in
+      def initialize(env)
+        super(env)
+      end
 
-				@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
+      # 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
+      # @param tag [String] tag to check out
+      def checkout_from_remote(url, local_dir, branch, tag = nil)
+        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
+        branch = tag if tag.nil? == false
 
-			# 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")
+        @env.chdir(local_dir)
+        res = @env.command("git checkout #{branch}")
+        @env.chdir('../')
 
-				res.stdout.gsub("\n", "")
-			end
+        raise RuntimeError, "could not switch to branch #{branch}" unless res.retval == 0
+      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 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 the scm tools that have to be installed on specific systems
-			#
-			# @return [Array] array of utilities
-			def cli_utils
-				[ 'git' ]
-			end
+      # Finds files that differ between two revisions and returns them
+      # as a array
+      #
+      # @param rev1 [String] sha1
+      # @param rev2 [String] sha1
+      #
+      # @return [Array]
+      def diff_files_between_revisions(rev1, rev2)
+        res = @env.command("git diff --name-only #{rev1} #{rev2}")
+        res.stdout.lines
+      end
 
-		end
-	end
+      # Finds files unknown file in the working directory and returns them
+      # as a array
+      #
+      # @return [Array]
+      def unknown_files_in_workdir
+        res = @env.command("git status -s | grep '^??' | awk '/^?? (.*)$/ {print $2}'")
+        res.stdout.lines
+      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', 'awk', 'grep']
+      end
+
+    end
+  end
 end

data/lib/avodeploy/scm_provider/scm_provider.rb

@@ -17,54 +17,68 @@
 =end
 
 module AvoDeploy
-	module ScmProvider
-		# scm provider facade
-		class ScmProvider
+  module ScmProvider
+    # scm provider base class
+    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?(AvoDeploy::Task::TaskExecutionEnvironment)
+      # Initializes the scm provider
+      #
+      # @param env [TaskExecutionEnvironment] env for the commands to be executed in
+      def initialize(env)
+        raise ArgumentError, 'env must be a TaskExecutionEnvironment' unless env.is_a?(AvoDeploy::Task::TaskExecutionEnvironment)
 
-				@env = env
-				@real_provider = nil
+        @env = env
+      end
 
-				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
+      # @param tag [String] tag to check out
+      def checkout_from_remote(url, local_dir, branch, tag = nil)
+        raise NotImplementedError
+      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
+      # Finds files that differ between two revisions and returns them
+      # as a array
+      #
+      # @param rev1 [String] sha1
+      # @param rev2 [String] sha1
+      #
+      # @return [Array]
+      def diff_files_between_revisions(rev1, rev2)
+        raise NotImplementedError
+      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
+      # Finds files unknown file in the working directory and returns them
+      # as a array
+      #
+      # @return [Array]
+      def unknown_files_in_workdir
+        raise NotImplementedError
+      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 current revision of the working copy
+      #
+      # @return [String] the current revision of the working copy
+      def scm_files
+        raise NotImplementedError
+      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
+      # Returns scm files to be executed in the deployment process
+      #
+      # @return [Array] array of scm control files
+      def cli_utils
+        raise NotImplementedError
+      end
+
+      # Returns the scm tools that have to be installed on specific systems
+      #
+      # @return [Array] array of utilities
+      def revision
+        raise NotImplementedError
+      end
+    end
+  end
 end

data/lib/avodeploy/skel/manifest_template.rb.erb

@@ -1,117 +1,128 @@
-AvoDeploy::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 %>
-	
+AvoDeploy::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 only Git and Bazaar are supported, but this will change
+    # in the future.
+    #
+    # Valid options:
+    #   :git
+    #   :bzr
+    #
+    set :scm, :git
+
+    # This is your repository url
+    #
+    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.
+    #
+    # >= 0.5: To use multiple strategies, use
+    #         `inherit_strategy :local_copy
+    #          inherit_strategy :some_other_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.
+    #
+    # `local_copy_partial`: Same as `local_copy` but uploads only files
+    #                       that have changed since the last deployment
+    #                       to the specific target system.
+    #
+    # Valid options:
+    #   :local_copy
+    #   :local_copy_partial
+    #
+    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', port: 22, user: 'deploy', auth: :pubkey, deploy_dir: '/var/www/staging/'
+    end
+    <% end %>
+
+
 end