gnm-jenkins_cap 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "capistrano", ">= 2.9.0"
+gem "json"
+gem "term-ansicolor"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,39 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    capistrano (2.11.2)
+      highline
+      net-scp (>= 1.0.0)
+      net-sftp (>= 2.0.0)
+      net-ssh (>= 2.0.14)
+      net-ssh-gateway (>= 1.1.0)
+    git (1.2.5)
+    highline (1.6.11)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.5)
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-sftp (2.0.5)
+      net-ssh (>= 2.0.9)
+    net-ssh (2.3.0)
+    net-ssh-gateway (1.1.0)
+      net-ssh (>= 1.99.1)
+    rake (0.9.2.2)
+    rcov (0.9.8)
+    shoulda (2.11.3)
+    term-ansicolor (1.0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  capistrano (>= 2.9.0)
+  jeweler (~> 1.6.4)
+  json
+  rcov
+  shoulda
+  term-ansicolor

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Gorilla Nation Media
+
+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/README.rdoc

@@ -0,0 +1,35 @@
+= gnm-jenkins_cap
+
+Adds Jenkins tasks to Capistrano.
+
+== Installation
+
+    $ gem install gnm-jenkins_cap
+    
+Include in your Capfile
+    require 'rubygems'
+    require 'gnm-jenkins_cap'
+    
+== Usage
+
+In your deploy.rb
+    set :jenkins_host, "http://jenkins.example.com"
+    set :jenkins_job_name, "mybuild"
+    
+    before 'deploy', 'jenkins_cap:build_check' # check if the revision has been built by Jenkins successfully
+
+== Contributing to gnm-jenkins_cap
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Gorilla Nation Media. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "gnm-jenkins_cap"
+  gem.homepage = "https://github.com/GorillaNation/gnm-jenkins_cap"
+  gem.license = "MIT"
+  gem.summary = %Q{adds Jenkins tasks to Capistrano}
+  gem.description = %Q{add Jenkins tasks to Capistrano}
+  gem.email = "configurationmanagement@gorillanation.com"
+  gem.authors = ["Dru Ibarra"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "gnm-jenkins_cap #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/gnm-jenkins_cap.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gnm-jenkins_cap}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Dru Ibarra}]
+  s.date = %q{2012-03-20}
+  s.description = %q{add Jenkins tasks to Capistrano}
+  s.email = %q{configurationmanagement@gorillanation.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "gnm-jenkins_cap.gemspec",
+    "lib/gnm-jenkins_cap.rb",
+    "test/helper.rb",
+    "test/test_jenkins_cap.rb",
+    "test/test_settings.yml.template"
+  ]
+  s.homepage = %q{https://github.com/GorillaNation/gnm-jenkins_cap}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{adds Jenkins tasks to Capistrano}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<capistrano>, [">= 2.9.0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<term-ansicolor>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<capistrano>, [">= 2.9.0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<term-ansicolor>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<capistrano>, [">= 2.9.0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<term-ansicolor>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/gnm-jenkins_cap.rb

@@ -0,0 +1,81 @@
+require 'json'
+require 'term/ansicolor'
+require 'capistrano'
+
+class String
+  include Term::ANSIColor
+end
+
+module Capistrano
+  module JenkinsCap
+    
+    def json_request(url)
+      response = `wget -q -O - #{url}`
+      JSON.load(response)
+    end
+
+    def get_builds()
+      json_results = json_request("#{jenkins_host}/job/#{jenkins_job_name}/api/json")
+      builds = []
+      json_results['builds'].each{|b| builds << b['number']}
+      builds
+    rescue NoMethodError => e
+      puts "WARNING: #{e}".yellow
+    end
+
+    def get_revision_from_build(build_number)
+      json_results = json_request("#{jenkins_host}/job/#{jenkins_job_name}/#{build_number}/api/json")
+      return nil if json_results['changeSet']['revisions'].nil?
+      revisions = [] 
+      json_results['changeSet']['revisions'].each{|r| revisions << r['revision']}
+      revisions.sort.last
+    rescue NoMethodError => e
+      puts "WARNING: #{e}".yellow
+    end
+
+    def build_has_revision?(build_number)
+      build_revision = get_revision_from_build(build_number)
+      #puts build_revision
+      build_revision.to_i == revision.to_i
+    end
+
+    def build_passed?(build_number)
+      json_results = json_request("#{jenkins_host}/job/#{jenkins_job_name}/#{build_number}/api/json")
+      json_results['result'] == "SUCCESS"
+    rescue NoMethodError => e
+      puts "WARNING: #{e}".yellow
+    end
+
+    def revision_passed?()
+      builds_list = get_builds()
+      return false if builds_list.nil?
+      
+      builds_list.each do |build_number|
+         if build_has_revision?(build_number) # check if build has the revision we care about
+           return build_passed?(build_number)
+         end
+      end
+      false
+    end
+    
+    def self.load_into(configuration)
+      configuration.load do
+        namespace :jenkins_cap do
+           desc "Check if this deployment as a good Jenkins build"
+           task "build_check" do
+             abort "\n\n\nThis revision #{revision} has not been built by Jenkins successfully!\n\n\n".red unless jenkins.revision_passed?
+             puts "\n Revision #{revision} has passed Jenkins tests.\n".green
+           end # end of task
+        end # end of namespace
+      end # end of configuration.load
+    end # end of def self.load_into
+    
+  end # end of JenkinsCap module
+
+  Capistrano.plugin :jenkins, JenkinsCap
+
+end # end of Capistrano module
+
+if Capistrano::Configuration.instance
+  Capistrano::JenkinsCap.load_into(Capistrano::Configuration.instance)
+end

data/test/helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'gnm-jenkins_cap'
+
+
+class Test::Unit::TestCase
+end

data/test/test_jenkins_cap.rb

@@ -0,0 +1,51 @@
+require 'helper'
+
+TEST_SETTINGS = YAML.load_file(File.join(File.dirname(__FILE__), "test_settings.yml"))
+
+class TestJenkinsCap < Test::Unit::TestCase
+  def setup
+    @config = Capistrano::Configuration.new
+    Capistrano::JenkinsCap.load_into(@config)
+    @config.role :app, TEST_SETTINGS["app"]
+    @config.set :deploy_to, TEST_SETTINGS["deploy_to"]
+    @config.set :jenkins_host, TEST_SETTINGS["jenkins_host"]
+    @config.set :jenkins_job_name, TEST_SETTINGS["jenkins_job_name"]
+    @config.set :revision, TEST_SETTINGS["revision"]
+  end
+  
+  # Unit tests for helper functions
+  #
+  should "get a successful JSON response" do
+    assert @config.jenkins.json_request("#{@config.jenkins_host}/api/json")
+  end
+  
+  should "get an Array of build numbers" do
+     assert_kind_of Array, @config.jenkins.get_builds
+  end
+  
+  should "get a revision number (or nil) without error" do
+     # no assertion here because can't be sure what we'll get from Jenkins
+     @config.jenkins.get_revision_from_build(TEST_SETTINGS["build_number"])
+  end
+  
+  should "check if a build contains the revision number about to be deployed" do
+    # no assertion here because can't be sure what we'll get from Jenkins
+    @config.jenkins.build_has_revision?(TEST_SETTINGS["build_number"])
+  end
+  
+  should "check if a build passed" do
+     # no assertion here because can't be sure what we'll get from Jenkins
+     @config.jenkins.build_passed?(TEST_SETTINGS["build_number"])
+  end
+  
+  should "check if a revision passed" do
+    # no assertion here because can't be sure what we'll get from Jenkins
+    @config.jenkins.revision_passed?
+  end
+  
+  # Unit tests for Capistrano tasks
+  should "run build_check task" do
+     # need a revision that will pass, otherwise the tests will abort
+     #@config.jenkins_cap.build_check
+  end
+end

data/test/test_settings.yml.template

@@ -0,0 +1,5 @@
+app: localhost
+deploy_to: "/tmp"
+jenkins_host: "http://localhost"
+jenkins_job_name: "test_job"
+revision: "1"

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification 
+name: gnm-jenkins_cap
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Dru Ibarra
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-20 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 2
+        - 9
+        - 0
+        version: 2.9.0
+  version_requirements: *id001
+  name: capistrano
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id002
+  name: json
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id003
+  name: term-ansicolor
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  name: shoulda
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  version_requirements: *id005
+  name: bundler
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  version_requirements: *id006
+  name: jeweler
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id007
+  name: rcov
+  prerelease: false
+description: add Jenkins tasks to Capistrano
+email: configurationmanagement@gorillanation.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- gnm-jenkins_cap.gemspec
+- lib/gnm-jenkins_cap.rb
+- test/helper.rb
+- test/test_jenkins_cap.rb
+- test/test_settings.yml.template
+homepage: https://github.com/GorillaNation/gnm-jenkins_cap
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: adds Jenkins tasks to Capistrano
+test_files: []
+