git-runner 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in git-runner.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 James Brooks
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# GitRunner
+
+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.
+
+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).
+
+## Installation
+
+    $ gem install git-runner
+
+## Usage
+
+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.
+
+## TODO
+
+* Allow file based configuration (currently configuration is hard-coded)
+* Extract our non-core instruction functionality into individual gems (e.g. the Deploy instruction)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/git-runner

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require 'pathname'
+
+$:.unshift File.expand_path('../../lib', Pathname.new(__FILE__).realpath)
+
+
+require 'git-runner'
+
+GitRunner::Base.new(ARGV).run

data/git-runner.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/git-runner/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  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."
+  gem.description   = "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."
+  gem.homepage      = "https://github.com/JamesBrooks/git-runner"
+
+  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/base.rb

@@ -0,0 +1,61 @@
+module GitRunner
+  class Base
+    attr_accessor :refs
+
+
+    def initialize(refs=[])
+      self.refs = refs
+    end
+
+    def run
+      begin
+        Text.begin
+
+        if refs && refs.is_a?(Array)
+          repository_path = Dir.pwd
+
+          # Only process HEAD references
+          refs.select { |str| str =~ /^refs\/heads\// }.each do |ref|
+            branch_name = ref.split('/').last
+            branch      = Branch.new(repository_path, branch_name)
+
+            branch.run
+          end
+        end
+
+
+      rescue GitRunner::Instruction::InstructionHalted => ex
+        Text.out("Stopping runner, no further instructions will be performed\n")
+
+      rescue GitRunner::Command::Failure => ex
+        Text.out("\n")
+        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
+        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)}"))
+        Text.new_line
+
+      ensure
+        Text.finish
+      end
+    end
+  end
+end

data/lib/git-runner/branch.rb

@@ -0,0 +1,42 @@
+module GitRunner
+  class Branch
+    attr_accessor :repository_path, :name
+
+
+    def initialize(repository_path, name)
+      self.repository_path = repository_path
+      self.name            = name
+    end
+
+    def run
+      instructions.each do |instruction|
+        instruction.run
+      end
+    end
+
+    def instructions
+      @instructions ||= extract_instructions
+    end
+
+    def repository_name
+      repository_path.split(File::SEPARATOR).last.gsub('.git', '')
+    end
+
+  private
+    def extract_instructions
+      # Use git to grep the current branch for instruction lines within the specific instruction file
+      output = Command.execute(
+        "cd #{repository_path}",
+        "git grep '^#{Configuration.instruction_prefix}' #{name}:#{Configuration.instruction_file}"
+      )
+
+      # Process the output to generate instructions
+      output.split("\n").map do |line|
+        instruction        = Instruction.from_raw(line)
+        instruction.branch = self
+
+        instruction
+      end
+    end
+  end
+end

data/lib/git-runner/command.rb

@@ -0,0 +1,66 @@
+require 'session'
+
+module GitRunner
+  module Command
+    extend self
+
+
+    def execute(*commands)
+      commands.each do |command|
+        out = StringIO::new
+
+        session.execute command, :stdout => out, :stderr => out
+
+        result = Result.new(command, out.string, session.exit_status)
+        history << result
+
+        raise Failure.new(result) if result.failure?
+      end
+
+      history.last.out
+    end
+
+    def history
+      @history ||= []
+    end
+
+
+  private
+    def session
+      @session ||= Session::Bash::Login.new
+    end
+  end
+end
+
+module GitRunner
+  module Command
+    class Result
+      attr_accessor :command, :out, :status
+
+
+      def initialize(command, out, status)
+        self.command = command
+        self.out     = out
+        self.status  = status
+      end
+
+      def success?
+        status == 0
+      end
+
+      def failure?
+        !success?
+      end
+    end
+
+    class Failure < StandardError
+      attr_accessor :result
+
+
+      def initialize(result)
+        super(result.command)
+        self.result = result
+      end
+    end
+  end
+end

data/lib/git-runner/configuration.rb

@@ -0,0 +1,20 @@
+module GitRunner
+  module Configuration
+    extend self
+
+    def __attributes
+      # TODO: Load configuration from /etc/git-runner.conf
+      @attributes ||= DEFAULT_CONFIGURATION.dup
+    end
+
+    def method_missing(method, *args, &block)
+      if __attributes.keys.include?(method)
+        __attributes[method]
+      elsif method.to_s.end_with?('=')
+        __attributes[method.to_s[0..-2].to_sym] = args[0]
+      else
+        super
+      end
+    end
+  end
+end

data/lib/git-runner/instruction.rb

@@ -0,0 +1,28 @@
+Dir[File.join(File.dirname(__FILE__), 'instructions', '*.rb')].each { |file| require file }
+
+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,
+          :priority => true
+        }
+
+        instruction
+      end
+    end
+
+    def self.from_raw(raw)
+      new(*%r[#{Regexp.escape(Configuration.instruction_prefix)}\s*(\w+)\s*(.*)$].match(raw).captures)
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+module GitRunner
+  class Instruction
+    class Base
+      attr_accessor :branch, :args, :opts
+
+
+      def initialize(args)
+        self.args = args
+      end
+
+      def perform
+        # No-op
+      end
+
+      def run
+        if should_run?
+          perform
+          Text.new_line
+
+          if halt?
+            raise InstructionHalted.new(self)
+          end
+        end
+      end
+
+      def should_run?
+        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]
+      end
+
+
+    private
+      def execute(*commands)
+        Command.execute(*commands)
+      end
+    end
+  end
+end

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

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

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

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

data/lib/git-runner/text.rb

@@ -0,0 +1,67 @@
+module GitRunner
+  class Text
+    COLOR_START = "\033["
+    COLOR_END   = "m"
+    COLOR_RESET = "#{COLOR_START}0#{COLOR_END}"
+
+    COLORS = {
+      :black  => 30,
+      :red    => 31,
+      :green  => 32,
+      :yellow => 33,
+      :blue   => 34,
+      :purple => 35,
+      :cyan   => 36,
+      :white  => 37
+    }
+
+    STYLES = {
+      :normal    => 0,
+      :bold      => 1,
+      :underline => 4
+    }
+
+
+    class << self
+      def begin
+        STDOUT.sync = true
+        print("\e[1G       \e[1G")
+      end
+
+      def finish
+        print("\n")
+      end
+
+      def out(str, style=nil)
+        # Ensure that new lines overwrite the default 'remote: ' text
+        str = str.gsub("\n", "\n\e[1G#{padding(nil)}")
+
+        print "\n\e[1G#{padding(style).ljust(7)}#{str}"
+      end
+
+      def new_line
+        out('')
+      end
+
+      # Color methods
+      COLORS.each do |color, code|
+        class_eval <<-EOF
+          def #{color}(str, style=:normal)
+            "#{COLOR_START}\#{STYLES[style]};#{code}#{COLOR_END}\#{str}#{COLOR_RESET}"
+          end
+        EOF
+      end
+
+
+    private
+      def padding(style)
+        case style
+        when :heading
+          '----->'
+        else
+          ''
+        end
+      end
+    end
+  end
+end

data/lib/git-runner/version.rb

@@ -0,0 +1,3 @@
+module GitRunner
+  VERSION = '0.0.1'
+end

data/lib/git-runner.rb

@@ -0,0 +1,17 @@
+require "git-runner/version"
+require "git-runner/base"
+require "git-runner/command"
+require "git-runner/configuration"
+require "git-runner/branch"
+require "git-runner/instruction"
+require "git-runner/text"
+
+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

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: git-runner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- James Brooks
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: session
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 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.
+email:
+- james@jamesbrooks.net
+executables:
+- git-runner
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/git-runner
+- git-runner.gemspec
+- lib/git-runner.rb
+- lib/git-runner/base.rb
+- lib/git-runner/branch.rb
+- lib/git-runner/command.rb
+- lib/git-runner/configuration.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/text.rb
+- lib/git-runner/version.rb
+homepage: https://github.com/JamesBrooks/git-runner
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby framework to run tasks after code has been pushed to a Git repository.
+test_files: []