damagecontrol 0.5.0 → 0.5.0.1391

data/lib/damagecontrol/publisher/ambient_orb.rb

@@ -0,0 +1,16 @@
+require 'damagecontrol/publisher/base'
+
+module DamageControl
+  module Publisher
+    class AmbientOrb < Base
+      #register self
+
+      def name
+        "Ambient Orb"
+      end    
+
+      def publish(build)
+      end
+    end
+  end
+end

data/lib/damagecontrol/publisher/archive.rb

@@ -0,0 +1,16 @@
+require 'damagecontrol/publisher/base'
+
+module DamageControl
+  module Publisher
+    class Execute < Base
+      #register self
+    
+      def name
+        "Execute"
+      end    
+
+      def publish(build)
+      end
+    end
+  end
+end

data/lib/damagecontrol/publisher/base.rb

@@ -0,0 +1,25 @@
+require 'rscm/annotations'
+require 'damagecontrol/project'
+
+module DamageControl
+  module Publisher
+  
+    # Base class for publishers. Subclasses must extend this class and call register self.
+    class Base
+
+      attr_accessor :enabled
+
+      @@classes = []
+      def self.register(cls) 
+        @@classes << cls unless @@classes.index(cls)
+      end      
+      def self.classes
+        @@classes
+      end
+  
+      Dir[File.dirname(__FILE__) + "/*.rb"].each do |src|
+        load(src) unless File.expand_path(src) == File.expand_path(__FILE__)
+      end
+    end
+  end
+end

data/lib/damagecontrol/publisher/build_duration.rb

@@ -0,0 +1,16 @@
+require 'damagecontrol/publisher/base'
+
+module DamageControl
+  module Publisher
+    class BuildDuration < Base
+      #register self
+
+      def name
+        "Build Duration"
+      end    
+
+      def publish(build)
+      end
+    end
+  end
+end

data/lib/damagecontrol/publisher/email.rb

@@ -0,0 +1,59 @@
+require 'action_mailer'
+require 'damagecontrol/publisher/base'
+
+module DamageControl
+  module Publisher
+    class Email < Base
+      register self
+    
+      attr_accessor :enabled
+
+      ann :description => "How to deliver email [\"sendmail\"|\"smtp\"]"
+      attr_accessor :delivery_method
+
+      ann :description => "Recipients (comma separated)"
+      attr_accessor :to
+
+      ann :description => "Who sends the email"
+      attr_accessor :from
+      
+      def initialize
+        @delivery_method = "sendmail"
+        @to = ""
+        @from = "\"DamageControl\" <dcontrol@codehaus.org>"
+      end
+      
+      def name
+        "Email"
+      end
+    
+      def publish(build)
+        BuildMailer.template_root = File.expand_path(File.dirname(__FILE__) + "/../../../app/views")
+        BuildMailer.delivery_method = @delivery_method      
+        BuildMailer.deliver_email(build, self)
+      end
+    end
+
+    class BuildMailer < ActionMailer::Base
+      def email(build, email_publisher, foo=nil, bar=nil)
+        @delivery_method = email_publisher.delivery_method
+        Log.info("Sending email to #{email_publisher.to.inspect} via #{@delivery_method}")
+        @recipients = email_publisher.to.split(%r{,\s*})
+
+        @from = email_publisher.from
+
+        @subject = "#{build.project.name} Build #{build.status_message}"
+        @sent_on = Time.new.utc
+        @headers['Content-Type'] = "text/html"
+        @body["build"] = build
+      end
+      
+      # We have to define this, since our name is used to find the email template
+      class << self
+        def to_s
+          "Build"
+        end        
+      end
+    end
+  end
+end  

data/lib/damagecontrol/publisher/execute.rb

@@ -0,0 +1,49 @@
+require 'fileutils'
+require 'rscm/path_converter' #TODO: move safer_popen to popen_ext.rb
+require 'damagecontrol/publisher/base'
+
+module DamageControl
+
+  class Build
+    def execute_publisher_stdout
+      File.expand_path("#{execute_publisher_dir}/stdout.log")
+    end
+
+    def execute_publisher_stderr
+      File.expand_path("#{execute_publisher_dir}/stderr.log")
+    end
+    
+    def execute_publisher_dir
+      File.expand_path("#{dir}/execute_publisher")
+    end
+  end
+
+  module Publisher
+    class Execute < Base
+      #register self
+    
+      ann :description => "Command line"
+      ann :tip => "Stdout and stderr for the command will be made available on the build page. Don't redirect streams."
+      attr_accessor :command_line
+
+      ann :description => "Directory"
+      ann :tip => "Relative directory (under checkout directory) where the command will be executed."
+      attr_accessor :command_line
+
+      def initialize
+        @command_line = "echo \"The build label is $DAMAGECONTROL_BUILD_LABEL\""
+      end
+
+      def name
+        "Execute"
+      end    
+
+      def publish(build)
+        FileUtils.mkdir_p(build.execute_publisher_dir)
+        safer_popen("{@command_line} > \"#{build.execute_publisher_stdout}\" 2> \"#{build.execute_publisher_stderr}\"") do |io|
+          io.read
+        end
+      end
+    end
+  end
+end

data/lib/damagecontrol/publisher/ftp.rb

@@ -0,0 +1,16 @@
+require 'damagecontrol/publisher/base'
+
+module DamageControl
+  module Publisher
+    class Execute < Base
+      #register self
+    
+      def name
+        "Execute"
+      end    
+
+      def publish(build)
+      end
+    end
+  end
+end

data/lib/damagecontrol/publisher/growl.rb

@@ -0,0 +1,44 @@
+require 'damagecontrol/publisher/base'
+require 'ruby-growl'
+
+module DamageControl
+  module Publisher
+    class Growl < Base
+      register self
+    
+      NOTIFICATION_TYPES = ["Build Successful", "Build Failed"] unless defined? NOTIFICATION_TYPES
+    
+      ann :description => "Hosts", :tip => "Comma-separated list of (OS X) hosts that will receive Growl notifications. Requires Growl 0.6 or later."
+      attr_reader :hosts
+
+      def initialize
+        @hosts = "localhost"
+      end
+
+      def name
+        "Growl"
+      end    
+
+      def publish(build)
+        message = nil
+        index = nil
+        if(build.successful?)
+          message = "#{build.status_message} build (by #{build.changeset.developer})"
+          index = 0
+        else
+          message = "#{build.changeset.developer} broke the build"
+          index = 1
+        end
+        @hosts.split(%r{,\s*}).each do |host|
+          begin
+            g = ::Growl.new(host, "DamageControl (#{build.project.name})", NOTIFICATION_TYPES)
+            # A bug in Ruby-Growl (or Growl) prevents the message from being sticky.
+            g.notify(NOTIFICATION_TYPES[index], build.project.name, message, 0, true)
+          rescue Exception => e
+            Log.info("Growl publisher failed to notify #{host}: #{e.message}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/damagecontrol/publisher/irc.rb

@@ -0,0 +1,31 @@
+require 'damagecontrol/publisher/base'
+
+module DamageControl
+  module Publisher
+    class Irc < Base
+      #register self
+    
+      ann :description => "IRC server"
+      attr_reader :server
+
+      ann :description => "IRC notification channel"
+      attr_reader :channel
+
+      ann :description => "DamageControl's IRC nick"
+      attr_reader :nick
+    
+      def initialize
+        @server = "irc.codehaus.org"
+        @channel = "#xxxxxx"
+        @nick = "dcontrol"
+      end
+
+      def name
+        "IRC"
+      end    
+
+      def publish(build)
+      end
+    end
+  end
+end

data/lib/damagecontrol/publisher/jabber.rb

@@ -0,0 +1,68 @@
+require 'damagecontrol/publisher/base'
+require 'jabber4r/jabber4r'
+
+
+module DamageControl
+  module Publisher
+    class Jabber < Base
+      register self
+
+      ann :description => "DamageControl Jabber Id/Resource"
+      attr_reader :id_resource
+
+      ann :description => "DamageControl Jabber Password"
+      attr_reader :password
+
+      ann :description => "DamageControl's Friends"
+      attr_reader :friends
+
+      def initialize
+        @id_resource = "damagecontrol@jabber.codehaus.org/damagecontrol"
+        @friends = "aslak@jabber.codehaus.org"
+      end
+    
+      def name
+        "Jabber"
+      end
+
+      def publish(build)
+        session = nil
+        begin
+          session = login
+          message = nil
+          if(build.successful?)
+            message = "#{build.project.name}: #{build.status_message} build (by #{build.changeset.developer})"
+          else
+            message = "#{build.project.name}: #{build.changeset.developer} broke the build"
+          end
+          @friends.split(%r{,\s*}).each do |friend|
+            begin
+              session.new_message(friend).set_subject(message).set_body(message).send
+            rescue Exception => e
+              Log.error "Failed to send Jabber message to #{friend}"
+            end
+          end
+        ensure
+          session.release if session
+        end
+      end
+      
+    private
+
+      # Logs in and tries to register (and log in again) if login fails
+      def login(register_if_login_fails=true)
+        begin
+          session = ::Jabber::Session.bind(@id_resource, @password)
+        rescue
+          if(register_if_login_fails)
+            if(::Jabber::Session.register(@id_resource, @password))
+              login(false)
+            else
+              raise "Failed to register #{@id_resource}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/damagecontrol/publisher/scp.rb

@@ -0,0 +1,16 @@
+require 'damagecontrol/publisher/base'
+
+module DamageControl
+  module Publisher
+    class Execute < Base
+      #register self
+    
+      def name
+        "Execute"
+      end    
+
+      def publish(build)
+      end
+    end
+  end
+end

data/lib/damagecontrol/publisher/x10cm11a.rb

@@ -0,0 +1,17 @@
+require 'damagecontrol/publisher/base'
+
+# http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/124460
+module DamageControl
+  module Publisher
+    class X10Cm11A < Base
+      #register self
+    
+      def name
+        "X10-CM11A"
+      end    
+
+      def publish(build)
+      end
+    end
+  end
+end

data/lib/damagecontrol/publisher/x10cm17a.rb

@@ -0,0 +1,17 @@
+require 'damagecontrol/publisher/base'
+
+# http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/124460
+module DamageControl
+  module Publisher
+    class X10Cm17A < Base
+      #register self
+    
+      def name
+        "X10-CM17A"
+      end    
+
+      def publish(build)
+      end
+    end
+  end
+end

data/lib/damagecontrol/publisher/yahoo.rb

@@ -0,0 +1,16 @@
+require 'damagecontrol/publisher/base'
+
+module DamageControl
+  module Publisher
+    class Yahoo < Base
+      #register self
+    
+      def name
+        "Yahoo"
+      end    
+
+      def publish(build)
+      end
+    end
+  end
+end

data/lib/damagecontrol/standard_persister.rb

@@ -33,9 +33,9 @@ module DamageControl
         File.open(project.changesets_rss_file, "w") do |io|
           rss_writer = DamageControl::Visitor::RssWriter.new(
             rss,
-            "Changesets for #{@name}",
+            "Changesets for #{project.name}",
             "http://localhost:4712/", # TODO point to web version of changeset
-            project.description, 
+            project.name, 
             project.tracker || Tracker::Null.new, 
             project.scm_web || SCMWeb::Null.new        
           )

data/lib/damagecontrol/tracker.rb

@@ -1,4 +1,5 @@
 require 'rscm/path_converter'
+require 'rscm/annotations'
 
 module DamageControl
   module Tracker
@@ -6,12 +7,23 @@ module DamageControl
     # Simple superclass so we can easily include mixins
     # for all subclasses in one fell swoop.
     class Base #:nodoc:
+      @@classes = []
+      def self.register(cls) 
+        @@classes << cls unless @@classes.index(cls)
+      end
+      
+      def self.classes
+        @@classes
+      end
+
       def htmlize(str)
         str.gsub(/\n/, "<br>")
       end
     end
 
     class Null < Base
+      register self
+    
       def name
         "No Tracker"
       end
@@ -27,9 +39,12 @@ module DamageControl
     end
 
     class Bugzilla < Base
+      register self
+
+      ann :description => "Bugzilla URL", :tip => "The URL of the Bugzilla installation."
       attr_accessor :url
 
-      def initialize(url=nil)
+      def initialize(url="http://bugzilla.org/")
         @url = url
       end
       
@@ -48,9 +63,12 @@ module DamageControl
     end
     
     class Trac < Base
+      register self
+
+      ann :description => "Trac URL", :tip => "The URL of the Trac installation. This URL should include no trailing slash. Example: http://my.trac.home/cgi-bin/trac.cgi"
       attr_accessor :url
 
-      def initialize(url=nil)
+      def initialize(url="http://trac.org/")
         @url = url
       end
       
@@ -69,10 +87,15 @@ module DamageControl
     end
 
     class JIRA < Base
+      register self
+
+      ann :description => "Base URL", :tip => "The base URL of the JIRA installation (not the URL to the specific JIRA project)."
       attr_accessor :baseurl
+
+      ann :description => "Project id", :tip => "The id of the project - example: 'DC'"
       attr_accessor :project_id
 
-      def initialize(baseurl=nil, project_id=nil)
+      def initialize(baseurl="http://jira.codehaus.org/", project_id="")
         @baseurl, @project_id = baseurl, project_id
       end
 
@@ -95,12 +118,19 @@ module DamageControl
     end
 
     class SourceForge < Base
+      register self
+
       PATTERN = /#([0-9]+)/
     
+      ann :description => "Project id"
+      ann :tip => "The id of the project (group_id). Example: <br><tt>http://sourceforge.net/tracker/index.php?func=detail&amp;aid=1051927&amp;group_id=<strong>7856</strong>&amp;atid=107856</tt>"
       attr_accessor :group_id
+
+      ann :description => "Tracker id"
+      ann :tip => "The id of the tracker (aid). Example: <br><tt>http://sourceforge.net/tracker/index.php?func=detail&amp;aid=<strong>1051927</strong>&amp;group_id=7856&amp;atid=107856</tt>."
       attr_accessor :tracker_id
 
-      def initialize(group_id=nil, tracker_id=nil)
+      def initialize(group_id="", tracker_id="")
         @group_id, @tracker_id = group_id, tracker_id
       end
 
@@ -118,8 +148,15 @@ module DamageControl
     end
 
     class RubyForge < SourceForge
+      register self
+
+      ann :description => "Project id"
+      ann :tip => "The id of the project (group_id). Example: <br><tt>http://rubyforge.org/tracker/index.php?func=detail&amp;aid=1120&amp;group_id=<strong>426</strong>&amp;atid=1698</tt>."
+      attr_accessor :group_id
 
-      # TODO: share the same rhtml template
+      ann :description => "Tracker id"
+      ann :tip => "The id of the tracker (aid). Example: <br><tt>http://rubyforge.org/tracker/index.php?func=detail&amp;aid=<strong>1120</strong>&amp;group_id=426&amp;atid=1698</tt>."
+      attr_accessor :tracker_id
 
       def name
         "RubyForge"
@@ -135,10 +172,15 @@ module DamageControl
     end
 
     class Scarab < Base
+      register self
+
+      ann :description => "Base URL", :tip => "The URL of the Scarab installation."
       attr_accessor :baseurl
+
+      ann :description => "Scarab Module", :tip => "The Scarab Module key."
       attr_accessor :module_key
 
-      def initialize(baseurl=nil, module_key=nil)
+      def initialize(baseurl="http://scarab.org/", module_key="")
         @baseurl, @module_key = baseurl, module_key
       end