roxanne 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5d851cce33eec10554348917d888de2850376f4
+  data.tar.gz: 8170b18990fa9ad11befe6a0da395acdf487cda8
+SHA512:
+  metadata.gz: ea7d837226ee30baa49c0efec2b78242803de3190d173abc2b2c1ffc4cf9db4321549dff008e6b9b56fb8f6ee5f10328f2424b73a49d08937ea4c4fa49e0ba86
+  data.tar.gz: cc624af0b25c3717e0a8c4a247d3c18110308e2700c1c2fa538f634311e0d6a39e851db05d19eb2dd2a270fd7c3ffc696c00b75656c352a9d956590390383f36

data/.gitignore

@@ -0,0 +1,5 @@
+Gemfile.lock
+roxanne.log
+roxanne.pid
+.*.swp
+pkg

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+- 1.9.3
+- 2.0.0
+- 2.1.1
+notifications:
+  hipchat:
+    rooms:
+      secure: B+SptkYk6J9+PPJnqzA8S4hce6veT/bHciATE5MEA6fBd4gZQ2YMACgdaPqqzv1TU2Lr725uKFRpMQkE/E5B6oLGBcck7tAzZccKKSLiXyKMxgpyEcw+WC2laGhqqnfzd83iYjQujMy6kwksTknmgLV34HIuMUcyREYovEIxPgA=

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,7 @@
+guard :minitest do
+  # with Minitest::Spec
+  watch(%r{^spec/(.*)_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+  watch(%r{^spec/support/(.*)\.rb$}) { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jef Mathiot
+
+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,131 @@
+# Roxanne
+
+Roxanne allows you to aggregate the status of Continuous Integration jobs or other sources and to
+publish the results on a BigVisibleThing™ (traffic light, lava lamp, whatever).
+
+[![Build Status](https://travis-ci.org/servebox/roxanne.png)](https://travis-ci.org/servebox/roxanne)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'roxanne'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install roxanne
+
+## Usage
+
+### Configuration
+
+Configuration is stored in a YAML file. By default, Roxanne will search for a `config/config.yml`
+file.
+
+#### Activation
+
+Roxanne is configured by default to only be active between 9am and 20pm during working days. You
+may use the `activation` section to change the default behavior:
+
+```yaml
+roxanne:
+  activation:
+    # Active from monday to wednesday
+    days: !ruby/range 1..3
+    # 07:00 to 14:59
+    timerange: !ruby/range 7...15
+```
+
+#### Consumers
+
+Use the `consumers` section to specify consumers configuration:
+
+```yaml
+roxanne:
+ consumers:
+   jenkins:
+     class: "Roxanne::Jenkins::Consumer"
+     host: "192.168.20.30"
+     port: 8080
+     use_ssl: false
+     path: "/api/json"
+```
+
+#### Publisher
+
+Use the `publisher` section to specify consumers configuration:
+
+```yaml
+roxanne:
+ publisher:
+   class: "Roxanne::GPIO::Publisher"
+   green_pin: 25
+   orange_pin: 17
+   red_pin: 27
+```
+
+### Start the daemon
+
+Start the daemon using the `start` command:
+
+```
+bundle exec roxanne start
+```
+
+If you want to specify a configuration file pass its path as the first argument:
+
+```
+bundle exec roxanne start /etc/roxanne/config.yml
+```
+
+Other available commands are obviously `stop`, `status` and `restart`.
+
+### Available Consumers
+
+#### Jenkins
+
+Use the `Roxanne::Jenkins::Consumer` class. Available options:
+
+* **host**: the Jenkins host name or IP address
+* **port**: the TCP port the Jenkins service can be reached on
+* **path**: the relative path to the JSON API (`/jenkins/api/json`)
+* **username**: the username to use for HTTP Basic Auth
+* **password**: the password to use for HTTP Basic Auth
+* **disable_certificate_verification** : set to true if you use a self-signed SSL certificate
+
+#### Travis CI
+
+Use the `Roxanne::Travis::Consumer` class. Available options:
+
+* **organization_or_user**: the Github organization or user to pull build states from
+
+### Available Publishers
+
+#### GPIO
+
+Use the `Roxanne::GPIO::Consumer` class. Available options:
+
+* **green_pin**: the GPIO pin to turn on when status changes to green
+* **orange_pin**: the GPIO pin to turn on when status changes to orange
+* **red_pin**: the GPIO pin to turn on when status changes to red
+
+## Statuses
+
+Every 5 seconds, Roxanne will loop to check the status of the consumers:
+
+* if any of the consumers returns `red` the publisher receive `red`
+* if all of the consumers return `green` the publisher receive `green`
+* if the previous state **was not** `green` and one of the consumer returns `orange` the publisher
+  receive `orange`
+
+## 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,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => [:test]

data/bin/roxanne

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'roxanne'
+require 'fileutils'
+
+basedir = File.expand_path(File.join( File.dirname(__FILE__) , '..'))
+%w(log pids).each do |dir|
+  dir = File.join(basedir, dir)
+  FileUtils.mkdir_p dir unless File.directory?(dir)
+end
+Roxanne::Server.spawn!(
+	 log_file: File.join(basedir, 'log/roxanne.log'),
+	 pid_file: File.join(basedir, 'pids/roxanne.pid'),
+	 sync_log: true,
+	 working_dir:  basedir
+ )

data/config/config.yml

@@ -0,0 +1,6 @@
+roxanne:
+  consumers:
+    test:
+      class: "Roxanne::Test::Consumer"
+  publisher:
+    class: "Roxanne::Test::Publisher"

data/lib/roxanne/configuration/yaml.rb

@@ -0,0 +1,46 @@
+require 'yaml'
+require 'active_support/core_ext'
+
+module Roxanne
+
+  module Configuration
+
+    class YAML < Base
+
+      def initialize(path)
+        super
+        yaml = ::YAML.load( File.open( path ) ).with_indifferent_access[:roxanne]
+        override_activation(yaml[:activation])
+        build_consumers(yaml[:consumers])
+        build_publisher(yaml[:publisher])
+      end
+
+      private
+      def override_activation(settings)
+        if settings
+          @active_days = settings[:days] if settings.has_key?(:days)
+          @timerange = settings[:timerange] if settings.has_key?(:timerange)
+        end
+      end
+
+      def build_consumers(hash)
+        (hash||{}).each do |id, hash|
+          @consumers << assign_properties( hash.delete(:class).constantize.new, hash )
+        end
+      end
+
+      def build_publisher(hash)
+          @publisher = assign_properties( hash.delete(:class).constantize.new, hash)
+      end
+
+      def assign_properties(object, hash)
+        hash.each do |prop, value|
+          object.send "#{prop}=", value
+        end
+        object
+      end
+      
+    end
+
+  end
+end

data/lib/roxanne/configuration.rb

@@ -0,0 +1,26 @@
+module Roxanne
+  module Configuration
+    class Base
+
+      attr_reader :consumers, :publisher, :active_days, :timerange
+
+      def initialize(*args)
+        @consumers = []
+        @publisher = nil
+        @active_days = 1..5
+        @timerange=8..19
+      end
+
+      def activated
+        will_activate(DateTime.now)
+      end
+
+      private
+      def will_activate( dt )
+        @active_days.include?(dt.wday) && @timerange.cover?(dt.hour)
+      end
+    end
+  end
+end
+
+require 'roxanne/configuration/yaml'

data/lib/roxanne/consumers.rb

@@ -0,0 +1,19 @@
+module Roxanne
+  module Consumers
+    module Priority
+
+      def prioritize(current_status, former_status)
+        [:red, :orange].each do |status|
+          return status if status == former_status
+        end
+        current_status
+      end
+
+    end
+  end
+end
+
+require 'roxanne/jenkins/consumer'
+require 'roxanne/test/consumer'
+require 'roxanne/travis/consumer'
+

data/lib/roxanne/gpio/publisher.rb

@@ -0,0 +1,24 @@
+require 'taopaipai'
+
+module Roxanne
+  module GPIO
+    class Publisher
+      attr_accessor :green_pin, :orange_pin, :red_pin
+
+      def disable
+        [green_pin, orange_pin, red_pin].each do |num|
+          Taopaipai.gpio.pin(num, direction: :out).value 0
+        end
+      end
+
+      def push(previous, status)
+        return disable unless status
+        [:green, :orange, :red].each do |color|
+          Taopaipai.gpio.pin(send("#{color}_pin"), direction: :out).
+            value(color == status ? 1 : 0)
+        end
+      end
+
+    end
+  end
+end

data/lib/roxanne/http/consumer.rb

@@ -0,0 +1,33 @@
+require 'roxanne/http_support'
+
+module Roxanne
+  module HTTP
+    class Consumer
+      include Consumers::Priority
+      include Roxanne::HTTPSupport
+
+      def pull
+        response = fetch_response
+        case response
+        when Net::HTTPSuccess
+          handle_response(response.body)
+        when Net::HTTPRedirection
+          puts "The request has been redirected to #{response['location']}"
+          :red
+        else
+          puts "The request has failed #{response.error}"
+          :red
+        end
+      rescue Exception => e
+        puts "Unable to fetch data : #{e.message}"
+        :red
+      end
+
+      def handle_response(body)
+        puts "Does nothing, HTTP consumer should be overriden."
+        :green
+      end
+      
+    end
+  end
+end

data/lib/roxanne/http_support.rb

@@ -0,0 +1,43 @@
+require 'net/http'
+
+module Roxanne
+  module HTTPSupport
+    attr_accessor :host
+    attr_accessor :use_ssl
+    attr_accessor :disable_certificate_verification
+    attr_accessor :path
+    attr_accessor :port
+    attr_accessor :username
+    attr_accessor :password
+
+    private
+    def fetch_response
+      connection = ::Net::HTTP.new(@host, @port)
+      connection.use_ssl=@use_ssl
+      if @disable_certificate_verification
+        # TODO retrieve the certificate from the remote system, see http://redcorundum.blogspot.com/2008/03/ssl-certificates-and-nethttps.html
+        # Avoid issues with autosigned certificates
+        connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      request = Net::HTTP::Get.new(complete_path, {'Accept'=>accept})
+
+      # TODO Authentication
+      unless (username.nil? && password.nil?)
+        request.basic_auth username, password
+      else
+      end
+      connection.request(request)
+    end
+
+    def complete_path
+      @path
+    end
+
+    # Override if needed to force a particular format : application/json, text/xml, etc
+    protected
+    def accept
+      '*'
+    end
+
+  end
+end

data/lib/roxanne/jenkins/consumer.rb

@@ -0,0 +1,34 @@
+require 'roxanne/http/consumer'
+require 'json'
+
+module Roxanne
+  module Jenkins
+    class Consumer < Roxanne::HTTP::Consumer
+
+      def handle_response(body)
+        json = JSON.parse(body)
+        status = :green
+        json['jobs'].each do |job|
+          if COLORS.keys.include?(job['color'])
+            status = prioritize(to_status(job['color']), status)
+          end
+        end
+        status
+      end
+
+      private
+      COLORS = {
+        'blue'=>:green,
+        'yellow'=>:green,
+        'red'=>:red,
+        'blue_anime'=>:orange,
+        'yellow_anime'=>:orange,
+        'red_anime'=>:orange
+      }
+
+      def to_status(hudson_color)
+        COLORS[hudson_color]
+      end
+    end
+  end
+end

data/lib/roxanne/loop.rb

@@ -0,0 +1,35 @@
+module Roxanne
+  class Loop
+    def initialize(config)
+      @config = config
+    end
+
+    def cycle
+      if @config.activated
+        status = :green
+        @config.consumers.each do |consumer|
+          actual = consumer.pull
+          if actual == :red
+            status = :red
+            break
+          elsif actual == :orange && @previous != :green
+            status = :orange
+          end
+        end
+        publish( @previous, status )
+        @previous = status
+      else
+        @config.publisher.disable
+      end
+    end
+
+    def reset
+      @config.publisher.push(nil, nil)
+    end
+
+    private
+    def publish(previous, current)
+      @config.publisher.push(previous, current)
+    end
+  end
+end

data/lib/roxanne/publishers.rb

@@ -0,0 +1,2 @@
+require 'roxanne/test/publisher'
+require 'roxanne/gpio/publisher'

data/lib/roxanne/server.rb

@@ -0,0 +1,24 @@
+require 'daemon_spawn'
+
+module Roxanne
+  class Server < DaemonSpawn::Base
+
+    def start(args)
+      puts "Roxanne starting in #{self.working_dir}"
+      @controller = Loop.new(config(args))
+      loop do
+        @controller.cycle
+        sleep 5
+      end
+    end
+
+    def stop
+      @controller.reset
+    end
+
+    def config(args)
+      @config ||= Configuration::YAML.new(args.first || 'config/config.yml')
+    end
+
+  end
+end

data/lib/roxanne/test/consumer.rb

@@ -0,0 +1,17 @@
+module Roxanne
+  module Test
+    class Consumer
+      def pull
+        @previous = if @previous.nil?
+          :green
+        elsif @previous == :green
+          :red
+        elsif @previous == :red
+          :orange
+        else
+          :green
+        end
+      end
+    end
+  end
+end

data/lib/roxanne/test/publisher.rb

@@ -0,0 +1,18 @@
+module Roxanne
+  module Test
+    class Publisher
+      def disable
+        puts "Publisher is now disabled"
+      end
+
+      def push(previous, status)
+        puts "Publisher switching from status #{default(previous)} to #{default(status)}"
+      end
+
+      private
+      def default(status)
+        status.nil? ? 'none' : status
+      end
+    end
+  end
+end

data/lib/roxanne/travis/consumer.rb

@@ -0,0 +1,32 @@
+require 'travis'
+
+module Roxanne
+  module Travis
+    class Consumer
+      include Consumers::Priority
+      
+      attr_accessor :organization_or_user
+
+      def pull
+        repos = ::Travis::Repository.find_all(owner_name: organization_or_user)
+        status = :green
+        repos.select{|repo| repo.active? }.each do |repo|
+          status = prioritize(to_status(repo.last_build_state), status)
+        end
+        status
+      end
+
+      private
+      STATES = {
+        'failed' => :red,
+        'started' => :orange,
+        'passed' => :green
+      }
+      
+      def to_status(travis_build_state)
+        STATES[travis_build_state]
+      end
+
+    end
+  end
+end

data/lib/roxanne/version.rb

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

data/lib/roxanne.rb

@@ -0,0 +1,10 @@
+require "roxanne/version"
+
+require 'roxanne/configuration'
+require 'roxanne/loop'
+require 'roxanne/server'
+require 'roxanne/consumers'
+require 'roxanne/publishers'
+
+module Roxanne
+end

data/roxanne.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'roxanne/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "roxanne"
+  spec.version       = Roxanne::VERSION
+  spec.authors       = ["Jef Mathiot", "Patrice Izzo", "Fabrice Nourisson",
+    "Benjamin Severac", "Eric Hartmann"]
+  spec.email         = ["foss@servebox.com"]
+  spec.description   = %q{Roxanne: publish your CI status to your device of choice}
+  spec.summary       = %q{Aggregate the status of Continuous Integration jobs or other sources and
+                       publish them}
+  spec.homepage      = "http://github.com/servebox/roxanne"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency 'json'
+  spec.add_dependency 'daemon-spawn'
+  spec.add_dependency 'activesupport', '>= 3.0.0'
+  spec.add_dependency 'taopaipai', '~> 0.1.1'
+  spec.add_dependency 'travis', '~> 1.6.8'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.0.7"
+  spec.add_development_dependency "minitest-implicit-subject", "~> 1.4.0"
+  spec.add_development_dependency "rb-readline", "~> 0.5.0"
+  spec.add_development_dependency "guard-minitest", "~> 2.1.3"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "mocha"
+end

data/service/etc_init.d_roxanne

@@ -0,0 +1,21 @@
+#! /bin/sh
+
+case "$1" in
+  start)
+        su roxanne -c "bash /var/lib/roxanne/roxanne/service/roxanne.sh start" ; exit	
+	;;
+  stop)
+	su roxanne -c "bash /var/lib/roxanne/roxanne/service/roxanne.sh stop" ; exit
+	;;
+  status)
+        ;;
+  restart|force-reload)
+	su roxanne -c "bash /var/lib/roxanne/roxanne/service/roxanne.sh restart" ; exit
+	;;
+  *)
+	#echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
+	echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2
+	exit 3
+	;;
+esac
+

data/service/roxanne.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+source $HOME/.bash_profile
+eval "$(rbenv init -)"
+cd /var/lib/roxanne/roxanne
+bundle exec ruby lib/roxanne_server.rb $1 config/golgotha.yml