jenkins_tracker 0.1.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rvmrc
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/fixtures/live
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jenkins_tracker.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Prashant Nadarajan, Bitium, Inc.
+
+MIT License
+
+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.md

@@ -0,0 +1,48 @@
+# JenkinsTracker
+
+`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`.
+
+* Ability to execute Ruby scripts.
+
+
+The following are required for your Pivotal Tracker project:-
+
+* [API access enabled](https://www.pivotaltracker.com/help/api) (enabled by default).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jenkins_tracker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jenkins_tracker
+
+
+## Usage
+
+TODO: Write usage instructions here
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/jenkins_tracker

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+root = File.expand_path('../../lib', __FILE__)
+$:.unshift(root) unless $:.include?(root)
+
+require 'jenkins_tracker'
+require 'jenkins_tracker/cli'
+
+JenkinsTracker::Cli.start

data/jenkins_tracker.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jenkins_tracker/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "jenkins_tracker"
+  gem.version       = JenkinsTracker::VERSION
+  gem.authors       = ["Prashant Nadarajan"]
+  gem.email         = ["prashant.nadarajan@gmail.com"]
+  gem.description   = %q{Integrate Jenkins build info with Pivotal Tracker project stories }
+  gem.summary       = %q{Integrate Jenkins build info as notes to the relevant Pivotal Tracker stories based on post commit message syntax}
+  gem.homepage      = "https://github.com/prashantrajan/jenkins_tracker"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = %w(jenkins_tracker)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'rest-client', '~> 1.6'
+  gem.add_runtime_dependency 'thor', '~> 0.15'
+
+  gem.add_development_dependency 'rake', '>= 0.8'
+  gem.add_development_dependency 'rspec', '~> 2.12'
+end

data/lib/jenkins_tracker.rb

@@ -0,0 +1,9 @@
+#require 'json'
+require 'ostruct'
+
+require 'rest-client'
+
+require 'jenkins_tracker/version'
+require 'jenkins_tracker/util'
+require 'jenkins_tracker/tracker_client'
+require 'jenkins_tracker/base'

data/lib/jenkins_tracker/base.rb

@@ -0,0 +1,22 @@
+module JenkinsTracker
+  class Base
+    include Util
+
+    attr_reader :changelog, :tracker_client, :job_name, :build_url
+
+    def initialize(options = {})
+      @changelog = File.read(options[:changelog_file])
+      @tracker_client = TrackerClient.new(:token => options[:tracker_token])
+      @job_name = options[:job_name]
+      @build_url = options[:build_url]
+    end
+
+    def integrate_job_with_tracker(project_id)
+      parse_changelog(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
+
+  end
+end

data/lib/jenkins_tracker/cli.rb

@@ -0,0 +1,31 @@
+require 'thor'
+
+module JenkinsTracker
+  class Cli < Thor
+
+    desc 'integrate', 'Integrate Jenkins build with Pivotal Tracker project stories'
+    method_option 'tracker-token', :required => true, :desc => 'Pivotal Tracker API Token'
+    method_option 'tracker-project-id', :required => true, :type => :numeric, :desc => 'Pivotal Tracker Project ID'
+    method_option 'job-name', :default => ENV['JOB_NAME'], :desc => 'Jenkins job name'
+    method_option 'build-url', :default => ENV['BUILD_URL'], :desc => 'Jenkins build URL'
+    method_option 'changelog-file', :desc => 'Absolute path to changelog file.', :default => "#{ENV['JENKINS_HOME']}/jobs/#{ENV['JOB_NAME']}/builds/#{ENV['BUILD_NUMBER']}/changelog.xml"
+    def integrate
+      job_name = options['job-name']
+      tracker_project_id = options['tracker-project-id']
+
+      begin
+        JenkinsTracker::Base.new(
+          :changelog_file => options['changelog-file'],
+          :tracker_token => options['tracker-token'],
+          :job_name      => job_name,
+          :build_url     => options['build-url']
+        ).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
+      end
+    end
+
+  end
+end

data/lib/jenkins_tracker/tracker_client.rb

@@ -0,0 +1,43 @@
+module JenkinsTracker
+  class TrackerClient
+
+    attr_writer :use_ssl
+    attr_reader :token
+
+    def initialize(options = {})
+      @token = options[:token]
+    end
+
+    def connection(options = {})
+      @connection ||= RestClient::Resource.new(api_url, :headers => { 'X-TrackerToken' => token, 'Content-Type' => 'application/xml' })
+    end
+
+    def add_note_to_story(project_id, story_id, note)
+      connection["projects/#{project_id}/stories/#{story_id}/notes"].post("<note><text>#{note}</text></note>")
+    end
+
+
+    private
+
+    def tracker_host
+      'www.pivotaltracker.com'
+    end
+
+    def api_path
+      '/services/v3'
+    end
+
+    def api_url
+      "#{protocol}://#{tracker_host}#{api_path}"
+    end
+
+    def use_ssl
+      @use_ssl || false
+    end
+
+    def protocol
+      use_ssl ? 'https' : 'http'
+    end
+
+  end
+end

data/lib/jenkins_tracker/util.rb

@@ -0,0 +1,32 @@
+module JenkinsTracker
+  module Util
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+    end
+
+    #def parse_json(str, options = {})
+    #  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

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

data/spec/fixtures/git_changelog.txt

@@ -0,0 +1,20 @@
+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

data/spec/fixtures/job.json

@@ -0,0 +1,105 @@
+{
+  "actions": [
+  {
+    "causes": [
+      {
+        "shortDescription": "Started by user Prashant Nadarajan",
+        "userId": "prashantrajan",
+        "userName": "Prashant Nadarajan"
+      }
+    ]
+  },
+  {
+    "buildsByBranchName": {
+      "origin/master": {
+        "buildNumber": 2,
+        "buildResult": null,
+        "revision": {
+          "SHA1": "05b96f9a60360525b5a17721e0ed107e53f42ede",
+          "branch": [
+            {
+              "SHA1": "05b96f9a60360525b5a17721e0ed107e53f42ede",
+              "name": "origin/master"
+            }
+          ]
+        }
+      }
+    },
+    "lastBuiltRevision": {
+      "SHA1": "05b96f9a60360525b5a17721e0ed107e53f42ede",
+      "branch": [
+        {
+          "SHA1": "05b96f9a60360525b5a17721e0ed107e53f42ede",
+          "name": "origin/master"
+        }
+      ]
+    },
+    "remoteUrls": ["ssh://git@github.com/prashantrajan/zz_test.git"],
+    "scmName": ""
+  },
+  {},
+  {}
+],
+  "artifacts": [],
+  "building": false,
+  "description": null,
+  "duration": 1355,
+  "estimatedDuration": 1618,
+  "executor": null,
+  "fullDisplayName": "zz_test #2",
+  "id": "2013-02-13_04-37-49",
+  "keepLog": false, "number": 2,
+  "result": "SUCCESS",
+  "timestamp": 1360759069600,
+  "url": "http://jenkins.example.com/job/zz_test/2/",
+  "builtOn": "",
+  "changeSet": {
+    "items": [
+      {
+        "affectedPaths": ["README.md"],
+        "commitId": "b1d0cda2f3766e5285cbe6f8c788d5d3c2d0aaf3",
+        "timestamp": 1360758738000,
+        "author": {
+          "absoluteUrl": "http://jenkins.example.com/user/prashantrajan",
+          "fullName": "Prashant Nadarajan"
+        },
+        "comment": "[#44375023] added test 1 to readme\n",
+        "date": "2013-02-13 04:32:18 +0800",
+        "id": "b1d0cda2f3766e5285cbe6f8c788d5d3c2d0aaf3",
+        "msg": "[#44375023] added test 1 to readme",
+        "paths": [
+          {
+            "editType": "edit",
+            "file": "README.md"
+          }
+        ]
+      },
+      {
+        "affectedPaths": ["README.md"],
+        "commitId": "05b96f9a60360525b5a17721e0ed107e53f42ede",
+        "timestamp": 1360758891000,
+        "author": {
+          "absoluteUrl": "http://jenkins.example.com/user/prashantrajan",
+          "fullName": "Prashant Nadarajan"
+        },
+        "comment": "[#44375023 #44375221] added more test\n",
+        "date": "2013-02-13 04:34:51 +0800",
+        "id": "05b96f9a60360525b5a17721e0ed107e53f42ede",
+        "msg": "[#44375023 #44375221] added more test",
+        "paths": [
+          {
+            "editType": "edit",
+            "file": "README.md"
+          }
+        ]
+      }
+    ],
+    "kind": null
+  },
+  "culprits": [
+    {
+      "absoluteUrl": "http://jenkins.example.com/user/prashantrajan",
+      "fullName": "Prashant Nadarajan"
+    }
+  ]
+}

data/spec/jenkins_tracker/base_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe JenkinsTracker::Base do
+
+  describe '#initialize' do
+    it 'does basic set up' do
+      obj = described_class.new(
+        :changelog_file => fixture_file_path('git_changelog.txt'),
+        :tracker_token => 'xxx',
+        :job_name => 'foo_job',
+        :build_url => 'http://jenkins.bitium/com/foo_job/3'
+      )
+      expect(obj.changelog).to eq( File.read(fixture_file_path('git_changelog.txt')) )
+      expect(obj.tracker_client.token).to eq('xxx')
+      expect(obj.job_name).to eq('foo_job')
+      expect(obj.build_url).to eq('http://jenkins.bitium/com/foo_job/3')
+    end
+  end
+
+end

data/spec/jenkins_tracker/tracker_client_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe JenkinsTracker::TrackerClient do
+
+  describe '#connection' do
+    it 'returns an instance of RestClient::Resource' do
+      tracker_client = described_class.new(:token => 'xxx')
+      expect(tracker_client.connection).to be_an_instance_of(RestClient::Resource)
+      expect(tracker_client.connection.to_s).to eq('http://www.pivotaltracker.com/services/v3')
+    end
+  end
+
+end

data/spec/jenkins_tracker/util_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+
+class UtilModuleTester
+  include JenkinsTracker::Util
+end
+
+
+describe JenkinsTracker::Util do
+  let!(:class_instance) { UtilModuleTester.new }
+
+  #describe '#parse_json' do
+  #  let(:json_str) { load_fixture_as_str('job.json') }
+  #
+  #  it 'returns a Ruby data structure representation of the JSON string' do
+  #    results = class_instance.parse_json(json_str)
+  #    expect(results['changeSet']['items'].size).to eq(2)
+  #  end
+  #
+  #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

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'jenkins_tracker'
+
+PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '../'))
+Dir[ File.join(PROJECT_ROOT, 'spec', 'support/**/*.rb') ].each { |f| require f }
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.include FixtureLoader
+end

data/spec/support/fixture_loader.rb

@@ -0,0 +1,11 @@
+module FixtureLoader
+
+  def load_fixture_as_str(filename)
+    File.read(fixture_file_path(filename))
+  end
+
+  def fixture_file_path(filename)
+    File.join(PROJECT_ROOT, 'spec', 'fixtures', filename)
+  end
+
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: jenkins_tracker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Prashant Nadarajan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+description: ! 'Integrate Jenkins build info with Pivotal Tracker project stories '
+email:
+- prashant.nadarajan@gmail.com
+executables:
+- jenkins_tracker
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/jenkins_tracker
+- jenkins_tracker.gemspec
+- lib/jenkins_tracker.rb
+- lib/jenkins_tracker/base.rb
+- lib/jenkins_tracker/cli.rb
+- lib/jenkins_tracker/tracker_client.rb
+- lib/jenkins_tracker/util.rb
+- lib/jenkins_tracker/version.rb
+- spec/fixtures/git_changelog.txt
+- spec/fixtures/job.json
+- spec/jenkins_tracker/base_spec.rb
+- spec/jenkins_tracker/tracker_client_spec.rb
+- spec/jenkins_tracker/util_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixture_loader.rb
+homepage: https://github.com/prashantrajan/jenkins_tracker
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1872917664060546366
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1872917664060546366
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Integrate Jenkins build info as notes to the relevant Pivotal Tracker stories
+  based on post commit message syntax
+test_files:
+- spec/fixtures/git_changelog.txt
+- spec/fixtures/job.json
+- spec/jenkins_tracker/base_spec.rb
+- spec/jenkins_tracker/tracker_client_spec.rb
+- spec/jenkins_tracker/util_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixture_loader.rb