edavis10-cerberus 0.7.8

data/Readme.markdown

@@ -0,0 +1,132 @@
+# Description
+
+Cerberus is a Continuous Integration software written in Ruby. Cerberus can be periodically run from scheduler to check if application tests are broken. In the case of test failure, Cerberus will send notification alerts via various methods. Cerberus perfectly works both on Windows and *nix platforms.
+
+For more CI theory, [read this document from Martin Fowler][1].  
+
+Cerberus's website is at [http://cerberus.rubyforge.org][6].
+
+***
+
+What does the 'Cerberus' name mean?
+> Quote from Wikipedia (http://en.wikipedia.org/wiki/Cerberus)
+>
+> Cerberus or Kerberos (Kerberos, demon of the pit), was the hound of Hades-a monstrous three-headed dog (sometimes said to have 50 or 100 heads) with a snake for a tail and innumerable snake heads on his back.
+He guarded the gate to Hades (the Greek underworld) and ensured that the dead could not leave and the living could not enter. His brother was Orthrus. He is the offspring of Echidna and Typhon.
+
+So, put simply, Cerberus will guard your tests and not allow your project to go to the world of dead. 
+
+***
+
+There are several CI solutions already present, why do you need to use Cerberus?
+
+Main advantages of Cerberus over other solutions include:
+
+1. Cerberus could be installed on any machine not only where the repository is located.
+2. Cerberus works not only for Rails projects, but for any other Ruby projects as well as for other platforms (Maven2 for Java)
+3. Cerberus multi-platform solution: it runs excellent both on *nix and Windows.
+4. Cerberus is distributed via RubyGems, making it very easy to install and very easy to update to the latest stable version
+5. Cerberus is very easy to start using. Just type 'cerberus add PROJECT_URL|PROJECT_DIR'
+6. Cerberus is a lightweight solution: a simple command line CI tool that only runs when the repository has changes
+
+## Requirements
+
+* ruby - 1.8.2 or higher
+* rake - 0.7.3 or higher (optional)
+* actionmailer - 2.0 or higher (optional)
+
+## Usage
+ 
+Cerberus is installed like any other Ruby gem.
+
+    gem install cerberus
+
+Alternatively, you can  get Cerberus in gem, zip or tarball right from [the RubyForge download page][5] 
+
+Next, add a project that will be watched by Cerberus.
+
+    cerberus add _REPOSITORY_
+
+The repository can be either a file path or URL.  Additional parameters can be found in the [wiki][2].
+
+Next, go to ~/.cerberus and edit the config.yml file (only needed once after installing Cerberus). Enter your configuration options here like email server, password, user_name and other options. See ActionMailer description - Cerberus uses it as notification layer. An example config file looks like this:
+
+    publisher:
+      mail:
+        address: mail.someserver.com
+        user_name: foobar
+        password: foobaz
+        domain: someserver.com
+        authentication: login
+
+Also check ~/.cerberus/config/<PROJECT_NAME>.yml and make sure that you have right settings specific to the project.
+
+Next run Cerberus 
+
+    cerberus build PROJECT_NAME    # Run project
+
+or
+
+    cerberus buildall     # Run all available projects
+
+
+Cerberus will check out the latest repository sources and run tests for your project.  If tests fail, the notification alerts will be sent
+
+You can also schedule Cerberus to run via CRON to automate the process.
+
+
+## Features
+
+Cerberus currently supports the following SCM tools: 
+
+  * Subversion
+  * Git
+  * Darcs
+  * Perforce
+  * CVS
+  * Bazaar
+  * Mercurial
+
+Cerberus currently supports the following notification systems: 
+
+  * Email
+  * Jabber
+  * IRC
+  * RSS
+  * Campfire
+  * Twitter
+
+Cerberus currently supports the following build systems: 
+
+  * Rake
+  * Ruby script
+  * RSpec
+  * Rant
+  * Maven2
+  * Bjam
+  
+
+## Documentation
+
+For instructions, guides and documentation, [please refer to the GitHub wiki][2].
+
+## Mailing List / Public Forums
+
+[http://groups.google.com/group/cerberusci][3]
+
+## Issue Tracker
+
+[http://cpjolicoeur.lighthouseapp.com/projects/22299-cerberus][4]
+
+## License
+
+This plugin is licensed under the MIT license. Complete license text
+is included in the License.txt file.
+
+
+[1]:http://www.martinfowler.com/articles/continuousIntegration.html
+[2]:http://wiki.github.com/cpjolicoeur/cerberus
+[3]:http://groups.google.com/group/cerberusci
+[4]:http://cpjolicoeur.lighthouseapp.com/projects/22299-cerberus
+[5]:http://rubyforge.org/frs/?group_id=1794
+[6]:http://cerberus.rubyforge.org

data/bin/cerberus

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+# Add lib dir to load path so that we don't have to be installed in rubygems
+require 'pathname' # Use Pathname to follow symlinks
+CERBERUS_LIB_DIR = File.join( File.dirname( Pathname.new( __FILE__ ).realpath ),'..','lib' )
+$:.unshift CERBERUS_LIB_DIR
+
+require 'cerberus/cli'
+
+Cerberus::CLI.new(*ARGV)

data/lib/cerberus/builder/base.rb

@@ -0,0 +1,4 @@
+module Cerberus
+  module Builder
+  end
+end

data/lib/cerberus/builder/bjam.rb

@@ -0,0 +1,30 @@
+require 'cerberus/builder/base'
+
+class Cerberus::Builder::Bjam
+ attr_reader :output
+
+ def initialize(config)
+   @config = config
+ end
+
+ def run
+   #set correct mountpoint if it present
+   build_dir = @config[:builder, :bjam, :build_dir]
+   Dir.chdir(build_dir) if build_dir
+
+   cmd = @config[:builder, :bjam, :cmd] || 'bjam'
+   task = @config[:builder, :bjam, :target] #|| 'clean'
+
+   @output = `#{cmd} #{task} 2>&1`
+   successful?
+ end
+
+ def successful?
+   $?.exitstatus == 0 and not @output =~ /failed|error:|skipped/ 
+     #/\*\*\* \d+ failure(s)? detected in test suite/ and not @output.include?("syntax error")
+ end
+
+ def brokeness
+   return nil
+ end
+end

data/lib/cerberus/builder/maven2.rb

@@ -0,0 +1,61 @@
+require 'cerberus/builder/base'
+
+class Cerberus::Builder::Maven2
+  attr_reader :output, :brokeness
+
+  def initialize(config)
+    @config = config
+  end
+
+  def run
+    cmd = @config[:builder, :maven2, :cmd] || 'mvn'
+    task = @config[:builder, :maven2, :task] || 'test'
+    @output = `#{@config[:bin_path]}#{cmd} #{system_properties} #{settings} #{task} 2>&1`
+    add_error_information
+    successful?
+  end
+
+  def successful?
+    $?.exitstatus == 0 and not @output.include?('[ERROR] BUILD FAILURE')
+  end
+
+  private
+
+  def system_properties
+    properties = []
+    system_properties = @config[:builder, :maven2, :system_properties]
+    if system_properties
+      system_properties.each do |p|
+        properties << %Q(-D#{p[0]}="#{p[1]}")
+      end
+    end
+    properties.join(' ')
+  end
+
+  def settings
+    settings_file = @config[:builder, :maven2, :settings]
+    if settings_file
+      return "-s #{settings_file}"
+    else
+      return ''
+    end
+  end
+
+  def add_error_information
+    str = @output
+    @output = ''
+    @brokeness = 0
+    while str =~ / <<< FAILURE!$/
+      @brokeness += 1
+      s = $'
+
+      $` =~ /^(.|\n)*Running (.*)$/
+      failed_class = $2
+      @output << $` << $& << ' <<< FAILURE!'
+      surefire_report_filename = "#{@config[:application_root]}/target/surefire-reports/#{failed_class}.txt"
+      @output << "\n" << IO.readlines(surefire_report_filename)[4..-1].join.lstrip if test(?e, surefire_report_filename)
+      str = s
+    end
+    @output << str
+  end
+end

data/lib/cerberus/builder/rake.rb

@@ -0,0 +1,11 @@
+require 'cerberus/builder/ruby_base'
+
+class Cerberus::Builder::Rake < Cerberus::Builder::RubyBase
+  def initialize(config)
+    super(config, "rake")
+  end
+
+  def successful?
+    $?.exitstatus == 0 and not @output.include?("#{@cmd} aborted!")
+  end
+end

data/lib/cerberus/builder/rant.rb

@@ -0,0 +1,11 @@
+require 'cerberus/builder/ruby_base'
+
+class Cerberus::Builder::Rant < Cerberus::Builder::RubyBase
+  def initialize(config)
+    super(config, "rant")
+  end
+
+  def successful?
+    $?.exitstatus == 0 and not @output.include?("#{@cmd} aborted!") and @output.include?("0 failures, 0 errors")
+  end
+end

data/lib/cerberus/builder/rspec.rb

@@ -0,0 +1,26 @@
+require 'cerberus/builder/ruby_base'
+
+class Cerberus::Builder::RSpec < Cerberus::Builder::RubyBase
+  def initialize(config)
+    super(config, "rspec", "spec")
+  end
+
+  def run
+    @output = if @config[:builder, @name.to_sym, :task]
+      `#{@config[:bin_path]}rake #{@config[:builder, @name.to_sym, :task]} 2>&1`
+    else
+      `#{@config[:bin_path]}rake #{choose_exec()} 2>&1`
+    end
+    successful?
+  end
+
+  def brokeness
+    if @output =~ /\d+ examples, (\d+) failures?/
+      $1.to_i
+    end
+  end
+
+  def successful?
+    $?.exitstatus == 0 and not @output.include?("#{@cmd} aborted!") and @output.include?("0 failures")
+  end
+end

data/lib/cerberus/builder/ruby.rb

@@ -0,0 +1,33 @@
+require 'cerberus/builder/ruby_base'
+
+class Cerberus::Builder::Ruby < Cerberus::Builder::RubyBase
+  def initialize(config)
+    super(config, "ruby")
+  end
+  
+  def run
+    ENV['PATH'] = "#{@config[:builder, @name.to_sym, :ruby_path]}::#{ENV['PATH']}"
+    super
+  end
+  
+  def successful?
+    if ( @config[:builder, @name.to_sym, :failure] and @config[:builder, @name.to_sym, :success] )
+      $?.exitstatus == 0 and !@output.include?(@config[:builder, @name.to_sym, :failure]) and @output.include?(@config[:builder, @name.to_sym, :success])
+    else
+      super # use RubyBase default if custom :success and :failure not specified
+    end
+  end
+
+  def brokeness
+    if @config[:builder, @name.to_sym, :brokeness]
+      re = Regexp.new( @config[:builder, @name.to_sym, :brokeness] )
+      md = re.match( @output )
+      if md
+        return md.captures.inject( 0 ) { |sum, n| sum += n.to_i }
+      end
+    else 
+      super # use RubyBase default if custom :brokeness not specified
+    end
+  end
+  
+end

data/lib/cerberus/builder/ruby_base.rb

@@ -0,0 +1,50 @@
+require 'cerberus/builder/base'
+
+class Cerberus::Builder::RubyBase
+  attr_reader :output
+
+  def initialize(config, name, cmd = name)
+    @config = config
+    @cmd = cmd
+    @name = name
+  end
+
+  def run
+    build_dir = @config[:builder, :build_dir]
+    Dir.chdir(build_dir) if build_dir
+
+    @output = `#{@config[:bin_path]}#{choose_exec()} #{@config[:builder, @name.to_sym, :task]} 2>&1`
+    successful?
+  end
+
+  def successful?
+    $?.exitstatus == 0 and not @output.include?("#{@cmd} aborted!")
+  end
+
+  def brokeness
+    if @output =~ /\d+ tests, \d+ assertions, (\d+) failures, (\d+) errors/
+      return $1.to_i + $2.to_i
+    end
+  end
+
+  private
+  def choose_exec
+    ext = ['']
+
+    if os() == :windows 
+      ext << '.bat' << '.cmd'
+    end
+
+    silence_stream(STDERR) {
+      ext.each do |e|
+        begin
+          out = `#{@config[:bin_path]}#{@cmd}#{e} --version 2>&1`
+          return "#{@cmd}#{e}" if out =~ /#{@cmd}/
+        rescue
+        end
+      end
+    }
+
+    raise "#{@cmd} builder did not find. Make sure that such script exists and have executable permissions."
+  end
+end

data/lib/cerberus/cli.rb

@@ -0,0 +1,81 @@
+require 'cerberus/manager'
+require 'cerberus/utils'
+require 'cerberus/constants'
+
+module Cerberus
+  class CLI     
+    def initialize(*args)
+      say HELP if args.empty?
+
+      command = args.shift
+
+      cli_options = extract_options(args)
+
+      case command
+      when 'add'
+        path = args.shift || Dir.pwd
+        command = Cerberus::AddCommand.new(path, cli_options)
+        command.run
+      when 'remove'
+        command = Cerberus::RemoveCommand.new(args.shift, cli_options)
+        command.run
+      when 'build'
+        say HELP if args.empty?
+
+        application_name  = args.shift
+
+        command = Cerberus::BuildCommand.new(application_name, cli_options)
+        command.run
+      when 'buildall'
+        command = Cerberus::BuildAllCommand.new(cli_options)
+        command.run
+      when 'list'
+        command = Cerberus::ListCommand.new(cli_options)
+        command.run
+      when 'status'
+        command = Cerberus::StatusCommand.new(cli_options)
+        command.run
+      else 
+        say HELP
+      end
+    end
+
+    private 
+    def extract_options(args)
+      result = {}
+      args_copy = args.dup
+      args_copy.each do |arg|
+        case arg
+        when /^(\w+)=(.*)$/
+          result[$1.downcase.to_sym] = $2
+          args.delete(arg)
+        when '--force'
+          result[:force] = true
+          args.delete(arg)
+        when '--verbose', '-v'
+          result[:verbose] = true
+          args.delete(arg)
+        end
+      end
+
+      result
+    end
+  end
+
+  HELP = %{
+    Cerberus is a lightweight command-line Continuous Integration tool for Ruby.
+
+    Usage:
+      cerberus add <URL>     --- add project from a repository to list watched of applications
+      cerberus add <PATH>    --- add project from local path to list of watched applications
+      cerberus remove <NAME> --- remove given project from cerberus
+      cerberus build <NAME>  --- build watched application
+      cerberus buildall      --- build all watched applications
+      cerberus list          --- see the list of all watched applications
+      cerberus status        --- see the current status of all cerberus projects
+
+    Version: #{Cerberus::VERSION}
+    Cerberus Path: "#{Cerberus::HOME}"
+    Cerberus Homepage: http://cerberus.rubyforge.org
+    }.gsub("\n    ","\n")
+end