janky 0.9.13 → 0.9.14.rc1

data/CHANGES

@@ -1,3 +1,11 @@
+= 0.9.14 / 2012-??-??
+
+ * Make the Jenkins job name human readable [Riley Guerin]
+
+ * Added GithubStatus Notifier for GitHub Status API: see https://github.com/blog/1227-status-api
+
+ * Added Build#queued_at for tracking when builds were queued vs actually built
+
 = 0.9.13 / 2012-06-24
 
  * Pull down the branch HEAD commit from the GitHub API for manual builds.

data/README.md

@@ -148,6 +148,17 @@ Using Janky with [GitHub Enterprise][ghe] requires one extra setting:
 
 [ghe]: https://enterprise.github.com
 
+### GitHub Status API
+
+https://github.com/blog/1227-commit-status-api
+
+To update pull requests with the build status generate an OAuth token
+like so:
+
+  curl -u username:password -d '{ "scopes": [ "repo:status" ], "note": "janky" }' https://api.github.com/authorizations
+
+then set `JANKY_GITHUB_STATUS_TOKEN`.
+
 ### Chat Notification
 
 #### Campfire
@@ -221,33 +232,33 @@ Hacking
 
 Get your environment up and running:
 
-    $ script/bootstrap
+    script/bootstrap
 
 Create the databases:
 
-    $ mysqladmin -uroot create janky_development
-    $ mysqladmin -uroot create janky_test
+    mysqladmin -uroot create janky_development
+    mysqladmin -uroot create janky_test
 
 Create the tables:
 
-    $ RACK_ENV=development bin/rake db:migrate
-    $ RACK_ENV=test bin/rake db:migrate
+    RACK_ENV=development bin/rake db:migrate
+    RACK_ENV=test bin/rake db:migrate
 
 Seed some data into the development database:
 
-    $ bin/rake db:seed
+    bin/rake db:seed
 
 Start the server:
 
-    $ script/server
+    script/server
 
 Open the app:
 
-    $ open http://localhost:9393/
+    open http://localhost:9393/
 
 Run the test suite:
 
-    $ bin/rake
+    script/test
 
 Contributing
 ------------

data/Rakefile

@@ -18,9 +18,7 @@ task "db:seed" do
   end
 end
 
-require "rake/testtask"
-Rake::TestTask.new(:test) do |t|
-  t.test_files = FileList["test/*_test.rb"]
-  t.ruby_opts << '-Itest -Ilib'
+task :test do
+  abort "Use script/test to run the test suite."
 end
 task :default => :test

data/janky.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new "janky", Janky::VERSION do |s|
 
   # test
   s.add_development_dependency "database_cleaner", "~>0.6"
+  s.add_development_dependency "mocha", "~>0.10.4"
 
   s.files = %w[
 CHANGES
@@ -64,6 +65,7 @@ lib/janky/database/migrate/1317384650_add_build_indexes.rb
 lib/janky/database/migrate/1317384651_add_more_build_indexes.rb
 lib/janky/database/migrate/1317384652_change_commit_message_to_text.rb
 lib/janky/database/migrate/1317384653_add_build_pusher.rb
+lib/janky/database/migrate/1317384654_add_build_queued_at.rb
 lib/janky/database/schema.rb
 lib/janky/database/seed.dump.gz
 lib/janky/exception.rb
@@ -79,6 +81,7 @@ lib/janky/hubot.rb
 lib/janky/job_creator.rb
 lib/janky/notifier.rb
 lib/janky/notifier/chat_service.rb
+lib/janky/notifier/github_status.rb
 lib/janky/notifier/mock.rb
 lib/janky/notifier/multi.rb
 lib/janky/public/css/base.css

data/lib/janky.rb

@@ -46,6 +46,7 @@ require "janky/notifier"
 require "janky/notifier/chat_service"
 require "janky/notifier/mock"
 require "janky/notifier/multi"
+require "janky/notifier/github_status"
 require "janky/app"
 require "janky/views/layout"
 require "janky/views/index"
@@ -97,6 +98,7 @@ module Janky
       settings["JANKY_BASE_URL"] = settings["JANKY_BASE_URL"] + "/"
     end
     base_url = URI(settings["JANKY_BASE_URL"]).to_s
+    Build.base_url = base_url
 
     connection = {
       :adapter   => adapter,
@@ -197,7 +199,14 @@ module Janky
     end
     ChatService.setup(chat_name, chat_settings, chat_room)
 
-    Notifier.setup(Notifier::ChatService)
+    if token = settings["JANKY_GITHUB_STATUS_TOKEN"]
+      Notifier.setup([
+        Notifier::GithubStatus.new(token, api_url),
+        Notifier::ChatService
+      ])
+    else
+      Notifier.setup(Notifier::ChatService)
+    end
   end
 
   # List of settings required in production.
@@ -212,10 +221,10 @@ module Janky
       JANKY_HUBOT_USER JANKY_HUBOT_PASSWORD]
   end
 
-  # Directory where Jenkins job configuration templates are located.
-  #
-  # Returns the directory as a Pathname.
   class << self
+    # Directory where Jenkins job configuration templates are located.
+    #
+    # Returns the directory as a Pathname.
     attr_accessor :jobs_config_dir
   end
 
@@ -272,7 +281,6 @@ module Janky
 
       # Web dashboard
       map "/" do
-        use Janky::NoAuth
         run Janky::App
       end
     }

data/lib/janky/app.rb

@@ -40,7 +40,7 @@ module Janky
 
     get "/?" do
       authorize_index
-      @builds = Build.started.first(50)
+      @builds = Build.queued.first(50)
       mustache :index
     end
 
@@ -54,7 +54,7 @@ module Janky
       repo = find_repo(repo_name)
       authorize_repo(repo)
 
-      @builds = repo.builds.started.first(50)
+      @builds = repo.builds.queued.first(50)
       mustache :index
     end
 
@@ -62,20 +62,8 @@ module Janky
       repo = find_repo(repo_name)
       authorize_repo(repo)
 
-      @builds = repo.branch_for(branch).builds.started.first(50)
+      @builds = repo.branch_for(branch).queued_builds.first(50)
       mustache :index
     end
   end
-
-  class NoAuth < Sinatra::Base
-    register Helpers
-
-    get "/boomtown" do
-      raise Error, "boomtown"
-    end
-
-    get "/site/sha" do
-      `cd /data/janky && git rev-parse HEAD`
-    end
-  end
 end

data/lib/janky/branch.rb

@@ -46,6 +46,11 @@ module Janky
       builds.completed
     end
 
+    # See Build.queued.
+    def queued_builds
+      builds.queued
+    end
+
     # Create a build for the given commit.
     #
     # commit  - the Janky::Commit instance to build.

data/lib/janky/build.rb

@@ -39,6 +39,13 @@ module Janky
       end
     end
 
+    # Find all builds that have been queued in Jenkins, most recent first.
+    #
+    # Returns an Array of Build objects.
+    def self.queued
+      where("queued_at IS NOT NULL").order("queued_at DESC, id DESC")
+    end
+
     # Find all started builds, most recent first.
     #
     # Returns an Array of Builds.
@@ -61,6 +68,21 @@ module Janky
       completed.where(:green => true)
     end
 
+    # Has this build been queued in Jenkins?
+    #
+    # Returns true when the build is complete or currently being built,
+    #   false otherwise.
+    def queued?
+      ! queued_at.nil?
+    end
+
+    # Is this build currently sitting in the queue waiting to be built?
+    #
+    # Returns true if the build is queued and not started, false otherwise.
+    def pending?
+      queued? && !started?
+    end
+
     # Is this build currently being built?
     #
     # Returns a Boolean.
@@ -94,6 +116,7 @@ module Janky
     # Returns nothing.
     def run
       builder.run(self)
+      update_attributes!(:queued_at => Time.now)
     end
 
     # See Repository#builder.
@@ -192,6 +215,30 @@ module Janky
       end
     end
 
+    class << self
+      # The full URL of the web app as a String, including the protocol.
+      attr_accessor :base_url
+
+      # The full URL to the Jenkins build page, as a String.
+      attr_reader :url
+    end
+
+    # URL of this build's web page, served by Janky::App.
+    #
+    # Returns the URL as a String.
+    def web_url
+      return if new_record?
+      self.class.base_url + "#{id}/output"
+    end
+
+    # URL of the web page for this build's branch, served by Janky::App.
+    #
+    # Returns the URL as a String.
+    def branch_url
+      return if new_record?
+      self.class.base_url + "#{repo_name}/#{branch_name}"
+    end
+
     def repo_id
       repository.id
     end
@@ -204,6 +251,10 @@ module Janky
       repository.name
     end
 
+    def repo_nwo
+      repository.nwo
+    end
+
     def repository
       branch.repository
     end

data/lib/janky/builder/http.rb

@@ -20,7 +20,7 @@ module Janky
 
         response = http.request(request)
 
-        unless response.code == "302"
+        if response.code != "302"
           Exception.push_http_response(response)
           raise Error, "Failed to create build"
         end

data/lib/janky/builder/runner.rb

@@ -19,8 +19,9 @@ module Janky
 
       def json_params
         Yajl.dump(:parameter => [
-          { :name => "JANKY_SHA1", :value => @build.sha1 },
-          { :name => "JANKY_ID",   :value => @build.id }
+          { :name => "JANKY_SHA1",   :value => @build.sha1 },
+          { :name => "JANKY_BRANCH", :value => @build.branch_name },
+          { :name => "JANKY_ID",     :value => @build.id }
         ])
       end
 

data/lib/janky/database/migrate/1317384654_add_build_queued_at.rb

@@ -0,0 +1,12 @@
+class AddBuildQueuedAt < ActiveRecord::Migration
+  def self.up
+    add_column :builds, :queued_at, :datetime, :null => true
+    Janky::Build.started.each do |b|
+      b.update_attributes!(:queued_at => b.created_at)
+    end
+  end
+
+  def self.down
+    remove_column :builds, :queued_at
+  end
+end

data/lib/janky/database/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 1317384652) do
+ActiveRecord::Schema.define(:version => 1317384654) do
 
   create_table "branches", :force => true do |t|
     t.string   "name",          :null => false
@@ -35,6 +35,7 @@ ActiveRecord::Schema.define(:version => 1317384652) do
     t.text     "output"
     t.integer  "room_id"
     t.string   "user"
+    t.datetime "queued_at"
   end
 
   add_index "builds", ["branch_id"], :name => "index_builds_on_branch_id"

data/lib/janky/hubot.rb

@@ -86,13 +86,15 @@ module Janky
 
       repo   = find_repo(repo_name)
       branch = repo.branch_for(branch_name)
-      builds = branch.completed_builds.limit(limit).map do |build|
+      builds = branch.queued_builds.limit(limit).map do |build|
         { :sha1     => build.sha1,
           :repo     => build.repo_name,
           :branch   => build.branch_name,
           :user     => build.user,
           :green    => build.green?,
-          :building => branch.building?,
+          :building => build.building?,
+          :queued   => build.queued?,
+          :pending  => build.pending?,
           :number   => build.number,
           :status   => (build.green? ? "was successful" : "failed"),
           :compare  => build.compare,

data/lib/janky/notifier/chat_service.rb

@@ -12,7 +12,7 @@ module Janky
           build.branch_name,
           status,
           build.duration,
-          build.compare
+          build.web_url
         ]
 
         ::Janky::ChatService.speak(message, build.room_id, {:color => color})

data/lib/janky/notifier/github_status.rb

@@ -0,0 +1,57 @@
+module Janky
+  module Notifier
+    # Create GitHub Status updates for builds.
+    #
+    # Note that Statuses are immutable - so we create one for
+    # "pending" status when a build starts, then create a new status for
+    # "success" or "failure" when the build is complete.
+    class GithubStatus
+      # Initialize with an OAuth token to POST Statuses with
+      def initialize(token, api_url)
+        @token = token
+        @api_url = URI(api_url)
+      end
+
+      # Create a Pending Status for the Commit when it starts.
+      def started(build)
+        repo   = build.repo_nwo
+        path  = "repos/#{repo}/statuses/#{build.sha1}"
+
+        post(path, "pending", build.web_url, "Build ##{build.number} started")
+      end
+
+      # Create a Success or Failure Status for the Commit.
+      def completed(build)
+        repo   = build.repo_nwo
+        path   = "repos/#{repo}/statuses/#{build.sha1}"
+        status = build.green? ? "success" : "failure"
+
+        desc = case status
+          when "success" then "Build ##{build.number} succeeded in #{build.duration}s"
+          when "failure" then "Build ##{build.number} failed in #{build.duration}s"
+        end
+
+        post(path, status, build.web_url, desc)
+      end
+
+      # Internal: POST the new status to the API
+      def post(path, status, url, desc)
+        http = Net::HTTP.new(@api_url.host, @api_url.port)
+        post = Net::HTTP::Post.new("#{@api_url.path}#{path}")
+
+        http.use_ssl = true
+
+        post["Content-Type"] = "application/json"
+        post["Authorization"] = "token #{@token}"
+
+        post.body = {
+          :state => status,
+          :target_url => url,
+          :description => desc,
+        }.to_json
+
+        http.request(post)
+      end
+    end
+  end
+end

data/lib/janky/public/css/base.css

@@ -146,6 +146,9 @@ ul.builds .building .status{
 ul.builds .janky .status{
   background-position:0 -200px;
 }
+ul.builds .pending .status{
+  background-position:0 -100px;
+}
 
 ul.builds h2{
   margin:0;
@@ -168,6 +171,12 @@ ul.builds .building a{
 ul.builds .building h2{
   color:#e59741;
 }
+ul.builds .pending a{
+  color:#e59741;
+}
+ul.builds .pending h2{
+  color:#e59741;
+}
 ul.builds .janky a{
   color:#ae0000;
 }

data/lib/janky/repository.rb

@@ -93,7 +93,7 @@ module Janky
     #
     # Returns the name as a String.
     def github_name
-      uri[/.*[\/:]([a-zA-Z0-9\-_]+)\/([a-zA-Z0-9\-_]+)/] && $2
+      uri[/.*[\/:]([a-zA-Z0-9\-_]+)\/([a-zA-Z0-9\-_\.]+)/] && $2
     end
 
     # Fully qualified GitHub name for this repository.
@@ -130,7 +130,7 @@ module Janky
       read_attribute(:room_id) || ChatService.default_room_id
     end
 
-    # Setups GitHub and Jenkins for build this repository.
+    # Setups GitHub and Jenkins for building this repository.
     #
     # Returns nothing.
     def setup
@@ -189,7 +189,7 @@ module Janky
       md5 << uri
       md5 << job_config_path.read
       md5 << builder.callback_url.to_s
-      md5.hexdigest
+      "#{github_owner}-#{github_name}-#{md5.hexdigest}"
     end
   end
 end

data/lib/janky/templates/console.mustache

@@ -1,4 +1,5 @@
 <p>
-<a href="{{ repo_path }}">{{ repo_name }}</a>/<a href="{{ branch_path }}">{{ branch_name }}</a>/<a href="{{ commit_url }}">{{ commit_short_sha }}</a>
+<a href="{{ repo_path }}">{{ repo_name }}</a>/<a href="{{ branch_path }}">{{ branch_name }}</a>/<a href="{{ commit_url }}">{{ commit_short_sha }}</a><br />
+<a href="{{ jenkins_url }}">{{ jenkins_url }}</a>
 </p>
 <pre>{{ output }}</pre>

data/lib/janky/version.rb

@@ -1,3 +1,3 @@
 module Janky
-  VERSION = "0.9.13"
+  VERSION = "0.9.14.rc1"
 end

data/lib/janky/views/console.rb

@@ -28,6 +28,10 @@ module Janky
       def output
         @build.output
       end
+
+      def jenkins_url
+        @build.url
+      end
     end
   end
 end

data/lib/janky/views/index.rb

@@ -25,7 +25,9 @@ module Janky
           "good"
         elsif build.building?
           "building"
-        else
+        elsif build.pending?
+          "pending"
+        elsif build.red?
           "janky"
         end
       end
@@ -35,6 +37,8 @@ module Janky
           "Build started <span class='relatize'>#{build.started_at}</span>…"
         elsif build.completed?
           "Built in <span>#{build.duration}</span> seconds"
+        elsif build.pending?
+          "Build queued <span class='relatize'>#{build.queued_at}</span>…"
         end
       end
     end

data/test/janky_test.rb

@@ -244,6 +244,13 @@ class JankyTest < Test::Unit::TestCase
 
   test "hubot status repo" do
     gh_post_receive("github")
+    payload = Yajl.load(hubot_status("github", "master").body)
+    assert_equal 1, payload.size
+    build = payload[0]
+    assert build["queued"]
+    assert build["pending"]
+    assert !build["building"]
+
     Janky::Builder.start!
     Janky::Builder.complete!
     hubot_build("github", "master")
@@ -310,15 +317,14 @@ class JankyTest < Test::Unit::TestCase
     assert hubot_build("github", "master").not_found?
   end
 
-  test "github owner is parsed correctly" do
-    repo = Janky::Repository.setup("github/janky")
-    assert_equal "github", repo.github_owner
-    assert_equal "janky", repo.github_name
-  end
+  test "build janky url" do
+    gh_post_receive("github")
+    Janky::Builder.start!
+    Janky::Builder.complete!
+
+    assert_equal "http://localhost:9393/1/output", Janky::Build.last.web_url
 
-  test "owner with a dash is parsed correctly" do
-    repo = Janky::Repository.setup("digital-science/central-ftp-manage")
-    assert_equal "digital-science", repo.github_owner
-    assert_equal "central-ftp-manage", repo.github_name
+    build_page = Janky::Build.last.repo_job_name + "/" + Janky::Build.last.number + "/"
+    assert_equal "http://localhost:8080/job/" + build_page, Janky::Build.last.url
   end
 end

data/test/test_helper.rb

@@ -2,6 +2,7 @@ $LOAD_PATH.unshift(File.expand_path("../../lib", __FILE__))
 
 require "janky"
 require "test/unit"
+require "mocha"
 require "database_cleaner"
 
 class Test::Unit::TestCase

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: janky
 version: !ruby/object:Gem::Version
-  version: 0.9.13
-  prerelease: 
+  version: 0.9.14.rc1
+  prerelease: 7
 platform: ruby
 authors:
 - Simon Rozet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-24 00:00:00.000000000 Z
+date: 2012-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -203,6 +203,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.4
 description: Janky is a Continuous Integration server
 email: 
 executables: []
@@ -246,6 +262,7 @@ files:
 - lib/janky/database/migrate/1317384651_add_more_build_indexes.rb
 - lib/janky/database/migrate/1317384652_change_commit_message_to_text.rb
 - lib/janky/database/migrate/1317384653_add_build_pusher.rb
+- lib/janky/database/migrate/1317384654_add_build_queued_at.rb
 - lib/janky/database/schema.rb
 - lib/janky/database/seed.dump.gz
 - lib/janky/exception.rb
@@ -261,6 +278,7 @@ files:
 - lib/janky/job_creator.rb
 - lib/janky/notifier.rb
 - lib/janky/notifier/chat_service.rb
+- lib/janky/notifier/github_status.rb
 - lib/janky/notifier/mock.rb
 - lib/janky/notifier/multi.rb
 - lib/janky/public/css/base.css
@@ -298,9 +316,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23