jenkins_cap 0.0.0 → 0.1.0

data/Gemfile

@@ -4,6 +4,7 @@ source "http://rubygems.org"
 #   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.

data/Gemfile.lock

@@ -24,6 +24,7 @@ GEM
     rake (0.9.2.2)
     rcov (0.9.8)
     shoulda (2.11.3)
+    term-ansicolor (1.0.7)
 
 PLATFORMS
   ruby
@@ -35,3 +36,4 @@ DEPENDENCIES
   json
   rcov
   shoulda
+  term-ansicolor

data/README.rdoc

@@ -1,6 +1,22 @@
 = jenkins_cap
 
-Description goes here.
+Adds Jenkins tasks to Capistrano.
+
+== Installation
+
+    $ gem install jenkins_cap
+    
+Include in your Capfile
+    require 'rubygems'
+    require '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 jenkins_cap
  

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/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{jenkins_cap}
+  s.version = "0.1.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-09}
+  s.description = %q{add Jenkins tasks to Capistrano}
+  s.email = %q{Druwerd@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "jenkins_cap.gemspec",
+    "lib/jenkins_cap.rb",
+    "test/helper.rb",
+    "test/test_jenkins_cap.rb",
+    "test/test_settings.yml.template"
+  ]
+  s.homepage = %q{http://github.com/Druwerd/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/jenkins_cap.rb

@@ -1,8 +1,14 @@
 require 'json'
+require 'term/ansicolor'
+require 'capistrano'
 
-Capistrano::Configuration.instance(true).load do
+class String
+  include Term::ANSIColor
+end
 
+module Capistrano
   module JenkinsCap
+    
     def json_request(url)
       response = `wget -q -O - #{url}`
       JSON.load(response)
@@ -13,6 +19,8 @@ Capistrano::Configuration.instance(true).load do
       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)
@@ -21,41 +29,52 @@ Capistrano::Configuration.instance(true).load do
       revisions = [] 
       json_results['changeSet']['revisions'].each{|r| revisions << r['revision']}
       revisions.sort.last
+    rescue NoMethodError => e
+      puts "WARNING: #{e}".yellow
     end
 
-    def build_has_current_revision?(build_number)
+    def build_has_revision?(build_number)
       build_revision = get_revision_from_build(build_number)
-      puts build_revision
-      build_revision.to_i == current_revision.to_i
+      #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")
-      puts json_results['result']
       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|
-         puts "checking #{build_number}"
-         if build_has_current_revision?(build_number) # check if build has the revision we care about
+         if build_has_revision?(build_number) # check if build has the revision we care about
            return build_passed?(build_number)
          end
       end
       false
     end
-  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?
+           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
 
-  namespace :jenkinscap do
-     desc "Check if this deployment as a good Jenkins build"
-     task "build_check" do
-       if (not jenkins.revision_passed?)
-          abort "\n\n\n\e[0;31m This revision #{current_revision} has not been built by Jenkins successfully!  \e[0m\n\n\n"
-       end
-     end
-  end
+end # end of Capistrano module
 
+if Capistrano::Configuration.instance
+  Capistrano::JenkinsCap.load_into(Capistrano::Configuration.instance)
 end

data/test/helper.rb

@@ -9,7 +9,6 @@ rescue Bundler::BundlerError => e
 end
 require 'test/unit'
 require 'shoulda'
-require 'capistrano'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/test_jenkins_cap.rb

@@ -1,10 +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
   
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+  # 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

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jenkins_cap
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 0
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Dru Ibarra
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-06 00:00:00 Z
+date: 2012-03-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -48,7 +48,7 @@ dependencies:
   name: json
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :development
+  type: :runtime
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -59,11 +59,25 @@ dependencies:
         - 0
         version: "0"
   version_requirements: *id003
-  name: shoulda
+  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: 
     - - ~>
@@ -74,12 +88,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  version_requirements: *id004
+  version_requirements: *id005
   name: bundler
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -90,12 +104,12 @@ dependencies:
         - 6
         - 4
         version: 1.6.4
-  version_requirements: *id005
+  version_requirements: *id006
   name: jeweler
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -104,7 +118,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id006
+  version_requirements: *id007
   name: rcov
   prerelease: false
 description: add Jenkins tasks to Capistrano
@@ -124,9 +138,11 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- jenkins_cap.gemspec
 - lib/jenkins_cap.rb
 - test/helper.rb
 - test/test_jenkins_cap.rb
+- test/test_settings.yml.template
 homepage: http://github.com/Druwerd/jenkins_cap
 licenses: 
 - MIT