jenkins-status-tool 0.0.4

data/README.markdown

@@ -0,0 +1,121 @@
+## The Jenkins Status Tool
+Small tool to get the build status from Jenkins.
+Useful for embedding Jenkins CI status images on your Github project.
+
+
+## API
+<table border=1>
+	<thead align=left>
+		<th>Method</th>
+		<th>Action</th>
+		<th>Info</th>
+		<th>Examples</th>
+	</thead>
+	<tbody>
+		<tr>
+			<td align=center><b>GET</b></td>
+			<td>/project/:project_id/status.json</td>
+			<td>Get project status json string</td>
+			<td>
+				{"status":"pass"}<br/>
+				{"status":"fail"}<br/>
+				{"status":"unknown"}
+			</td>
+			
+		</tr>
+
+			<tr>
+				<td align=center><b>GET</b></td>
+				<td>/project/:project_id/status.png</td>
+				<td>Get project status image</td>
+				<td>
+					<img src="https://github.com/kontera-technologies/jenkins-status-tool/raw/master/public/images/pass.png"><br/>
+					<img src="https://github.com/kontera-technologies/jenkins-status-tool/raw/master/public/images/fail.png"><br/>
+					<img src="https://github.com/kontera-technologies/jenkins-status-tool/raw/master/public/images/unknown.png">					
+				</td>
+			</tr>
+			
+			<tr>
+				<td align=center><b>GET</b></td>
+				<td>/project/:project_id/rcov.png</td>
+				<td>Get project rcov graph image</td>
+				<td>
+					<img src="https://github.com/kontera-technologies/jenkins-status-tool/raw/master/readme-files/rcov.png"><br/>
+				</td>
+				
+			</tr>
+			
+
+		</tbody>
+</table>
+
+
+## Installation 
+currently available only via source
+
+```bash
+[root@far-far-away] git clone git@github.com:kontera-technologies/jenkins-status-tool.git
+[root@far-far-away] bundle install
+[root@far-far-away] bundle exec rake install
+```
+
+## Usage
+after installing the gem, the `jenkins-status-tool` command should be available
+
+```bash
+[root@far-far-away] jenkins-status-tool --help
+
+The Jenkins Status Tool
+Usage: jenkins-status-tool [options]
+
+Options:
+    -j, --jenkins URL                Jenkins url, e.g http://jenkins:8080, default is localhost
+    -p, --port URL                   listening port, default is 7676
+    -d, --daemonize                  run in background
+    -P, --pid-file FILE              pid file, default /var/run/jenkins-status-tool.pid
+    -s, --https                      use this if running behind https forwarder (e.g stunnel)
+
+More Info:
+https://github.com/kontera-technologies/jenkins-status-tool
+
+```
+
+## Example
+lets say that our Jenkins server is running on ```jenkins-server:1234```
+
+```
+[root@far-far-away] jenkins-status-tool --jenkins jenkins-server:1234 --port 5555 --daemonize
+[root@far-far-away] curl http://localhost:5555/project/my-project/status.json
+{"status":"pass"}
+[root@far-far-away] wget http://localhost:5555/project/my-project/status.png
+[...SHOULD DOWNLOAD ONE OF THE IMAGES ABOVE...]
+``` 
+
+## Embed it
+you can easily embed the current status of your builds in any html type document.
+
+TextLite
+
+```bash
+"!https://jenkins-status-tool-url/projects/PROJECT-NAME/status.png!":http://jenkins.example.com/jobs/PROJET-NAME
+```
+
+RDoc
+
+```bash
+{<img src="https://jenkins-status-tool-url/projects/PROJECT-NAME/status.png" />}[http://jenkins.example.com/jobs/PROJET-NAME]
+```
+
+MarkDown
+
+```bash
+[![Build Status](https://jenkins-status-tool-url/projects/PROJECT-NAME/status.png)](http://jenkins.example.com/jobs/PROJET-NAME)
+```
+
+>
+> **The tunnel...** 
+> We used STunnel to route jenkins-status-tool-url:443 <=> jenkins-status-tool-url:5555
+> This allow us to fetch the status images using https.
+
+## Credits
+* Status images by [travis-ci](https://github.com/travis-ci/travis-ci)

data/Rakefile

@@ -0,0 +1,5 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+require 'jenkins-status-tool'
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/jenkins-status-tool

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+$:.unshift File.join(File.dirname(__FILE__), '..','lib')
+
+# loading app
+require 'jenkins-status-tool'
+
+# starting sinatra app
+JenkinsStatusTool::Runner.new(ARGV).run!
+
+# w/o any stupid exit handlers
+Process.exit!

data/lib/jenkins-status-tool.rb

@@ -0,0 +1,16 @@
+module JenkinsStatusTool
+  ROOT = File.expand_path File.dirname __FILE__
+  
+  autoload :Version,        "#{ROOT}/jenkins-status-tool/version"
+  autoload :WebApp,         "#{ROOT}/jenkins-status-tool/webapp"
+  autoload :Runner,         "#{ROOT}/jenkins-status-tool/runner"
+  autoload :Config,         "#{ROOT}/jenkins-status-tool/config"
+  autoload :Utils,          "#{ROOT}/jenkins-status-tool/utils"
+  autoload :JenkinsBroker,  "#{ROOT}/jenkins-status-tool/jenkins-broker"
+  autoload :JenkinsProject, "#{ROOT}/jenkins-status-tool/jenkins-project"
+  
+  def self.version
+    Version::VERSION
+  end
+  
+end

data/lib/jenkins-status-tool/config.rb

@@ -0,0 +1,22 @@
+require 'ostruct'
+require 'singleton'
+
+module JenkinsStatusTool
+  class Config < OpenStruct
+    include Singleton
+    
+    def initialize
+      super
+      self.port    = 7676
+      self.jenkins = "localhost:8080"
+      self.pid     = '/var/run/jenkins-status-tool.pid'
+      self.root    = File.expand_path File.join(JenkinsStatusTool::ROOT, "..")
+      self.https   = false
+    end
+    
+    def https?
+      self.https
+    end
+    
+  end
+end

data/lib/jenkins-status-tool/jenkins-broker.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'open-uri'
+require 'singleton'
+require 'json'
+
+module JenkinsStatusTool
+  class JenkinsBroker
+    include Singleton
+    
+    def project_info project
+      json["jobs"].select {|o| o["name"] == project}.first rescue Hash.new
+    end
+    
+    def project_rcov_graph project
+      open("http://#{Config.instance.jenkins}/job/#{project}/rcov/graph").read rescue nil
+    end
+    
+    private
+    def json
+      JSON.parse open("http://#{Config.instance.jenkins}/api/json").read
+    end
+    
+  end
+end

data/lib/jenkins-status-tool/jenkins-project.rb

@@ -0,0 +1,36 @@
+require 'ostruct'
+
+module JenkinsStatusTool
+  class JenkinsProject < OpenStruct
+
+    def initialize hash
+      super
+      self.project = hash.fetch :project
+      self.jenkins = JenkinsBroker::instance
+    end
+    
+    def status
+      case color
+      when :red     then :fail
+      when :blue    then :pass
+      when :gray    then :inactive
+      else :unknown
+      end
+    end
+
+    def color
+      data["color"].to_sym
+    end
+    
+    def rcov_image
+      jenkins.project_rcov_graph project
+    end
+    
+    private
+    
+    def data
+      jenkins.project_info project
+    end
+    
+  end
+end

data/lib/jenkins-status-tool/runner.rb

@@ -0,0 +1,67 @@
+require 'optparse'
+
+module JenkinsStatusTool
+  class Runner
+
+    def initialize(argv)
+      parser.parse! argv
+    end
+    
+    def run!
+      config.daemonize ? daemonize! : WebApp.run!
+    end
+    
+    private
+    def daemonize!
+      fork do
+        Process.setsid
+        exit if fork
+        Dir.chdir('/tmp')
+        STDOUT.reopen('/dev/null','a')
+        STDIN.reopen('/dev/null')
+        STDERR.reopen('/dev/null','a')
+        File.open(options.pid, 'w') { |f| f.write Process.pid } rescue nil
+        WebApp.run!
+      end
+    end
+        
+    def parser
+      OptionParser.new do |opts|
+        opts.banner = "The Jenkins Status Tool"
+        opts.define_head "Usage: jenkins-status-tool [options]"
+        opts.separator ""
+        opts.separator "Options:"
+        
+        opts.on('-j', '--jenkins URL', 'Jenkins url, e.g http://jenkins:8080, default is localhost') do |url|
+          config.jenkins = url
+        end
+        
+        opts.on('-p', '--port URL', 'listening port, default is 7676') do |port|
+          config.port = port
+        end
+        
+        opts.on("-d", "--daemonize","run in background") do
+          config.daemonize = true
+        end
+        
+        opts.on("-P", "--pid-file FILE","pid file, default /var/run/jenkins-status-tool.pid") do |file|
+          config.pid = file
+        end
+        
+        opts.on('-s', '--https', 'add this switch if you are running behind https forwarder (e.g stunnel)') do
+          config.https = true
+        end
+        
+        opts.separator ""
+        opts.separator "More Info:"
+        opts.separator "https://github.com/kontera-technologies/jenkins-status-tool"
+        opts.separator ""
+      end
+    end
+    
+    def config
+      Config.instance
+    end
+    
+  end
+end

data/lib/jenkins-status-tool/utils.rb

@@ -0,0 +1,17 @@
+require 'singleton'
+
+module JenkinsStatusTool
+  module Utils
+
+    class Singleton
+      include Object::Singleton
+      
+      def self.method_missing(m,*a,&b)
+        instance.send(m,*a,&b)
+      end
+      
+    end
+    
+  end
+end
+

data/lib/jenkins-status-tool/version.rb

@@ -0,0 +1,5 @@
+module JenkinsStatusTool
+  class Version
+    VERSION = "0.0.4"
+  end
+end

data/lib/jenkins-status-tool/webapp.rb

@@ -0,0 +1,61 @@
+require 'sinatra/base'
+
+module JenkinsStatusTool
+  class WebApp < Sinatra::Base
+        
+    set :root, Config::instance.root
+    set :port, Config::instance.port
+    
+    get "/" do
+      erb :index
+    end
+    
+    get "/project/:project/status.?:format?" do
+      case format
+      when :png  then
+         redirect "/images/#{project.status}.png"
+      when :json then
+         {:status => project.status }.to_json
+      end
+    end
+    
+    get "/project/:project/rcov.?:format?" do
+      case format
+      when :png then
+        content_type 'image/jpeg'
+        project.rcov_image or redirect "/images/rcov-no-data.png"
+      end
+    end
+    
+    protected
+    
+    def redirect path
+      if config.https? and relative? path
+        super ["https://",request.host,path].join
+      else
+        super path
+      end
+    end
+    
+    def relative? path
+      path !~ /http(s*)?:\/\//i
+    end
+    
+    def format
+      symbolize_params.fetch(:format).to_sym
+    end
+    
+    def symbolize_params
+      @_params ||= Hash[params.map {|a| [a[0].to_sym,a[1]]}]
+    end
+    
+    def project
+      @project ||= JenkinsProject.new symbolize_params
+    end
+        
+    def config 
+      self.class.config
+    end
+    
+  end
+end

data/tasks/build.rake

@@ -0,0 +1,44 @@
+require 'rubygems/package_task'
+
+JenkinsStatusTool::GemSpec = Gem::Specification.new do |s|
+  s.name                  = "jenkins-status-tool"
+  s.version               = JenkinsStatusTool.version
+  s.platform              = Gem::Platform::RUBY
+  s.summary               = "JenkinsStatusTool"
+  s.description           = "JenkinsStatusTool - get jenkins status"
+  s.author                = "Eran Barak Levi"
+  s.email                 = 'eran@kontera.com'
+  s.homepage              = 'http://www.kontera.com'
+  s.executables           = %w(jenkins-status-tool)
+  s.required_ruby_version = '>= 1.8.7'
+  s.rubyforge_project     = "jenkins-status-tool"
+  s.files                 = %w(README.markdown Rakefile) + Dir.glob("{bin,lib,test,tasks,public,views}/**/*")
+  s.require_path          = "lib"
+  s.bindir                = "bin"
+
+  s.add_dependency 'sinatra'
+  s.add_dependency 'json'
+end
+
+task :gem => [:clobber_package]
+Gem::PackageTask.new(JenkinsStatusTool::GemSpec) do |p|
+  p.gem_spec = JenkinsStatusTool::GemSpec
+end
+
+task :install => [:gem] do
+   sh "gem install pkg/jenkins-status-tool"
+   Rake::Task['clobber_package'].execute
+end
+
+namespace :gem do
+  desc "Upload jenkins-status-tool to Kontera's repo"
+  task :upload => [:build] do
+    sh "gem inabox --host http://gems.kontera.com pkg/jenkins-status-tool-#{JenkinsStatusTool.version}.gem"
+  end
+  
+  desc "Update GraphiteAPI gem version and build gem"
+  task :build => [:test] do
+    sh "rake gem"
+  end 
+  
+end

data/tasks/tests.rake

@@ -0,0 +1,5 @@
+task :test do
+  #
+end
+
+task :default => [:test]

data/views/index.erb

@@ -0,0 +1,46 @@
+<h2> Jenkins Status Tool API</h2></br>
+
+<table border=1>
+	<thead align=left>
+		<th>Method</th>
+		<th>Action</th>
+		<th>Info</th>
+		<th>Examples</th>
+	</thead>
+	<tbody>
+		<tr>
+			<td align=center><b>GET</b></td>
+			<td>/project/:project_id/status.json</td>
+			<td>Get project status json string</td>
+			<td>
+				{"status":"pass"}<br/>
+				{"status":"fail"}<br/>
+				{"status":"unknown"}
+			</td>
+			
+		</tr>
+
+			<tr>
+				<td align=center><b>GET</b></td>
+				<td>/project/:project_id/status.png</td>
+				<td>Get project status image</td>
+				<td>
+					<img src="/images/pass.png"><br/>
+					<img src="/images/fail.png"><br/>
+					<img src="/images/unknown.png">
+				</td>
+			</tr>
+			
+			<tr>
+				<td align=center><b>GET</b></td>
+				<td>/project/:project_id/rcov.png</td>
+				<td>Get project rcov graph image</td>
+				<td>
+					<img src="/images/rcov-example.png"><br/>
+				</td>
+				
+			</tr>
+			
+
+		</tbody>
+</table>

data/views/layout.erb

@@ -0,0 +1,24 @@
+<html>
+
+ <head>
+   <style>
+     body { background-color: #fff; color: #333; }
+     body, p, ol, ul, td {
+       font-family: verdana, arial, helvetica, sans-serif;
+       font-size:   16px;
+       line-height: 18px;
+     }
+     a { color: #000; }
+     a:visited { color: #666; }
+     a:hover { color: #fff; background-color:#000; }
+   </style>
+		
+	<title>The Jenkins Status Tool</title>
+ </head>
+
+ <body>
+  <div class = "container">
+     <%= yield %>
+   </div>
+ </body>
+</html>

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: jenkins-status-tool
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Eran Barak Levi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70325820167340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70325820167340
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70325820166820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70325820166820
+description: JenkinsStatusTool - get jenkins status
+email: eran@kontera.com
+executables:
+- jenkins-status-tool
+extensions: []
+extra_rdoc_files: []
+files:
+- README.markdown
+- Rakefile
+- bin/jenkins-status-tool
+- lib/jenkins-status-tool/config.rb
+- lib/jenkins-status-tool/jenkins-broker.rb
+- lib/jenkins-status-tool/jenkins-project.rb
+- lib/jenkins-status-tool/runner.rb
+- lib/jenkins-status-tool/utils.rb
+- lib/jenkins-status-tool/version.rb
+- lib/jenkins-status-tool/webapp.rb
+- lib/jenkins-status-tool.rb
+- tasks/build.rake
+- tasks/tests.rake
+- public/images/fail.png
+- public/images/inactive.png
+- public/images/pass.png
+- public/images/rcov-example.png
+- public/images/rcov-no-data.png
+- public/images/unknown.png
+- views/index.erb
+- views/layout.erb
+homepage: http://www.kontera.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: jenkins-status-tool
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: JenkinsStatusTool
+test_files: []