janky 0.10.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d531dd95f17c83f106364fc9bb3b56a83e7c84f
-  data.tar.gz: ea8e851492074c805a207ec0938a0eff692e9e7e
+  metadata.gz: e4e36e0fb610583f88d64b504993cb6c57305e15
+  data.tar.gz: 827b6fa7764586c70852a679a4a9fcab23d18601
 SHA512:
-  metadata.gz: 1c10a412e74e88045013e915ad1859a481e949a01da50c207d26302fe2651d9d1e748cf9bb81399a0296adde8befcb4e53b062b5f7a5445a00bd52ade2afa60f
-  data.tar.gz: c8ea975e0f9b6527c80b2b91b796b9ca72d4cc3ee82a7503c302839c6476cb9ee43fb688494a23d453b2f5071574e85a7e73d7f59adc1ba29f63a85f81bd87d4
+  metadata.gz: 4546417aef772b7d387ec7808631c16d1869d202569ed316fa93bbf862fd34242492a1e691dbc58b125be088d11b2dc3f1b1d82754308f56afc1d9c7bfec2749
+  data.tar.gz: 4ee74b538771d5b05da1f4d10388f996749cd7b6daaaeb136771dd8f66af0e88e0fcd3557736bbbe70920e732e1c0fa19fbaa254b932f8e82ef94d6843043cb9

data/CHANGES

@@ -1,3 +1,15 @@
+= 0.11.0 / 2014-11-14
+
+ * Add support for Slack chat rooms
+ * Convert chat room ids from integers to strings
+ * Ensure build completion works with new Jenkins versions
+ * Allow custom build templates to be provided when setting up projects
+ * Mark builds that are queued in Jenkins as pending on GitHub
+ * Delete and recreate hooks when setting up repositories
+ * Add the ability to delete repos via `/ci delete`
+ * Get detailed info about repos via `/ci show`
+ * Send updates from Janky as a separate context to GitHub
+
 = 0.10.2 / 2013-10-02
 
  * Revert AR deprecation warnings

data/README.md

@@ -31,6 +31,10 @@ anything unless it needs to. It takes an optional name argument:
 
     hubot ci setup github/janky janky-ruby1.9.2
 
+It also takes an optional template name argument:
+
+    hubot ci setup github/janky janky-ruby1.9.2 ruby-build
+
 All branches are built automatically on push. Disable auto build with:
 
     hubot ci toggle janky
@@ -106,7 +110,7 @@ After configuring the app (see below), create the database:
 
     $ heroku run rake db:migrate
 
-**NOTE:** Ruby version 1.9.3 is required to run Janky.
+**NOTE:** Ruby version 2.0.0+ is required to run Janky.
 
 [gist]: https://gist.github.com/1497335
 
@@ -176,7 +180,9 @@ via the GitHub API:
       -d '{ "scopes": [ "repo:status" ], "note": "janky" }' \
       https://api.github.com/authorizations
 
-then set `JANKY_GITHUB_STATUS_TOKEN`.
+then set `JANKY_GITHUB_STATUS_TOKEN`.  Optionally, you can also set
+`JANKY_GITHUB_STATUS_CONTEXT` to send a context to the GitHub API by
+default
 
 `username` and `password` in the above example should be the same as the
 values provided for `JANKY_GITHUB_USER` and `JANKY_GITHUB_PASSWORD`
@@ -215,6 +221,36 @@ Installation:
 * `bundle`
 * `git commit -am "install hipchat"`
 
+#### Slack
+
+Required settings:
+
+* `JANKY_CHAT=slack`
+* `JANKY_CHAT_SLACK_TEAM`: slack team name
+* `JANKY_CHAT_SLACK_TOKEN`: authentication token for the user sending build notifications.
+* `JANKY_CHAT_SLACK_USERNAME`: name that messages will appear be sent from.
+  Defaults to `CI`.
+* `JANKY_CHAT_SLACK_ICON_URL`: URL to an image to use as the icon for this message.
+
+Installation:
+
+* Add `require "janky/chat_service/slack"` to the `config/environment.rb`
+  file **before** the `Janky.setup(ENV)` line.
+* `echo 'gem "slack.rb"' >> Gemfile`
+* `bundle`
+* `git commit -am "install slack"`
+
+#### Hubot
+
+Sends notifications to Hubot via [janky script](http://git.io/hubot-janky).
+
+Required settings:
+
+* `JANKY_CHAT_HUBOT_URL`: URL to your Hubot instance.
+* `JANKY_CHAT_HUBOT_ROOMS`: List of rooms which can be set via `ci set room`.
+  * For IRC: Comma-separated list of channels `"#room, #another-room"`
+  * For Campfire/HipChat: List with room id and name `"34343:room, 23223:another-room"`
+
 ### Authentication
 
 To restrict access to members of a GitHub organization, [register a new
@@ -247,8 +283,10 @@ For more control you can add a `script/cibuild` at the root of your
 repository for Jenkins to execute instead.
 
 For total control, whole Jenkins' `config.xml` files can be associated
-with Janky builds. Given a build called `windows`, Janky will try
-`config/jobs/windows.xml.erb` before falling back to the default
+with Janky builds. Given a build called `windows` and a template name
+of `psake`, Janky will try `config/jobs/psake.xml.erb` to use a template,
+`config/jobs/windows.xml.erb` to try the job name if the template does
+not exit,  before finally falling back to the default
 configuration, `config/jobs/default.xml.erb`. After updating or adding
 a custom config, run `hubot ci setup` again to update the Jenkins
 server.
@@ -294,8 +332,13 @@ send a Pull Request.  Note that any changes to behavior without tests will
 be rejected.  If you are adding significant new features, please add both
 tests and documentation.
 
+Maintainers
+-----------
+
+* [@mattr-](https://github.com/mattr-)
+
 Copying
 -------
 
-Copyright © 2011-2013, GitHub, Inc. See the `COPYING` file for license
+Copyright © 2011-2014, GitHub, Inc. See the `COPYING` file for license
 rights and limitations (MIT).

data/janky.gemspec

@@ -16,7 +16,7 @@ https://github.com/github/janky/commit/0fc6214e3a75cc138aed46a2493980440e848aa3#
 EOL
 
   # runtime
-  s.add_dependency "rake", "~>0.9.2"
+  s.add_dependency "rake", "~>10.0"
   s.add_dependency "sinatra", "~>1.3"
   s.add_dependency "sinatra_auth_github", "~>1.0.0"
   s.add_dependency "mustache", "~>0.11"
@@ -57,6 +57,7 @@ lib/janky/builder/runner.rb
 lib/janky/chat_service.rb
 lib/janky/chat_service/campfire.rb
 lib/janky/chat_service/hipchat.rb
+lib/janky/chat_service/slack.rb
 lib/janky/chat_service/mock.rb
 lib/janky/commit.rb
 lib/janky/database/migrate/1312115512_init.rb
@@ -73,6 +74,9 @@ 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/migrate/1317384655_add_template.rb
+lib/janky/database/migrate/1398262033_add_context.rb
+lib/janky/database/migrate/1400144784_change_room_id_to_string.rb
 lib/janky/database/schema.rb
 lib/janky/database/seed.dump.gz
 lib/janky/exception.rb
@@ -88,6 +92,7 @@ lib/janky/hubot.rb
 lib/janky/job_creator.rb
 lib/janky/notifier.rb
 lib/janky/notifier/chat_service.rb
+lib/janky/notifier/failure_service.rb
 lib/janky/notifier/github_status.rb
 lib/janky/notifier/mock.rb
 lib/janky/notifier/multi.rb

data/lib/janky.rb

@@ -44,6 +44,7 @@ require "janky/chat_service/mock"
 require "janky/exception"
 require "janky/notifier"
 require "janky/notifier/chat_service"
+require "janky/notifier/failure_service"
 require "janky/notifier/mock"
 require "janky/notifier/multi"
 require "janky/notifier/github_status"
@@ -109,7 +110,8 @@ module Janky
       :username  => database.user,
       :password  => database.password,
       :host      => database.host,
-      :port      => database.port
+      :port      => database.port,
+      :reconnect => true,
     }
     if socket = settings["JANKY_DATABASE_SOCKET"]
       connection[:socket] = socket
@@ -203,9 +205,11 @@ module Janky
     ChatService.setup(chat_name, chat_settings, chat_room)
 
     if token = settings["JANKY_GITHUB_STATUS_TOKEN"]
+      context = settings["JANKY_GITHUB_STATUS_CONTEXT"]
       Notifier.setup([
-        Notifier::GithubStatus.new(token, api_url),
-        Notifier::ChatService
+        Notifier::GithubStatus.new(token, api_url, context),
+        Notifier::ChatService,
+        Notifier::FailureService
       ])
     else
       Notifier.setup(Notifier::ChatService)

data/lib/janky/branch.rb

@@ -57,7 +57,7 @@ module Janky
     # user    - The login of the GitHub user who pushed.
     # compare - optional String GitHub Compare View URL. Defaults to the
     #           commit last build, if any.
-    # room_id - optional Fixnum Campfire room ID. Defaults to the room set on
+    # room_id - optional String room ID. Defaults to the room set on
     #           the repository.
     #
     # Returns the newly created Janky::Build.
@@ -66,7 +66,8 @@ module Janky
         compare = build.compare
       end
 
-      if room_id.nil? || room_id.zero?
+      room_id = room_id.to_s
+      if room_id.empty? || room_id == "0"
         room_id = repository.room_id
       end
 
@@ -90,24 +91,7 @@ module Janky
       sha_to_build = GitHub.branch_head_sha(repository.nwo, name)
       return if !sha_to_build
 
-      commit_data = GitHub.commit(repository.nwo, sha_to_build)
-      commit_message = commit_data["commit"]["message"]
-      commit_url = repository.github_url("commit/#{sha_to_build}")
-      author_data = commit_data["commit"]["author"]
-      commit_author =
-        if email = author_data["email"]
-          "#{author_data["name"]} <#{email}>"
-        else
-          author_data["name"]
-        end
-
-      commit = repository.commit_for({
-        :repository => repository,
-        :sha1 => sha_to_build,
-        :author => commit_author,
-        :message => commit_message,
-        :url => commit_url,
-      })
+      commit = repository.commit_for_sha(sha_to_build)
 
       current_sha = current_build ? current_build.sha1 : "#{sha_to_build}^"
       compare_url = repository.github_url("compare/#{current_sha}...#{commit.sha1}")

data/lib/janky/build.rb

@@ -11,7 +11,7 @@ module Janky
       select(columns)
     end
 
-    scope :building, -> {
+    scope :building, lambda {
       where("started_at IS NOT NULL AND completed_at IS NULL")
     }
 
@@ -131,7 +131,7 @@ module Janky
     # Run a copy of itself. Typically used to force a build in case of
     # temporary test failure or when auto-build is disabled.
     #
-    # new_room_id - optional Campfire room Fixnum ID. Defaults to the room of the
+    # new_room_id - optional Campfire room String ID. Defaults to the room of the
     #               build being re-run.
     #
     # Returns the build copy.
@@ -214,7 +214,7 @@ module Janky
     #
     # Returns the String room name.
     def room_name
-      if room_id && room_id > 0
+      if room_id && !room_id.empty?
         ChatService.room_name(room_id)
       end
     end

data/lib/janky/build_request.rb

@@ -29,6 +29,7 @@ module Janky
       if !current_build || (current_build && current_build.red?)
         if @repo.enabled?
           build.run
+          Notifier.queued(build)
         end
       end
     end

data/lib/janky/builder/payload.rb

@@ -40,7 +40,7 @@ module Janky
       end
 
       def completed?
-        @phase == "FINISHED"
+        @phase == "FINISHED" || @phase == "FINALIZED"
       end
 
       def green?

data/lib/janky/chat_service.rb

@@ -37,7 +37,7 @@ module Janky
     # Send a message to a Chat room.
     #
     # message - The String message.
-    # room_id - The Integer room ID.
+    # room_id - The String room ID.
     # options - Optional hash passed to the chat adapter.
     #
     # Returns nothing.
@@ -58,7 +58,7 @@ module Janky
 
     # Get the name of a room given its ID.
     #
-    # id - the Fixnum room ID.
+    # id - the String room ID.
     #
     # Returns the name as a String or nil when not found.
     def self.room_name(id)
@@ -90,7 +90,7 @@ module Janky
 
     # Configure available rooms. Only available in mock mode.
     #
-    # value - Hash of room map (Fixnum ID => String name)
+    # value - Hash of room map (String ID => String name)
     #
     # Returns nothing.
     def self.rooms=(value)

data/lib/janky/chat_service/slack.rb

@@ -0,0 +1,65 @@
+require "slack"
+
+module Janky
+  module ChatService
+    class Slack
+      def initialize(settings)
+        team = settings["JANKY_CHAT_SLACK_TEAM"]
+
+        if team.nil? || team.empty?
+          raise Error, "JANKY_CHAT_SLACK_TEAM setting is required"
+        end
+
+        token = settings["JANKY_CHAT_SLACK_TOKEN"]
+
+        if token.nil? || token.empty?
+          raise Error, "JANKY_CHAT_SLACK_TOKEN setting is required"
+        end
+
+        username = settings["JANKY_CHAT_SLACK_USERNAME"] || 'CI'
+        icon_url = settings["JANKY_CHAT_SLACK_ICON_URL"]
+
+        @client = ::Slack::Client.new(team: team, token: token, username: username, icon_url: icon_url)
+      end
+
+      def speak(message, room_id, options = {})
+        room_name = ChatService.room_name(room_id) || room_id
+
+        if options[:build].present?
+          @client.post_message(nil, room_name, {attachments: attachments(message, options[:build])})
+        else
+          @client.post_message(message, room_name, options)
+        end
+      end
+
+      def rooms
+        @rooms ||= @client.channels.map do |channel|
+          Room.new(channel['id'], channel['name'])
+        end
+      end
+
+      private
+
+      def attachments(fallback, build)
+        status = build.green? ? "was successful" : "failed"
+        color = build.green? ? "good" : "danger"
+
+        message = "Build #%s of %s/%s %s" % [
+          build.number,
+          build.repo_name,
+          build.branch_name,
+          status
+        ]
+
+        janky_field = ::Slack::AttachmentField.new("Janky", build.web_url, false)
+        commit_field = ::Slack::AttachmentField.new("Commit", "<#{build.commit_url}|#{build.short_sha1}>", true)
+        duration_field = ::Slack::AttachmentField.new("Duration", "#{build.duration}s", true)
+        fields = [janky_field.to_h, commit_field.to_h, duration_field.to_h]
+
+        [::Slack::Attachment.new(fallback, message, nil, color, ["text", "title", "fallback"], fields)]
+      end
+    end
+  end
+
+  register_chat_service "slack", ChatService::Slack
+end

data/lib/janky/commit.rb

@@ -6,5 +6,22 @@ module Janky
     def last_build
       builds.last
     end
+
+    def build!(user, room_id = nil, compare = nil)
+      compare = repository.github_url("compare/#{sha1}^...#{sha1}")
+
+      room_id = room_id.to_s
+      if room_id.empty? || room_id == "0"
+        room_id = repository.room_id
+      end
+
+      builds.create!(
+        :compare   => compare,
+        :user      => user,
+        :commit    => self,
+        :room_id   => room_id,
+        :branch_id => repository.branch_for('master').id
+      )
+    end
   end
 end

data/lib/janky/database/migrate/1317384655_add_template.rb

@@ -0,0 +1,9 @@
+class AddTemplate < ActiveRecord::Migration
+  def self.up
+    add_column :repositories, :job_template, :string, :null => true
+  end
+
+  def self.down
+    remove_column :repositories, :job_template
+  end
+end

data/lib/janky/database/migrate/1398262033_add_context.rb

@@ -0,0 +1,9 @@
+class AddContext < ActiveRecord::Migration
+  def self.up
+    add_column :repositories, :context, :string, :null => true
+  end
+
+  def self.down
+    remove_column :repositories, :context
+  end
+end

data/lib/janky/database/migrate/1400144784_change_room_id_to_string.rb

@@ -0,0 +1,6 @@
+class ChangeRoomIdToString < ActiveRecord::Migration
+  def change
+    change_column :repositories, :room_id, :string
+    change_column :builds, :room_id, :string
+  end
+end

data/lib/janky/database/schema.rb

@@ -11,29 +11,29 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 1317384654) do
+ActiveRecord::Schema.define(:version => 1400144784) do
 
   create_table "branches", :force => true do |t|
     t.string   "name",          :null => false
     t.integer  "repository_id", :null => false
-    t.datetime "created_at"
-    t.datetime "updated_at"
+    t.datetime "created_at",    :null => false
+    t.datetime "updated_at",    :null => false
   end
 
   add_index "branches", ["name", "repository_id"], :name => "index_branches_on_name_and_repository_id", :unique => true
 
   create_table "builds", :force => true do |t|
-    t.boolean  "green",                            :default => false
+    t.boolean  "green",        :default => false
     t.string   "url"
-    t.string   "compare",                                             :null => false
+    t.string   "compare",                         :null => false
     t.datetime "started_at"
     t.datetime "completed_at"
-    t.integer  "commit_id",                                           :null => false
-    t.integer  "branch_id",                                           :null => false
-    t.datetime "created_at"
-    t.datetime "updated_at"
+    t.integer  "commit_id",                       :null => false
+    t.integer  "branch_id",                       :null => false
+    t.datetime "created_at",                      :null => false
+    t.datetime "updated_at",                      :null => false
     t.text     "output"
-    t.integer  "room_id"
+    t.string   "room_id"
     t.string   "user"
     t.datetime "queued_at"
   end
@@ -51,8 +51,8 @@ ActiveRecord::Schema.define(:version => 1317384654) do
     t.string   "author",        :null => false
     t.datetime "committed_at"
     t.integer  "repository_id", :null => false
-    t.datetime "created_at"
-    t.datetime "updated_at"
+    t.datetime "created_at",    :null => false
+    t.datetime "updated_at",    :null => false
     t.string   "url",           :null => false
   end
 
@@ -61,12 +61,14 @@ ActiveRecord::Schema.define(:version => 1317384654) do
   create_table "repositories", :force => true do |t|
     t.string   "name",                             :null => false
     t.string   "uri",                              :null => false
-    t.integer  "room_id"
-    t.datetime "created_at"
-    t.datetime "updated_at"
+    t.string   "room_id"
+    t.datetime "created_at",                       :null => false
+    t.datetime "updated_at",                       :null => false
     t.boolean  "enabled",        :default => true, :null => false
     t.string   "hook_url"
     t.integer  "github_team_id"
+    t.string   "job_template"
+    t.string   "context"
   end
 
   add_index "repositories", ["enabled"], :name => "index_repositories_on_enabled"