janky 0.9.0

data/CHANGES

@@ -0,0 +1,3 @@
+= 0.9 / 2011-12-19
+
+ * Initial public release.

data/COPYING

@@ -0,0 +1,22 @@
+Copyright (c) 2011 GitHub, Inc. <https://github.com>
+
+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/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/README.md

@@ -0,0 +1,211 @@
+Janky
+=====
+
+This is Janky, a continuous integration server built on top of
+[Jenkins][], controlled by [Hubot][], and designed for [GitHub][].
+
+* **Built on top of Jenkins.** The power, vast amount of plugins and large
+  communauty of the popular CI server all wrapped up in a great experience.
+
+* **Controlled by Hubot.** Day to day operations are exposed as simple
+  Hubot commands that the whole team can use.
+
+* **Designed for GitHub.** Janky creates the appropriate [web hooks][w] for
+  you and the web app restricts access to members of your GitHub organization.
+
+[GitHub]: https://github.com
+[Hubot]: http://hubot.github.com
+[Jenkins]: http://jenkins-ci.org
+[w]: http://developer.github.com/v3/repos/hooks/
+
+Hubot Usage
+-----------
+
+Start by setting up a new Jenkins job and GitHub web hook for a
+repository:
+
+    hubot ci setup github/janky
+
+The `setup` command can safely be run over and over again. It won't do
+anything unless it needs to. It takes an optional name argument:
+
+    hubot ci setup github/janky janky-ruby1.9.2
+
+All branches are built automatically on push. Disable auto build with:
+
+    hubot ci toggle janky
+
+Run the command again to re-enable it. Force a build of the master
+branch:
+
+    hubot ci build janky
+
+Of a specific branch:
+
+    hubot ci build janky/libgit2
+
+Different builds aren't relevant to the same Campfire room and so Janky
+lets you choose where notifications are sent to. First get a list of
+available rooms:
+
+    hubot ci rooms
+
+Then pick one:
+
+    hubot ci set janky room The Serious Room
+
+Get the status of a build:
+
+    hubot ci status janky
+
+Specific branch:
+
+    hubot ci status janky/libgit2
+
+All builds:
+
+    hubot ci status
+
+Finally, get a quick reference of the available commands with:
+
+    hubot ci?
+
+Installing
+----------
+
+### Jenkins
+
+Janky requires access to a Jenkins server. Version **1.427** is
+recommended. Refer to the Jenkins [documentation][doc] for installation
+instructions and install the [Notification Plugin][np] version 1.4.
+
+[doc]: https://wiki.jenkins-ci.org/display/JENKINS/Installing+Jenkins
+[np]: https://wiki.jenkins-ci.org/display/JENKINS/Notification+Plugin
+
+### Deploying
+
+Janky is designed to be deployed to [Heroku](https://heroku.com).
+
+Grab all the necessary files from [this gist][gist]:
+
+    $ git clone gist://gist.github.com/123 janky
+
+Then push up it to a new Heroku app:
+
+    $ cd janky
+    $ heroku create --stack cedar
+    $ git push heroku master
+
+After configuration the app (see below), create the database:
+
+    $ heroku run rake db:migrate
+
+[gist]: https://gist.github.com/gist/1234
+
+### Configuring
+
+Janky is configured using environment variables. Use the `heroku config`
+command:
+
+    $ heroku config:add VARIABLE=value
+
+Required settings:
+
+* `JANKY_BASE_URL`: The application URL with a trailing slash. Example:
+  `http://mf-doom-42.heroku.com/`.
+* `JANKY_BUILDER_DEFAULT`: The Jenkins server URL with a trailing slash.
+   Example: `http://jenkins.example.com/`.
+* `JANKY_CONFIG_DIR`: Directory where build config templates are stored.
+  Typically set to `/app/config` on Heroku.
+* `JANKY_HUBOT_USER`: Login used to protect the Hubot API.
+* `JANKY_HUBOT_PASSWORD`: Password for the Hubot API.
+* `JANKY_GITHUB_USER`: The login of the GitHub user used to access the
+  API. Requires Push and Pull privileges.
+* `JANKY_GITHUB_PASSWORD`: The password for the GitHub user.
+* `JANKY_GITHUB_HOOK_SECRET`: Secret used to sign hook requests from
+  GitHub.
+* `JANKY_CAMPFIRE_ACCOUNT`: The name of your Campfire account.
+* `JANKY_CAMPFIRE_TOKEN`: The authentication token of the user sending
+  build notifications.
+* `JANKY_CAMPFIRE_DEFAULT_ROOM`: The name of the room where notifications
+  are sent by default. Example: "Builds".
+
+To restrict access to members of a GitHub organization, [register a new
+OAuth application on GitHub](https://github.com/account/applications)
+with the callback set to `$JANKY_BASE_URL/auth/github/callback` then set
+a few extra settings:
+
+* `JANKY_SESSION_SECRET`: Random session cookie secret. Typically
+  generated by a tool like `pgwen`.
+* `JANKY_AUTH_CLIENT_ID`: The client ID of the OAuth application.
+* `JANKY_AUTH_CLIENT_SECRET`: The client secret of the OAuth application.
+* `JANKY_AUTH_ORGANIZATION`: The organization name. Example: "github".
+
+### Hubot
+
+Install the [ci script](http://git.io/hubot-ci-master) in your Hubot
+then set the `HUBOT_JANKY_URL` environment variable. Example:
+`http://user:secret@janky.example.com/_hubot/`, with user and password
+replaced by `JANKY_HUBOT_USER` and `JANKY_HUBOT_PASSWORD` repectively.
+
+### Custom Build Configuration
+
+The default build command should suffice for most Ruby applications:
+
+    $ bundle install --path vendor/gems --binstubs
+    $ bundle exec rake
+
+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
+configuration, `config/jobs/default.xml.erb`. After updating or adding
+a custom config, run `hubot ci setup` again to update the Jenkins
+server.
+
+Hacking
+-------
+
+Create the databases:
+
+    $ 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
+
+Get your environment up and running:
+
+    $ script/boostrap
+
+Seed some data into the development database:
+
+    $ bin/rake db:seed
+
+Start the server:
+
+    $ script/server
+
+Open the app:
+
+    $ open http://localhost:9393/
+
+Run the test suite:
+
+    $ ruby test/janky_spec.rb
+
+Contributing
+------------
+
+Fork the [Janky repository on GitHub](https://github.com/github/janky) and
+send a Pull Request.
+
+Copying
+-------
+
+Copyright © 2011, GitHub, Inc. See the `COPYING` file for license
+rights and limitations (MIT).

data/Rakefile

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift(File.expand_path("../lib", __FILE__))
+ENV["RACK_ENV"] ||= "development"
+
+require "janky"
+Janky.setup(ENV)
+require "janky/tasks"
+
+task "db:seed" do
+  if ENV["RACK_ENV"] != "development"
+    fail "refusing to load seed data into non-development database"
+  end
+
+  dump = File.expand_path("../lib/janky/database/seed.dump.gz", __FILE__)
+
+  Replicate::Loader.new do |loader|
+    loader.log_to $stderr, false, false
+    loader.read Zlib::GzipReader.open(dump)
+  end
+end

data/config.ru

@@ -0,0 +1,3 @@
+require "janky"
+Janky.setup(ENV)
+run Janky.app

data/janky.gemspec

@@ -0,0 +1,102 @@
+require File.expand_path("../lib/janky/version", __FILE__)
+
+Gem::Specification.new "janky", Janky::VERSION do |s|
+  s.description = "Janky is a Continuous Integration server"
+  s.summary = "Continuous Integration server built on top of Jenkins and " \
+    "designed for GitHub and Hubot"
+  s.authors = ["GitHub, Inc."]
+  s.homepage = "https://github.com/github/janky"
+  s.has_rdoc = false
+
+  # runtime
+  s.add_dependency "rake", "~>0.9.2"
+  s.add_dependency "sinatra", "~>1.3"
+  s.add_dependency "sinatra_auth_github", "~>0.1.5"
+  s.add_dependency "mustache", "~>0.11"
+  s.add_dependency "yajl-ruby", "~>0.8"
+  s.add_dependency "activerecord", "~>3.1.0"
+  s.add_dependency "broach", "~>0.2"
+  s.add_dependency "replicate", "~>1.4"
+
+  # development
+  s.add_development_dependency "shotgun", "~>0.9"
+  s.add_development_dependency "thin", "~>1.2"
+  s.add_development_dependency "mysql2", "~>0.3.0"
+
+  # test
+  s.add_development_dependency "database_cleaner", "~>0.6"
+
+  s.files = %w[
+CHANGES
+COPYING
+Gemfile
+README.md
+Rakefile
+config.ru
+janky.gemspec
+lib/janky.rb
+lib/janky/app.rb
+lib/janky/branch.rb
+lib/janky/build.rb
+lib/janky/build_request.rb
+lib/janky/builder.rb
+lib/janky/builder/client.rb
+lib/janky/builder/http.rb
+lib/janky/builder/mock.rb
+lib/janky/builder/payload.rb
+lib/janky/builder/receiver.rb
+lib/janky/builder/runner.rb
+lib/janky/campfire.rb
+lib/janky/campfire/mock.rb
+lib/janky/commit.rb
+lib/janky/database/migrate/1312115512_init.rb
+lib/janky/database/migrate/1312117285_non_unique_repo_uri.rb
+lib/janky/database/migrate/1312198807_repo_enabled.rb
+lib/janky/database/migrate/1313867551_add_build_output_column.rb
+lib/janky/database/migrate/1313871652_add_commit_url_column.rb
+lib/janky/database/migrate/1317384618_add_repo_hook_url.rb
+lib/janky/database/migrate/1317384619_add_build_room_id.rb
+lib/janky/database/migrate/1317384629_drop_default_room_id.rb
+lib/janky/database/migrate/1317384649_github_team_id.rb
+lib/janky/database/schema.rb
+lib/janky/database/seed.dump.gz
+lib/janky/exception.rb
+lib/janky/github.rb
+lib/janky/github/api.rb
+lib/janky/github/commit.rb
+lib/janky/github/mock.rb
+lib/janky/github/payload.rb
+lib/janky/github/payload_parser.rb
+lib/janky/github/receiver.rb
+lib/janky/helpers.rb
+lib/janky/hubot.rb
+lib/janky/job_creator.rb
+lib/janky/notifier.rb
+lib/janky/notifier/campfire.rb
+lib/janky/notifier/mock.rb
+lib/janky/notifier/multi.rb
+lib/janky/public/css/base.css
+lib/janky/public/images/building-bot.gif
+lib/janky/public/images/disclosure-arrow.png
+lib/janky/public/images/logo.png
+lib/janky/public/images/robawt-status.gif
+lib/janky/public/javascripts/application.js
+lib/janky/public/javascripts/jquery.js
+lib/janky/public/javascripts/jquery.relatize.js
+lib/janky/repository.rb
+lib/janky/tasks.rb
+lib/janky/templates/console.mustache
+lib/janky/templates/index.mustache
+lib/janky/templates/layout.mustache
+lib/janky/version.rb
+lib/janky/views/console.rb
+lib/janky/views/index.rb
+lib/janky/views/layout.rb
+]
+
+s.test_files = %w[
+test/default.xml.erb
+test/janky_test.rb
+test/test_helper.rb
+]
+end

data/lib/janky.rb

@@ -0,0 +1,224 @@
+require "net/http"
+require "digest/md5"
+
+require "active_record"
+require "replicate"
+require "sinatra/base"
+require "mustache/sinatra"
+require "yajl"
+require "yajl/json_gem"
+require "tilt"
+require "broach"
+require "sinatra/auth/github"
+
+require "janky/repository"
+require "janky/branch"
+require "janky/commit"
+require "janky/build"
+require "janky/build_request"
+require "janky/github"
+require "janky/github/api"
+require "janky/github/mock"
+require "janky/github/payload"
+require "janky/github/commit"
+require "janky/github/payload_parser"
+require "janky/github/receiver"
+require "janky/job_creator"
+require "janky/helpers"
+require "janky/hubot"
+require "janky/builder"
+require "janky/builder/client"
+require "janky/builder/runner"
+require "janky/builder/http"
+require "janky/builder/mock"
+require "janky/builder/payload"
+require "janky/builder/receiver"
+require "janky/campfire"
+require "janky/exception"
+require "janky/notifier"
+require "janky/notifier/mock"
+require "janky/notifier/multi"
+require "janky/notifier/campfire"
+require "janky/app"
+require "janky/views/layout"
+require "janky/views/index"
+require "janky/views/console"
+
+# This is Janky, a continuous integration server. Checkout the 'app'
+# method on this module for an overview of the different components
+# involved.
+module Janky
+  # The base exception class raised when errors are encountered.
+  class Error < StandardError; end
+
+  # Setup the application, including the database and Jenkins connections.
+  #
+  # settings - Hash of app settings. Typically ENV but any object responding
+  #            to #[] is valid. See required_settings for required keys.
+  #            The RACK_ENV setting is always required.
+  #
+  # Raises an Error when required settings are missing.
+  # Returns nothing.
+  def self.setup(settings)
+    env = settings["RACK_ENV"]
+    if env.nil? || env.empty?
+      raise Error, "RACK_ENV is required"
+    end
+
+    required_settings.each do |setting|
+      next if !settings[setting].nil? && !settings[setting].empty?
+
+      if env == "production"
+        raise Error, "#{setting} setting is required"
+      end
+    end
+
+    if env != "production"
+      settings["DATABASE_URL"] ||= "mysql2://root@localhost/janky_#{env}"
+      settings["JANKY_BASE_URL"] ||= "http://localhost:9393"
+      settings["JANKY_BUILDER_DEFAULT"] ||= "http://localhost:8080/"
+      settings["JANKY_CONFIG_DIR"] ||= File.dirname(__FILE__)
+    end
+
+    database = URI(settings["DATABASE_URL"])
+    adapter  = database.scheme == "postgres" ? "postgresql" : database.scheme
+    base_url = URI(settings["JANKY_BASE_URL"]).to_s
+
+    ActiveRecord::Base.establish_connection(
+      :adapter   => adapter,
+      :host      => database.host,
+      :database  => database.path[1..-1],
+      :username  => database.user,
+      :password  => database.password,
+      :reconnect => true
+    )
+
+    self.jobs_config_dir = config_dir = Pathname(settings["JANKY_CONFIG_DIR"])
+    if !config_dir.directory?
+      raise Error, "#{config_dir} is not a directory"
+    end
+
+    # Setup the callback URL of this Janky host.
+    Janky::Builder.setup(base_url + "/_builder")
+
+    # Setup the default Jenkins build host
+    Janky::Builder[:default] = settings["JANKY_BUILDER_DEFAULT"]
+
+    Janky::GitHub.setup(
+      settings["JANKY_GITHUB_USER"],
+      settings["JANKY_GITHUB_PASSWORD"],
+      settings["JANKY_GITHUB_HOOK_SECRET"],
+      base_url + "/_github"
+    )
+
+    if settings.key?("JANKY_SESSION_SECRET")
+      Janky::App.register Sinatra::Auth::Github
+      Janky::App.set({
+        :sessions => true,
+        :session_secret => settings["JANKY_SESSION_SECRET"],
+        :github_team_id => settings["JANKY_AUTH_TEAM_ID"],
+        :github_organization => settings["JANKY_AUTH_ORGANIZATION"],
+        :github_options => {
+          :secret => settings["JANKY_AUTH_CLIENT_SECRET"],
+          :client_id => settings["JANKY_AUTH_CLIENT_ID"],
+          :scopes => "repo",
+        },
+      })
+    end
+
+    Janky::Hubot.set(
+      :base_url => settings["JANKY_BASE_URL"],
+      :username => settings["JANKY_HUBOT_USER"],
+      :password => settings["JANKY_HUBOT_PASSWORD"]
+    )
+
+    Janky::Campfire.setup(
+      settings["JANKY_CAMPFIRE_ACCOUNT"],
+      settings["JANKY_CAMPFIRE_TOKEN"],
+      settings["JANKY_CAMPFIRE_DEFAULT_ROOM"]
+    )
+
+    Janky::Exception.setup(Janky::Exception::Mock)
+
+    Notifier.setup(Notifier::Campfire)
+  end
+
+  # List of settings required in production.
+  #
+  # Returns an Array of Strings.
+  def self.required_settings
+    %w[RACK_ENV DATABASE_URL
+      JANKY_BASE_URL
+      JANKY_BUILDER_DEFAULT
+      JANKY_CONFIG_DIR
+      JANKY_GITHUB_USER JANKY_GITHUB_PASSWORD JANKY_GITHUB_HOOK_SECRET
+      JANKY_HUBOT_USER JANKY_HUBOT_PASSWORD
+      JANKY_CAMPFIRE_ACCOUNT JANKY_CAMPFIRE_TOKEN JANKY_CAMPFIRE_DEFAULT_ROOM]
+  end
+
+  # Directory where Jenkins job configuration templates are located.
+  #
+  # Returns the directory as a Pathname.
+  class << self
+    attr_accessor :jobs_config_dir
+  end
+
+  # Mock out all network-dependant components. Must be called after setup.
+  # Typically used in test environments.
+  #
+  # Returns nothing.
+  def self.enable_mock!
+    Janky::Builder.enable_mock!
+    Janky::GitHub.enable_mock!
+    Janky::Notifier.enable_mock!
+    Janky::Campfire.enable_mock!
+    Janky::App.disable :github_team_id
+  end
+
+  # Reset the state of the mocks.
+  #
+  # Returns nothing.
+  def self.reset!
+    Janky::Notifier.reset!
+    Janky::Builder.reset!
+  end
+
+  # The Janky Rack application, assembled from four apps. Exceptions
+  # raised during the request cycle are caught by the Exception
+  # middleware which typically report exceptions to an external
+  # service before re-raising the exception.
+  #
+  # Returns a memoized Rack application.
+  def self.app
+    @app ||= Rack::Builder.app {
+      # Exception reporting middleware.
+      use Janky::Exception::Middleware
+
+      # GitHub Post-Receive requests.
+      map "/_github" do
+        run Janky::GitHub.receiver
+      end
+
+      # Jenkins callback requests.
+      map "/_builder" do
+        run Janky::Builder.receiver
+      end
+
+      # Hubot API, protected by Basic Auth.
+      map "/_hubot" do
+        use Rack::Auth::Basic do |username, password|
+          username == Janky::Hubot.username &&
+            password == Janky::Hubot.password
+        end
+
+        run Janky::Hubot
+      end
+
+      # Web dashboard
+      map "/" do
+        use Janky::NoAuth
+        run Janky::App
+      end
+    }
+  end
+end