WTBuildHelpers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 899f3d4ed4d147d9310a7327e55318e6ec88bc38
+  data.tar.gz: 3eae7c5fe00913c91c507972610b0166845a4d46
+SHA512:
+  metadata.gz: aec03ba6b56605356742fe8d81c2f322016b63860202e7e8d1b4b5a230a2de855d63263c8c02da24cbb9aff925c88fca07938f32ef448211738eefc6602d9650
+  data.tar.gz: 2f2212b2a1c62cc090d51ac58c95a82c972ee3ccb44636a8e4ed212b8cf5d863cbbc78767aac4b679cf679f82143930eed2c3156b7da9075ecaf1a292c2e3c11

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 WillowTree
+
+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,59 @@
+# WTBuildHelpersGem
+
+This is a set of scripts for multiple platforms to help with building and testing tasks
+specific to WillowTree's pipelines and integrations.
+
+### JIRA 
+
+#### perform_jira_update
+Updates any jira tickets based on the supplied git commit range.
+
+Environment Variables
+  - JIRA_URL - Base url for JIRA
+  - JIRA_USERNAME - Username for accessing JIRA
+  - JIRA_PASSWORD - Password for accessing JIRA
+  - Supplied by Travis-CI:
+    - TRAVIS_COMMIT_RANGE - range of commits to update
+    - TRAVIS_BUILD_NUMBER - build number
+  - Supplied by TeamCity
+    - BUILD_NUMBER - build number
+    - TRAMCITY_COMMIT_RANGE - created by teamcity_git_range_fetch
+
+Command Line Usage:
+```bash
+$ wtbuild_jira_update
+```
+
+### TeamCity 
+#### teamcity_git_range_fetch
+Fetches the last good build from the TeamCity server and uses that to produce the a git commit range.
+
+Command Line Usage (from TeamCity build step):
+```bash
+$ wtbuild_teamcity_fetch_git_range "%teamcity.serverUrl%" "%system.teamcity.buildType.id%" "%system.teamcity.auth.userId%" "%system.teamcity.auth.password%"``
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'WTBuildHelpersGem'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install WTBuildHelpersGem
+
+## Usage
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

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

data/WTBuildHelpers.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'WTBuildHelpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "WTBuildHelpers"
+  spec.summary       = "Helpers for performing common WillowTree build tasks and integrations"
+  spec.version       = WTBuildHelpers::VERSION
+  spec.authors       = ["WillowTreeApps"]
+  spec.email         = ["jeff.ward@willowtreeapps.com"]
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'OptionParser', '~> 0.5.1'
+  spec.add_runtime_dependency 'rest-client', '~> 1.8.0'
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "WTBuildHelpers"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/wtbuild_jira_update

@@ -0,0 +1,5 @@
+#! /usr/bin/env ruby
+
+require 'WTBuildHelpers'
+
+WTBuildHelpers::Jira.perform_jira_update(nil)

data/exe/wtbuild_teamcity_fetch_git_range

@@ -0,0 +1,13 @@
+#! /usr/bin/env ruby
+
+require 'WTBuildHelpers'
+
+if ARGV.length != 4
+	puts "Usage: teamcity_git_range_fetch.rb [TeamCity Url] [TeamCity Build Type Id] [TeamCity User Name] [TeamCity Password]"
+	puts "These parameters can be passed from TeamCity with the following line: "
+	puts "    teamcity_git_range_fetch.rb \"%teamcity.serverUrl%\" \"%system.teamcity.buildType.id%\" \"%system.teamcity.auth.userId%\" \"%system.teamcity.auth.password%\""
+	
+	exit
+end
+
+WTBuildHelpers::TeamCity.fetch_commit_range(ARGV[0], ARGV[1], ARGV[2], ARGV[3])

data/lib/WTBuildHelpers/version.rb

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

data/lib/WTBuildHelpers.rb

@@ -0,0 +1,8 @@
+require "WTBuildHelpers/version"
+
+require "jira_tasks"
+require "teamcity_git_range_fetch"
+
+module WTBuildHelpers
+  # Your code goes here...
+end

data/lib/jira_tasks.rb

@@ -0,0 +1,241 @@
+#! /usr/bin/env ruby
+
+require 'optparse'
+require 'pp'
+require 'set'
+require 'rest_client'
+require 'base64'
+require 'json'
+
+module WTBuildHelpers
+    module Jira
+        Options = Struct.new(:commit_range, :site, :username, :password, :build)
+
+        class JiraInfo
+            attr_reader :fixed_in_build_field_id
+            attr_reader :build_complete_transition_id
+            
+            attr_reader :site
+            attr_reader :base_url
+            attr_reader :auth_token
+            
+            def initialize(site, username, password)
+                @site = site
+                @username = username
+                @password = password
+                
+                @auth_token = Base64.encode64("#{username}:#{password}")
+                @base_url = File.join(site, '/rest/api/2')
+            end
+            
+            def update_fixed_in_build()
+                headers = { "Authorization" => "Basic #{@auth_token}" }
+            
+                # Find the Fixed In Build field
+                begin
+                    fields_url = File.join(@base_url, 'field')
+                    response = RestClient.get(fields_url, headers=headers)
+                    
+                    fields = JSON.parse(response.body);
+                    fixed_field = fields.find do |field|
+                        field["name"] == "Fixed In Build"
+                    end
+                
+                    @fixed_in_build_field_id = fixed_field["id"]
+                rescue RestClient::Exception => e
+                    puts "Error code #{e.response.code} attempting to find Fixed In Build field"
+                end 
+            end
+            
+            def update_build_complete_transition(issue_key)
+                headers = { "Authorization" => "Basic #{@auth_token}"}
+            
+                fields_url = File.join(@base_url, 'issue', issue_key, 'transitions')
+                begin
+                    response = RestClient.get(fields_url, headers=headers)
+                
+                    response_json = JSON.parse(response.body)
+                    transitions = response_json["transitions"]
+                    build_complete_transition = transitions.find do |transition|
+                        transition["name"] == "Build Complete"
+                    end
+                
+                    if not build_complete_transition.nil?
+                        @build_complete_transition_id = build_complete_transition["id"]
+                    end
+                rescue RestClient::Exception => e
+                    puts "Error code #{e.response.code} attempting to find Build Complete transition"
+                end
+            end
+        end
+
+        class Parser
+            def self.parse(options)
+                args = Options.new()
+           
+                opt_parser = OptionParser.new do |opts|
+                    opts.banner = "Usage: jira_tasks.rb [options]"
+                
+                    opts.on("-c", "--commits COMMIT_RANGE", "Specify a commit range") do |commit_range|
+                        args.commit_range = commit_range
+                    end
+                    
+                    opts.on("-u", "--username USERNAME", "Specify the user to connecto to JIRA") do |username|
+                        args.username = username
+                    end
+                    
+                    opts.on("-p", "--password PASSWORD", "Specify the password to connect to JIRA") do |password|
+                        args.password = password
+                    end
+                    
+                    opts.on("-s", "--site SITE", "Specify the base location of the JIRA instance") do |site|
+                        site.slice!("http://")
+                        site.insert(0, "https://")
+                        args.site = site
+                    end
+                    
+                    opts.on("-b", "--build BUILD", "The build number for which this script is executing") do |build|
+                        args.build = build
+                    end
+                    
+                    opts.on_tail("-h", "--help", "Show this message") do
+                        puts opts
+                        exit
+                    end
+                end
+            
+                opt_parser.parse!(options)
+                return args   
+            end
+        end
+
+        def self.find_jira_issues(logs)
+            issue_set = Set.new
+            logs.each do |log|
+                issues = log.scan(/[A-Z][A-Z]+-[1-9][0-9]*/)
+                issue_set.merge(issues)
+            end
+            
+            return issue_set
+        end
+
+        def self.get_git_history(commit_range)
+            happyface = "\u263A".encode('utf-8')
+            git_log = `git --no-pager log --format="%B#{happyface}" #{commit_range} `
+            
+            #parse out the log
+            logs = git_log.split(happyface)
+            
+            return logs
+        end
+
+        def self.jira_update(jira_info, issues, build)
+            jira_url = File.join(jira_info.base_url, 'issue')
+            
+            if jira_info.fixed_in_build_field_id.nil?
+                jira_info.update_fixed_in_build
+            end
+            
+            # Something's wrong. We're not on our JIRA
+            return if jira_info.fixed_in_build_field_id.nil?
+            
+            headers = { "Authorization" => "Basic #{jira_info.auth_token}",
+                        "Content-Type" => "application/json" }
+            
+            issues.each do |issue_key|
+                #try to perform the transition
+                if jira_info.build_complete_transition_id.nil?
+                    jira_info.update_build_complete_transition(issue_key)
+                end
+                
+                #still nil? Can't perform this transition
+                if jira_info.build_complete_transition_id.nil?
+                    puts "Could no update issue #{issue_key}: could not find transition"
+                    next
+                end
+                
+                params = {
+                    transition: {
+                        id: jira_info.build_complete_transition_id
+                    },
+                    fields: {
+                        jira_info.fixed_in_build_field_id => build
+                    }
+                }
+                transition_url = File.join(jira_url, issue_key, 'transitions')
+                
+                puts "Updating issue #{issue_key}"
+                begin
+                    issue_response = RestClient.post(transition_url, JSON.generate(params), headers=headers)
+                rescue RestClient::Exception => e
+                    puts "Error updating issue #{issue_key}: Error code #{e.response.code}"
+                end
+            end
+        end
+
+        def self.pull_travis_options(options)
+            puts "Pulling parameters from Travis-CI environment variables where needed...."
+            options.commit_range = ENV["TRAVIS_COMMIT_RANGE"] if options.commit_range == nil
+            options.build = ENV["TRAVIS_BUILD_NUMBER"] if options.build == nil
+        end
+
+        def self.pull_team_city_options(options)
+            puts "Pulling parameters from TeamCity environment variables where needed...."
+            options.commit_range = ENV["TEAMCITY_COMMIT_RANGE"] if options.commit_range == nil
+            options.build = ENV["BUILD_NUMBER"] if options.build == nil
+        end
+
+        def self.pull_common_options(options)
+            options.site = ENV["JIRA_URL"] if options.site == nil
+            options.username = ENV["JIRA_USERNAME"] if options.username == nil
+            options.password = ENV["JIRA_PASSWORD"] if options.password == nil
+        end
+
+        def self.validate_options(options)
+            valid_options = true
+            if options.commit_range == nil 
+                puts "Commit range is required. None specified."
+                puts "You can specify this in TeamCity by running 'teamcity_git_range_fetch.rb' before this step." if ENV["TEAMCITY_VERSION"]
+                valid_options = false
+            end
+            if options.site == nil
+                puts "Site parameter is required, or use JIRA_URL environment variable on build servers"
+                valid_options = false
+            end
+            if options.username == nil
+                puts "No username for JIRA provided. Use JIRA_USERNAME environment variable on build servers"
+                valid_options = false
+            end
+            if options.password == nil
+                puts "No password for JIRA provided. Use JIRA_PASSWORD environment variable on build servers"
+                valid_options = false
+            end
+
+            valid_options
+        end
+
+        def self.perform_jira_update(options = nil)
+            options = Options.new if options == nil
+            if ENV["TRAVIS"]
+                pull_travis_options(options)
+            # Detect running on TeamCity for common prarams 
+            elsif ENV["TEAMCITY_VERSION"]
+                pull_team_city_options(options)
+            end
+            pull_common_options(options)
+
+            if validate_options(options)    
+                logs = get_git_history(options.commit_range)
+                issue_set = find_jira_issues(logs)
+                
+                jira_info = JiraInfo.new options.site, options.username, options.password 
+                jira_update(jira_info, issue_set, options.build)
+            end
+        end
+    end
+end
+
+if __FILE__ == $0
+    options = WTBuildHelpers::Jira::Parser.parse(ARGV)
+    WTBuildHelpers::Jira.perform_jira_update(options)
+end

data/lib/teamcity_git_range_fetch.rb

@@ -0,0 +1,40 @@
+#! /usr/bin/env ruby
+
+require 'base64'
+require 'json'
+require 'rest_client'
+require 'pp'
+
+module WTBuildHelpers
+	module TeamCity
+		def self.fetch_commit_range(teamcity_url, build_type_id, username, password)
+
+			auth_token = Base64.encode64("#{username}:#{password}")
+		    headers = { "Authorization" => "Basic #{auth_token}",
+		    			"Accept" => "application/json" 
+		    		  }
+
+		    full_url = "#{teamcity_url}/app/rest/buildTypes/id:#{build_type_id}/builds/status:SUCCESS"
+
+		    response = RestClient.get(full_url, headers=headers)
+		    json_response = JSON.parse(response.body)
+		    
+		    start_revision = ENV["BUILD_VCS_NUMBER"]
+		    end_revision = json_response["revisions"]["revision"][0]["version"]
+		    
+		    puts "##teamcity[setParameter name='env.TEAMCITY_COMMIT_RANGE' value='#{start_revision}..#{end_revision}']" 
+		end
+	end
+end
+
+if __FILE__ == $0
+	if ARGV.length < 4
+		puts "Usage: teamcity_git_range_fetch.rb [TeamCity Url] [TeamCity Build Type Id] [TeamCity User Name] [TeamCity Password]"
+		puts "These parameters can be passed from TeamCity with the following line: "
+		puts "    teamcity_git_range_fetch.rb \"%teamcity.serverUrl%\" \"%system.teamcity.buildType.id%\" \"%system.teamcity.auth.userId%\" \"%system.teamcity.auth.password%\""
+		
+		exit
+	end
+
+	WTBuildHelpers::TeamCity.fetch_commit_range(ARGV[0], ARGV[1], ARGV[2], ARGV[3])
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: WTBuildHelpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- WillowTreeApps
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: OptionParser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- jeff.ward@willowtreeapps.com
+executables:
+- wtbuild_jira_update
+- wtbuild_teamcity_fetch_git_range
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- WTBuildHelpers.gemspec
+- bin/console
+- bin/setup
+- exe/wtbuild_jira_update
+- exe/wtbuild_teamcity_fetch_git_range
+- lib/WTBuildHelpers.rb
+- lib/WTBuildHelpers/version.rb
+- lib/jira_tasks.rb
+- lib/teamcity_git_range_fetch.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Helpers for performing common WillowTree build tasks and integrations
+test_files: []