engineyard-jenkins 0.4.0

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+.DS_Store
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in engineyard-jenkins.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    engineyard-jenkins (0.4.0)
+      engineyard (~> 1.3.17)
+      jenkins (~> 0.6.2)
+      thor (~> 0.14.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    awesome_print (0.3.2)
+    builder (2.1.2)
+    crack (0.1.8)
+    cucumber (0.9.4)
+      builder (~> 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.2.9)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    diff-lcs (1.1.2)
+    engineyard (1.3.17)
+      engineyard-serverside-adapter (= 1.4.1)
+      escape (~> 0.0.4)
+      highline (~> 1.6.1)
+      json_pure
+      net-ssh (~> 2.1.0)
+      rest-client (~> 1.6.0)
+      thor (~> 0.14.6)
+    engineyard-serverside-adapter (1.4.1)
+      escape (~> 0.0.4)
+      json_pure
+    escape (0.0.4)
+    fakeweb (1.3.0)
+    gherkin (2.2.9)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    highline (1.6.1)
+    hpricot (0.8.4)
+    httparty (0.6.1)
+      crack (= 0.1.8)
+    jenkins (0.6.2)
+      builder (>= 2.1.2)
+      hpricot
+      httparty (~> 0.6.1)
+      term-ansicolor (>= 1.0.4)
+      thor (~> 0.14.2)
+    json (1.4.6)
+    json_pure (1.5.1)
+    mime-types (1.16)
+    net-ssh (2.1.4)
+    open4 (1.0.1)
+    rack (1.2.1)
+    rake (0.8.7)
+    realweb (0.1.6)
+      rack (>= 1.1.0)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    sinatra (1.2.0)
+      rack (~> 1.1)
+      tilt (< 2.0, >= 1.2.2)
+    term-ansicolor (1.0.5)
+    thor (0.14.6)
+    tilt (1.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  cucumber (~> 0.9.4)
+  engineyard-jenkins!
+  fakeweb (~> 1.3.0)
+  json (~> 1.4.0)
+  open4
+  rake (~> 0.8.7)
+  realweb (~> 0.1.6)
+  rspec (~> 2.1.0)
+  sinatra

data/History.md

@@ -0,0 +1,32 @@
+# History
+
+## 0.4.0 - 2011-4-11
+
+* Rename to engineyard-jenkins
+* Fix bug in "ey-jenkins install ." wiring into Thor
+
+## 0.3.2 - 2011-3-3
+
+* remove dependency on ruby-debug
+
+## 0.3.1 - 2010-12-1
+
+* install_server
+  * Updates the default host for `jenkins` CLI to newly created server
+  * Explicitly set $HOME/$USER so Jenkins/Java has access to .gitconfig
+
+## 0.3.0 - 2010-11-24
+
+* Renamed task 'server' => 'install_server'
+* install_server does the complete job of setup/installation of Jenkins into an environment on AppCloud
+* install_server can take --environment/--account options OR auto-discover which environment to install Jenkins into
+
+
+## 0.2.0 - 2010-10-30
+
+* Initial 'server' task implementation
+
+## 0.1.0 - 2010-10-30
+
+* Initial 'ey-jenkins install .' command
+* 'ey-jenkins server' shows 'Coming soon'

data/README.md

@@ -0,0 +1,186 @@
+# Easier to do CI than not to.
+
+Run your continuous integration (CI) tests against your Engine Yard AppCloud environments - the exact same configuration you are using in production!
+
+You're developing on OS X or Windows, deploying to Engine Yard AppCloud (Gentoo/Linux), and you're running your CI on your local machine or a spare Ubuntu machine in the corner of the office, or ... you're not running CI at all?
+
+It's a nightmare. It was for me. 
+
+But now, [Jenkins CI](http://jenkins-ci.org/), the [jenkins](http://github.com/cowboyd/jenkins.rb) CLI project, and **engineyard-jenkins** now make CI easier to do than not to for Engine Yard AppCloud users.
+
+And here's some logos:
+
+<img src="http://img.skitch.com/20101103-gcq2turgih14rjdqatt1kjkd6u.png">
+
+## Installation
+
+    gem install engineyard-jenkins
+
+This will also install the `jenkins` CLI to interact with your Jenkins CI from the command line.
+
+## Hosting on Engine Yard AppCloud
+
+Using Engine Yard AppCloud "Quick Start" wizard, create an application with Git Repo `git://github.com/engineyard/jenkins_server.git` (options: rails 3, passenger), and add your own SSH keys. This will create an environment called `jenkins_server_production`. Boot the environment as a Single instance (or Custom cluster with a single instance). 
+
+Optionally, though it is quite pretty, deploy/ship the jenkins_server application and visit the HTTP link to see the remaining "Almost there..." instructions.
+
+Finally, install Jenkins CI and rebuild the environment:
+
+    $ ey-jenkins install_server
+
+When this completes, visit the URL or refresh the "Almost there..." page to see your Jenkins CI server.
+
+Using the `jenkins list` CLI task you can also test there is a working server with no jobs:
+
+*For the Jenkins slaves' configuration, you'll need:*
+
+The `jenkins_server_production` instance public key:
+
+    $ ey ssh -e jenkins_server_production
+    # cat /home/deploy/.ssh/id_rsa.pub
+
+Do those steps, copy down the configuration and you're done! Now, you either visit your Jenkins CI site or use `jenkins list` to see the status of your projects being tested.
+
+## Hosting elsewhere
+
+Hosting Jenkins CI on Engine Yard AppCloud is optional; yet delightfully simple. Jenkins CI can be hosted anywhere.
+
+If you host your Jenkins CI elsewhere then you need the following information about your Jenkins CI environment to be able to add EngineYard AppCloud instances as Jenkins nodes/slaves:
+
+* Jenkins CI public host & port
+* Jenkins CI's user's public key (probably at `/home/deploy/.ssh/id_rsa.pub`)
+* Jenkins CI's user's private key path (probably `/home/deploy/.ssh/id_rsa`)
+
+## Running your CI tests on Engine Yard AppCloud
+
+This is the exciting part - ensuring that your CI tests are being run in the same environment as your production applications. In this case, on Engine Yard AppCloud.
+
+It is assumed that you already have a production application environment (might have multiple applications in it):
+
+<img src="http://img.skitch.com/20101103-k2u4dpnn6ukkwq1dafbtiuwi2s.png">
+
+In the Engine Yard AppCloud UI, create another environment that matches the production environment exactly (same Ruby, same set of applications, same Unix libraries).
+
+<img src="http://img.skitch.com/20101103-h58t3kfrpc2qm4eb6t4664m13.png">
+
+Now, in just a few steps and you will have your applications' tests running in an environment that matches your production environment:
+
+    $ cd /my/project
+    $ ey-jenkins install .
+    
+Now edit `cookbooks/jenkins_slave/attributes/default.rb` to set up the Jenkins CI instance details gathered above.
+
+    $ ey recipes upload -e ci_demo_app_ci
+    $ ey recipes apply -e ci_demo_app_ci
+
+Boot your `ci_demo_app_ci` environment, visit your Jenkins CI and WOW! jobs have been created, they are already running, and they are doing it upon your `ci_demo_app_ci` environment!
+
+At any time from the command line you can use `jenkins list` to see the status of your jobs
+
+## Conventions/Requirements
+
+* Do not use your production environment as your Jenkins CI slave. There are no guarantees what will happen. I expect bad things.
+* You must name your CI environments with a suffix of `_ci` or `_jenkins_slave`.
+* You should not name any other environments with a suffix of `_ci` or `_jenkins_slave`; lest they offer themselves to your Jenkins CI as slave nodes.
+* Keep your production and CI environments exactly the same. Use the same Ruby implementation/version, same database, and include the same RubyGems and Unix packages. Why? This is the entire point of the exercise: to run your CI tests in the same environment as your production application runs.
+
+For example, note the naming convention of the two CI environments below (one ends in `_jenkins_slave` and the other `_ci`).
+
+<img src="http://img.skitch.com/20101031-dxnk7hbn32yce9rum1ctwjwt1w.png" style="width: 100%">
+
+## What happens?
+
+When you boot your Engine Yard AppCloud CI environments, each resulting EC2 instance executes a special "jenkins_slave" recipe (see `cookbooks/jenkins_slave/recipes/default.rb` in your project). This does three things:
+
+* Adds this instance to your Jenkins CI server as a slave
+* Adds each Rails/Rack application for the AppCloud environment into your Jenkins CI as a "job".
+* Commences the first build of any newly added job.
+
+If your CI instances have already been booted and you re-apply the recipes over and over (`ey recipes apply`), nothing good or bad will happen. The instances will stay registered as slaves and the applications will stay registered as Jenkins CI jobs.
+
+If a new application is on the instance, then a new job will be created on Jenkins CI.
+
+To delete a job from Jenkins CI, you should also delete it from your AppCloud CI environment to ensure it isn't re-added the next time you re-apply or re-build or terminate/boot your CI environment. (To delete a job, use the Jenkins CI UI or `jenkins remove APP-NAME` from the CLI.)
+
+In essence, to add new Rails/Rack applications into your Jenkins CI server you:
+
+* Add them to one of your Engine Yard AppCloud CI environments (the one that matches the production environment where the application will be hosted)
+* Rebuild the environment or re-apply the custom recipes (`ey recipes apply`)
+
+### Applications are run in their respective CI environment
+
+Thusly demonstrated below: the application/job "ci_demo_app" is in the middle of a build on its target slave "ci_demo_app_ci". See the AppCloud UI example above to see the relationship between the application/job names and the environment/slave names.
+
+<img src="http://img.skitch.com/20101031-tga2f23wems1acpad1ua41qdmb.png" style="width: 100%">
+
+### Can I add applications/jobs to Jenkins CI other ways?
+
+Yes. There are three simple ways to get Jenkins CI to run tests for your application ("create a job to run builds"). Above is the first: all "applications" on the Engine Yard AppCloud CI environment will automatically become Jenkins CI jobs. The alternates are:
+
+* Use the `jenkins create .` command from the [jenkins](http://github.com/cowboyd/jenkins.rb) CLI. 
+
+Pass the `--assigned_node xyz` flag to make the project's test be executed on a specific slave node. "xyz" is the name of another application on your AppCloud account; your tests will be executed on the same instance, with the same version of Ruby etc.
+
+* Use the Jenkins CI UI to create a new job. As above, you can make sure the tests are run on a specific Engine Yard AppCloud instance by setting the assigned node label to be the same as another AppCloud application in your account that is being tested.
+
+Specifically, Jenkins CI uses "labels" to match jobs to slaves. A common example usage is to label a Windows slave as "windows". A job could then be restricted to only running on slaves with label "windows". We are using this same mechanism.
+
+## Automatically triggering job builds
+
+In Jenkins CI, a "job" is one of your projects. Each time it runs your tests, it is called a "build".
+
+It is often desirable to have your SCM trigger Jenkins CI to run your job build whenever you push new code.
+
+### GitHub Service Hooks
+
+* Go to the "Admin" section of your GitHub project
+* Click "Service Hooks"
+* Click "Post-Receive URLs"
+* Enter the URL `http://HUDSON-CI-URL/job/APP-NAME/build`
+* Click "Update Settings"
+
+And here's a picture.
+
+<img src="http://img.skitch.com/20101031-d5wrc7hysrahihqr9k53xgxi1t.png" style="width: 100%;">
+
+You can also use the "Test Hook" link to test this is wired up correctly.
+
+### CLI
+
+Using the `jenkins` CLI:
+
+    jenkins build path/to/APP-NAME
+
+### Curl
+
+You are triggering the build via a GET call to an URL endpoint. So you can also use `curl`:
+
+    curl http://HUDSON-CI-URL/job/APP-NAME/build
+
+## Contributions
+
+* Dr Nic Williams ([drnic](http://github.com/drnic))
+* Bodaniel Jeanes ([bjeanes](http://github.com/bjeanes)) - initial chef recipes for [Jenkins server + slave](http://github.com/bjeanes/ey-cloud-recipes)
+
+## License
+
+Copyright (c) 2010 Dr Nic Williams, Engine Yard
+
+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/Rakefile

@@ -0,0 +1,24 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new
+
+namespace :cucumber do
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:wip, 'Run features that are being worked on') do |t|
+    t.cucumber_opts = "--tags @wip"
+  end
+  Cucumber::Rake::Task.new(:ok, 'Run features that should be working') do |t|
+    t.cucumber_opts = "--tags ~@wip"
+  end
+  task :all => [:ok, :wip]
+end
+
+desc 'Alias for cucumber:ok'
+task :cucumber => 'cucumber:ok'
+
+desc "Start test server; Run cucumber:ok; Kill Test Server;"
+task :default => ["spec", "cucumber"]

data/bin/ey-jenkins

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'engineyard-jenkins'
+require 'engineyard-jenkins/cli'
+
+Engineyard::Jenkins::CLI.start

data/engineyard-jenkins.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "engineyard-jenkins"
+  s.version     = '0.4.0'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Dr Nic Williams"]
+  s.email       = ["drnicwilliams@gmail.com"]
+  s.homepage    = "http://github.com/engineyard/engineyard-jenkins"
+  s.summary     = %q{Easier to do CI than not to. Use Jenkins CI with Engine Yard AppCloud.}
+  s.description = %q{Run your continuous integration (CI) tests against your Engine Yard AppCloud environments - the exact same configuration you are using in production!}
+
+  s.rubyforge_project = "engineyard-jenkins"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency("thor", ["~> 0.14.6"])
+  s.add_dependency("engineyard", ["~> 1.3.17"])
+  s.add_dependency("jenkins", ["~> 0.6.2"])
+
+  s.add_development_dependency("rake", ["~> 0.8.7"])
+  s.add_development_dependency("cucumber", ["~> 0.9.4"])
+  s.add_development_dependency("rspec", ["~> 2.1.0"])
+  s.add_development_dependency("json", ["~>1.4.0"])
+  s.add_development_dependency("awesome_print")
+  s.add_development_dependency("realweb", '~>0.1.6')
+  s.add_development_dependency("open4")
+  s.add_development_dependency("sinatra")
+  s.add_development_dependency("fakeweb", "~>1.3.0")
+end

data/features/install.feature

@@ -0,0 +1,53 @@
+Feature: Managing a rails project as a Jenkins CI job on AppCloud
+  I want to build/test my project in the same environment I run in Engine Yard AppCloud
+  
+  Scenario: Setup first project as a slave for Jenkins
+    Given I am in the "rails" project folder
+    When I run local executable "ey-jenkins" with arguments "install ."
+    Then file "cookbooks/jenkins_slave/attributes/default.rb" is created
+    And file "cookbooks/jenkins_slave/recipes/default.rb" is created
+    And file "cookbooks/main/recipes/default.rb" is created
+    And file "cookbooks/main/libraries/ruby_block.rb" is created
+    And I should see exactly
+      """
+            create  cookbooks
+            create  cookbooks/main/attributes/recipe.rb
+            create  cookbooks/main/definitions/ey_cloud_report.rb
+            create  cookbooks/main/libraries/ruby_block.rb
+            create  cookbooks/main/libraries/run_for_app.rb
+            create  cookbooks/jenkins_slave/attributes/default.rb
+            create  cookbooks/jenkins_slave/recipes/default.rb
+            create  cookbooks/main/recipes/default.rb
+      
+      Finally:
+      * edit cookbooks/jenkins_slave/attributes/default.rb as necessary.
+      * run: ey recipes upload # use --environment(-e) & --account(-c)
+      * run: ey recipes apply  #   to select environment
+      * Boot your environment if not already booted.
+      When the recipe completes, your project will commence its first build on Jenkins CI.
+      """
+  
+  Scenario: Setup project with existing cookbooks as a slave for Jenkins
+    Given I am in the "rails" project folder
+    And I already have cookbooks installed
+    When I run local executable "ey-jenkins" with arguments "install ."
+    Then file "cookbooks/jenkins_slave/attributes/default.rb" is created
+    And file "cookbooks/jenkins_slave/recipes/default.rb" is created
+    And file "cookbooks/main/recipes/default.rb" is created
+    And file "cookbooks/redis/recipes/default.rb" is created
+    And I should see exactly
+      """
+            create  cookbooks/jenkins_slave/attributes/default.rb
+            create  cookbooks/jenkins_slave/recipes/default.rb
+            append  cookbooks/main/recipes/default.rb
+
+      Finally:
+      * edit cookbooks/jenkins_slave/attributes/default.rb as necessary.
+      * run: ey recipes upload # use --environment(-e) & --account(-c)
+      * run: ey recipes apply  #   to select environment
+      * Boot your environment if not already booted.
+      When the recipe completes, your project will commence its first build on Jenkins CI.
+      """
+
+  
+  

data/features/install_server.feature

@@ -0,0 +1,69 @@
+Feature: Managing ey jenkins server
+  I want to install a Jenkins CI server hosted on Engine Yard AppCloud
+  
+  Background:
+    Given I have setup my engineyard email/password for API access
+    And I have "two accounts, two apps, two environments, ambiguous"
+    And I want to fake out the boot sequence of Jenkins
+    
+  Scenario: Install new Jenkins CI server on AppCloud
+    When I run local executable "ey-jenkins" with arguments "install_server . --account account_2 --environment giblets"
+    Then file "cookbooks/main/recipes/default.rb" is created
+    And file "cookbooks/jenkins_master/recipes/default.rb" is created
+    And file "cookbooks/jenkins_master/attributes/default.rb" contains ":plugins => %w[git github rake ruby greenballs envfile]"
+    And I should see exactly
+      """
+            create  cookbooks
+            create  cookbooks/jenkins_master/recipes/default.rb
+            create  cookbooks/jenkins_master/templates/default/init.sh.erb
+            create  cookbooks/jenkins_master/templates/default/proxy.conf.erb
+            create  cookbooks/main/attributes/recipe.rb
+            create  cookbooks/main/definitions/ey_cloud_report.rb
+            create  cookbooks/main/libraries/ruby_block.rb
+            create  cookbooks/main/libraries/run_for_app.rb
+            create  cookbooks/main/recipes/default.rb
+            create  cookbooks/jenkins_master/attributes/default.rb
+      
+      Uploading to 'giblets' environment on 'account_2' account...
+      Environment is rebuilding...
+      ..
+      Jenkins is starting...
+      .
+      Done! Jenkins CI hosted at http://app-master-hostname.compute-1.amazonaws.com
+      """
+    When I run executable "jenkins" with arguments "default_host"
+    Then I should see "http://app-master-hostname.compute-1.amazonaws.com"
+  
+  @wip
+  Scenario: Install Jenkins CI server with additional Jenkins plugins
+    When I run local executable "ey-jenkins" with arguments "install_server . -p ' chucknorris , googleanalytics ' -c account_2 -e giblets"
+    Then file "cookbooks/main/recipes/default.rb" is created
+    And file "cookbooks/jenkins_master/recipes/default.rb" is created
+    And file "cookbooks/jenkins_master/attributes/default.rb" contains ":plugins => %w[git github rake ruby greenballs envfile chucknorris googleanalytics]"
+
+  Scenario: Display example explicit calls if multiple accounts/options
+    When I run local executable "ey-jenkins" with arguments "install_server . -e giblets"
+    Then file "cookbooks/main/recipes/default.rb" is not created
+    And I should see exactly
+      """
+      Multiple environments possible, please be more specific:
+
+        ey-jenkins install_server --environment 'giblets' --account 'main'
+        ey-jenkins install_server --environment 'giblets' --account 'account_2'
+      """
+  
+  Scenario: Ask for environment/account details if no obvious jenkins environment on AppCloud
+    When I run local executable "ey-jenkins" with arguments "install_server ."
+    Then file "cookbooks/main/recipes/default.rb" is not created
+    And I should see exactly
+      """
+      No environments with name jenkins, jenkins_server, jenkins_production, jenkins_server_production.
+      Either:
+        * Create an AppCloud environment called jenkins, jenkins_server, jenkins_production, jenkins_server_production
+        * Use --environment/--account flags to select AppCloud environment
+      """
+  
+  
+  
+  
+