damagecontrol 0.5.0

data/README

@@ -0,0 +1,75 @@
+= DamageControl - a cross platform continuous integration server.
+
+= Feature overview
+
+* Supports all SCMs supported by RSCM.
+* Web interface based on RoR (http://www.rubyonrails.org/)
+* Colourised HTML diffs.
+* RSS feeds for changesets and builds.
+* Generation of URL links to diffs for several popular SCM web front-ends.
+* Generation of URL links to bugs/issues for several popular bug/issue trackers.
+* Uses UTC times according to the SCM server's clock, not the machine running RSCM. No NTP needed!
+
+== DamageControl Server
+
+DamageControl ships with a web app based on Ruby On Rails (which you currently have to install separately). To launch:
+
+  ruby script/server
+  
+You also need to launch (in a separate console) the DamageControl daemon process:
+
+  ruby -Ilib lib/damagecontrol/server.rb
+  
+The daemon process is the core of DamageContriol that performs SCM access and executes builds. The web app communicates with this process over Drb to display results. 
+
+The reason why two processes are needed is due to the fact that Dir.chdir may happen in various threads,
+which would confuse the webapp if they ran in the same Ruby process. We tried with forking, but this is not 
+supported on Windows. We may support a fork-based one-process alternative for Linux/Cygwin in the future.
+
+Once the two servers are started, you can access the web app on:
+
+  http://localhost:4712/
+
+== Colourised HTML diffs
+
+The web interface will present changesets as colourised diffs. Even for SCMs you never thought would support
+that kind of feature. (As long as there is an RSCM plugin for it).
+
+== RSS Support
+
+The DamageControl daemon can generate RSS feeds for all supported SCMs. The RSS feeds will have one item per changeset.
+Each RSS item's description contains the changeset's commit message, optionally with HTML links to
+issue/bug tracker issues (if detected in the changeset's commit message). The item's description
+will also contain a list of all the modified files, optionally with HTML links to a diff page
+in an SCM web front-end.
+
+== Supported Issue trackers
+
+DamageControl can recognise bug/issue numbers (in commit messages) for a number of popular issue 
+tracking systems. It converts the SCM commit message to HTML with links to the issues mentioned in the commit message.
+
+* Bugzilla - http://www.bugzilla.org/
+* JIRA - http://www.atlassian.com/software/jira/
+* RubyForge - http://rubyforge.org/
+* Scarab - http://scarab.tigris.org/
+* SourceForge - http://sourceforge.net/
+* Trac - http://www.edgewall.com/trac/
+
+Planned:
+
+* RT - http://fsck.com/projects/rt/
+
+== SCM web front-ends - diffs
+
+DamageControl's web interface features colourised diffs for all changes in a changeset.
+It can also generate links to individual diff pages in other SCM web frontends:
+
+* RSCM Built-in HTML diffs.
+* Fisheye - http://www.cenqua.com/fisheye/
+* ViewCVS - http://viewcvs.sourceforge.net/
+
+Planned:
+
+* Trac - http://www.edgewall.com/trac/
+* Chora - http://horde.org/chora/
+

data/README.license

@@ -0,0 +1,5 @@
+This software consists of parts that are covered by different licenses.
+See the following locations for details:
+
+* public/licenses directories.
+* public/images/README.license

data/Rakefile

@@ -0,0 +1,111 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+
+PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
+PKG_NAME      = 'damagecontrol'
+PKG_VERSION   = '0.5.0' + PKG_BUILD
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+desc "Default Task"
+task :default => [ :all ]
+
+# Run the unit tests
+# To run a specific test: rake test TEST=path/to/test
+fl = FileList.new('test/**/*_test.rb')
+# TODO: figure out how to add all the stuff in app.
+Rake::TestTask.new { |t|
+  # We need some of the test utils from rscm
+  t.libs << "test" << File.expand_path(File.dirname(__FILE__) + "/../rscm/test") << File.expand_path(File.dirname(__FILE__) + "/../rscm/lib")
+  t.test_files = fl
+  t.verbose = true
+}
+
+rd = Rake::RDocTask.new { |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'DamageControl - Cross platform Continuous Integration server'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('docs/**/*.rd')
+}
+
+task :all => [:gem]
+
+PKG_FILES = FileList[
+  '[A-Z]*',
+  'doc/**/*',
+  'bin/**/*',
+  'app/**/*',
+  'config/**/*',
+  'docs/**/*',
+  'lib/**/*', 
+  'public/**/*',
+  'script/**/*',
+  'test/**/*'
+]
+
+if ! defined?(Gem)
+  puts "Package Target requires RubyGEMs"
+else
+  spec = Gem::Specification.new do |s|
+    
+    #### Basic information.
+
+    s.name = 'damagecontrol'
+    s.version = PKG_VERSION
+    s.summary = "DamageControl"
+    s.description = <<-EOF
+      DamageControl.
+    EOF
+
+    #### Dependencies and requirements.
+
+    s.add_dependency('log4r', '> 1.0.4')
+    s.add_dependency('rscm')
+    s.add_dependency('needle')
+#    s.add_dependency('rgl')
+    #s.requirements << ""
+
+    #### Which files are to be included in this gem?  Everything!  (Except CVS directories.)
+
+    s.files = PKG_FILES.to_a
+
+    #### C code extensions.
+
+    #s.extensions << "ext/rmagic/extconf.rb"
+
+    #### Load-time details: library and application (you will need one or both).
+
+    s.require_path = 'lib'                         # Use these for libraries.
+    s.autorequire = 'damagecontrol/app'
+
+    s.bindir = "bin"                               # Use these for applications.
+    s.executables = ["damagecontrol", "damagecontrol-webrick"]
+    s.default_executable = "damagecontrol"
+
+    #### Documentation and testing.
+
+    s.has_rdoc = true
+    s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
+    rd.options.each do |op|
+      s.rdoc_options << op
+    end
+
+    #### Author and project details.
+
+    s.author = "Aslak Hellesoy"
+    s.email = "dev@damagecontrol.codehaus.org"
+    s.homepage = "http://damagecontrol.codehaus.org/"
+#    s.rubyforge_project = "rscm"
+  end
+
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_zip = true
+    pkg.need_tar = true
+  end
+end

data/app/controllers/admin_controller.rb

@@ -0,0 +1,10 @@
+#require 'rscm'
+#require 'rscm/tracker'
+
+class AdminController < ApplicationController
+
+  def new_project
+    redirect_to(:controller => "project", :action => "view")
+  end
+
+end

data/app/controllers/application.rb

@@ -0,0 +1,163 @@
+# The filters added to this controller will be run for all controllers in the application.
+# Likewise will all the methods added be available for all controllers.
+
+require 'rubygems'
+require_gem 'rscm'
+require 'damagecontrol/project'
+require 'damagecontrol/build'
+require 'damagecontrol/tracker'
+require 'damagecontrol/scm_web'
+
+# Start Drb - this is how we communicate with the daemon.
+DRb.start_service()
+Rscm = DRbObject.new(nil, 'druby://localhost:9000')
+
+class ApplicationController < ActionController::Base
+
+  layout 'rscm'
+
+  def initialize
+    @sidebar_links = [
+      {
+        :controller => "project", 
+        :action     => "new", 
+        :image      => "/images/24x24/box_new.png",
+        :name       => "New project"
+      }
+    ]
+    @controller = self
+  end
+
+  # Loads the project specified by the +id+ parameter and places it into the @project variable  
+  def load_project
+    project_name = @params["id"]
+    @project = DamageControl::Project.load(project_name)
+  end
+
+  def breadcrumbs
+    subpaths = @request.path.split(/\//)
+#    subpaths.collect { |p| link_to_unless_current(p) }.links.join(" ")
+  end
+  
+protected
+
+  # Sets the links to display in the sidebar. Override this method in other controllers
+  # To change what to display.
+  def set_sidebar_links
+
+  end
+  
+end
+
+module ActionView
+  module Helpers
+    module UrlHelper
+      # Modify the original behaviour of +link_to+ so that the link
+      # includes the client's timezone as URL param +timezone+ in the request.
+      # Can be used by server to adjust formatting of UTC dates so they match the client's time zone.
+      def convert_confirm_option_to_javascript!(html_options)
+        # We're adding this JS call to add the timezone info as a URL param.
+        html_options["onclick"] = "intercept(this);"
+        if html_options.include?(:confirm)
+          html_options["onclick"] += "return confirm('#{html_options[:confirm]}');"
+          html_options.delete(:confirm)
+        end
+      end
+    end
+  end
+  
+  class Base
+    def text_or_input(input, options)
+      if(input)
+        options[:class] = "setting-input" unless options[:class]
+        tag("input", options)
+      elsif(options[:value] =~ /^http?:\/\//)
+        content_tag("a", options[:value], "href" => options[:value])
+      else
+        options[:value]
+      end
+    end
+    
+    def text_or_select(input, options)
+      values = options.delete(:values)
+      if(input)
+        options[:class] = "setting-input" unless options[:class]
+        
+        option_tags = ""
+        values.each do |value|
+          option_attrs = {:value => value.class.name}
+          option_attrs[:selected] = "true" if value.selected?
+          option_tag = content_tag("option", value.name, option_attrs)
+          option_tags << option_tag
+        end
+        content_tag("select", option_tags, options)
+      else
+        values.find {|v| v.selected?}.name
+      end
+    end
+    
+    # Creates an image with a tooltip that will show on mouseover.
+    #
+    # Options:
+    # * <tt>:txt</tt> - The text to put in the tooltip. Can be HTML.
+    # * <tt>:img</tt> - The image to display on the page. Defaults to '/images/16x16/about.png'
+    def tip(options)
+      tip = options.delete(:txt)
+      options[:src] = options.delete(:img) || "/images/16x16/about.png"
+      options[:onmouseover] = "Tooltip.show(event,#{tip})"
+      options[:onmouseout] = "Tooltip.hide()"
+
+      tag("img", options)
+    end
+  end
+end
+
+module DamageControl
+
+  # Add some generic web capabilities to the RSCM classes
+  module Web
+    module Configuration
+
+      def selected?
+        false
+      end
+
+      # Returns the short lowercase name. Used for javascript and render_partial.
+      def short
+        $1.downcase if self.class.name =~ /.*::(.*)/
+      end
+
+    end
+  end
+end
+
+class RSCM::AbstractSCM
+  include DamageControl::Web::Configuration
+end
+
+class DamageControl::Tracker::Base
+  include DamageControl::Web::Configuration
+end
+
+class DamageControl::Project
+  include DamageControl::Web::Configuration
+end
+
+class DamageControl::Build
+  def small_image
+    exit_code == 0 ? "/images/green-16.gif" : "/images/red-16.gif"
+  end
+end
+
+class RSCM::Change
+  ICONS = {
+    MODIFIED => "/images/16x16/document_edit.png",
+    DELETED => "/images/16x16/document_delete.png",
+    ADDED => "/images/16x16/document_add.png",
+    MOVED => "/images/16x16/document_exchange.png",
+  }
+    
+  def icon
+    ICONS[@status] || "/images/16x16/document_warning.png"
+  end
+end

data/app/controllers/files_controller.rb

@@ -0,0 +1,19 @@
+require 'rscm/directories'
+
+class FilesController < ApplicationController
+
+  def list
+    load_project
+    
+    root = @project.checkout_dir
+    relative_path = @params['path']
+    absolute_path = relative_path ? "#{root}/#{relative_path}" : root
+    if(File.file?(absolute_path))
+      # TODO: use http://rubyforge.org/projects/syntax/
+      # TODO: the file contents should be rendered within the regular layout
+      render_text(File.open(absolute_path).read)
+    else
+      @relative_paths = Dir["#{absolute_path}/*"].collect {|f| f[root.length+1..-1]}
+    end
+  end
+end

data/app/controllers/project_controller.rb

@@ -0,0 +1,284 @@
+require 'rscm'
+require 'damagecontrol/project'
+require 'damagecontrol/directories'
+require 'damagecontrol/diff_parser'
+require 'damagecontrol/diff_htmlizer'
+
+class ProjectController < ApplicationController
+
+  # TODO: check if the various SCMs are installed and disable them with a warning if not.
+  # Each SCM class should have an available? method
+
+  SCMS = [
+# Uncomment this to see Mooky in action in the web interface!
+#    RSCM::Mooky,
+    RSCM::CVS, 
+    RSCM::SVN, 
+    RSCM::StarTeam
+  ]
+
+  TRACKERS = [
+    DamageControl::Tracker::Null, 
+    DamageControl::Tracker::Bugzilla, 
+    DamageControl::Tracker::JIRA,
+    DamageControl::Tracker::RubyForge,
+    DamageControl::Tracker::SourceForge,
+    DamageControl::Tracker::Scarab,
+    DamageControl::Tracker::Trac
+  ]
+
+  SCM_WEBS = [
+#    SCMWeb::Null.new, 
+#    SCMWeb::ViewCVS.new, 
+#    SCMWeb::Fisheye.new
+  ]
+
+  def initialize
+    super
+    @navigation_name = "changesets_list"
+  end
+
+  def index
+    @projects = DamageControl::Project.find_all
+    @navigation_name = "null"
+  end
+
+  def new
+    @project = DamageControl::Project.new
+    @scms = SCMS.collect {|o| o.new}
+    first_scm = @scms[0]
+    def first_scm.selected?
+      true
+    end
+    @trackers = TRACKERS.collect {|o| o.new}
+    first_tracker = @trackers[0]
+    def first_tracker.selected?
+      true
+    end
+    @edit = true
+    @new_project = true
+    render_action("view")
+  end
+
+  def view
+    return render_text("No project specified") unless @params["id"]
+    @edit = false
+    load
+  end
+
+  def edit
+    @edit = true
+    load
+    render_action("view")
+  end
+  
+  def changesets_rss
+    load
+    send_file(@project.changesets_rss_file)
+  end
+
+  def delete
+    load_project
+    begin
+      Rscm.delete_project(project)
+    rescue => e
+      return render_text("Couldn't connect to RSCM server. Please make sure it's running.<br>" + e.message)
+    end
+    index
+  end
+
+  def save
+    project         = instantiate_from_params("project")
+    project.scm     = instantiate_from_params("scm")
+    project.tracker = instantiate_from_params("tracker")
+    
+    begin
+      Rscm.save_project(project)
+    rescue => e
+      $stderr.puts(e.backtrace.join("\n"))
+      return render_text("Couldn't connect to RSCM server. Please make sure it's running.<br>" + e.message)
+    end
+
+    redirect_to(:action => "view", :id => project.name)
+  end
+  
+  def changesets
+    load
+    last_changeset_identifier = @params["changeset"]
+    @changesets = @project.changesets(last_changeset_identifier.to_identifier, 1)    
+    @changesets.accept(HtmlDiffVisitor.new(@project))
+  end
+  
+protected
+
+  # Visitor that adds a method called +html_diff+ to each change
+  class HtmlDiffVisitor
+    def initialize(project)
+      @project = project
+    end
+    
+    def visit_changesets(changesets)
+    end
+
+    def visit_changeset(changeset)
+      @changeset = changeset
+    end
+
+    def visit_change(change)
+      def change.html_diff=(html)
+        @html = html
+      end
+
+      def change.html_diff
+        @html
+      end
+
+      html = ""
+      dp = DamageControl::DiffParser.new
+      diff_file = DamageControl::Directories.diff_file(@project.name, @changeset, change)
+      if(File.exist?(diff_file))
+        File.open(diff_file) do |diffs_io|
+          diffs = dp.parse_diffs(diffs_io)
+          dh = DamageControl::DiffHtmlizer.new(html)
+          diffs.accept(dh)
+          if(html == "")
+            html = "Diff was calculated, but was empty. (This may be a bug - new, moved and binary files and are not supported yet)."
+          end
+        end
+      else
+        html = "Diff not calculated yet."
+      end
+      change.html_diff = html
+    end
+  end
+
+  def set_sidebar_links
+    if(@project.exists?)
+      @sidebar_links << {
+        :controller => "project", 
+        :action     => "edit",
+        :id         => @project.name,
+        :image      => "/images/24x24/wrench.png",
+        :name       => "Edit #{@project.name} settings"
+      }
+    end
+
+#    if(@project.exists?)
+#      @sidebar_links << {
+#        :controller => "project", 
+#        :action     => "delete", 
+#        :id         => @project.name,
+#        :image      => "/images/24x24/box_delete.png",
+#        :name       => "Delete #{@project.name} project"
+#      }
+#    end
+
+    if(@project.exists? && @project.scm && !@project.scm.exists? && @project.scm.can_create?)
+      @sidebar_links << {
+        :controller => "scm", 
+        :action     => "create", 
+        :id         => @project.name,
+        :image      => "/images/24x24/safe_new.png",
+        :name       => "Create #{@project.scm.name} repository"
+      }
+    end
+
+#    if(@project.exists? && !@project.checked_out?)
+#      @sidebar_links << {
+#        :controller => "scm", 
+#        :action     => "checkout", 
+#        :id         => @project.name,
+#        :image      => "/images/24x24/safe_out.png",
+#        :name       => "Check out from #{@project.scm.name}"
+#      }
+#    end
+
+    if(@project.exists? && @project.checked_out?)
+      @sidebar_links << {
+        :controller => "files", 
+        :action     => "list",
+        :id         => @project.name,
+        :image      => "/images/24x24/folders.png",
+        :name       => "Browse working copy"
+      }
+    end
+
+    if(@project.exists? && @project.checked_out?)
+      @sidebar_links << {
+        :controller => "scm", 
+        :action     => "delete_working_copy", 
+        :id         => @project.name,
+        :image      => "/images/24x24/garbage.png",
+        :name       => "Delete working copy"
+      }
+    end
+
+    if(@project.exists?)
+      @sidebar_links << {
+        :href       => @project.tracker.url, 
+        :image      => "/images/24x24/scroll_information.png",
+        :name       => @project.tracker.name
+      }
+    end
+
+    if(@project.exists? && @project.home_page && @project.home_page != "")
+      @sidebar_links << {
+        :href       => @project.home_page, 
+        :image      => "/images/24x24/home.png",
+        :name       => "#{@project.name} home page"
+      }
+    end
+
+    if(@project.changesets_rss_exists?)
+      @sidebar_links << {
+        :controller => "project", 
+        :action     => "changesets_rss", 
+        :id         => @project.name,
+        :image      => "/images/rss.gif",
+        :name       => "Changesets RSS"
+      }
+    end
+
+  end
+
+private
+
+  def load
+    load_project
+
+    scm = @project.scm
+    def scm.selected?
+      true
+    end
+
+    tracker = @project.tracker
+    def tracker.selected?
+      true
+    end
+
+    # Make a dupe of the scm/tracker lists and substitute with project's value
+    @scms = SCMS.collect {|o| o.new}
+    @scms.each_index {|i| @scms[i] = @project.scm if @scms[i].class == @project.scm.class}
+
+    @trackers = TRACKERS.collect {|o| o.new}
+    @trackers.each_index {|i| @trackers[i] = @project.tracker if @trackers[i].class == @project.tracker.class}
+
+    @linkable_changesets = @project.changesets(@project.latest_changeset_identifier, 10)
+    @select_changeset_identifiers = @project.changeset_identifiers[0..-(@linkable_changesets.length+1)]
+
+    set_sidebar_links
+  end
+
+  # Instantiates an object from parameters
+  def instantiate_from_params(param)
+    class_name = @params[param]
+    clazz = eval(class_name)
+    ob = clazz.new
+    attribs = @params[class_name] || {}
+    attribs.each do |k,v|
+      ob.send("#{k}=", v)
+    end
+    ob
+  end
+
+end