jenkins_tracker 0.3.0 → 0.3.1

data/README.md

@@ -3,24 +3,33 @@
 [![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/gems/jenkins_tracker) that integrates [Jenkins](http://jenkins-ci.org/) build information with
-the relevant [Pivotal Tracker](https://www.pivotaltracker.com) stories within a project.
+`jenkins_tracker` is a command line utility packaged as a [RubyGem](https://rubygems.org/gems/jenkins_tracker) that
+integrates [Jenkins CI](http://jenkins-ci.org/) build information with [Pivotal Tracker](https://www.pivotaltracker.com) stories within a project.
+The underlying library is also used in the native [Jenkins Tracker Plugin](https://github.com/prashantrajan/jenkins-tracker-plugin).
 
-This utility makes some very specific assumptions about your Jenkins environment:-
+This is an example of a successful build integration:
+
+![Jenkins Post Build Action Screenshot](https://raw.github.com/prashantrajan/static_assets/master/jenkins_tracker/images/tracker_comment_2.jpg)
+
+
+## Requirements
+
+### Jenkins
 
 * 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 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 1.9.x scripts.
+* `Ruby` is available in the environment.
 
 * Environment variables exists for `$JENKINS_HOME`, `$JOB_NAME`, `$BUILD_NUMBER` & `$BUILD_URL`.
 
+### Pivotal Tracker
 
-The following are required for your Pivotal Tracker project:-
+* You have created an [API Token](https://www.pivotaltracker.com/profile).
 
-* [API access enabled](https://www.pivotaltracker.com/help/api) (enabled by default).
+* Project has [API access enabled](https://www.pivotaltracker.com/help/api) (it's enabled by default).
 
 
 ## Installation
@@ -40,18 +49,18 @@ Or install it yourself as:
 
 ## Usage
 
-    # 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)
+### As a Post-build Action script
 
-This utility could be run as a `Post Build Action` in Jenkins:
+Requires the [Post build task plugin](http://wiki.hudson-ci.org/display/HUDSON/Post+build+task):
 
-![Jenkins Post Build Action Screenshot](https://raw.github.com/prashantrajan/static_assets/master/jenkins_tracker/images/jenkins_post_build_action.jpg)
+```
+# Assuming environment variables for $JENKINS_HOME, $JOB_NAME, $BUILD_NUMBER & $BUILD_URL exists
 
-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_2.jpg)
+$ bundle exec jenkins_tracker integrate --tracker-token ABC123456 --tracker-project-id 123456
+# => Successfully integrated Jenkins Job $JOB_NAME with Pivotal Tracker Project #123456
+```
+    
+![Jenkins Post Build Action Screenshot](https://raw.github.com/prashantrajan/static_assets/master/jenkins_tracker/images/jenkins_post_build_action_2.jpg)
 
 
 ## Contributing

data/lib/jenkins_tracker.rb

@@ -1,5 +1,4 @@
 #require 'json'
-require 'ostruct'
 
 require 'rest-client'
 
@@ -7,4 +6,5 @@ require 'jenkins_tracker/version'
 require 'jenkins_tracker/exceptions'
 require 'jenkins_tracker/util'
 require 'jenkins_tracker/tracker_client'
+require 'jenkins_tracker/changelog_item'
 require 'jenkins_tracker/base'

data/lib/jenkins_tracker/base.rb

@@ -1,6 +1,6 @@
 module JenkinsTracker
   class Base
-    include Util
+    #include Util
 
     attr_reader :changelog, :tracker_client, :job_name, :build_url
 
@@ -17,11 +17,30 @@ module JenkinsTracker
     end
 
     def integrate_job_with_tracker(project_id)
-      parse_changelog(changelog).each do |change|
+      parse_changelog.each do |change|
         note = "*#{change.commit_message}* integrated in *#{job_name}* (#{build_url})"
         tracker_client.add_note_to_story(project_id, change.story_id, note)
       end
     end
 
+    def parse_changelog
+      results = []
+
+      changelog.scan(/(\[[#a-zA-Z0-9\s]+\])(.*)/) do |ids, msg|
+        parse_tracker_story_ids(ids).each do |id|
+          results << ChangelogItem.new(:story_id => id, :commit_message => "#{ids}#{msg}".strip)
+        end
+      end
+
+      results.uniq
+    end
+
+
+    private
+
+    def parse_tracker_story_ids(str)
+      str.strip.gsub(/[\[#\]]/, '').split(' ').map(&:to_i).reject { |i| i == 0 }
+    end
+
   end
 end

data/lib/jenkins_tracker/changelog_item.rb

@@ -0,0 +1,24 @@
+module JenkinsTracker
+  class ChangelogItem
+
+    attr_accessor :story_id, :commit_message
+
+    def initialize(options = {})
+      @story_id = options[:story_id]
+      @commit_message = options[:commit_message]
+    end
+
+    def ==(other)
+      self.story_id == other.story_id && self.commit_message == other.commit_message
+    end
+
+    def eql?(other)
+      (self.class == other.class) && self == other
+    end
+
+    def hash
+      [story_id, commit_message].hash
+    end
+
+  end
+end

data/lib/jenkins_tracker/tracker_client.rb

@@ -17,7 +17,7 @@ module JenkinsTracker
         connection["projects/#{project_id}/stories/#{story_id}/notes"].post("<note><text>#{note}</text></note>")
       rescue => e
         # if the post fails for whatever reason (e.g. invalid story id etc), just ignore it
-        puts ["An error occurred while trying add note to Story ##{story_id} in Project ##{project_id} ", e.message, e.backtrace] * "\n"
+        #puts ["An error occurred while trying add note to Story ##{story_id} in Project ##{project_id} ", e.message, e.backtrace] * "\n"
       end
     end
 

data/lib/jenkins_tracker/util.rb

@@ -12,21 +12,5 @@ module JenkinsTracker
     #  JSON.parse(str, options)
     #end
 
-    def parse_changelog(str)
-      results = []
-
-      str.scan(/(\[[#a-zA-Z0-9\s]+\])(.*)/) do |ids, msg|
-        parse_tracker_story_ids(ids).each do |id|
-          results << OpenStruct.new(:story_id => id, :commit_message => "#{ids}#{msg}".strip)
-        end
-      end
-
-      results
-    end
-
-    def parse_tracker_story_ids(str)
-      str.strip.gsub(/[\[#\]]/, '').split(' ').map(&:to_i).reject { |i| i == 0 }
-    end
-
   end
 end

data/lib/jenkins_tracker/version.rb

@@ -1,3 +1,3 @@
 module JenkinsTracker
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/spec/fixtures/git_changelog_with_duplicates.txt

@@ -0,0 +1,39 @@
+Changes in branch origin/master, between c0d9a605c020d0ccaac2ef7f4a52607f0b1032ff and 05b96f9a60360525b5a17721e0ed107e53f42ede
+commit 05b96f9a60360525b5a17721e0ed107e53f42ede
+tree 90fae1497ff2e0eb19992993ac2a335561ef9e21
+parent b1d0cda2f3766e5285cbe6f8c788d5d3c2d0aaf3
+author Prashant Nadarajan <mrp@example.com> 1360758891 +0800
+committer Prashant Nadarajan <mrp@example.com> 1360758902 +0800
+
+    [#123 #456] added more test
+
+:100644 100644 7da3210b8da221718054af45ca5384a1b3c5a654 e57a7a9b044142080875d0b5b6548ea62f666143 M      README.md
+
+commit b1d0cda2f3766e5285cbe6f8c788d5d3c2d0aaf3
+tree 5364d5d2ec4e082218ef7a1d779ac35a89647f3b
+parent c0d9a605c020d0ccaac2ef7f4a52607f0b1032ff
+author Prashant Nadarajan <mrp@example.com> 1360758738 +0800
+committer Prashant Nadarajan <mrp@example.com> 1360758738 +0800
+
+    [Fixes #456 #789] added test 1 to readme
+
+:100644 100644 3979ab174391acf45520c09801a8b6919fd9df95 7da3210b8da221718054af45ca5384a1b3c5a654 M      README.md
+commit 05b96f9a60360525b5a17721e0ed107e53f42ede
+tree 90fae1497ff2e0eb19992993ac2a335561ef9e21
+parent b1d0cda2f3766e5285cbe6f8c788d5d3c2d0aaf3
+author Prashant Nadarajan <mrp@example.com> 1360758891 +0800
+committer Prashant Nadarajan <mrp@example.com> 1360758902 +0800
+
+    [#123 #456] added more test
+
+:100644 100644 7da3210b8da221718054af45ca5384a1b3c5a654 e57a7a9b044142080875d0b5b6548ea62f666143 M      README.md
+
+commit b1d0cda2f3766e5285cbe6f8c788d5d3c2d0aaf3
+tree 5364d5d2ec4e082218ef7a1d779ac35a89647f3b
+parent c0d9a605c020d0ccaac2ef7f4a52607f0b1032ff
+author Prashant Nadarajan <mrp@example.com> 1360758738 +0800
+committer Prashant Nadarajan <mrp@example.com> 1360758738 +0800
+
+    [Fixes #456 #789] added test 1 to readme
+
+:100644 100644 3979ab174391acf45520c09801a8b6919fd9df95 7da3210b8da221718054af45ca5384a1b3c5a654 M      README.md

data/spec/jenkins_tracker/base_spec.rb

@@ -35,4 +35,32 @@ describe JenkinsTracker::Base do
     end
   end
 
+  describe '#parse_changelog' do
+    it 'returns an array of ChangelogItems' do
+      changelog_file = fixture_file_path('git_changelog.txt')
+
+      results = described_class.new(:changelog_file => changelog_file).parse_changelog
+      expect(results.size).to eq(4)
+
+      expect(results.first.story_id).to eq(123)
+      expect(results.first.commit_message).to eq('[#123 #456] added more test')
+
+      expect(results.last.story_id).to eq(789)
+      expect(results.last.commit_message).to eq('[Fixes #456 #789] added test 1 to readme')
+    end
+
+    it 'does not return duplicate ChangelogItems' do
+      changelog_file = fixture_file_path('git_changelog_with_duplicates.txt')
+
+      results = described_class.new(:changelog_file => changelog_file).parse_changelog
+      expect(results.size).to eq(4)
+
+      expect(results.first.story_id).to eq(123)
+      expect(results.first.commit_message).to eq('[#123 #456] added more test')
+
+      expect(results.last.story_id).to eq(789)
+      expect(results.last.commit_message).to eq('[Fixes #456 #789] added test 1 to readme')
+    end
+  end
+
 end

data/spec/jenkins_tracker/changelog_item_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe JenkinsTracker::ChangelogItem do
+
+  describe '#story_id' do
+    it 'accessor methods' do
+      expect(described_class.new).to respond_to('story_id')
+      expect(described_class.new).to respond_to('story_id=')
+    end
+  end
+
+  describe '#commit_message' do
+    it 'accessor methods' do
+      expect(described_class.new).to respond_to('commit_message')
+      expect(described_class.new).to respond_to('commit_message=')
+    end
+  end
+
+  describe '==(other)' do
+    it 'is equal to other when its story_id & commit_message are equal' do
+      item1 = described_class.new(:story_id => 1, :commit_message => '123abc')
+      item2 = described_class.new(:story_id => 1, :commit_message => '123abc')
+      item3 = item1
+
+      expect(item1).to eq(item2)
+      expect(item3).to eq(item2)
+    end
+
+    it 'is not equal to other when its story_id are not equal' do
+      item1 = described_class.new(:story_id => 1, :commit_message => '123abc')
+      item2 = described_class.new(:story_id => 2, :commit_message => '123abc')
+
+      expect(item1).to_not eq(item2)
+    end
+
+    it 'is not equal to other when its commit_message are not equal' do
+      item1 = described_class.new(:story_id => 1, :commit_message => '123abc')
+      item2 = described_class.new(:story_id => 1, :commit_message => 'xyz')
+
+      expect(item1).to_not eq(item2)
+    end
+  end
+
+  describe 'eql?(other)' do
+    let(:fake_changelog_class) { Struct.new(:story_id, :commit_message) }
+
+    it 'is equal to other when its class and attributes are equal' do
+      item1 = described_class.new(:story_id => 1, :commit_message => '123abc')
+      item2 = fake_changelog_class.new(1, '123abc')
+      item3 = item1
+
+      expect(item1).to_not eql(item2)
+      expect(item3).to eql(item1)
+    end
+  end
+
+  describe 'an array of ChangelogItems' do
+    it 'correctly removes duplicates when uniq is called' do
+      item1 = described_class.new(:story_id => 1, :commit_message => '123abc')
+      item2 = described_class.new(:story_id => 1, :commit_message => '123abc')
+      item3 = described_class.new(:story_id => 1, :commit_message => 'xyz')
+      item4 = described_class.new(:story_id => 2, :commit_message => '123abc')
+
+      expect([item1, item2].uniq.size).to eq(1)
+      expect([item1, item3].uniq.size).to eq(2)
+      expect([item1, item4].uniq.size).to eq(2)
+      expect([item1, item3, item4].uniq.size).to eq(3)
+    end
+  end
+
+end

data/spec/jenkins_tracker/util_spec.rb

@@ -7,7 +7,7 @@ end
 
 
 describe JenkinsTracker::Util do
-  let!(:class_instance) { UtilModuleTester.new }
+  #let!(:class_instance) { UtilModuleTester.new }
 
   #describe '#parse_json' do
   #  let(:json_str) { load_fixture_as_str('job.json') }
@@ -19,17 +19,4 @@ describe JenkinsTracker::Util do
   #
   #end
 
-  describe '#parse_changelog' do
-    let(:git_changelog) { load_fixture_as_str('git_changelog.txt') }
-
-    it 'returns an array of struct objects' do
-      results = class_instance.parse_changelog(git_changelog)
-      expect(results.first.story_id).to eq(123)
-      expect(results.first.commit_message).to eq('[#123 #456] added more test')
-
-      expect(results.last.story_id).to eq(789)
-      expect(results.last.commit_message).to eq('[Fixes #456 #789] added test 1 to readme')
-    end
-  end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_tracker
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-16 00:00:00.000000000 Z
+date: 2013-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -94,14 +94,17 @@ files:
 - jenkins_tracker.gemspec
 - lib/jenkins_tracker.rb
 - lib/jenkins_tracker/base.rb
+- lib/jenkins_tracker/changelog_item.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
 - spec/fixtures/git_changelog.txt
+- spec/fixtures/git_changelog_with_duplicates.txt
 - spec/fixtures/job.json
 - spec/jenkins_tracker/base_spec.rb
+- spec/jenkins_tracker/changelog_item_spec.rb
 - spec/jenkins_tracker/tracker_client_spec.rb
 - spec/jenkins_tracker/util_spec.rb
 - spec/spec_helper.rb
@@ -120,7 +123,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2227372096919744340
+      hash: -4233350795122730482
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -129,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2227372096919744340
+      hash: -4233350795122730482
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -139,8 +142,10 @@ summary: Integrate Jenkins build information as notes in the relevant Pivotal Tr
   stories based on its post commit message
 test_files:
 - spec/fixtures/git_changelog.txt
+- spec/fixtures/git_changelog_with_duplicates.txt
 - spec/fixtures/job.json
 - spec/jenkins_tracker/base_spec.rb
+- spec/jenkins_tracker/changelog_item_spec.rb
 - spec/jenkins_tracker/tracker_client_spec.rb
 - spec/jenkins_tracker/util_spec.rb
 - spec/spec_helper.rb