jenkins_tracker 0.1.0 → 0.2.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"

data/README.md

@@ -1,17 +1,21 @@
 # JenkinsTracker
 
+[![Build Status](https://travis-ci.org/prashantrajan/jenkins_tracker.png?branch=master)](https://travis-ci.org/prashantrajan/jenkins_tracker)
+[![Gem Version](https://badge.fury.io/rb/jenkins_tracker.png)](http://badge.fury.io/rb/jenkins_tracker)
+
 `jenkins_tracker` is a command line utility packaged as a [RubyGem](https://rubygems.org) that integrates [Jenkins](http://jenkins-ci.org/) build information with
 the relevant [Pivotal Tracker](https://www.pivotaltracker.com) stories within a project.
 
-It's ideally run as a Post Build Action in Jenkins.
-
 This utility makes some very specific assumptions about your Jenkins environment:-
 
 * Git as your SCM via the [Jenkins Git Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin).
 
 * The Jenkins build changelog file is available at `$JENKINS_HOME/jobs/$JOB_NAME/builds/$BUILD_NUMBER/changelog.xml`.
+  The changelog contents look like this [example](https://github.com/prashantrajan/jenkins_tracker/blob/master/spec/fixtures/git_changelog.txt).
 
-* Ability to execute Ruby scripts.
+* Ability to execute Ruby 1.9.x scripts.
+
+* Environment variables exists for `$JENKINS_HOME`, `$JOB_NAME`, `$BUILD_NUMBER` & `$BUILD_URL`.
 
 
 The following are required for your Pivotal Tracker project:-
@@ -36,7 +40,17 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    # Assuming environment variables for $JENKINS_HOME, $JOB_NAME, $BUILD_NUMBER & $BUILD_URL exists
+    $ bundle exec jenkins_tracker integrate --tracker-token ABC123456 --tracker-project-id 123456
+      # => Successfully integrated Jenkins Job ($JOB_NAME) with Pivotal Tracker Project (123456)
+
+It's best to run this utility as a Post Build Action in Jenkins:
+
+![Jenkins Post Build Action Screenshot](https://raw.github.com/prashantrajan/static_assets/master/jenkins_tracker/images/jenkins_post_build_action.jpg)
+
+The integration will result in comments being added to the relevant Pivotal Tracker stories:
+
+![Jenkins Post Build Action Screenshot](https://raw.github.com/prashantrajan/static_assets/master/jenkins_tracker/images/tracker_comment.jpg)
 
 
 ## Contributing

data/Rakefile

@@ -1 +1,7 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/jenkins_tracker.rb

@@ -4,6 +4,7 @@ require 'ostruct'
 require 'rest-client'
 
 require 'jenkins_tracker/version'
+require 'jenkins_tracker/exceptions'
 require 'jenkins_tracker/util'
 require 'jenkins_tracker/tracker_client'
 require 'jenkins_tracker/base'

data/lib/jenkins_tracker/base.rb

@@ -5,6 +5,8 @@ module JenkinsTracker
     attr_reader :changelog, :tracker_client, :job_name, :build_url
 
     def initialize(options = {})
+      raise FileNotFoundError, "Changelog file not found at: #{options[:changelog_file]}" unless File.file?(options[:changelog_file])
+
       @changelog = File.read(options[:changelog_file])
       @tracker_client = TrackerClient.new(:token => options[:tracker_token])
       @job_name = options[:job_name]

data/lib/jenkins_tracker/cli.rb

@@ -22,8 +22,8 @@ module JenkinsTracker
         ).integrate_job_with_tracker(tracker_project_id)
 
         say "Successfully integrated Jenkins Job (#{job_name}) with Pivotal Tracker Project (#{tracker_project_id})", :green
-      rescue
-        # do nothing
+      rescue FileNotFoundError => e
+        say e.message, :red
       end
     end
 

data/lib/jenkins_tracker/exceptions.rb

@@ -0,0 +1,10 @@
+module JenkinsTracker
+
+  # our base error class
+  class Error < StandardError
+  end
+
+  class FileNotFoundError < Error
+  end
+
+end

data/lib/jenkins_tracker/version.rb

@@ -1,3 +1,3 @@
 module JenkinsTracker
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/jenkins_tracker/base_spec.rb

@@ -15,6 +15,21 @@ describe JenkinsTracker::Base do
       expect(obj.job_name).to eq('foo_job')
       expect(obj.build_url).to eq('http://jenkins.bitium/com/foo_job/3')
     end
+
+    context 'when changelog file does not exist' do
+      it 'raises a FileNotFoundError' do
+        changelog_file = '/a/non-existent/file/path'
+
+        expect {
+          described_class.new(
+            :changelog_file => changelog_file,
+            :tracker_token => 'xxx',
+            :job_name      => 'foo_job',
+            :build_url     => 'http://jenkins.bitium/com/foo_job/3'
+          )
+        }.to raise_error(JenkinsTracker::FileNotFoundError, "Changelog file not found at: #{changelog_file}")
+      end
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_tracker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -85,6 +85,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -94,6 +95,7 @@ files:
 - lib/jenkins_tracker.rb
 - lib/jenkins_tracker/base.rb
 - lib/jenkins_tracker/cli.rb
+- lib/jenkins_tracker/exceptions.rb
 - lib/jenkins_tracker/tracker_client.rb
 - lib/jenkins_tracker/util.rb
 - lib/jenkins_tracker/version.rb
@@ -118,7 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1872917664060546366
+      hash: 4101774404869784256
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -127,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1872917664060546366
+      hash: 4101774404869784256
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24