joshuapinter-cijoe 0.9.3

data/lib/cijoe/queue.rb

@@ -0,0 +1,55 @@
+class CIJoe
+  # An in memory queue used for maintaining an order list of requested
+  # builds.
+  class Queue
+    # enabled - determines whether builds should be queued or not.
+    def initialize(enabled, verbose=false)
+      @enabled = enabled
+      @verbose = verbose
+      @queue = []
+
+      log("Build queueing enabled") if enabled
+    end
+
+    # Public: Appends a branch to be built, unless it already exists
+    # within the queue.
+    #
+    # branch - the name of the branch to build or nil if the default
+    #         should be built.
+    #
+    # Returns nothing
+    def append_unless_already_exists(branch)
+      return unless enabled?
+      unless @queue.include? branch
+        @queue << branch
+        log "#{Time.now.to_i}: Queueing #{branch}"
+      end
+    end
+
+    # Returns a String of the next branch to build
+    def next_branch_to_build
+      branch = @queue.shift
+      log "#{Time.now.to_i}: De-queueing #{branch}"
+      branch
+    end
+
+    # Returns true if there are requested builds waiting and false
+    # otherwise.
+    def waiting?
+      if enabled?
+        not @queue.empty?
+      else
+        false
+      end
+    end
+
+  protected
+    def log(msg)
+      puts msg if @verbose
+    end
+
+    def enabled?
+      @enabled
+    end
+  end
+end

data/lib/cijoe/server.rb

@@ -0,0 +1,114 @@
+require 'sinatra/base'
+require 'erb'
+require 'json'
+
+class CIJoe
+  class Server < Sinatra::Base
+    attr_reader :joe
+
+    dir = File.dirname(File.expand_path(__FILE__))
+
+    set :views, "#{dir}/views"
+    set :public_folder, "#{dir}/public"
+    set :static, true
+    set :lock, true
+
+    before { joe.restore }
+
+    get '/ping' do
+      if joe.building? || !joe.last_build || !joe.last_build.worked?
+        halt 412, (joe.building? || joe.last_build.nil?) ? "building" : joe.last_build.sha
+      end
+
+      joe.last_build.sha
+    end
+
+    get '/?' do
+      erb(:template, {}, :joe => joe)
+    end
+
+    post '/?' do
+      unless params[:rebuild]
+        payload = JSON.parse(params[:payload])
+        pushed_branch = payload["ref"].split('/').last
+      end
+      
+      # Only build if we were given an explicit branch via `?branch=blah`
+      # or the payload exists and the "ref" property matches our 
+      # specified build branch.
+      if params[:branch] || params[:rebuild] || pushed_branch == joe.git_branch
+        joe.build(params[:branch])
+      end
+
+      redirect request.path
+    end
+
+    get '/api/json' do
+        response  = [200, {'Content-Type' => 'application/json'}]
+        response_json = erb(:json, {}, :joe => joe)
+      if params[:jsonp]
+        response << params[:jsonp] + '(' +  response_json + ')'
+      else
+        response << response_json
+      end
+      response
+    end
+
+
+    helpers do
+      include Rack::Utils
+      alias_method :h, :escape_html
+
+      # thanks integrity!
+      def ansi_color_codes(string)
+        string.gsub("\e[0m", '</span>').
+          gsub(/\e\[(\d+)m/, "<span class=\"color\\1\">")
+      end
+
+      def pretty_time(time)
+        time.strftime("%Y-%m-%d %H:%M")
+      end
+
+      def cijoe_root
+        root = request.path
+        root = "" if root == "/"
+        root
+      end
+    end
+
+    def initialize(*args)
+      super
+      check_project
+      @joe = CIJoe.new(options.project_path)
+    end
+
+    def self.start(host, port, project_path)
+      set :project_path, project_path
+      CIJoe::Server.run! :host => host, :port => port
+    end
+
+    def self.rack_start(project_path)
+      set :project_path, project_path
+      self.new
+    end
+
+    def self.project_path=(project_path)
+      user, pass = Config.cijoe(project_path).user.to_s, Config.cijoe(project_path).pass.to_s
+      if user != '' && pass != ''
+        use Rack::Auth::Basic do |username, password|
+          [ username, password ] == [ user, pass ]
+        end
+        puts "Using HTTP basic auth"
+      end
+      set :project_path, Proc.new{project_path}, true
+    end
+
+    def check_project
+      if options.project_path.nil? || !File.exists?(File.expand_path(options.project_path))
+        puts "Whoops! I need the path to a Git repo."
+        puts "  $ git clone git@github.com:username/project.git project"
+        abort "  $ cijoe project"
+      end
+    end
+  end
+end

data/lib/cijoe/version.rb

@@ -0,0 +1,3 @@
+class CIJoe
+  Version = VERSION = "0.9.3"
+end

data/lib/cijoe/views/json.erb

@@ -0,0 +1,16 @@
+{ "jobs": [
+<% if joe.last_build %>
+{"name":"<%= joe.project %>",
+ "url":"<%= joe.url %>",
+ "color":"<%= joe.last_build.status.to_s == "failed" ? 'red' : 'blue' %>",
+ "status":"<%= joe.last_build.status %>",
+ "started_at":"<%= pretty_time(joe.last_build.started_at) %>",
+ "finished_at":"<%= pretty_time(joe.last_build.finished_at) %>",
+ "duration":"<%= joe.last_build.duration if joe.last_build.duration %>",
+ "sha":"<%= joe.last_build.sha %>",
+ "short_sha":"<%= joe.last_build.short_sha %>",
+ "commit_url":"<%= joe.last_build.commit.url if joe.last_build.commit %>",
+ "branch":"<%= joe.last_build.branch %>"
+ }
+<% end %>
+]}

data/lib/cijoe/views/template.erb

@@ -0,0 +1,74 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <link href="<%= cijoe_root %>/screen.css" media="screen" rel="stylesheet" type="text/css" />
+    <link rel="shortcut icon" href="<%= cijoe_root %>/favicon.ico" type="image/x-icon" />
+    <title><%= h(joe.project) %>: CI Joe</title>
+  </head>
+  <body>
+    <div class="site">
+      <div class="title">
+        <a href="<%= cijoe_root %>/">CI Joe</a>
+        <span class="extra">because knowing is half the battle</span>
+      </div>
+
+      <div id="home">
+        <h1><a href="<%= joe.url %>"><%= joe.project %></a></h1>
+        <ul class="posts">
+          <% if joe.current_build %>
+            <li>
+              <span class="date"><%= pretty_time(joe.current_build.started_at) if joe.current_build %></span> &raquo;
+              <% if joe.current_build.sha %>
+                Building <%= joe.current_build.branch %> at <a href="<%= joe.current_build.commit.url %>"><%= joe.current_build.short_sha %></a> <small>(pid: <%= joe.pid %>)</small>
+              <% else %>
+                Build starting...
+              <% end %>
+            </li>
+          <% else %>
+            <li><form method="POST"><input type="hidden", name="rebuild" value="true"><input type="submit" value="Build"/></form></li>
+          <% end %>
+          
+          <% if joe.last_build %>
+            <li>
+              <span class="date"><%= pretty_time(joe.last_build.finished_at) %></span> &raquo;
+              <% if joe.last_build.sha %>
+                Built <%= joe.last_build.branch %> at <a href="<%= joe.last_build.commit.url %>"><%= joe.last_build.short_sha %></a>
+              <% end %>
+              <span class="<%= joe.last_build.status %>">(<%= joe.last_build.status %>)</span>
+              <% if joe.last_build.duration %>
+                in <span class="duration"><%= joe.last_build.duration %></span> seconds.
+              <% end %>
+            </li>
+            <% if joe.last_build.failed? %>
+              <li><pre class="terminal"><code><%=ansi_color_codes h(joe.last_build.output) %></code></pre></li>
+            <% end %>
+          <% end %>
+        </ul>
+      </div>
+
+      <div class="footer">
+        <div class="contact">
+          <p>
+            <a href="https://github.com/defunkt/cijoe#readme">Documentation</a><br/>
+            <a href="https://github.com/defunkt/cijoe">Source</a><br/>
+            <a href="https://github.com/defunkt/cijoe/issues">Issues</a><br/>
+            <a href="https://github.com/defunkt/cijoe/tree/v<%= CIJoe::VERSION %>">v<%= CIJoe::VERSION %></a>
+          </p>
+        </div>
+        <div class="contact">
+          <p>
+            Designed by <a href="http://tom.preston-werner.com/">Tom Preston-Werner</a><br/>
+            Influenced by <a href="http://integrityapp.com/">Integrity</a><br/>
+            Built with <a href="http://sinatrarb.com/">Sinatra</a><br/>
+            Keep it simple, Sam.
+          </p>
+        </div>        
+        <div class="rss">
+          <a href="http://github.com/defunkt/cijoe">
+            <img src="<%= cijoe_root %>/octocat.png" alt="Octocat!" />
+          </a>
+        </div>
+      </div>
+    </div>
+  </body>
+</html>

data/lib/cijoe.rb

@@ -0,0 +1,225 @@
+##
+# CI Joe.
+# Because knowing is half the battle.
+#
+# This is a stupid simple CI server. It can build one (1)
+# git-based project only.
+#
+# It only remembers the last build.
+#
+# It only notifies to Campfire.
+#
+# It's a RAH (Real American Hero).
+#
+# Seriously, I'm gonna be nuts about keeping this simple.
+
+require 'cijoe/version'
+require 'cijoe/config'
+require 'cijoe/commit'
+require 'cijoe/build'
+require 'cijoe/campfire'
+require 'cijoe/server'
+require 'cijoe/queue'
+
+class CIJoe
+  attr_reader :user, :project, :url, :current_build, :last_build, :campfire
+
+  def initialize(project_path)
+    @project_path = File.expand_path(project_path)
+
+    @user, @project = git_user_and_project
+    @url = "http://github.com/#{@user}/#{@project}"
+
+    @campfire = CIJoe::Campfire.new(project_path)
+
+    @last_build = nil
+    @current_build = nil
+    @queue = Queue.new(!repo_config.buildqueue.to_s.empty?, true)
+
+    trap("INT") { stop }
+  end
+
+  # is a build running?
+  def building?
+    !!@current_build
+  end
+
+  # the pid of the running child process
+  def pid
+    building? and current_build.pid
+  end
+
+  # kill the child and exit
+  def stop
+    Process.kill(9, pid) if pid
+    exit!
+  end
+
+  # build callbacks
+  def build_failed(output, error)
+    finish_build :failed, "#{error}\n\n#{output}"
+    run_hook "build-failed"
+  end
+
+  def build_worked(output)
+    finish_build :worked, output
+    run_hook "build-worked"
+  end
+
+  def finish_build(status, output)
+    @current_build.finished_at = Time.now
+    @current_build.status = status
+    @current_build.output = output
+    @last_build = @current_build
+
+    @current_build = nil
+    write_build 'current', @current_build
+    write_build 'last', @last_build
+    @campfire.notify(@last_build) if @campfire.valid?
+
+    build(@queue.next_branch_to_build) if @queue.waiting?
+  end
+
+  # run the build but make sure only one is running
+  # at a time (if new one comes in we will park it)
+  def build(branch=nil)
+    if building?
+      @queue.append_unless_already_exists(branch)
+      # leave anyway because a current build runs
+      return
+    end
+    @current_build = Build.new(@project_path, @user, @project)
+    write_build 'current', @current_build
+    Thread.new { build!(branch) }
+  end
+
+  def open_pipe(cmd)
+    read, write = IO.pipe
+
+    pid = fork do
+      read.close
+      $stdout.reopen write
+      exec cmd
+    end
+
+    write.close
+
+    yield read, pid
+  end
+
+  # update git then run the build
+  def build!(branch=nil)
+    @git_branch = branch
+    build = @current_build
+    output = ''
+    git_update
+    build.sha = git_sha
+    build.branch = git_branch
+    write_build 'current', build
+
+    open_pipe("cd \"#{@project_path}\" && #{runner_command} 2>&1") do |pipe, pid|
+      puts "#{Time.now.to_i}: Building #{build.branch} at #{build.short_sha}: pid=#{pid}"
+
+      build.pid = pid
+      write_build 'current', build
+      output = pipe.read
+    end
+
+    Process.waitpid(build.pid, 1)
+    status = $?.exitstatus.to_i
+    @current_build = build
+    puts "#{Time.now.to_i}: Built #{build.short_sha}: status=#{status}"
+
+    status == 0 ? build_worked(output) : build_failed('', output)
+  rescue Object => e
+    puts "Exception building: #{e.message} (#{e.class})"
+    build_failed('', e.to_s)
+  end
+
+  # shellin' out
+  def runner_command
+    runner = repo_config.runner.to_s
+    runner == '' ? "rake -s test:units" : runner
+  end
+
+  def git_sha
+    `cd \"#{@project_path}\" && git rev-parse origin/#{git_branch}`.chomp
+  end
+
+  def git_update
+    `cd \"#{@project_path}\" && git fetch origin && git reset --hard origin/#{git_branch}`
+    run_hook "after-reset"
+  end
+
+  def git_user_and_project
+    Config.remote(@project_path).origin.url.to_s.chomp('.git').split(':')[-1].split('/')[-2, 2]
+  end
+
+  def git_branch
+    return @git_branch if @git_branch
+    branch = repo_config.branch.to_s
+    @git_branch = branch == '' ? "master" : branch
+  end
+
+  # massage our repo
+  def run_hook(hook)
+    if File.exists?(file=path_in_project(".git/hooks/#{hook}")) && File.executable?(file)
+      data =
+        if @last_build && @last_build.commit
+          {
+            "MESSAGE" => @last_build.commit.message,
+            "AUTHOR" => @last_build.commit.author,
+            "SHA" => @last_build.commit.sha,
+            "OUTPUT" => @last_build.env_output
+          }
+        else
+          {}
+        end
+
+      orig_ENV = ENV.to_hash
+      ENV.clear
+      data.each{ |k, v| ENV[k] = v }
+      output = `cd \"#{@project_path}\" && sh #{file}`
+      
+      ENV.clear
+      orig_ENV.to_hash.each{ |k, v| ENV[k] = v}
+      output
+    end
+  end
+
+  # restore current / last build state from disk.
+  def restore
+    @last_build = read_build('last')
+    @current_build = read_build('current')
+
+    Process.kill(0, @current_build.pid) if @current_build && @current_build.pid
+  rescue Errno::ESRCH
+    # build pid isn't running anymore. assume previous
+    # server died and reset.
+    @current_build = nil
+  end
+
+  def path_in_project(path)
+    File.join(@project_path, path)
+  end
+
+  # write build info for build to file.
+  def write_build(name, build)
+    filename = path_in_project(".git/builds/#{name}")
+    Dir.mkdir path_in_project('.git/builds') unless File.directory?(path_in_project('.git/builds'))
+    if build
+      build.dump filename
+    elsif File.exist?(filename)
+      File.unlink filename
+    end
+  end
+
+  def repo_config
+    Config.cijoe(@project_path)
+  end
+
+  # load build info from file.
+  def read_build(name)
+    Build.load(path_in_project(".git/builds/#{name}"), @project_path)
+  end
+end

data/test/fixtures/payload.json

@@ -0,0 +1,52 @@
+{
+    "after": "416cb2f7105e7f989bc223d1a975b93a6491b276",
+    "before": "0ae4da1eea2d191b33ebfbd5db48e3c1f91953ad",
+    "commits": [
+        {
+            "added": [
+                
+            ],
+            "author": {
+                "email": "joshua.owens@gmail.com",
+                "name": "Josh Owens",
+                "username": "queso" 
+            },
+            "id": "09293a1703b3bdb36aba70d38abd5e44396c50a5",
+            "message": "Update README",
+            "modified": [
+                "README.textile" 
+            ],
+            "removed": [
+                
+            ],
+            "timestamp": "2011-02-07T15:27:35-08:00",
+            "url": "https:\/\/github.com\/fourbeansoup\/broth\/commit\/09293a1703b3bdb36aba70d38abd5e44396c50a5" 
+        } 
+    ],
+    "compare": "https:\/\/github.com\/fourbeansoup\/broth\/compare\/0ae4da1...416cb2f",
+    "forced": false,
+    "ref": "refs\/heads\/master",
+    "repository": {
+        "created_at": "2009\/12\/05 10:44:57 -0800",
+        "description": "FourBeanSoup's Broth Application, a tasty starting point for every app",
+        "fork": true,
+        "forks": 4,
+        "has_downloads": true,
+        "has_issues": true,
+        "has_wiki": true,
+        "homepage": "",
+        "language": "JavaScript",
+        "name": "broth",
+        "open_issues": 2,
+        "organization": "fourbeansoup",
+        "owner": {
+            "email": "josh+scm@fourbeansoup.com",
+            "name": "fourbeansoup" 
+        },
+        "private": false,
+        "pushed_at": "2011\/02\/07 17:17:00 -0800",
+        "size": 604,
+        "url": "https:\/\/github.com\/fourbeansoup\/broth",
+        "watchers": 10 
+    }
+}

data/test/helper.rb

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+
+ENV['RACK_ENV'] = 'test'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'cijoe'
+
+CIJoe::Server.set :project_path, "."
+CIJoe::Server.set :environment,  "test"
+
+TMP_DIR = '/tmp/cijoe_test'
+
+def tmp_dir
+  TMP_DIR
+end
+
+def setup_git_info(options = {})
+  @tmp_dirs ||= []
+  @tmp_dirs += [options[:tmp_dir]]
+  create_tmpdir!(options[:tmp_dir])
+  dir = options[:tmp_dir] || tmp_dir
+  `cd #{dir} && git init`
+  options[:config].each do |key, value|
+    `cd #{dir} && git config --add #{key} "#{value}"`
+  end
+end
+
+def teardown_git_info
+  remove_tmpdir!
+  @tmp_dirs.each do |dir|
+    remove_tmpdir!(dir)
+  end
+end
+
+def remove_tmpdir!(passed_dir = nil)
+  FileUtils.rm_rf(passed_dir || tmp_dir)
+end
+
+def create_tmpdir!(passed_dir = nil)
+  FileUtils.mkdir_p(passed_dir || tmp_dir)
+end
+
+class Test::Unit::TestCase
+end

data/test/test_campfire.rb

@@ -0,0 +1,48 @@
+require "helper"
+require "cijoe"
+require "fakefs/safe"
+
+
+class TestCampfire < Test::Unit::TestCase
+
+  class ::CIJoe
+    attr_writer :current_build, :last_build
+  end
+
+  attr_accessor :app
+
+  def setup
+    @app = CIJoe::Server.new
+    joe = @app.joe
+    
+    # make Build#restore a no-op so we don't overwrite our current/last
+    # build attributes set from tests.
+    def joe.restore
+    end
+    
+    # make CIJoe#build! and CIJoe#git_update a no-op so we don't overwrite our local changes
+    # or local commits nor should we run tests.
+    def joe.build!
+    end
+  end
+  
+  def teardown
+    teardown_git_info
+  end
+  
+  def test_campfire_pulls_campfire_config_from_git_config
+    setup_git_info(:config => {"campfire.subdomain" => "github", "remote.origin.url" => "https://github.com/defunkt/cijoe.git"})
+    cf = CIJoe::Campfire.new(tmp_dir)
+    assert_equal "github", cf.campfire_config[:subdomain]
+  end
+  
+  def test_campfire_pulls_campfire_config_from_its_own_git_config
+    setup_git_info(:config => {"campfire.subdomain" => "github"})
+    setup_git_info(:config => {"campfire.subdomain" => "37signals"}, :tmp_dir => "/tmp/cijoe_test_37signals")
+    cf1 = CIJoe::Campfire.new(tmp_dir)
+    cf2 = CIJoe::Campfire.new("/tmp/cijoe_test_37signals")
+    assert_equal "github", cf1.campfire_config[:subdomain]
+    assert_equal "37signals", cf2.campfire_config[:subdomain]
+  end
+  
+end

data/test/test_cijoe.rb

@@ -0,0 +1,17 @@
+require 'helper'
+
+class TestCIJoe < Test::Unit::TestCase
+  def test_raise_error_on_invalid_command
+    assert_raise RuntimeError, LoadError do
+      CIJoe::Config.new('--invalid').to_s
+    end
+  end
+  
+  def test_return_value_of_config
+    assert_equal `git config blame`.chomp, CIJoe::Config.new('blame').to_s
+  end
+  
+  def test_return_empty_string_when_config_does_not_exist
+    assert_equal '', CIJoe::Config.new('invalid').to_s
+  end
+end

data/test/test_cijoe_queue.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+class TestCIJoeQueue < Test::Unit::TestCase
+  def test_a_disabled_queue
+    subject = CIJoe::Queue.new(false)
+    subject.append_unless_already_exists("test")
+    assert_equal false, subject.waiting?
+  end
+
+  def test_adding_two_items_to_a_queue
+    subject = CIJoe::Queue.new(true)
+    subject.append_unless_already_exists("test")
+    subject.append_unless_already_exists(nil)
+    assert_equal true, subject.waiting?
+    assert_equal "test", subject.next_branch_to_build
+    assert_equal nil, subject.next_branch_to_build
+    assert_equal false, subject.waiting?
+  end
+
+  def test_adding_two_duplicate_items_to_a_queue
+    subject = CIJoe::Queue.new(true)
+    subject.append_unless_already_exists("test")
+    subject.append_unless_already_exists("test")
+    assert_equal true, subject.waiting?
+    assert_equal "test", subject.next_branch_to_build
+    assert_equal false, subject.waiting?
+  end
+end