greenscreen 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+/Gemfile.lock
+/config.yml
+/pkg

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "rake"

data/README.md

@@ -0,0 +1,30 @@
+GreenScreen
+===========
+
+GreenScreen is a build monitoring tool that is designed to be used as a dynamic Big Visible Chart (BVC) in your work area.  It lets you add links to your build servers and displays the largest possible information on a monitor so that the team can see the build status from anywhere in the room.
+
+Getting Started
+---------------
+
+GreenScreen can be used to monitor jobs on any build server that publishes a information in "CruiseControl Multiple Project Summary Reporting Standard" format:
+
+  http://confluence.public.thoughtworks.org/display/CI/Multiple+Project+Summary+Reporting+Standard
+
+This includes Jenkins/Hudson, as well as all variants of CruiseControl.
+
+Create a "greenscreen.yml" file, to tell GreenScreen which servers you want to monitor:
+
+    # all jobs from the local Jenkins server
+    sources:
+      -
+        url: http://localhost:8080/cc.xml
+
+Now, start GreenScreen with
+
+     greenscreen -c greenscreen.yml
+
+This start a web-server listening on (by default) port 3000.  Point your browser at http://localhost:3000 to see thestatus of all of your builds.  The screen will refresh every 15 seconds to keep itself up to date.
+
+NOTE: GreenScreen is set up so that the name of the project will flash when it is building, but neither Safari nor IE support blinking text.  You probably want to use Firefox to get the most value out of it.
+
+If running on Windows, I'd suggest running Firefox in full screen mode.  If on a Mac, either expand the window size to take up as much space as possible, or try finding a plugin that lets you go full screen.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+Bundler.setup

data/bin/greenscreen

@@ -0,0 +1,32 @@
+#! /usr/bin/env ruby
+
+require 'clamp'
+require 'hashie'
+require 'greenscreen/app'
+
+class GreenScreenCommand < Clamp::Command
+
+  option ["-c", "--config"], "FILE", "config file", :attribute_name => :config_file, :default => "~/.greenscreen.yml"
+
+  option ["-p", "--port"], "PORT", "server port", :default => 3000 do |v|
+    Integer(v)
+  end
+
+  def default_config_file
+    ENV["HOME"] + "/.greenscreen.yml"
+  end
+
+  def load_config
+    @config ||= begin
+      signal_usage_error("no such file: #{config_file.inspect}") unless File.exist?(config_file)
+      Hashie::Mash.new(YAML.load_file(config_file))
+    end
+  end
+
+  def execute
+    GreenScreen::App.run!(:port => port, :config => load_config)
+  end
+
+end
+
+GreenScreenCommand.run

data/greenscreen.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "greenscreen/version"
+
+Gem::Specification.new do |s|
+
+  s.name        = "greenscreen"
+  s.version     = GreenScreen::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Marty Andrews", "Mike Williams"]
+  s.email       = ["marty@cogentconsulting.com.au", "mike@cogentconsulting.com.au"]
+  s.homepage    = ""
+  s.summary     = "Makes the status of your builds highly visible"
+  s.description = <<EOT
+GreenScreen is a build monitoring tool that is designed to be used as a dynamic Big Visible Chart (BVC) in your work area.  It displays the status of builds from one or more build servers on a monitor, so that the team can see the status from anywhere in the room.
+EOT
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "sinatra", "~> 1.2.0"
+  s.add_runtime_dependency "thin"
+  s.add_runtime_dependency "clamp", "~> 0.2.3"
+  s.add_runtime_dependency "hashie", ">= 1.2.0"
+
+end

data/lib/greenscreen/app.rb

@@ -0,0 +1,60 @@
+require 'erb'
+require 'hashie'
+require 'open-uri'
+require 'rexml/document'
+require 'sinatra/base'
+require 'yaml'
+
+module GreenScreen
+
+  Job = Struct.new(:name, :url, :activity, :last_run)
+  Run = Struct.new(:label, :time, :status)
+
+  class App < Sinatra::Base
+
+    set :app_file, __FILE__
+    set :server, "thin"
+
+    get '/' do
+
+      @auto_refresh_period = 15
+
+      @jobs = settings.config.sources.map do |source|
+        load_source(source)
+      end.flatten
+
+      erb :index
+
+    end
+
+    private
+
+    def load_source(source)
+      jobs = load_cc_xml(source.url)
+      if included_jobs = source.jobs
+        jobs = jobs.select { |j| included_jobs.member?(j.name) }
+      end
+      jobs
+    rescue => e
+      $stderr.puts "ERROR loading #{source.url.inspect}: #{e}"
+    end
+
+    def load_cc_xml(url)
+      xml = REXML::Document.new(open(url))
+      xml.elements["//Projects"].map do |project_element|
+        data = project_element.attributes
+        Job.new.tap do |job|
+          job.name = data["name"]
+          job.url = data["webUrl"]
+          job.activity = data["activity"]
+          job.last_run = Run.new.tap do |run|
+            run.label = data["lastBuildLabel"]
+            run.time = Time.parse(data["lastBuildTime"]).localtime
+            run.status = data["lastBuildStatus"]
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/greenscreen/public/styles.css

@@ -0,0 +1,65 @@
+body {
+  text-align: center;
+  margin: 0;
+  font-family: "Times New Roman", "Serif";
+}
+
+div {
+  margin: 0;
+  padding: 0;
+}
+
+h1 {
+  font-size: 96px;
+  font-family: "Helvetica Neue", Helvetica, Arial, "Sans Serif";
+  margin: 0;
+}
+
+p {
+  font-size: 120%;
+}
+
+a {
+  text-decoration: none;
+  color: inherit;
+}
+
+.clear {
+  border: none;
+  clear: both;
+}
+
+.build {
+  overflow: hidden;
+}
+
+.build .border {
+  height: 100%;
+  border: black 1px solid;
+  display: table;
+  width: 100%;
+}
+
+.build .content {
+  display: table-cell;
+  vertical-align: middle;
+}
+
+.success {
+  background-color: #669933;
+  color: #F2F2F2;
+}
+
+.failure {
+  background-color: #E83454;
+  color: #F2F2F2;
+}
+
+.unknown {
+  background-color: #999999;
+}
+
+.building h1 {
+  text-decoration: blink;
+  font-style: italic;
+}

data/lib/greenscreen/version.rb

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

data/lib/greenscreen/views/index.erb

@@ -0,0 +1,31 @@
+<html>
+  <head>
+    <title>Green Screen - Monitor Your Builds</title>
+    <% if @auto_refresh_period %>
+      <meta http-equiv="refresh" content="<%= @auto_refresh_period %>" />
+    <% end %>
+    <link rel='stylesheet' href='/styles.css' type='text/css' media="screen">
+    <% unless @jobs.empty? %>
+    <style type="text/css">
+      .build {
+        height: <%= 100.0 / @jobs.size %>%;
+      }
+    </style>
+    <% end %>
+  </head>
+  <body>
+    <% @jobs.each do |job| %>
+      <div class="build <%= job.last_run.status %> <%= job.activity %>">
+        <div class="border">
+          <div class="content">
+            <h1><a href="<%= job.url %>"><%= job.name %></a></h1>
+            <p>
+              Build <strong><%= job.last_run.label %></strong>
+              <%= job.last_run.time.strftime("@ %R on %a, %e %b") %>
+            </p>
+          </div>
+        </div>
+      </div>
+    <% end %>
+  </body>
+</html>

data/sample/greenscreen-test.yml

@@ -0,0 +1,3 @@
+sources:
+  -
+    url: sample/test-cc.xml

data/sample/greenscreen.yml

@@ -0,0 +1,13 @@
+# build-servers to monitor
+sources:
+
+  # all jobs from the local Jenkins server
+  -
+    url: http://localhost:8080/cc.xml
+
+  # specific jobs from another server
+  -
+    url: http://another.build.server:8080/cc.xml
+    jobs:
+      - roodi
+      - runway

data/sample/test-cc.xml

@@ -0,0 +1 @@
+<Projects><Project webUrl="http://jenkins.example.com/job/one/" name="one" lastBuildLabel="108" lastBuildTime="2011-09-28T07:15:16Z" lastBuildStatus="Success" activity="Sleeping"/><Project webUrl="http://jenkins.example.com/job/two/" name="two" lastBuildLabel="666" lastBuildTime="2011-02-15T09:00:13Z" lastBuildStatus="Failure" activity="Sleeping"/><Project webUrl="http://jenkins.example.com/job/three/" name="three" lastBuildLabel="666" lastBuildTime="2011-02-15T09:00:13Z" lastBuildStatus="Failure" activity="Building"/></Projects>

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: greenscreen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Marty Andrews
+- Mike Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70167918720160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70167918720160
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: &70167918719180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70167918719180
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: &70167918718040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70167918718040
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70167918716440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70167918716440
+description: ! 'GreenScreen is a build monitoring tool that is designed to be used
+  as a dynamic Big Visible Chart (BVC) in your work area.  It displays the status
+  of builds from one or more build servers on a monitor, so that the team can see
+  the status from anywhere in the room.
+
+'
+email:
+- marty@cogentconsulting.com.au
+- mike@cogentconsulting.com.au
+executables:
+- greenscreen
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/greenscreen
+- greenscreen.gemspec
+- lib/greenscreen/app.rb
+- lib/greenscreen/public/styles.css
+- lib/greenscreen/version.rb
+- lib/greenscreen/views/index.erb
+- sample/greenscreen-test.yml
+- sample/greenscreen.yml
+- sample/test-cc.xml
+homepage: ''
+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: 2565789720247557591
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2565789720247557591
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Makes the status of your builds highly visible
+test_files: []