chicanery 0.0.4 → 0.0.5

data/.gitignore

@@ -1,3 +1,4 @@
+repos
 *.gem
 *.rbc
 *.example

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
   - "1.9.2"
-  - "1.9.3"
+  - "1.9.3"
+script: bundle exec rake COVERAGE=true

data/Gemfile

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

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    chicanery (0.0.4)
+    chicanery (0.0.5)
       nokogiri (~> 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.1.3)
+    multi_json (1.3.7)
     nokogiri (1.5.5)
     rake (0.9.2.2)
     rspec (2.11.0)
@@ -18,6 +19,12 @@ GEM
     rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.11.3)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-gem-adapter (1.0.1)
+      simplecov
+    simplecov-html (0.7.1)
 
 PLATFORMS
   ruby
@@ -26,3 +33,5 @@ DEPENDENCIES
   chicanery!
   rake (~> 0)
   rspec (~> 2)
+  simplecov
+  simplecov-gem-adapter

data/README.md

@@ -17,9 +17,23 @@ State is persisted between executions so that it be scheduled to run regularly w
 Create a configuration file.  This file is just a ruby file that can make use of a few configuration and callback methods:
 
     require 'chicanery/cctray'
+    require 'chicanery/git'
 
+    include Chicanery::Git
+
+    git_repo 'chicanery', '/tmp/chicanery', remotes: {
+      github: { url: 'git://github.com/markryall/chicanery.git' }
+    }
     server Chicanery::Cctray.new 'tddium', 'https://cihost.com/cctray.xml'
 
+    when_run do |state|
+      puts 'checked state'
+    end
+
+    when_commit do |repo, commit, previous|
+      puts "commit #{previous}..#{commit} detected in repo #{repo}"
+    end
+
     when_succeeded do |job_name, job|
       puts "#{job_name} has succeeded"
     end
@@ -66,7 +80,6 @@ Basic authentication is supported by passing :user => 'user', :password => 'pass
 
 ## Plans for world domination
 
-* monitoring a git repository for push notifications
 * monitoring a mercurial repository for push notifications
 * monitoring a subversion repository for commit notifications
 * monitoring heroku for deployment event notification

data/bin/chicanery

@@ -4,4 +4,4 @@ $:.unshift File.dirname(__FILE__)+'/../lib'
 
 require 'chicanery'
 extend Chicanery
-execute *ARGV
+execute ARGV

data/chicanery.gemspec

@@ -21,4 +21,6 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rake', '~>0'
   gem.add_development_dependency 'rspec', '~>2'
-end
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'simplecov-gem-adapter'
+end

data/examples/evil.rb

@@ -0,0 +1,24 @@
+require 'chicanery/git'
+
+include Chicanery::Git
+
+git_repo 'chicanery', '.', branches: [:master]
+
+start = Time.now.to_i
+maximum = ARGV.shift.to_i
+
+puts "Uncommitted changes will be automatically reverted after #{maximum} seconds"
+
+when_run do |state|
+  elapsed = Time.now.to_i - start
+  if elapsed >= maximum
+    puts "no commits detected in #{elapsed} seconds - reverting all uncommitted changes"
+    `git reset --hard`
+    start = Time.now.to_i
+  end
+end
+
+when_commit do |branch, commit, previous|
+  puts "commit detected - resetting timer"
+  start = Time.now.to_i
+end

data/examples/github.rb

@@ -0,0 +1,11 @@
+require 'chicanery/git'
+
+include Chicanery::Git
+
+git_repo 'chicanery', '.', branches: [:master], remotes: {
+  github: { url: 'git://github.com/markryall/chicanery.git' }
+}
+
+when_commit do |branch, commit, previous|
+  puts "commit #{previous}..#{commit} detected in #{branch}"
+end

data/examples/travis.rb

@@ -1,26 +1,41 @@
 require 'chicanery/cctray'
+require 'chicanery/git'
+
+include Chicanery::Git
+
+git_repo 'chicanery', '.', remotes: {
+  github: { url: 'git://github.com/markryall/chicanery.git' }
+}
 
 server Chicanery::Cctray.new 'travis', 'https://api.travis-ci.org/repositories/markryall/chicanery/cc.xml'
 
+def growlnotify message
+  `growlnotify -t "some new chicanery ..." --image ~/icons/chicanery.png -m \"#{message}\"`
+end
+
+when_commit do |repo, commit, previous|
+  growlnotify "commit #{previous}..#{commit} detected in repo #{repo}"
+end
+
 when_started do |job_name, job|
-  `afplay ~/build_sounds/startup.mp3`
-  puts "job #{job_name} has started"
+  growlnotify "job #{job_name} has started"
+  `afplay ~/build_sounds/ticktock.mp3`
 end
 
 when_succeeded do |job_name, job|
-  puts "job #{job_name} #{job[:last_label]} has succeeded"
+  growlnotify "job #{job_name} #{job[:last_label]} has succeeded"
 end
 
 when_failed do |job_name, job|
-  puts "job #{job_name} #{job[:last_label]} has failed"
+  growlnotify "job #{job_name} #{job[:last_label]} has failed"
 end
 
 when_broken do |job_name, job|
+  growlnotify "job #{job_name} is broken"
   `afplay ~/build_sounds/ambulance.mp3`
-  puts "job #{job_name} is broken"
 end
 
 when_fixed do |job_name, job|
+  growlnotify "job #{job_name} is fixed"
   `afplay ~/build_sounds/applause.mp3`
-  puts "job #{job_name} is fixed"
 end

data/lib/chicanery.rb

@@ -1,33 +1,48 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  require 'simplecov-gem-adapter'
+  SimpleCov.start 'gem'
+end
+
 require 'chicanery/persistence'
-require 'chicanery/servers'
+require 'chicanery/collections'
 require 'chicanery/handlers'
 require 'chicanery/state_comparison'
 
 module Chicanery
   include Persistence
-  include Servers
+  include Collections
   include Handlers
   include StateComparison
 
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 
-  def execute *args
-    load args.shift
-    poll_period = args.shift
-    loop do
-      previous_state = restore
-      current_state = {
-        servers: {}
-      }
-      servers.each do |server|
-        current_jobs = server.jobs
-        compare_jobs current_jobs, previous_state[:servers][server.name] if previous_state[:servers]
-        current_state[:servers][server.name] = current_jobs
+  def execute args
+    begin
+      load args.shift
+      poll_period = args.shift
+      loop do
+        previous_state = restore
+        current_state = {
+          servers: {},
+          repos: {}
+        }
+        repos.each do |repo|
+          repo_state = repo.state
+          compare_repo_state repo.name, repo_state, previous_state[:repos][repo.name] if previous_state[:repos]
+          current_state[:repos][repo.name] = repo_state
+        end
+        servers.each do |server|
+          current_jobs = server.jobs
+          compare_jobs current_jobs, previous_state[:servers][server.name] if previous_state[:servers]
+          current_state[:servers][server.name] = current_jobs
+        end
+        run_handlers.each {|handler| handler.call current_state }
+        persist current_state
+        break unless poll_period
+        sleep poll_period.to_i
       end
-      run_handlers.each {|handler| handler.call current_state }
-      persist current_state
-      break unless poll_period
-      sleep poll_period.to_i
+    rescue Interrupt
     end
   end
 end

data/lib/chicanery/collections.rb

@@ -0,0 +1,15 @@
+module Chicanery
+  module Collections
+    %w{server repo}.each do |entity|
+      class_eval <<-EOF
+        def #{entity} entity
+          #{entity}s << entity
+        end
+
+        def #{entity}s
+          @#{entity}s ||= []
+        end
+      EOF
+    end
+  end
+end

data/lib/chicanery/git.rb

@@ -0,0 +1,58 @@
+require 'fileutils'
+
+module Chicanery
+  module Git
+    class Repo
+      include FileUtils
+
+      attr_reader :name, :path, :branches, :remotes
+
+      def initialize name, path, params={}
+        @name, @path = name, path
+        @branches = params[:branches] || []
+        @remotes = params[:remotes] || {}
+      end
+
+      def in_repo
+        Dir.chdir(path) { yield }
+      end
+
+      def prepare
+        return if File.exists? path
+        mkdir_p path
+        in_repo { git 'init' }
+      end
+
+      def state
+        prepare
+        response = {}
+        in_repo do
+          remotes.each do |name, remote|
+            git "remote add #{name} #{remote[:url]}" unless git("remote | grep #{name}") == name.to_s
+            git "fetch -q #{name}"
+            (remote[:branches] || ['master']).each do |branch|
+              response["#{name}/#{branch}"] = head "#{name}/#{branch}"
+            end
+          end
+          branches.each do |branch|
+            response[branch] = head branch
+          end
+        end
+        response
+      end
+
+      def head branch
+        match = /^([^ ]*) /.match git "log -n 1 #{branch} --pretty=oneline"
+        match[1] if match
+      end
+
+      def git command
+        `git #{command}`.chomp
+      end
+    end
+
+    def git_repo *args
+      repo Repo.new *args
+    end
+  end
+end

data/lib/chicanery/handlers.rb

@@ -1,6 +1,6 @@
 module Chicanery
   module Handlers
-    %w{run started succeeded failed broken fixed}.each do |status|
+    %w{run started succeeded failed broken fixed commit}.each do |status|
       class_eval <<-EOF
         def when_#{status} &block
           #{status}_handlers << block

data/lib/chicanery/state_comparison.rb

@@ -8,15 +8,22 @@ module Chicanery
     end
 
     def compare_job name, current, previous
-      return unless current[:last_build_time] != previous[:last_build_time]
       if current[:activity] == :building and previous[:activity] == :sleeping
         notify_started_handlers name, current
-        return
       end
+      return unless current[:last_build_time] != previous[:last_build_time]
       notify_succeeded_handlers name, current if current[:last_build_status] == :success
       notify_failed_handlers name, current if current[:last_build_status] == :failure
       notify_broken_handlers name, current if current[:last_build_status] == :failure and previous[:last_build_status] == :success
       notify_fixed_handlers name, current if current[:last_build_status] == :success and previous[:last_build_status] == :failure
     end
+
+    def compare_repo_state name, current, previous
+      return unless previous
+      current.each do |branch, state|
+        next unless previous[branch]
+        notify_commit_handlers "#{name}/#{branch}", state, previous[branch] if state != previous[branch]
+      end
+    end
   end
 end

data/spec/chicanery/collections_spec.rb

@@ -0,0 +1,14 @@
+describe Chicanery::Collections do
+  include Chicanery::Collections
+
+  %w{server repo}.each do |entity|
+    it "should default to an empty list of #{entity}s" do
+      send("#{entity}s").should == []
+    end
+
+    it "should append to #{entity}s list" do
+      send entity, :entity
+      send("#{entity}s").should == [:entity]
+    end
+  end
+end

data/spec/chicanery/persistence_spec.rb

@@ -0,0 +1,27 @@
+describe Chicanery::Persistence do
+  include Chicanery::Persistence
+
+  describe '#persist' do
+    it 'should write state to disk as yaml' do
+      file = stub 'file'
+      state = stub 'state', to_yaml: :yaml
+      File.should_receive(:open).with('state', 'w').and_yield file
+      file.should_receive(:puts).with :yaml
+      persist state
+    end
+  end
+
+  describe '#restore' do
+    it 'should return empty hash if state file does not exist' do
+      File.should_receive(:exist?).with('state').and_return false
+      restore.should == {}
+    end
+
+    it 'should read yaml from disk' do
+      state = stub 'state'
+      File.should_receive(:exist?).with('state').and_return true
+      YAML.should_receive(:load_file).with('state').and_return state
+      restore.should == state
+    end
+  end
+end

data/spec/chicanery/state_comparison_spec.rb

@@ -1,20 +1,63 @@
-require 'chicanery/state_comparison'
-
 describe Chicanery::StateComparison do
   include Chicanery::StateComparison
 
-  let(:current_jobs) { {} }
-  let(:previous_jobs) { {} }
+  describe '#compare_jobs' do
+    let(:current_jobs) { {} }
+    let(:previous_jobs) { {} }
+
+    after { compare_jobs current_jobs, previous_jobs }
+
+    it 'should do nothing when there are no jobs in current state' do
+      should_not_receive :compare_job
+      previous_jobs[:job] = {}
+    end
 
-  it 'should do nothing when there are no jobs in current state' do
-    should_not_receive :compare_job
-    previous_jobs[:job] = {}
-    compare_jobs current_jobs, previous_jobs
+    it 'should do nothing when there is no previous state' do
+      should_not_receive :compare_job
+      current_jobs[:job] = {}
+    end
   end
 
-  it 'should do nothing when there is no previous state' do
-    should_not_receive :compare_job
-    current_jobs[:job] = {}
-    compare_jobs current_jobs, previous_jobs
+  describe '#compare_job' do
+    let(:current_job)  { { activity: :sleeping, last_build_time: Time.now,  } }
+    let(:previous_job) { { activity: :sleeping, last_build_time: (Time.now-1) } }
+
+    before {
+      stub! :notify_failed_handlers
+      stub! :notify_succeeded_handlers
+    }
+
+    after { compare_job 'name', current_job, previous_job }
+
+    it 'should do nothing when build times are equal' do
+      current_job[:last_build_time] = previous_job[:last_build_time] = Time.now
+    end
+
+    it 'should notify started handlers when activity changes to building' do
+      current_job[:activity] = :building
+      should_receive(:notify_started_handlers).with 'name', current_job
+    end
+
+    it 'should notify succeeded handlers when a build is successful' do
+      current_job[:last_build_status] = :success
+      should_receive(:notify_succeeded_handlers).with 'name', current_job
+    end
+
+    it 'should notify failed handlers when a build fails' do
+      current_job[:last_build_status] = :failure
+      should_receive(:notify_failed_handlers).with 'name', current_job
+    end
+
+    it 'should notify broken handlers when a build is broken' do
+      previous_job[:last_build_status] = :success
+      current_job[:last_build_status] = :failure
+      should_receive(:notify_broken_handlers).with 'name', current_job
+    end
+
+    it 'should notify fixed handlers when a build is fixed' do
+      previous_job[:last_build_status] = :failure
+      current_job[:last_build_status] = :success
+      should_receive(:notify_fixed_handlers).with 'name', current_job
+    end
   end
 end

data/spec/chicanery_spec.rb

@@ -1,12 +1,30 @@
-require 'chicanery'
-
 describe Chicanery do
   include Chicanery
 
   describe '#execute' do
+    before { %w{load restore persist}.each {|m| stub! m } }
+
     it 'should load configuration and exit immediately when nothing is configured no poll period is provided' do
       should_receive(:load).with 'configuration'
-      execute 'configuration'
+      execute %w{configuration}
+    end
+
+    it 'should restore previous state' do
+      should_receive(:restore)
+      execute %w{configuration}
+    end
+
+    it 'should persist new state' do
+      should_receive(:persist).with({
+        servers: {},
+        repos: {}
+      })
+      execute %w{configuration}
+    end
+
+    it 'should sleep for specified time when poll period is provided' do
+      should_receive(:sleep).with(10).and_raise Interrupt
+      execute %w{configuration 10}
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chicanery
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-18 00:00:00.000000000 Z
+date: 2012-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -59,6 +59,38 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-gem-adapter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: trigger various events related to a continuous integration environment
 email:
 - mark@ryall.name
@@ -76,15 +108,18 @@ files:
 - Rakefile
 - bin/chicanery
 - chicanery.gemspec
+- examples/evil.rb
+- examples/github.rb
 - examples/travis.rb
 - lib/chicanery.rb
 - lib/chicanery/cctray.rb
+- lib/chicanery/collections.rb
+- lib/chicanery/git.rb
 - lib/chicanery/handlers.rb
 - lib/chicanery/persistence.rb
-- lib/chicanery/servers.rb
 - lib/chicanery/state_comparison.rb
-- spec/broken.xml
-- spec/building.xml
+- spec/chicanery/collections_spec.rb
+- spec/chicanery/persistence_spec.rb
 - spec/chicanery/state_comparison_spec.rb
 - spec/chicanery_spec.rb
 homepage: http://github.com/markryall/chicanery
@@ -101,7 +136,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3725593527818179587
+      hash: -2101217152092119930
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -110,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3725593527818179587
+      hash: -2101217152092119930
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -118,7 +153,7 @@ signing_key:
 specification_version: 3
 summary: polls various resources related to a ci environment and performs custom notifications
 test_files:
-- spec/broken.xml
-- spec/building.xml
+- spec/chicanery/collections_spec.rb
+- spec/chicanery/persistence_spec.rb
 - spec/chicanery/state_comparison_spec.rb
 - spec/chicanery_spec.rb

data/lib/chicanery/servers.rb

@@ -1,11 +0,0 @@
-module Chicanery
-  module Servers
-    def server new_server
-      servers << new_server
-    end
-
-    def servers
-      @servers ||= []
-    end
-  end
-end

data/spec/broken.xml

@@ -1,18 +0,0 @@
-
-<?xml version="1.0" encoding="utf-8"?>
-<Projects>
-  <Project name="sampleproject :: specs" activity="Sleeping" lastBuildStatus="Success" lastBuildLabel="55" lastBuildTime="2012-11-10T12:39:46" webUrl="http://192.168.1.2:8153/go/pipelines/sampleproject/55/specs/1" />
-  <Project name="sampleproject :: specs :: specs" activity="Sleeping" lastBuildStatus="Success" lastBuildLabel="55" lastBuildTime="2012-11-10T12:39:46" webUrl="http://192.168.1.2:8153/go/tab/build/detail/sampleproject/55/specs/1/specs" />
-  <Project name="sampleproject :: features" activity="Sleeping" lastBuildStatus="Failure" lastBuildLabel="55" lastBuildTime="2012-11-10T13:06:00" webUrl="http://192.168.1.2:8153/go/pipelines/sampleproject/55/features/1">
-    <messages>
-      <message text="build breaker &lt;buildbreaker@sampleproject.com&gt;" kind="Breakers" />
-    </messages>
-  </Project>
-  <Project name="sampleproject :: features :: features" activity="Sleeping" lastBuildStatus="Failure" lastBuildLabel="55" lastBuildTime="2012-11-10T13:06:00" webUrl="http://192.168.1.2:8153/go/tab/build/detail/sampleproject/55/features/1/features">
-    <messages>
-      <message text="build breaker &lt;buildbreaker@sampleproject.com&gt;" kind="Breakers" />
-    </messages>
-  </Project>
-  <Project name="sampleproject :: staging" activity="Sleeping" lastBuildStatus="Success" lastBuildLabel="51" lastBuildTime="2012-10-23T00:23:22" webUrl="http://192.168.1.2:8153/go/pipelines/sampleproject/51/staging/1" />
-  <Project name="sampleproject :: staging :: deploy" activity="Sleeping" lastBuildStatus="Success" lastBuildLabel="51" lastBuildTime="2012-10-23T00:23:22" webUrl="http://192.168.1.2:8153/go/tab/build/detail/sampleproject/51/staging/1/deploy" />
-</Projects>

data/spec/building.xml

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<Projects>
-  <Project name="sampleproject :: specs" activity="Sleeping" lastBuildStatus="Success" lastBuildLabel="55" lastBuildTime="2012-11-10T12:39:46" webUrl="http://192.168.1.2:8153/go/pipelines/sampleproject/55/specs/1" />
-  <Project name="sampleproject :: specs :: specs" activity="Sleeping" lastBuildStatus="Success" lastBuildLabel="55" lastBuildTime="2012-11-10T12:39:46" webUrl="http://192.168.1.2:8153/go/tab/build/detail/sampleproject/55/specs/1/specs" />
-  <Project name="sampleproject :: features" activity="Building" lastBuildStatus="Success" lastBuildLabel="1" lastBuildTime="2012-11-10T12:31:53" webUrl="http://192.168.1.2:8153/go/pipelines/sampleproject/55/features/1" />
-  <Project name="sampleproject :: features :: features" activity="Building" lastBuildStatus="Success" lastBuildLabel="1" lastBuildTime="2012-11-10T12:31:53" webUrl="http://192.168.1.2:8153/go/tab/build/detail/sampleproject/55/features/1/features" />
-  <Project name="sampleproject :: staging" activity="Sleeping" lastBuildStatus="Success" lastBuildLabel="51" lastBuildTime="2012-10-23T00:23:22" webUrl="http://192.168.1.2:8153/go/pipelines/sampleproject/51/staging/1" />
-  <Project name="sampleproject :: staging :: deploy" activity="Sleeping" lastBuildStatus="Success" lastBuildLabel="51" lastBuildTime="2012-10-23T00:23:22" webUrl="http://192.168.1.2:8153/go/tab/build/detail/sampleproject/51/staging/1/deploy" />
-</Projects>