github_informer 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bede0acb6870c5ba232527f3eed280ea5b5c1c5d
+  data.tar.gz: 6ea2200407bbcfcc44c6986fae3e18337bd1823d
+SHA512:
+  metadata.gz: 83e0f5b017e0d649aff7cd433ff76fd990618766c444981e6fca2e11741b0372a97fc3461188da768b64e10cacaa1dc5328c8a3123656231fc683af971ad8507
+  data.tar.gz: b93dc24ee431518428ff7c3ffe89c58284127a3eaa97400c2fa89b08affec3dbad5e73552815d894e3299195e6b2f49c7cb9fc3ed5e792e741e4caf29204cbcb

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 BBC
+
+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,51 @@
+# github_informer
+
+Gem for submitting useful metadata to github to inform pull requests
+
+## Submitting CI information
+
+GithubInformer lets you wrap execution of your test or build scripts with github
+hooks to let you add CI status check information to your commits. These status
+checks appear alongside your pull request discussion in github and help with the
+conversation.
+
+### Using the CLI
+
+The CLI is the easiest method of capturing your status checks. Simply install
+the gem and wrap your ci commands like this example:
+
+    gh_execute --cmd 'bundle exec rspec'
+
+You can add a context to the execution so it's more identifiable in github:
+
+    gh_execute --context 'Rspec tests' --cmd 'bundle exec rspec'
+
+There are numerous optional arguments for more control:
+
+    gh_execute --cmd 'bundle exec rspec'
+              [--context <CONTEXT>]
+              [--path <PATH_TO_CHECKOUT>]
+              [--url <URL_LINK_TO_CI_JOB>]
+
+If you're running in jenkins, url will automatically get picked up by the
+environment.
+
+### Using the API
+
+You can have much more control over the messages that get reported into github
+if you write a ruby script to wrap your execution. For example, the following
+script gives comprehensive failure messages:
+
+    # Create new informer
+    g = GithubInformer.new(:context => 'HiveCI', :url => ENV['HIVE_JOB_URL'] )
+
+    # Add a pending status check to github
+    g.report_start( :description => 'Executing unit tests in Hive environment')
+
+    # Wrap execution of the script
+    g.execute( 'bundle exec rake unittests' )
+
+    # Report a different message depending on the exit value of the script
+    g.report_end( 0      => [:pass, 'Unit tests were fine: good to merge'],
+                  1      => [:pending, 'Tests are re-running. Hold off merge.'],
+                  2..200 => [:fail, 'Unit test failure. Do not merge'] )

data/bin/gh_execute

@@ -0,0 +1,60 @@
+#! /usr/bin/env ruby
+
+require 'optparse'
+require 'ostruct'
+require 'github_informer'
+
+class CLIParser
+
+  #
+  # Return a structure describing the options.
+  #
+  def self.parse(args)
+    
+    # Default values
+    options = OpenStruct.new
+    options.context = 'Custom Check'
+    options.path = '.'
+    options.url  = ENV['BUILD_URL'] #Chances are this is running in jenkins
+
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = "Usage: ghi_execute [options]"
+
+      opts.on("-c", "--context NAME",
+              "Name to identify this check.") do |name|
+        options.context = name
+      end
+      
+      opts.on("-p", "--path PATH",
+              "Path to the cloned github repo") do |path|
+        options.path = path
+      end
+ 
+       opts.on("-c", "--cmd COMMAND",
+              "The command to run") do |cmd|
+        options.cmd = cmd
+      end
+      
+       opts.on("-u", "--url URL",
+              "Url to link back to the execution from github") do |path|
+        options.url = url
+      end
+
+    end
+
+    opt_parser.parse!(args)
+    options
+  end 
+end 
+
+options = CLIParser.parse(ARGV)
+
+raise "Must include a cmd to execute ( --cmd 'make' )" if !options.cmd
+
+g = GithubInformer.new(:context => options.context, :url => options.url, :repo => options.path)
+
+g.report_start()
+
+g.execute( options.cmd )
+
+g.report_end()

data/lib/github_informer.rb

@@ -0,0 +1,85 @@
+require 'octokit'
+
+class GithubInformer
+  
+  attr_accessor :params, :repo, :sha, :result
+
+  # Create a new GithubInformer
+  # GithubInformer.new( :context => 'HiveCI',
+  #                     :url => 'http://hive.local',
+  #                     :repo => '/path/to/checkout' )
+  def initialize( args = {} )
+
+    ::Octokit.configure do |c|
+      c.access_token = args[:github_auth] || ENV['GITHUB_AUTH']
+      c.auto_paginate = true
+    end
+
+    @params = {}
+    @params[:context]    = args[:context] or raise "Requires a context"
+    @params[:target_url] = args[:url]
+    
+    path = args[:repo] || '.'
+    @repo = GithubInformer.determine_repo(path)
+    @sha  = GithubInformer.determine_sha(path)
+  end
+
+  # Report start of job to github
+  # ghi.report_start( :description => 'Build job in progress')
+  def report_start( args = {} )
+    Octokit.create_status( repo, sha, 'pending', params.merge(args) )
+  end
+
+  def execute( cmd )
+    system( cmd )
+    @result = $?.exitstatus
+  end
+
+  # Report 
+  # ghi.report_end( 0        => [ :pass, 'Build passed successfully'],
+  #                 1..100   => [ :fail, 'Build had errors' ],
+  #                 :default => [ :error, 'Build totally broken'] )
+  def report_end( args = { 0        => [:pass, 'Good to merge'],
+                           :default => [:fail, 'Do not merge' ] } )
+    if result
+      (status,description) = args[:default] || [ :fail, 'Do not merge' ]
+      hash = args.select { |a| a === result }
+      if !hash.empty?
+        (status, description) = hash.values.flatten
+      end
+      
+      status = GithubInformer.normalise_status(status)
+      Octokit.create_status( repo, sha, status, params.merge( {:description => description} ) )
+    else
+      Octokit.create_status( repo, sha, 'error', params.merge( {:description => 'Program never completed'} ) )
+    end
+  end
+
+  # Make sure the statuses are what the github api expect
+  def self.normalise_status(status)
+    case
+    when status.to_s.match(/fail/)
+      'failure'
+    when status.to_s.match(/pass/)
+      'success'
+    else
+      status.to_s
+    end
+  end
+
+
+  def self.determine_repo(path)
+    output = `cd #{path} && git remote -v | grep github`
+    res = output.match(/github.com:(.*\/.*).git/)
+    repo = res.captures.first
+    raise "Couldn't determine repo" if !repo
+    repo
+  end
+
+  def self.determine_sha(path)
+    sha = `cd #{path} && git rev-parse HEAD`.strip
+    raise "Couldn't determine sha" if !sha || sha.length == 0
+    sha
+  end
+
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: github_informer
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- BBC
+- David Buckhurst
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Publish CI results to Github
+email: david.buckhurst@bbc.co.uk
+executables:
+- gh_execute
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/gh_execute
+- lib/github_informer.rb
+homepage: https://github.com/bbc/github_informer
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Github Informer
+test_files: []
+has_rdoc: