ucb_deployer 0.0.1 → 0.0.2

data/Manifest

@@ -1,19 +1,23 @@
+Manifest
 README.txt
 Rakefile
+TODO.txt
 bin/deployer
-cas_web.xml
-lib/confluence_deployer.rb
-spec/build/confluence/lib/soulwing-casclient-x.x.x.jar
-spec/build/confluence/src/confluence/WEB-INF/classes/confluence-init.properties
-spec/build/confluence/src/confluence/WEB-INF/classes/seraph-config.xml
-spec/build/confluence/src/confluence/WEB-INF/lib/postgresql-x.x.x.jar
-spec/build/confluence/src/confluence/WEB-INF/lib/soulwing-casclient-x.x.x.jar
-spec/build/confluence/src/confluence/WEB-INF/web.xml
-spec/confluence_deployer/confluence_deployer_spec.rb
-spec/fixtures/bad_dot_cdeprc
-spec/fixtures/confluence-init.properties
-spec/fixtures/dot_cdeprc
-spec/fixtures/seraph-config.xml
-spec/fixtures/web.xml
+lib/ucb_deployer.rb
+lib/ucb_deployer/confluence_deployer.rb
+lib/ucb_deployer/deployer.rb
+lib/ucb_deployer/jira_deployer.rb
+resources/confluence_cas_web.xml
+resources/jdom.jar
+resources/jira_cas_web.xml
+resources/soulwing-casclient-0.5.3.jar
+spec/fixtures/confluence/bad_deploy.yml
+spec/fixtures/confluence/confluence-init.properties
+spec/fixtures/confluence/deploy.yml
+spec/fixtures/confluence/seraph-config.xml
+spec/fixtures/confluence/web.xml
+spec/fixtures/jira/web.xml
 spec/spec_helper.rb
-Manifest
+spec/ucb_deployer/confluence_deployer_spec.rb
+spec/ucb_deployer/jira_deployer_spec.rb
+spec/ucb_deployer/ucb_deployer_spec.rb

data/README.txt

@@ -0,0 +1,67 @@
+
+= UCB Deployer
+
+UCB Deployer is gem to automate confluence and jira  deployments to Tomcat.
+
+
+== Getting Started
+
+=== Installation
+  gem install ucb_deployer
+
+
+=== Assumptions
+We assume __Jira__ and __Confluence__ both have their own instance of tomcat (their own
+$CATALINA_HOME). For more information on this type of setup see:
+
+http://wikihub.berkeley.edu/x/RQAnAg
+
+We also assume the following __config/__ file is setup for each app:
+
+$HOME/config/confluence/deploy.yml
+$HOME/config/jira/deploy.yml
+
+Where $HOME is the home directory of the user that will be doing the deployments:
+we are using a special user __app_relmgt__ for this purpose.
+
+=== Configuration
+
+The deploy.yml files for __Jira__ and __Confluence__ both accept the following options:
+
+* build_dir
+* deploy_dir
+* war_name
+* cas_service_url
+* cas_server_url
+* data_dir
+* svn_username            
+* svn_project_url
+
+Assuming we had the following directories setup:
+  # where we deploy from
+  $HOME=/home/app_relmgt
+
+  # where we run jira (confluence would have it's own dir: /var/lib/confluence)
+  $JIRA_HOME=/var/lib/jira
+
+  $HOME/build/jira/src
+  $HOME/build/jira/lib
+
+Our __deploy.yml__ file would look like so:
+
+  build_dir: /home/app_relmgt/build
+  deploy_dir: /var/lib/jira/tomcat5/webapps
+  war_name: ROOT
+  cas_server_url: http://cas-server.berkeley.edu
+  cas_service_url: https://wikihub.berkeley.edu
+  data_dir: /var/lib/jira/data
+  svn_username: app_relmgt
+  svn_project_url: svn.berkeley.edu/svn/ist-svn/berkeley/projects/ist/as/webapps/jira_archives/tags
+
+
+== Usage
+  deployer jira VERSION=x.x.x
+
+or
+
+  deployer confluence VERSION=x.x.x

data/Rakefile

@@ -3,15 +3,13 @@ require 'rake'
 require 'echoe'
 require 'spec/rake/spectask'
 
-Echoe.new('ucb_deployer', '0.0.1') do |p|
+Echoe.new('ucb_deployer', '0.0.2') do |p|
   p.description    = "Tool for deploying java applications"
   p.url            = "http://ucbrb.rubyforge.org"
   p.author         = "Steven Hansen"
   p.email          = "runner@berkeley.edu"
-  p.ignore_pattern = ["svn_user.yml", "svn_project.rake"]
   p.project = "ucbrb"
   p.rdoc_pattern = "README.txt", "lib/**/**"
-#   p.rdoc_options = "-o doc --inline-source -T hanna lib/*.rb" 
 end
  
 desc "Run RSpec tests"

data/TODO.txt

@@ -0,0 +1,5 @@
+* add "clean" task to remove previous build dirs, files, etc
+
+* Don't needlessly download source from svn everytime.  If source for requested version has
+already been pulled down to the filesystem, reuse it.
+

data/bin/deployer

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 require 'rake'
-require 'confluence_deployer'
+require 'deployer'
 
 Rake.application.init("deployer")
 
@@ -21,14 +21,15 @@ task :export => [:init] do
 end
 
 task :init => [:check_usage] do
-  # @deployer = Deployer.factory(:confluence)
-  @deployer = ConfluenceDeployer.new()
+  @deployer = UcbDeployer.factory(ENV["APP"])
   @deployer.version = ENV["VERSION"]
 end
 
 task :check_usage do
-  if ENV["VERSION"].nil?
-    $stderr.puts("Usage: rake deploy VERSION=x.x.x")
+  usage = "Usage: deployer APP=<confluence|jira> VERSION=x.x.x"
+  
+  if !(ENV["APP"] && ENV["VERSION"] && [:confluence, :jira].include?(ENV["APP"].to_sym))
+    $stderr.puts(usage)
     exit(1)
   end
 end

data/lib/ucb_deployer/confluence_deployer.rb

@@ -0,0 +1,150 @@
+
+module UcbDeployer
+  class ConfluenceDeployer < Deployer
+    
+    def initialize(config_file = "#{ENV['HOME']}/config/confluence/deploy.yml")
+      FileUtils.touch(config_file) if !File.exists?(config_file)
+      load_config(config_file)
+    end
+    
+    def export()
+      UcbDeployer.debug("Exporting from: #{svn_project_url}")
+      pwd = Dir.getwd
+      Dir.chdir("#{build_dir}")
+      FileUtils.rm_rf("#{build_dir}/src")
+      `svn export svn+ssh://#{svn_username}@#{svn_project_url}/confluence-#{version}`
+      FileUtils.mv("confluence-#{version}", "src")
+      Dir.chdir(pwd)
+      $stdout.puts("Export Completed")
+    end
+    
+    def configure
+      config_web_xml
+      config_seraph_config_xml
+      config_confluence_init_properties
+      reshuffle_jars
+    end
+
+    def build
+      pwd = Dir.getwd
+      Dir.chdir("#{build_dir}/src")
+      exec("sh #{build_dir}/src/build.sh")
+      Dir.chdir(pwd)    
+    end
+
+    def deploy
+      display_maintenance_file
+      FileUtils.rm_rf(Dir["#{deploy_dir}/#{war_name}*"])
+      FileUtils.mkdir("#{deploy_dir}/#{war_name}")    
+      FileUtils.cp(Dir["#{build_dir}/src/dist/*.war"], "#{deploy_dir}/#{war_name}")
+      exec("jar -xvf #{deploy_dir}/#{war_name}/#{war_name}.war")
+      FileUtils.rm("#{deploy_dir}/#{war_name}/#{war_name}.war")
+    end
+
+    def rollback
+    end
+
+    def svn_username
+      @svn_username || "app_relmgt"
+    end
+    
+    def svn_base_url
+      @svn_base_url || "svn.berkeley.edu/svn/ist-svn/berkeley/projects/ist/as/webapps/confluence_archives"
+    end
+    
+    ##
+    # Shortcut to confluence web.xml file
+    #
+    def web_xml()
+      "#{build_dir}/src/confluence/WEB-INF/web.xml"
+    end
+    
+    ##
+    # Shortcut to confluence seraph-config.xml file
+    #
+    def seraph_config_xml()
+      "#{build_dir}/src/confluence/WEB-INF/classes/seraph-config.xml"
+    end
+    
+    ##
+    # Shortcut to confluence confluence-init.properties file
+    #
+    def confluence_init_properties()
+      "#{build_dir}/src/confluence/WEB-INF/classes/confluence-init.properties"
+    end
+    
+    def web_xml_token()
+      "<!-- Uncomment the following to disable the space export long running task. -->"
+    end
+    
+    def seraph_config_xml_token()
+      "com.atlassian.confluence.user.ConfluenceAuthenticator"
+    end
+    
+    def cas_authenticator_class()
+      "org.soulwing.cas.apps.atlassian.ConfluenceCasAuthenticator"
+    end
+    
+    ##
+    # Updates the confluence web.xml file with the soulwing (CAS library)
+    # authentication configuration
+    #
+    def config_web_xml()
+      web_xml = File.readlines(self.web_xml)
+      
+      web_xml = web_xml.map do |line|
+        if line =~ /#{web_xml_token}/
+          template = File.open("#{DEPLOYER_HOME}/resources/confluence_cas_web.xml") { |f| f.read }
+          ERB.new(template).result(self.send(:binding))
+        else
+          line
+        end
+      end
+      
+      File.open(self.web_xml, "w") do |io|
+        web_xml.each { |line| io.puts(line) }
+      end
+    end
+
+    ##
+    # Updates the confluence seraph_config.xml file with the soulwing
+    # authenticator.
+    #
+    def config_seraph_config_xml()
+      seraph_xml = File.readlines(self.seraph_config_xml)
+      
+      seraph_xml = seraph_xml.map do |line|
+        if m = /(#{Regexp.quote(seraph_config_xml_token)})/.match(line)
+          debug(m[0])
+          debug("#{m.pre_match}#{cas_authenticator_class}#{m.post_match}")
+          "#{m.pre_match}#{cas_authenticator_class}#{m.post_match}"
+        else
+          line
+        end
+      end
+      
+      File.open(self.seraph_config_xml, "w") do |io|
+        seraph_xml.each { |line| io.puts(line) }
+      end
+    end
+    
+    ##
+    # Sets the confluence.home property in the file: confluence-init.properties
+    #
+    def config_confluence_init_properties()
+      File.open(self.confluence_init_properties, "w") { |io| io.puts("confluence.home=#{data_dir}") }
+    end
+
+    def reshuffle_jars()
+      FileUtils.cp(Dir["#{UcbDeployer::RESOURCES_DIR}/soulwing-casclient-*"],
+                   "#{build_dir}/src/confluence/WEB-INF/lib/")
+      # Remove the postgres jar since we have it installed at the container level
+      FileUtils.rm_rf(Dir["#{build_dir}/src/confluence/WEB-INF/lib/postgresql-*"])
+    end
+    
+    def debug(str)
+      UcbDeployer.debug(str)
+    end
+  end
+end
+

data/lib/ucb_deployer/deployer.rb

@@ -0,0 +1,115 @@
+
+module UcbDeployer
+  ##
+  # @author Steven Hansen
+  #
+  # @abstract Subclass and override {#export, #build, #configure, #deploy,
+  # #rollback} to implement a custom UcbDeployer class
+  #
+  class Deployer
+    
+    CONFIG_OPTIONS = [
+      :build_dir,
+      :deploy_dir,
+      :war_name,
+      :cas_service_url,
+      :cas_server_url,
+      :data_dir,
+      :svn_username,                  
+      :svn_project_url,
+    ]
+    
+    
+    attr_accessor *CONFIG_OPTIONS
+    attr_accessor :version, :debug_mode
+    
+    
+    def export()
+    end
+    
+    def configure()
+    end
+
+    def build()
+    end
+
+    def rollback()
+    end
+    
+    def deploy()
+    end
+
+    def svn_username()
+      @svn_username || "app_relmgt"
+    end
+    
+    ##
+    # Configuration options are:
+    #
+    # +build_dir+
+    # +deploy_dir+
+    # +war_name+
+    # +svn_project_url+
+    # +svn_username+
+    # +cas_service_url+
+    # +cas_server_url+
+    # +data_dir+  
+    #
+    def load_config(config_file)
+      hash = YAML.load_file(config_file)
+      hash.each do |key, val|
+        if CONFIG_OPTIONS.include?(key.to_sym)
+          self.send("#{key}=", val)
+        else
+          raise(ConfigError, "Unrecognized Option: #{key}")
+        end
+      end
+    end
+    
+    def display_maintenance_file()
+      maint_start = Time.now.strftime("%m-%d-%Y %H:%M:%S")
+      template = ERB.new(maintenance_template)
+      File.open("/var/www/html/confluence/maintenance.html", "w") do |f|
+        f.puts template.result(binding)
+      end
+    end
+    
+    def maintenance_template()
+      %q{
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+<head>
+  <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+  <title>Site Maintenance<title>
+  <style type="text/css">
+  body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+  div.dialog {
+  width: 35em;
+  padding: 0 3em;
+  margin: 3em auto 0 auto;
+  border: 1px solid #ccc;
+  border-right-color: #999;
+  border-bottom-color: #999;
+  }
+  h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <div class="dialog">
+    <h1>Site Maintenance</h1>
+    <p>
+        The site is down for maintenance as of: <strong><%= maint_start %></strong> <br/>
+        it should be available shortly.
+    </p>
+  </div>
+</body>
+</html>
+}
+    end
+
+  end
+end

data/lib/ucb_deployer/jira_deployer.rb

@@ -0,0 +1,77 @@
+
+module UcbDeployer
+  class JiraDeployer < Deployer
+    
+    def initialize(config_file = "#{ENV['HOME']}/config/jira/deploy.yml")
+      FileUtils.touch(config_file) if !File.exists?(config_file)
+      load_config(config_file)
+    end
+    
+    def export()
+    end
+    
+    def configure
+    end
+
+    def build
+    end
+
+    def deploy
+    end
+
+    def rollback
+    end
+
+    ##
+    # Shortcut to confluence web.xml file
+    #
+    def web_xml()
+    end
+    
+    ##
+    # Shortcut to confluence seraph-config.xml file
+    #
+    def seraph_config_xml()
+    end
+    
+    ##
+    # Shortcut to confluence confluence-init.properties file
+    #
+    def confluence_init_properties()
+    end
+    
+    def web_xml_token()
+    end
+    
+    def seraph_config_xml_token()
+    end
+    
+    def cas_authenticator_class()
+    end
+    
+    ##
+    # Updates the confluence web.xml file with the soulwing (CAS library)
+    # authentication configuration
+    #
+    def config_web_xml()
+    end
+
+    ##
+    # Updates the confluence seraph_config.xml file with the soulwing
+    # authenticator.
+    #
+    def config_seraph_config_xml()
+    end
+    
+    ##
+    # Sets the confluence.home property in the file: confluence-init.properties
+    #
+    def config_confluence_init_properties()
+    end
+
+    def reshuffle_jars()
+    end
+
+  end
+end
+

data/lib/ucb_deployer.rb

@@ -0,0 +1,46 @@
+require 'yaml'
+require 'net/http'
+require 'erb'
+require 'ucb_deployer/deployer'
+require 'ucb_deployer/confluence_deployer'
+require 'ucb_deployer/jira_deployer'
+
+
+module UcbDeployer
+  class ConfigError < RuntimeError; end
+  
+  DEPLOYER_HOME = File.expand_path(File.dirname(__FILE__) + '/..') unless defined?(DEPLOYER_HOME)
+  RESOURCES_DIR = File.expand_path("#{DEPLOYER_HOME}/resources") unless defined?(RESOURCES_DIR)  
+  
+
+  ##
+  # Valid options are
+  #
+  # @param [Symbol|String] valid __app_name__ values are: "confluence", "jira"
+  # @raise [UcbDeployer::ConfigError] raises if invalid value is used for __app_name__
+  # @return [UcbDeployer::Deployer]
+  #
+  def self.factory(app_name)
+    if app == :confluence
+      UcbDeployer::ConfluenceDeployer.new()
+    elsif app == :jira
+      UcbDeployer::JiraDeployer.new()
+    else
+      raise(ConfigError, "Unrecognized app_name: #{app_name}")
+    end
+  end
+
+  def self.debug(str)
+    if debug_mode
+      $stdout.puts(str)
+    end
+  end
+
+  def self.debug_mode
+    @debug_mode || false
+  end
+
+  def self.debug_mode=(bool)
+    @debug_mode = bool
+  end
+end

data/{cas_web.xml → resources/confluence_cas_web.xml}

@@ -1,4 +1,5 @@
 
+<!-- CAS Configuration --> 
 <context-param>
   <param-name>casServerUrl</param-name>
   <param-value><%= cas_server_url %></param-value>
@@ -97,4 +98,4 @@
   <filter-name>CAS-Service-Validation</filter-name>
   <url-pattern>/*</url-pattern>
 </filter-mapping>
-
+<!-- end CAS Configuration --> 

data/resources/jira_cas_web.xml

@@ -0,0 +1,95 @@
+
+<!-- CAS Configuration --> 
+<context-param> 
+  <param-name>casServerUrl</param-name> 
+  <param-value><%= cas_server_url %></param-value> 
+</context-param> 
+<context-param>
+  <param-name>casServiceUrl</param-name>
+  <param-value><%= cas_service_url %></param-value> 
+</context-param> 
+
+<listener> 
+  <listener-class>org.soulwing.cas.filter.ProtocolConfigurationListener</listener-class> 
+</listener> 
+
+<filter> 
+  <filter-name>CAS-Session-Bypass</filter-name> 
+  <filter-class>org.soulwing.cas.filter.SessionBypassFilter</filter-class> 
+  <init-param> 
+    <param-name>logoutPath</param-name> 
+    <param-value>/casLogout.action</param-value> 
+  </init-param> 
+  <init-param> 
+    <param-name>applicationLogout</param-name> 
+    <param-value>true</param-value> 
+  </init-param> 
+  <init-param> 
+    <param-name>globalLogout</param-name> 
+    <param-value>true</param-value> 
+  </init-param>
+  <init-param>
+    <param-name>bypassRedirectUrl</param-name>
+    <param-value>/secure/Logout!default.jspa</param-value> 
+  </init-param> 
+  <init-param> 
+    <param-name>bypassPaths</param-name> 
+    <param-value>/login.jsp, /sr*, /secure/RunPortlet*</param-value> 
+  </init-param> 
+</filter> 
+
+<filter> 
+  <filter-name>CAS-Simple-Bypass</filter-name> 
+  <filter-class>org.soulwing.cas.filter.SimpleBypassFilter</filter-class> 
+  <init-param> 
+    <param-name>bypassPaths</param-name> 
+    <param-value>
+      /rpc/*, /images/*, /styles/*, /secure/Logout!default.jspa
+    </param-value> 
+  </init-param> 
+</filter> 
+
+<filter>
+  <filter-name>CAS-Logout</filter-name>
+  <filter-class>
+    org.soulwing.cas.filter.LogoutFilter
+  </filter-class>
+  <init-param>
+    <param-name>logoutPath</param-name>
+    <param-value>/secure/Logout!default.jspa</param-value>
+  </init-param>
+  <init-param>
+    <param-name>applicationLogout</param-name>
+    <param-value>true</param-value>
+  </init-param>
+  <init-param>
+    <param-name>globalLogout</param-name>
+    <param-value>true</param-value>
+  </init-param>
+</filter>
+
+<filter-mapping>
+  <filter-name>CAS-Logout</filter-name>
+  <url-pattern>/*</url-pattern>
+</filter-mapping>
+
+<filter> 
+  <filter-name>CAS-Service-Validation</filter-name> 
+  <filter-class>org.soulwing.cas.filter.ServiceValidationFilter</filter-class> 
+</filter> 
+
+<filter-mapping> 
+  <filter-name>CAS-Session-Bypass</filter-name> 
+  <url-pattern>/*</url-pattern> 
+</filter-mapping> 
+
+<filter-mapping> 
+  <filter-name>CAS-Simple-Bypass</filter-name> 
+  <url-pattern>/*</url-pattern> 
+</filter-mapping> 
+
+<filter-mapping> 
+  <filter-name>CAS-Service-Validation</filter-name> 
+  <url-pattern>/*</url-pattern> 
+</filter-mapping> 
+<!-- end CAS Configuration --> 

data/spec/fixtures/{dot_cdeprc → confluence/deploy.yml}

@@ -1,4 +1,4 @@
-build_dir: /path/to/build_dir
+build_dir: /path/to/build_dir/confluence
 deploy_dir: /path/to/deploy_dir
 war_name: war_name
 svn_username: runner