git-runner 0.0.2 → 0.0.3

data/README.md

@@ -2,6 +2,8 @@
 
 GitRunner is a ruby framework to implement and run tasks after code has been pushed to a Git repository. It works by invoking `git-runner` through `hooks/post-update` in your remote Git repository.
 
+[Demonstration Video, Using git-runner to perform automatic deploys](http://ascii.io/a/1349)
+
 Configuration for GitRunner is read from a pre-determined file within the repository (at this time, that file is config/deploy.rb but this will soon be configurable). Any instructions detected are then processed and ran.
 
 Instructions are contained within `lib/git-runner/instructions`, though soon these will be extracted out to separate gems, leaving only the core instructions present. Currently the only *real* instruction that users will want to run is Deploy, which will checkout your code, run bundler and perform a cap deploy (with multistage support).
@@ -14,10 +16,19 @@ Instructions are contained within `lib/git-runner/instructions`, though soon the
 
 Symlink `hooks/post-update` to `git-runner`, or if `post-update` is already in use modify it to run `git-runner` with the arguments supplied to the hook.
 
+## Configuration
+
+Configuration can be overwritten through a YAML file at either `/etc/git-runner.yml` or `$HOME/.git-runner.yml`. The current configuration options are:
+
+  * **git_executable** (default: '/usr/bin/env git')
+  * **instruction_file** (default: 'config/deploy.rb')
+  * **instruction_prefix** (default: '# GitRunner:')
+  * **tmp_directory** (default: '/tmp/git-runner')
+
 ## TODO
 
-* Allow file based configuration (currently configuration is hard-coded)
 * Extract our non-core instruction functionality into individual gems (e.g. the Deploy instruction)
+* Format README.md nicely
 
 ## Contributing
 

data/git-runner.gemspec

@@ -1,7 +1,11 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/git-runner/version', __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'git-runner/version'
 
 Gem::Specification.new do |gem|
+  gem.name          = "git-runner"
+  gem.version       = GitRunner::VERSION
   gem.authors       = ["James Brooks"]
   gem.email         = ["james@jamesbrooks.net"]
   gem.summary       = "Ruby framework to run tasks after code has been pushed to a Git repository."
@@ -10,9 +14,7 @@ Gem::Specification.new do |gem|
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.name          = "git-runner"
   gem.require_paths = ["lib"]
-  gem.version       = GitRunner::VERSION
 
   gem.add_dependency 'session'
 end

data/lib/git-runner.rb

@@ -1,17 +1,11 @@
-require "git-runner/version"
 require "git-runner/base"
+require "git-runner/branch"
 require "git-runner/command"
 require "git-runner/configuration"
-require "git-runner/branch"
+require "git-runner/hooks"
 require "git-runner/instruction"
 require "git-runner/text"
+require "git-runner/version"
 
 module GitRunner
-  DEFAULT_CONFIGURATION = {
-    :git_executable     => '/usr/bin/env git',
-    :instruction_file   => 'config/deploy.rb',
-    :instruction_prefix => '# GitRunner:',
-    :tmp_directory      => '/tmp/git-runner',
-    :rvm_ruby_version   => '1.9.3'
-  }
 end

data/lib/git-runner/base.rb

@@ -24,38 +24,50 @@ module GitRunner
         end
 
 
-      rescue GitRunner::Instruction::InstructionHalted => ex
+      rescue GitRunner::Instruction::Failure => ex
+        Text.new_line
         Text.out("Stopping runner, no further instructions will be performed\n")
+        Text.new_line
 
       rescue GitRunner::Command::Failure => ex
-        Text.out("\n")
+        Text.new_line
         Text.out(Text.red("\u2716 Command failed: " + Text.red(ex.result.command)), :heading)
 
-        # Write error log
-        log_directory = File.join(Configuration.tmp_directory, 'logs')
-        error_log     = File.join(log_directory, Time.now.strftime("%Y%m%d%H%M%S") + '-error.log')
-
-        Dir.mkdir(log_directory) unless Dir.exists?(log_directory)
-        File.open(error_log, 'w') do |file|
-          Command.history.each do |result|
-            file << "Status: #{result.status}; Command: #{result.command}\n"
-            file << result.out
-            file << "\n--------------------\n"
-          end
+        write_error_log do |log|
+          log << Command.history_to_s
         end
 
-        Text.out("An error log has been created: #{error_log}")
         Text.new_line
 
       rescue Exception => ex
         Text.new_line
         Text.out(Text.red("\u2716 Unknown exception occured: #{ex}"), :heading)
-        Text.out(ex.backtrace.join("\n").gsub("\n", "\n#{''.ljust(10)}"))
+
+        write_error_log do |log|
+          log << Command.history_to_s
+          log << ex.message + "\n"
+          log << ex.backtrace.map { |line| "    #{line}\n" }.join
+        end
+
         Text.new_line
 
       ensure
         Text.finish
       end
     end
+
+
+  private
+    def write_error_log
+      log_directory = File.join(Configuration.tmp_directory, 'logs')
+      error_log     = File.join(log_directory, Time.now.strftime("%Y%m%d%H%M%S") + '-error.log')
+
+      Command.execute("mkdir -p #{log_directory}") unless Dir.exists?(log_directory)
+
+      File.open(error_log, 'w') { |file| yield(file) }
+
+      Text.out("An error log has been created: #{error_log}")
+      error_log
+    end
   end
 end

data/lib/git-runner/command.rb

@@ -24,6 +24,12 @@ module GitRunner
       @history ||= []
     end
 
+    def history_to_s
+      history.map do |result|
+        "Status: #{result.status}; Command: #{result.command}\n#{result.out}\n--------------------\n"
+      end.join
+    end
+
 
   private
     def session

data/lib/git-runner/configuration.rb

@@ -2,19 +2,45 @@ module GitRunner
   module Configuration
     extend self
 
+    FILE_LOCATIONS = %w(/etc/git-runner.yml ~/.git-runner.yml)
+
+    DEFAULTS = {
+      'git_executable'     => '/usr/bin/env git',
+      'instruction_file'   => 'config/deploy.rb',
+      'instruction_prefix' => '# GitRunner:',
+      'tmp_directory'      => '/tmp/git-runner',
+    }
+
+
     def __attributes
-      # TODO: Load configuration from /etc/git-runner.conf
-      @attributes ||= DEFAULT_CONFIGURATION.dup
+      @attributes ||= __load_attributes
     end
 
     def method_missing(method, *args, &block)
-      if __attributes.keys.include?(method)
-        __attributes[method]
+      method_s = method.to_s
+
+      if __attributes.keys.include?(method_s)
+        __attributes[method_s]
       elsif method.to_s.end_with?('=')
-        __attributes[method.to_s[0..-2].to_sym] = args[0]
+        __attributes[method_s[0..-2]] = args[0]
       else
         super
       end
     end
+
+
+  private
+    def __load_attributes
+      attrs = DEFAULTS.dup
+
+      FILE_LOCATIONS.each do |location|
+        begin
+          path = File.expand_path(location)
+          attrs.merge!(YAML.load_file(path)) if File.exist?(path)
+        end
+      end
+
+      attrs
+    end
   end
 end

data/lib/git-runner/hooks.rb

@@ -0,0 +1,19 @@
+module GitRunner
+  module Hooks
+    extend self
+
+
+    def registrations
+      @registrations ||= Hash.new { |hash, key| hash[key] = [] }
+    end
+
+    def register(name, object, method)
+      registrations[name] << [ object, method ]
+    end
+
+    def fire(name)
+      return unless registrations.keys.include?(name)
+      registrations[name].each { |object, method| object.send(method) }
+    end
+  end
+end

data/lib/git-runner/instruction.rb

@@ -2,22 +2,16 @@ Dir[File.join(File.dirname(__FILE__), 'instructions', '*.rb')].each { |file| req
 
 module GitRunner
   class Instruction
-    class InstructionHalted < StandardError ; end
-
-
     def self.new(name, args={})
       begin
         const_get(name).new(args)
 
       rescue NameError => e
-        # Return a console message instruction to inform the user
-        instruction      = ConsoleMessage.new(Text.red("\u2716 Instruction not found: #{name}"))
-        instruction.opts = {
-          :halt     => true,
+        # Display message for missing instruction, halt further execution
+        Display.new(Text.red("\u2716 Instruction not found: #{name}"), {
+          :fail     => true,
           :priority => true
-        }
-
-        instruction
+        })
       end
     end
 
@@ -26,3 +20,10 @@ module GitRunner
     end
   end
 end
+
+module GitRunner
+  class Instruction
+    class Failure < StandardError
+    end
+  end
+end

data/lib/git-runner/instructions/base.rb

@@ -4,8 +4,9 @@ module GitRunner
       attr_accessor :branch, :args, :opts
 
 
-      def initialize(args)
+      def initialize(args, opts={})
         self.args = args
+        self.opts = opts
       end
 
       def perform
@@ -17,8 +18,8 @@ module GitRunner
           perform
           Text.new_line
 
-          if halt?
-            raise InstructionHalted.new(self)
+          if opts[:fail]
+            raise Failure.new(self)
           end
         end
       end
@@ -27,17 +28,8 @@ module GitRunner
         true
       end
 
-      def halt!
-        self.opts ||= {}
-        self.opts[:halt] = true
-      end
-
-      def halt?
-        self.opts && !!self.opts[:halt]
-      end
-
-      def priority?
-        self.opts && !!self.opts[:priority]
+      def fail!
+        raise Failure.new(self)
       end
 
 

data/lib/git-runner/instructions/{console_message.rb → display.rb}

@@ -1,6 +1,6 @@
 module GitRunner
   class Instruction
-    class ConsoleMessage < Base
+    class Display < Base
       def perform
         Text.out(message, :heading)
       end

data/lib/git-runner/version.rb

@@ -1,3 +1,3 @@
 module GitRunner
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-runner
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-05 00:00:00.000000000 Z
+date: 2012-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: session
@@ -49,10 +49,10 @@ files:
 - lib/git-runner/branch.rb
 - lib/git-runner/command.rb
 - lib/git-runner/configuration.rb
+- lib/git-runner/hooks.rb
 - lib/git-runner/instruction.rb
 - lib/git-runner/instructions/base.rb
-- lib/git-runner/instructions/console_message.rb
-- lib/git-runner/instructions/deploy.rb
+- lib/git-runner/instructions/display.rb
 - lib/git-runner/text.rb
 - lib/git-runner/version.rb
 homepage: https://github.com/JamesBrooks/git-runner

data/lib/git-runner/instructions/deploy.rb

@@ -1,111 +0,0 @@
-require 'digest'
-
-module GitRunner
-  class Instruction
-
-    # Performs deployments using capistrano (cap deploy)
-    class Deploy < Base
-      attr_accessor :clone_directory
-
-
-      def should_run?
-        branches.empty? || branches.include?(branch.name)
-      end
-
-      def perform
-        start_time = Time.now
-
-        Text.out(Text.green("Performing Deploy (#{environment_from_branch(branch)})"), :heading)
-
-        checkout_branch
-
-        if missing_capfile?
-          Text.out(Text.red("Missing Capfile, unable to complete deploy."))
-          halt! && return
-        end
-
-        prepare_deploy_environment
-        perform_deploy
-        cleanup_deploy_environment
-
-        end_time = Time.now
-
-        Text.out(Text.green("\u2714 Deploy successful, completed in #{(end_time - start_time).ceil} seconds"))
-      end
-
-      def branches
-        args.split(/\s+/)
-      end
-
-      def rvm_string
-        "#{Configuration.rvm_ruby_version}@git-runner-#{branch.repository_name}-#{branch.name}"
-      end
-
-      def missing_capfile?
-        !File.exists?("#{clone_directory}/Capfile")
-      end
-
-      def uses_bundler?
-        File.exists?("#{clone_directory}/Gemfile")
-      end
-
-      def multistage?
-        result = execute("grep -e 'require.*capistrano.*multistage' #{clone_directory}/#{Configuration.instruction_file} || true")
-        !result.empty?
-      end
-
-      def checkout_branch
-        timestamp            = Time.now.strftime("%Y%m%d%H%M%S")
-        self.clone_directory = File.join(Configuration.tmp_directory, "#{branch.repository_name}-#{environment_from_branch(branch)}-#{timestamp}")
-
-        Text.out("Checking out #{branch.name} to #{clone_directory}")
-
-        execute(
-          "mkdir -p #{clone_directory}",
-          "git clone --depth=1 --branch=#{branch.name} file://#{branch.repository_path} #{clone_directory}"
-        )
-      end
-
-      def prepare_deploy_environment
-        Text.out("Preparing deploy environment")
-
-        if uses_bundler?
-          execute(
-            "cd #{clone_directory}",
-            "bundle install --path=#{File.join(Configuration.tmp_directory, '.gems')}"
-          )
-        end
-      end
-
-      def perform_deploy
-        cap_deploy_command = if multistage?
-          Text.out("Deploying application (multistage detected)")
-          "cap #{environment_from_branch(branch)} deploy"
-        else
-          Text.out("Deploying application")
-          "cap deploy"
-        end
-
-        execute(
-          "cd #{clone_directory}",
-          cap_deploy_command
-        )
-      end
-
-      def cleanup_deploy_environment
-        Text.out("Cleaning deploy environment")
-        execute("rm -rf #{clone_directory}")
-      end
-
-
-    private
-      def environment_from_branch(branch)
-        if branch.name == 'master'
-          'production'
-        else
-          branch.name
-        end
-      end
-    end
-  end
-end