avodeploy 0.4.2 → 0.5

data/lib/avodeploy/command_execution_result.rb

@@ -17,10 +17,10 @@
 =end
 
 module AvoDeploy
-	class CommandExecutionResult
-		attr_accessor :stdin
-		attr_accessor :stdout
-		attr_accessor :stderr
-		attr_accessor :retval
-	end
+  class CommandExecutionResult
+    attr_accessor :stdin
+    attr_accessor :stdout
+    attr_accessor :stderr
+    attr_accessor :retval
+  end
 end

data/lib/avodeploy/config.rb

@@ -17,103 +17,124 @@
 =end
 
 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
-		#
-		# @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)
-			raise ArgumentError, "key #{key} is not set" unless @config.has_key?(key)
-
-			@config[key]
-		end
-
-		# Defines a task
-		# 
-		# @param name [Symbol] task name
-		# @param options [Hash] task options
-		# @param block [Block] the code to be executed when the task is started 
-		def task(name, options = {}, &block)
-			AvoDeploy::Deployment.instance.task_manager.add_task(name, options, &block)
-		end
-
-		# Defines a stage
-		#
-		# @param name [Symbol] stage name
-		# @param options [Hash] stage options
-		# @param block [Block] the stage configuration 
-		def setup_stage(name, options = {}, &block)
-			stages[name] = ''
-
-			if options.has_key?(:desc)
-				stages[name] = options[:desc]	
-			end
-
-			if name.to_s == get(:stage).to_s
-				@loaded_stage = name
-				
-				instance_eval(&block)
-			end
-		end
-
-		# Defines a deployment target
-		#
-		# @param name [Symbol] the deployment targets' name
-		# @param options [Hash] target options
-		def target(name, options = {})
-			@targets[name] = AvoDeploy::Target.new(name, options)
-		end
-
-		# Merges the configuration with another config hash
-		#
-		# @param other_config [Hash] configuration hash
-		# @return [Hash] the merged hash
-		def merge(other_config)
-			@config.merge(other_config)
-		end
-
-		private
-			# Sets up configuration defaults
-			#
-			# @return [Hash] configuration defaults
-			def setup_config_defaults
-				{
-					:project_name => '',
-					:scm => :git,
-					:repo_url => '',
-					:branch => :master,
-					:ssh_host => '',
-					:ssh_user => 'root',
-					:ssh_auth => :pubkey,
-					:deploy_dir => '/var/www/',
-					:stage => :production,
-					:strategy => :local_copy,
-					:ignore_files => [],
-					:log_level => Logger::WARN,
-				}
-			end
-
-	end
+  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
+    #
+    # @param key [Symbol] configuration key
+    # @param value [mixed] configuration value
+    def set(key, value)
+      # compatibility with releases < 0.5
+      if key == :strategy
+        inherit_strategy(value)
+        return
+      end
+
+      @config[key] = value
+    end
+
+    # Loads a strategy. Because the strategy files are loaded in
+    # the specified order, it's possible to override tasks.
+    # This is how inheritance of strategies is realized.
+    #
+    # @param strategy [Symbol] the strategy to load
+    def inherit_strategy(strategy)
+      AvoDeploy::Deployment.instance.log.debug "Loading deployment strategy #{strategy.to_s}..."
+
+      strategy_file_path = File.dirname(__FILE__) + "/strategy/#{strategy.to_s}.rb"
+
+      if File.exist?(strategy_file_path)
+        require strategy_file_path
+      else
+        raise RuntimeError, "The requested strategy '#{strategy.to_s}' does not exist"
+      end
+    end
+
+    # Returns a configuration item if set
+    #
+    # @param key [Symbol] configuration key
+    # @return [mixed] configuration value
+    def get(key)
+      raise ArgumentError, "key #{key} is not set" unless @config.has_key?(key)
+
+      @config[key]
+    end
+
+    # Defines a task
+    #
+    # @param name [Symbol] task name
+    # @param options [Hash] task options
+    # @param block [Block] the code to be executed when the task is started
+    def task(name, options = {}, &block)
+      AvoDeploy::Deployment.instance.log.debug "registering task #{name}..."
+      AvoDeploy::Deployment.instance.task_manager.add_task(name, options, &block)
+    end
+
+    # Defines a stage
+    #
+    # @param name [Symbol] stage name
+    # @param options [Hash] stage options
+    # @param block [Block] the stage configuration
+    def setup_stage(name, options = {}, &block)
+      stages[name] = ''
+
+      if options.has_key?(:desc)
+        stages[name] = options[:desc]
+      end
+
+      if name.to_s == get(:stage).to_s
+        @loaded_stage = name
+
+        instance_eval(&block)
+      end
+    end
+
+    # Defines a deployment target
+    #
+    # @param name [Symbol] the deployment targets' name
+    # @param options [Hash] target options
+    def target(name, options = {})
+      @targets[name] = AvoDeploy::Target.new(name, options)
+    end
+
+    # Merges the configuration with another config hash
+    #
+    # @param other_config [Hash] configuration hash
+    # @return [Hash] the merged hash
+    def merge(other_config)
+      @config.merge(other_config)
+    end
+
+    private
+    # Sets up configuration defaults
+    #
+    # @return [Hash] configuration defaults
+    def setup_config_defaults
+      {
+          :project_name => '',
+          :scm => :git,
+          :repo_url => '',
+          :branch => :master,
+          :stage => :production,
+          :strategy => nil,
+          :ignore_files => [],
+          :log_level => Logger::WARN,
+          :force_tag => false,
+      }
+    end
+
+  end
 end

data/lib/avodeploy/core_ext/string_colors.rb

@@ -19,27 +19,27 @@
 class String
 
   # Paints the string red on CLI
-	def red
+  def red
     "\033[31m#{self}\033[0m"
   end
-	
+
   # Paints the string green on CLI
   def green
-    "\033[32m#{self}\033[0m" 
+    "\033[32m#{self}\033[0m"
   end
-	
+
   # Paints the string cyan on CLI
   def cyan
-    "\033[36m#{self}\033[0m" 
+    "\033[36m#{self}\033[0m"
   end
-	
+
   # Paints the string yellow on CLI
   def yellow
-    "\e[33m#{self}\e[0m" 
+    "\e[33m#{self}\e[0m"
   end
-	
+
   # Paints the string gray on CLI
   def gray
-    "\033[37m#{self}\033[0m" 
+    "\033[37m#{self}\033[0m"
   end
 end

data/lib/avodeploy/deployment.rb

@@ -17,60 +17,57 @@
 =end
 
 module AvoDeploy
-	class Deployment
+  class Deployment
 
-		attr_accessor :config
-		attr_accessor :task_manager
-		attr_reader :log
-		attr_reader :log_file
+    attr_accessor :config
+    attr_accessor :task_manager
+    attr_reader :log
 
-		# Initializes the deployment
-		def initialize
-			@stages = {}
-			@task_manager = AvoDeploy::Task::TaskManager.new
-			@config = AvoDeploy::Config.new
+    # Initializes the deployment
+    def initialize
+      @stages = {}
+      @task_manager = AvoDeploy::Task::TaskManager.new
+      @config = AvoDeploy::Config.new
 
-			@log = ::Logger.new(STDOUT)
-		end
+      @log = ::Logger.new(STDOUT)
+    end
 
-		# Configures the deployment
-		#
-		# @param block [Block] configuration block
-		def self.configure(&block)
-			@instance = self.instance
-			@instance.config.instance_eval(&block)
+    # Configures the deployment
+    #
+    # @param block [Block] configuration block
+    def self.configure(&block)
+      @instance = self.instance
+      @instance.config.instance_eval(&block)
 
-			# @todo check config and throw exception
-		end
+      # @todo check config and throw exception
+    end
 
-		# Returns the deployment instance
-		#
-		# @return [Deployment] the deployment instance
-		def self.instance
-			if @instance.nil?
-				@instance = self.new
-			end
+    # Returns the deployment instance
+    #
+    # @return [Deployment] the deployment instance
+    def self.instance
+      if @instance.nil?
+        @instance = self.new
+      end
 
-			@instance
-		end
+      @instance
+    end
 
-		# Handles exceptions
-		#
-		# @param [Exception] the exception to handle
-		def handle_abort(e)
-			if e.class != SystemExit
-				@log.error e.message.red
-				@log.info "cleaning up..."
+    # Handles exceptions
+    #
+    # @param e [Exception] the exception to handle
+    def handle_abort(e)
+      if log.level == ::Logger::DEBUG
+        raise e
+      elsif e.class != SystemExit
+        @log.error e.message.red
+        @log.info 'cleaning up...'
 
-				task_manager.invoke_task_oneshot(:cleanup_local)
+        task_manager.invoke_task_oneshot(:cleanup_local)
+      end
+      
+      Kernel.exit(true)
+    end
 
-				#if e.kind_of?(::Net::SSH::AuthenticationFailed) == false
-				#	task_manager.invoke_task_oneshot(:cleanup_remote)
-				#end
-				
-				Kernel.exit(true)
-			end
-		end
-				
-	end
+  end
 end

data/lib/avodeploy/multi_io.rb

@@ -17,24 +17,24 @@
 =end
 
 module AvoDeploy
-	class MultiIO
+  class MultiIO
     # Initializes the MultiIO with various target
     #
     # @param targets [Array] targets to handle
-	  def initialize(*targets)
-	     @targets = targets
-	  end
+    def initialize(*targets)
+      @targets = targets
+    end
 
     # Writes to all targets
     # 
     # @param args [mixed] arguments
-	  def write(*args)
-	    @targets.each {|t| t.write(*args)}
-	  end
+    def write(*args)
+      @targets.each { |t| t.write(*args) }
+    end
 
     # Closes the targets
-	  def close
-	    @targets.each(&:close)
-	  end
-	end
+    def close
+      @targets.each(&:close)
+    end
+  end
 end

data/lib/avodeploy/scm_provider/bzr_scm_provider.rb

@@ -0,0 +1,111 @@
+=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 BzrScmProvider < ScmProvider
+
+      # Initializes the provider
+      #
+      # @param env [TaskExecutionEnvironment] Environment for the commands to be executed in
+      def initialize(env)
+        super(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, not used here because branches are encoded in the bazaar urls
+      # @param tag [String] tag to check out
+      def checkout_from_remote(url, local_dir, branch, tag = nil)
+        cmd = "bzr co --lightweight #{url} #{local_dir}"
+
+        if tag.nil? == false
+          cmd += " -r tag:#{tag}"
+        end
+
+        res = @env.command(cmd)
+        raise RuntimeError, "Could not checkout from bzr url #{url}" 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('bzr revno --tree')
+
+        res.stdout.gsub("\n", '')
+      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)
+        # same revision, nothing changed
+        if rev1 == rev2
+          return []
+        end
+
+        # exclude rev1 itself
+        rev1 = rev1.to_i + 1
+
+        res = @env.command("bzr log -r#{rev1}..#{rev2} -v --short")
+
+        files = []
+
+        res.stdout.lines.each do |line|
+          line.strip!
+          next unless line.start_with?('A') || line.start_with?('M')
+
+          files << line[3, line.length]
+        end
+
+        files
+      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("bzr status --short | 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
+        ['.bzr', '.bzrignore']
+      end
+
+      # Returns the scm tools that have to be installed on specific systems
+      #
+      # @return [Array] array of utilities
+      def cli_utils
+        ['bzr']
+      end
+
+    end
+  end
+end