cerberus 0.5 → 0.6

data/Changelog.txt

@@ -1,5 +1,14 @@
 = Cerberus Changelog
 
+== Version 0.6
+New Ruby builder, bugfixes, and refactoring
+
+* added new Ruby builder for using custom ruby scripts to build projects
+* fixed issue with require explicit version of the twitter4r gem
+* refactoring and cleanup of the git SCM code
+* some cleanup of the 'cerberus status' command output
+* only check for process exit status or abort message for ruby_base builder
+
 == Version 0.5
 Bugfixes and Ticket Support
 

data/Rakefile

@@ -1,11 +1,12 @@
+%w(rubygems rake rake/clean rake/testtask fileutils newgem rubigen).each { |f| require f }
+require File.join( File.dirname(__FILE__), 'lib', 'cerberus', 'constants.rb' )
+
 require 'rubygems'
 require 'rake'
 require 'rake/testtask'
 require 'rake/packagetask'
 require 'rake/gempackagetask'
 
-require "./lib/cerberus/constants"
-
 PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
 PKG_NAME      = 'cerberus'
 PKG_VERSION   = Cerberus::VERSION + PKG_BUILD
@@ -34,6 +35,15 @@ task :clean => :clobber_package do
   rm_rf "#{root}/doc/site/webgen.cache"
 end
 
+# $hoe = Hoe.new('cerberus', Cerberus::VERSION) do |p|
+#   p.rubyforge_name          = p.name
+#   p.developer( 'Craig P Jolicoeur', 'cpjolicoeur@gmail.com' )
+#   p.url                     = 'http://cerberus.rubyforge.org'
+#   p.need_tar                = true
+#   p.need_zip                = true
+# 
+#   p.changes                 = p.paragraphs_of( 'Changelog.txt', 0..1 ).join( "\n\n" )
+# end
 
 GEM_SPEC = Gem::Specification.new do |s|
   s.name = PKG_NAME
@@ -58,7 +68,7 @@ GEM_SPEC = Gem::Specification.new do |s|
   s.add_dependency 'twitter4r', '>= 0.3.0'
 
   s.files = Dir.glob("{bin,lib,test}/**/*").delete_if { |item| item.include?('__workdir') }
-  s.files += %w(License.txt Readme.txt Changelog.txt Rakefile)
+  s.files += %w(License.txt Readme.markdown Changelog.txt Rakefile)
   s.files += Dir.glob("doc/*").delete_if { |item| item.include?('__workdir') }
 
   s.bindir = "bin"
@@ -126,8 +136,6 @@ task :release_files => [:clean, :package] do
     release.files = release_files.to_a
     release.package_name    = PKG_NAME
     release.release_name = "Cerberus #{PKG_VERSION}"
-    release.release_notes = IO.read( File.dirname( __FILE__ ) + '/Changelog.txt' )
-    release.release_changes = IO.read( File.dirname( __FILE__ ) + '/Changelog.txt' )
   end
 
 end
@@ -145,16 +153,12 @@ task :publish_news do
 end
 
 require 'webgen/webgentask'
-task :generate_site => :webgen do
-
-  Webgen::WebgenTask.new do |t|
-    t.directory = File.join( File.dirname( __FILE__ ), 'doc/site')
-    t.clobber_outdir = true
-  end
-
+Webgen::WebgenTask.new do |t|
+  t.directory = File.join( File.dirname( __FILE__ ), 'doc/site')
+  t.clobber_outdir = true
 end
 
-task :publish_site => :generate_site do
+task :publish_site => :webgen do
   sh %{scp -r -q doc/site/out/* #{RUBYFORGE_USER}@rubyforge.org:/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/}
 end
 

data/Readme.markdown

@@ -0,0 +1,135 @@
+# 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 - 1.3.3 or higher (optional)
+* activesupport - 1.4.2 or higher (optional)
+* xmpp4r - 0.3.1 or higher (optional)
+* Ruby-IRC - 1.0.7 or higher (optional)
+* gmailer - 0.1.7 or higher (optional)
+* twitter4r - 0.3.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
+
+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/cerberusci
+[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/lib/cerberus/builder/rake.rb

@@ -4,4 +4,8 @@ class Cerberus::Builder::Rake < Cerberus::Builder::RubyBase
   def initialize(config)
     super(config, "rake")
   end
+
+  def successful?
+    $?.exitstatus == 0 and not @output.include?("#{@cmd} aborted!") and @output.include?("0 failures, 0 errors")
+  end
 end

data/lib/cerberus/builder/rant.rb

@@ -4,4 +4,8 @@ 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/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

@@ -16,7 +16,7 @@ class Cerberus::Builder::RubyBase
   end
 
   def successful?
-    $?.exitstatus == 0 and not @output.include?("#{@cmd} aborted!") and @output.include?("0 failures, 0 errors")
+    $?.exitstatus == 0 and not @output.include?("#{@cmd} aborted!")
   end
 
   def brokeness

data/lib/cerberus/component_lazy_loader.rb

@@ -68,7 +68,8 @@ module Cerberus
       :rake => 'Rake',
       :rspec => 'RSpec',
       :rant => 'Rant',
-      :bjam => 'Bjam'
+      :bjam => 'Bjam',
+      :ruby => 'Ruby'
     }
 
     def self.get(type)

data/lib/cerberus/constants.rb

@@ -4,5 +4,5 @@ module Cerberus
 
   LOCK_WAIT = 30 * 60 #30 minutes
 
-  VERSION = '0.5'
+  VERSION = '0.6'
 end

data/lib/cerberus/manager.rb

@@ -37,9 +37,10 @@ module Cerberus
     end
     
     private
+
     def extract_project_name(path)
       path = File.expand_path(path) if test(?d, path)
-      File.basename(path).strip
+      File.basename(path).strip.gsub( /\.git$/, '' )
     end
     
     def create_example_config
@@ -241,9 +242,9 @@ module Cerberus
         delim = ' | '
         cols  = [
           ['Project Name', 30, lambda { |p, s| p }],
-          ['Revision',     10, lambda { |p, s| "r#{s.revision.to_s.slice( 0, 8 ) }"}],
+          ['Revision',     10, lambda { |p, s| "#{s.revision.to_s.slice( 0, 8 ) }"}],
           ['Status',       10, lambda { |p, s| s.previous_build_successful ? 'Pass' : 'Fail' }],
-          ['Last Success', 10, lambda { |p, s| "r#{s.successful_build_revision.to_s.slice( 0, 8 )}"}],
+          ['Last Success', 10, lambda { |p, s| "#{s.successful_build_revision.to_s.slice( 0, 8 )}"}],
         ]
         header = cols.map { |head, size, lamb| head.ljust(size) }.join(delim)
         puts '-' * header.length

data/lib/cerberus/publisher/base.rb

@@ -7,7 +7,7 @@ module Cerberus
         subject = 
         case state.current_state
         when :setup
-          "Cerberus set up for project (##{manager.scm.current_revision})"
+          "Cerberus set up for project (#{manager.scm.current_revision})"
         when :broken
           additional_message = nil
           if state.previous_brokeness and state.current_brokeness
@@ -19,15 +19,15 @@ module Cerberus
                 ' and getting worse'
             end
           end
-          "Build still broken#{additional_message} (##{manager.scm.current_revision})"
+          "Build still broken#{additional_message} (#{manager.scm.current_revision})"
 
         #FIXME instead of using last author as person that broken build try to guess it. I.e. only if one author since last commit did commit - then he broken it.
         when :failed
-          "Build broken by #{manager.scm.last_author} (##{manager.scm.current_revision})"
+          "Build broken by #{manager.scm.last_author} (#{manager.scm.current_revision})"
         when :revival
-          "Build fixed by #{manager.scm.last_author} (##{manager.scm.current_revision})"
+          "Build fixed by #{manager.scm.last_author} (#{manager.scm.current_revision})"
         when :successful
-          "Build successful (##{manager.scm.current_revision})"
+          "Build successful (#{manager.scm.current_revision})"
         else                              
           raise "Unknown build state '#{state.current_state.to_s}'"
         end

data/lib/cerberus/publisher/twitter.rb

@@ -13,7 +13,7 @@ require 'cerberus/utils'
 class Cerberus::Publisher::Twitter < Cerberus::Publisher::Base
   def self.publish(state, manager, options)
     begin
-      gem 'twitter4r', '0.3.0'
+      gem 'twitter4r', '>=0.3.0'
       require 'twitter'
 
       twitter_options = options[:publisher, :twitter]

data/lib/cerberus/scm/git.rb

@@ -14,29 +14,31 @@ class Cerberus::SCM::Git
 
   def update!
     if test(?d, @path + '/.git')
-      extract_last_commit_info
-      @status = execute("reset", "--hard #{@revision}") + execute('pull')
+      get_updates
+      execute("reset", "--hard #{remote_head}")
     else
       FileUtils.rm_rf(@path) if test(?d, @path)
       encoded_url = (@config[:scm, :url].include?(' ') ? "\"#{@config[:scm, :url]}\"" : @config[:scm, :url])
+      @new = true
       @status = execute("clone", "#{encoded_url} #{@path}", false)
-      if @config[:scm, :branch]
-        branch = @config[:scm, :branch]
-        execute('branch', "--track #{branch} origin/#{branch}")
+      if branch = @config[:scm, :branch]
+        execute('branch', "--track #{branch} #{remote_head}")
         execute('checkout', branch)
       end
     end
   end
 
   def has_changes?
-    return false if @status =~ /Already up-to-date./
-    return true if @status =~ /Fast forward/
-    return true if @status =~ /Initialized empty Git repository/
-    return false
+    extract_current_head_revision
+    new? or ( last_tested_revision != @revision )
   end
 
-  def current_revision
-    @revision
+  def new?
+    @new == true
+  end
+
+  def current_revision( _full=false )
+    _full ? @revision : @revision.slice(0,8)
   end
 
   def url
@@ -56,6 +58,15 @@ class Cerberus::SCM::Git
   end
 
   private
+  
+  def get_updates
+    execute("fetch")
+  end
+
+  def remote_head
+    branch = @config[:scm, :branch] 
+    branch ? "origin/#{branch}" : "origin"
+  end
 
   def execute(command, parameters = nil, with_path = true)
    if with_path
@@ -67,13 +78,25 @@ class Cerberus::SCM::Git
    `#{cmd}`
   end
 
-  def extract_last_commit_info
-    message = execute("show", "--pretty='format:%an(%ae)|%ai|%H|%s'")
-    message = message.split("|")
-    
-    @author = message[0]
-    @date = message[1]
-    @revision = message[2]
-    @message = message[3]
+  def extract_commit_info( commit=remote_head )
+    message = execute("show", "#{ commit } --pretty='format:%an(%ae)|%ai|%H|%s'").split("|")
+    { :author => message[0], :date => message[1], :revision => message[2], :message => message[3] }
+  end
+
+  def last_tested_revision
+    # TODO Is there a better way to extract the last tested commit?
+    app_name          = @config['application_name']
+    app_root          = "#{Cerberus::HOME}/work/#{app_name}"
+    status            = Cerberus::Status.new("#{app_root}/status.log")
+    commit_info = extract_commit_info(status.revision)
+    @last_tested_revision ||= commit_info[:revision]
+  end
+
+  def extract_current_head_revision
+    commit_info = extract_commit_info
+    @author     = commit_info[:author]
+    @date       = commit_info[:date]
+    @revision   = commit_info[:revision]
+    @message    = commit_info[:message]
   end
 end

data/lib/cerberus/utils.rb

@@ -151,8 +151,8 @@ end
 
 
 class IO
-  def self.write(filename, str)
-    File.open(filename, 'w'){|f| f.write str}
+  def self.write(filename, str, mode='w')
+    File.open(filename, mode){|f| f.write str}
   end
 end
 

data/test/functional_test.rb

@@ -63,7 +63,7 @@ class FunctionalTest < Test::Unit::TestCase
     #Check outpus that run needed tasks
     assert_match /1 tests, 1 assertions, 0 failures, 0 errors/, output
     assert output !~ /Task 'custom1' has been invoked/
-    assert_equal '[myapp] Cerberus set up for project (#2)', mail.subject
+    assert_equal '[myapp] Cerberus set up for project (2)', mail.subject
     assert output =~ %r{http://someurl.changeset.com/2}
 
     status_file = HOME + '/work/myapp/status.log'

data/test/mail_publisher_test.rb

@@ -21,6 +21,6 @@ class MailPublisherTest < Test::Unit::TestCase
     assert_equal 1, mails.size
     mail = mails[0]
     assert_equal 'haha', mail.from_addrs[0].address
-    assert_equal '[MyApp] Cerberus set up for project (#1232)', mail.subject
+    assert_equal '[MyApp] Cerberus set up for project (1232)', mail.subject
   end
 end

data/test/mock/twitter.rb

@@ -1,4 +1,4 @@
-gem 'twitter4r', '0.3.0'
+gem 'twitter4r', '>=0.3.0'
 require 'twitter'
 
 class Twitter::Client

data/test/ruby_builder_test.rb

@@ -0,0 +1,77 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+require 'cerberus/builder/ruby'
+require 'tmpdir'
+
+class Cerberus::Builder::Ruby
+ attr_writer :output
+end
+
+class RubyBuilderTest < Test::Unit::TestCase
+
+  def setup
+    tmp = Dir::tmpdir
+    @cfg = Cerberus::Config.new( nil, { :application_root => tmp } )
+  end
+
+  def test_builder
+    @cfg.merge!(:builder => {:ruby => {:success => 'Build successful', :failure => 'Build failed', :brokeness => '(\d+) failures, (\d+) errors'}})
+    builder = Cerberus::Builder::Ruby.new(@cfg)
+
+    builder.output = SUCCESS_OUTPUT
+    assert builder.successful?
+
+    builder.output = FAILURE_OUTPUT
+    assert !builder.successful?
+    assert_equal 10, builder.brokeness
+
+
+    @cfg.merge!(:builder => {:ruby => {:success => 'Build successful', :failure => '[Build] FAILURE', :brokeness => '(\d+) failures, (\d+) errors, (\d+) huge problems'}})
+    builder.output = CUSTOM_FAILURE_OUTPUT
+    assert !builder.successful?
+    assert_equal 19, builder.brokeness
+  end
+
+  def test_builder_without_custom_config
+    @cfg.merge!( :builder => { :ruby => {} } )
+    builder = Cerberus::Builder::Ruby.new( @cfg )
+
+    builder.output = DEFAULT_SUCCESS_OUTPUT
+    assert builder.successful?
+    assert_equal 0, builder.brokeness
+  end
+  
+end
+
+SUCCESS_OUTPUT=<<-END
+A
+Bunch
+Of 
+Output
+Build successful
+END
+
+DEFAULT_SUCCESS_OUTPUT=<<-END
+A
+Bunch of
+Output
+23 tests, 46 assertions, 0 failures, 0 errors
+END
+
+FAILURE_OUTPUT=<<-END
+A
+Bunch
+Of 
+Output
+Build failed
+7 failures, 3 errors
+END
+
+CUSTOM_FAILURE_OUTPUT=<<-END
+A
+Bunch
+Of 
+Output
+[Build] FAILURE
+7 failures, 3 errors, 9 huge problems
+END

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cerberus
 version: !ruby/object:Gem::Version 
-  version: "0.5"
+  version: "0.6"
 platform: ruby
 authors: 
 - Craig P Jolicoeur
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-22 00:00:00 -04:00
+date: 2009-05-29 00:00:00 -04:00
 default_executable: cerberus
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -100,6 +100,7 @@ files:
 - lib/cerberus/builder/rake.rb
 - lib/cerberus/builder/rant.rb
 - lib/cerberus/builder/rspec.rb
+- lib/cerberus/builder/ruby.rb
 - lib/cerberus/builder/ruby_base.rb
 - lib/cerberus/cli.rb
 - lib/cerberus/component_lazy_loader.rb
@@ -132,7 +133,6 @@ files:
 - test/data
 - test/data/darcs.zip
 - test/data/git.zip
-- test/data/git.zip.bak
 - test/data/subversion.dump
 - test/functional_test.rb
 - test/integration_test.rb
@@ -149,10 +149,11 @@ files:
 - test/perforce_scm_test.rb
 - test/rspec_builder_test.rb
 - test/rss_publisher_test.rb
+- test/ruby_builder_test.rb
 - test/test_helper.rb
 - test/twitter_publisher_test.rb
 - License.txt
-- Readme.txt
+- Readme.markdown
 - Changelog.txt
 - Rakefile
 - doc/site
@@ -195,4 +196,5 @@ test_files:
 - test/perforce_scm_test.rb
 - test/rspec_builder_test.rb
 - test/rss_publisher_test.rb
+- test/ruby_builder_test.rb
 - test/twitter_publisher_test.rb

data/Readme.txt

@@ -1,104 +0,0 @@
-Cerberus is a Continuous Builder software. Cerberus could be periodically run from scheduler and check if application tests are broken. If it happens then Cerberus will send notification to developers. Cerberus perfectly works both on Windows and *nix platforms.
-
-For more CI theory read this document from Martin Fowler 
-http://www.martinfowler.com/articles/continuousIntegration.html.
-
-Requirements: 
-  ruby - 1.8.2 or higher
-  rake - 0.7 or higher
-
-What 'Cerberus' name means?
-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 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 are:
- 1) Cerberus could be installed on any machine not only where SVN repository 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 multiplatform solution: it runs excellent both on *nix and Windows.
- 4) Cerberus distributed via RubyGems, so it is very easy to install and very easy to update to the latest stable version
- 5) Cerberus very easy to start using. Just type 'cerberus add PROJECT_URL|PROJECT_DIR'
- 6) Cerberus is lightweight solution: most of the time ruby process even not runs - Rake runs only in case if changes in project sources are found.
-
- 
-To use Cerberus it is very easy. First install it. Easiest way to do it through RubyGems package manager.
-
-'gem install cerberus'
-
-or get Cerberus distribution package right from download page http://rubyforge.org/frs/?group_id=1794&release_id=6442
-
-then you need to add project that will be watched by Cerberus. Do it by
-
-cerberus add (DIR|SVN_URL) APPLICATION_NAME=some_app RECIPIENTS=dev1@project.com,dev2@project.com
-
-as second parameter you could pass URL to subversion repository or directory with working SVN folder.
-
-Go to ~/.cerberus and edit config.yml file (only once after installing Cerberus). Enter your configuration options here like email server, password, user_name and other options. See ActiveMailer description - Cerberus uses it as notification layer. My config file looks like this
-
-publisher:
-  mail:
-    address: mail.somesever.com
-    user_name: anatol
-    password: anatol
-    domain: somesever.com
-    authentication: login
-
-Also check ~/.cerberus/config/<APPLICATION_NAME>.yml and make sure that you have right options.
-
-And then run Cerberus 
-
-cerberus build APPLICATION_NAME    # Run project
-
-or
-
-cerberus buildall     # Run all available projects
-
-
-It will check out latest sources and run tests for your application. If tests are broken - recipients will receive notifications.
-
-But of course better run Cerberus automatically from Cron. Run Cerberus for project each 10 minutes would be ok.
-
-== Features
-
-Cerberus currently supports the following SCM tools: 
-
-  * Subversion
-  * Git
-  * Darcs
-  * Perforce
-  * CVS
-
-Cerberus currently supports the following notification systems: 
-
-  * Email
-  * Jabber
-  * IRC
-  * RSS
-  * Campfire
-  * Twitter
-
-Cerberus currently supports the following build systems: 
-
-  * Rake
-  * RSpec
-  * Rant
-  * Maven2
-  * Bjam
-
-== Mailing List / Public Forums
-
-http://groups.google.com/group/cerberusci
-
-== Issue Tracker
-
-http://cpjolicoeur.lighthouseapp.com/projects/22299-cerberus
-
-== License
-
-This plugin is licensed under the MIT license. Complete license text
-is included in the License.txt file.