CapistranoTrac 0.5.0

data/History.txt

@@ -0,0 +1,6 @@
+== 0.5.0 / 2007-10-04
+
+* First release
+  * Automated Trac notifications for deployment and rollback
+  * Currently no formal testing, since I'm yet to get to grips with properly testing capistrano recipes
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/capistrano_trac.rb
+lib/capistrano_trac/recipes.rb
+test/test_capistrano_trac.rb

data/README.txt

@@ -0,0 +1,68 @@
+CapistranoTrac
+    by HandleIT
+    http://handle.it
+
+== DESCRIPTION:
+  
+  The capistrano_trac library provides capistrano tasks to interact with a project's Trac site.
+  
+  Currently, the library simply provides 2 tasks for recording deployments and rollbacks of code related to tickets. This is done by parsing the SVN log between deployed revisions, looking for Trac formatted references to tickets (e.g. #70), and appending a comment to the tickets, recording the deployment/rollback.
+
+== FEATURES/PROBLEMS:
+  
+  * Failure is incredibly ungraceful, though generally unlikely, given that the requirements for accessing the Trac site are roughly the same as those for accessing the repository.
+  * Currently, the trac user/pass must be the same as the SCM user/pass. It remains to be seen how much of a problem this will be.
+  
+== SYNOPSIS:
+  
+  Include the recipes:
+    require 'capistrano_trac/recipes'
+  
+  For the trac tasks to work, the :trac_url variable must be set to the root of your trac site.
+  For example:
+    set :trac_url, "http://www.yourtrachost/trac/yourproject"
+  
+  The 2 trac ticketing tasks are designed to be run in conjunction with a deployment or rollback, although this isn't mandatory.
+  
+  To automatically document deployments and rollbacks in your capistrano deployment, add the lines:
+  
+  * after "deploy", "trac:record_deployment"
+  * before "deploy:rollback", "trac:record_rollback"
+  
+  Order is important, otherwise the tasks will be looking at the wrong revisions.
+  
+  To manually record changes, simply run the record_deployment task to document the most recent deployment changes, or the record_rollback task to document a rollback that is about to be run.
+  
+== REQUIREMENTS:
+  
+* capistrano >= 2.0.0
+* mechanize >= 0.6.10
+  
+== INSTALL:
+  
+* sudo gem install capistrano_trac
+  
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 FIX
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'hoe'
+require './lib/capistrano_trac.rb'
+
+Hoe.new('CapistranoTrac', CapistranoTrac::VERSION) do |p|
+  p.rubyforge_name = 'capistrano_trac'
+  p.author = 'HandleIT'
+  p.email = 'support@handle.it'
+  p.summary = 'A collection of Trac related Capistrano tasks'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = 'http://handle.rubyforge.org'
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.extra_deps << ['mechanize', '>= 0.6.10']
+end
+

data/lib/capistrano_trac.rb

@@ -0,0 +1,3 @@
+module CapistranoTrac
+  VERSION = '0.5.0'
+end

data/lib/capistrano_trac/recipes.rb

@@ -0,0 +1,101 @@
+require 'capistrano'
+require 'net/https'
+require 'mechanize'
+
+module CapistranoTrac
+  configuration = Capistrano::Configuration.respond_to?( :instance ) ?
+    Capistrano::Configuration.instance( :must_exist ) :
+    Capistrano.configuration( :must_exist )
+
+  configuration.load do
+    namespace :trac do
+      # Sets up the Mechanize agent
+      # and logs in to Trac
+      def trac_setup
+        # Prepare the mechanize agent
+        agent = WWW::Mechanize.new
+        agent.user_agent_alias = 'Mac Safari'
+        agent.basic_auth( scm_username, scm_password )
+        # Log in to the Trac site
+        agent.get( trac_url + '/login' )
+        return agent
+      end
+
+      # Appends a comment to a given ticket in the Trac system
+      def append_comment( ticket_num, comment )
+        agent = trac_setup
+        # Grab ticket page
+        ticket_page = agent.get( "#{ trac_url }/ticket/#{ ticket_num }" )
+        # Find comment form on page
+        comment_form = ticket_page.forms.with.action( "#{ URI.parse( trac_url ).path }/ticket/#{ ticket_num }#preview" ).first
+        # Enter comment on form
+        comment_field = comment_form.fields.with.name( 'comment' ).first
+        comment_field.value = comment
+        # Submit with button that commits the comment rather than the preview button
+        comment_form.submit( comment_form.buttons.with.value( 'Submit changes' ).first )
+      end
+
+      # Returns a Trac formatted link to a range of log messages
+      def log_range_link( rev_path, start_rev, end_rev )
+        "log:#{ rev_path }@#{ start_rev }:#{ end_rev }"
+      end
+
+      # Finds the root of the repository cap is deploying from
+      def repository_root( repo_url )
+        svn_info = `svn info #{ repo_url }`
+        YAML.load( svn_info )['Repository Root']
+      end
+
+      # Finds the path within the repository that leads to the base of the app being deployed
+      def repository_path( repo_url )
+        repo_url.sub( repository_root( repo_url ), '' )
+      end
+
+      # Determines the current deployment stage.
+      # Works in both multistage and vanilla cap.
+      def deployment_stage
+        if exists?( :stage )
+          stage
+        elsif exists?( :default_stage )
+          default_stage
+        else
+          "production"
+        end
+      end
+
+      # Finds all the ticket numbers ( in Trac format ) mentioned in the log messages
+      # between two changesets.
+      def ticket_numbers( old_rev, new_rev )
+        # Get all log messages between the previous and current revisions
+        # skip over the previous revision to avoid comments for last deployed revision
+        svn_log = `svn log #{ repository } -r #{ old_rev.to_i + 1 }:#{ new_rev }`
+        # Process log, recording instances of tickets mentioned in trac format ( #n )
+        ( svn_log.scan(/\B#(\d+)\b/).collect { |match| match.first } ).uniq
+      end
+
+      desc "Appends deployment comment to the end of all trac tickets resolved by the latest deployment"
+      task :record_deployment, :roles => :app do
+        # Set previous revision to 0 if no previous revision ( i.e. first deployment )
+        set( :previous_revision, '0' ) unless releases.length > 1
+        # Check if there are actually any changesets deployed, return if not
+        return unless ( previous_revision.to_i + 1 ) < latest_revision.to_i
+        # Append a comment to each affected ticket
+        ticket_numbers( previous_revision, latest_revision ).each do |ticket|
+          comment_text = "Deployed #{ log_range_link( repository_path( repository ), previous_revision, latest_revision ) } to #{ deployment_stage } at #{ Time.now.to_s }"
+          append_comment( ticket, comment_text )
+        end
+      end
+
+      desc "Appends rollback comments to all trac tickets resolved by the last rolled back deployment"
+      task :record_rollback, :roles => :app do
+        # Bail if nothing to roll back to
+        return unless releases.length > 1
+        # Append a comment to each affected ticket
+        ticket_numbers( previous_revision, latest_revision ).each do |ticket|
+          comment_text = "Rolled back #{ log_range_link( repository_path( repository ), previous_revision, latest_revision ) } in #{ deployment_stage } at #{ Time.now.to_s }"
+          append_comment( ticket, comment_text )
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: CapistranoTrac
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+date: 2007-10-04 00:00:00 +10:00
+summary: A collection of Trac related Capistrano tasks
+require_paths: 
+- lib
+email: support@handle.it
+homepage: http://handle.rubyforge.org
+rubyforge_project: capistrano_trac
+description: "== FEATURES/PROBLEMS:  * Failure is incredibly ungraceful, though generally unlikely, given that the requirements for accessing the Trac site are roughly the same as those for accessing the repository. * Currently, the trac user/pass must be the same as the SCM user/pass. It remains to be seen how much of a problem this will be.  == SYNOPSIS:  Include the recipes: require 'capistrano_trac/recipes'  For the trac tasks to work, the :trac_url variable must be set to the root of your trac site. For example: set :trac_url, \"http://www.yourtrachost/trac/yourproject\"  The 2 trac ticketing tasks are designed to be run in conjunction with a deployment or rollback, although this isn't mandatory.  To automatically document deployments and rollbacks in your capistrano deployment, add the lines:  * after \"deploy\", \"trac:record_deployment\" * before \"deploy:rollback\", \"trac:record_rollback\"  Order is important, otherwise the tasks will be looking at the wrong revisions.  To manually record changes, simply run the record_deployment task to document the most recent deployment changes, or the record_rollback task to document a rollback that is about to be run.  == REQUIREMENTS:  * capistrano >= 2.0.0 * mechanize >= 0.6.10  == INSTALL:  * sudo gem install capistrano_trac  == LICENSE:  (The MIT License)  Copyright (c) 2007 FIX  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- HandleIT
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/capistrano_trac.rb
+- lib/capistrano_trac/recipes.rb
+- test/test_capistrano_trac.rb
+test_files: 
+- test/test_capistrano_trac.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.10
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: