ucb_deployer 1.0.1 → 1.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ucb_deployer (1.0.1)
+    ucb_deployer (1.0.0)
       rake (= 0.8.7)
 
 GEM

data/lib/ucb_deployer/config_tasks/jira/config_app_properties.rb

@@ -0,0 +1,34 @@
+module UcbDeployer::ConfigTasks
+  module Jira
+    class ConfigAppProperties
+
+      def initialize(config)
+        @config= config
+      end
+
+      def execute()
+        file_data = File.readlines(self.jira_app_properties_path()).map do |line|
+          if /(#{Regexp.quote(self.jira_home_token())})/.match(line)
+            "#{self.jira_home_token()} #{@config.data_dir()}"
+          else
+            line
+          end
+        end
+
+        File.open(self.jira_app_properties_path(), "w") do |io|
+          file_data.each { |line| io.puts(line) }
+        end
+      end
+
+
+      def jira_home_token()
+        "jira.home ="
+      end
+
+      def jira_app_properties_path()
+        "#{@config.build_dir()}/src/edit-webapp/WEB-INF/classes/jira-application.properties"
+      end
+
+    end
+  end
+end

data/lib/ucb_deployer/config_tasks/jira/config_cas_auth.rb

@@ -0,0 +1,76 @@
+module UcbDeployer::ConfigTasks
+  module Jira
+    class ConfigCasAuth
+
+      def initialize(config)
+        @config = config
+      end
+
+      def execute()
+        self.update_seraph_config_xml()
+        self.update_web_xml()
+      end
+
+
+      def seraph_config_path()
+        "#{@config.build_dir()}/src/webapp/WEB-INF/classes/seraph-config.xml"
+      end
+
+      def seraph_config_auth_token()
+        "com.atlassian.jira.security.login.JiraSeraphAuthenticator"
+      end
+
+      def seraph_config_logout_url_token()
+        "/secure/Logout!default.jspa"
+      end
+
+      def cas_authenticator_class()
+        "org.soulwing.cas.apps.atlassian.JiraCasAuthenticator"
+      end
+
+      def cas_logout_url()
+        "/casLogout.action"
+      end
+
+      def web_xml_path()
+        "#{@config.build_dir()}/src/webapp/WEB-INF/web.xml"
+      end
+
+      def web_xml_token()
+        "<!--This filter is used to determine is there are any Application Errors before any pages are accessed"
+      end
+
+      def update_seraph_config_xml()
+        seraph_xml_data = File.readlines(self.seraph_config_path()).map do |line|
+          if m = /(#{Regexp.quote(self.seraph_config_auth_token())})/.match(line)
+            "#{m.pre_match}#{self.cas_authenticator_class()}#{m.post_match}"
+          elsif m = /(#{Regexp.quote(self.seraph_config_logout_url_token())})/.match(line)
+            "#{m.pre_match}#{@config.cas_server_url()}/logout#{m.post_match}"
+          else
+            line
+          end
+        end
+
+        File.open(self.seraph_config_path(), "w") do |io|
+          seraph_xml_data.each { |line| io.puts(line) }
+        end
+      end
+
+      def update_web_xml()
+        web_xml_data = File.readlines(self.web_xml_path()).map do |line|
+          if line =~ /#{web_xml_token}/
+            template = File.open("#{@config.resources_dir()}/jira_cas_web.xml") { |f| f.read() }
+            line + ERB.new(template).result(@config.send(:binding))
+          else
+            line
+          end
+        end
+
+        File.open(self.web_xml_path(), "w") do |io|
+          web_xml_data.each { |line| io.puts(line) }
+        end
+      end
+
+    end
+  end
+end

data/lib/ucb_deployer/config_tasks/jira/config_ist_banner.rb

@@ -0,0 +1,19 @@
+##
+# Places IST banner jpg in images directory
+#
+module UcbDeployer::ConfigTasks
+  module Jira
+    class ConfigIstBanner
+
+      def initialize(config)
+        @config = config
+      end
+
+      def execute()
+        FileUtils.cp("#{UcbDeployer::RESOURCES_DIR}/ist_banner.jpg",
+                     "#{@config.build_dir()}/src/webapp/images/")
+      end
+
+    end
+  end
+end

data/lib/ucb_deployer/config_tasks/jira/config_jira_config_properties.rb

@@ -0,0 +1,26 @@
+module UcbDeployer::ConfigTasks
+  module Jira
+    class ConfigJiraConfigProperties
+
+      def initialize(config)
+        @config = config
+      end
+
+      def execute()
+        File.open(self.jira_config_properties_path(), "w") do |fd|
+          fd.puts(self.projectkey_config())
+        end
+      end
+
+
+      def projectkey_config()
+        "jira.projectkey.pattern = ([A-Z][A-Z0-9]+)"
+      end
+
+      def jira_config_properties_path()
+        "#{@config.data_dir()}/jira-config.properties"
+      end
+
+    end
+  end
+end

data/lib/ucb_deployer/config_tasks/jira/remove_conflicting_jar_files.rb

@@ -0,0 +1,26 @@
+##
+# Remove jars from WEB-INF/lib that have been installed at the container
+# level to avoid conflicts.
+#
+module UcbDeployer::ConfigTasks
+  module Jira
+    class RemoveConflictingJarFiles
+
+      def initialize(config)
+        @config = config
+      end
+
+      def execute()
+        FileUtils.mkdir_p("#{@config.build_dir()}/src/edit-webapp/WEB-INF/lib/")
+        FileUtils.cp(Dir["#{UcbDeployer::RESOURCES_DIR}/soulwing-casclient-*"],
+                     "#{@config.build_dir()}/src/edit-webapp/WEB-INF/lib/")
+
+        # These have been placed in $CATALINA_HOME/lib
+        ["mail", "activation", "javamail", "commons-logging", "log4j"].each do |jar_file|
+          FileUtils.rm_rf(Dir["#{@config.build_dir()}/src/webapp/WEB-INF/lib/#{jar_file}-*"])
+        end
+      end
+
+    end
+  end
+end

data/lib/ucb_deployer/confluence_deployer.rb

@@ -2,7 +2,7 @@
 module UcbDeployer
   class ConfluenceDeployer < Deployer
     
-    def initialize(config_file = "#{ENV['HOME']}/.ucb_deployer/config/confluence/deploy.yml")
+    def initialize(config_file = "#{ENV['HOME']}/config/confluence/deploy.yml")
       debug("Using config file: #{config_file}")
       debug("")
       load_config(config_file)

data/lib/ucb_deployer/deployer.rb

@@ -24,18 +24,23 @@ module UcbDeployer
     
     
     def export()
+      raise NotImplementedError
     end
     
     def configure()
+      raise NotImplementedError
     end
 
     def build()
+      raise NotImplementedError
     end
 
     def rollback()
+      raise NotImplementedError
     end
     
     def deploy()
+      raise NotImplementedError
     end
 
     ##
@@ -66,7 +71,15 @@ module UcbDeployer
         end
       end
     end
-    
+
+    def deployer_home()
+      ::UcbDeployer::DEPLOYER_HOME
+    end
+
+    def resources_dir()
+      ::UcbDeployer::RESOURCES_DIR
+    end
+
     def debug(str)
       UcbDeployer.debug(str)
     end

data/lib/ucb_deployer/jira_deployer.rb

@@ -1,4 +1,3 @@
-
 module UcbDeployer
   class JiraDeployer < Deployer
     
@@ -19,16 +18,14 @@ module UcbDeployer
     
     def configure()
       self.info("Configuring application.")
-      self.config_web_xml()
-      self.config_seraph_config_xml()
-      self.config_entityengine_xml()
-      self.config_jira_application_properties()
-      self.config_ist_banner()
-      self.reshuffle_jars()
+
+      tasks = self.load_tasks()
+      self.execute_config_tasks(tasks)
     end
 
     def build()
       self.info("Building application.")
+
       Dir.chdir("#{self.build_dir()}/src") { `sh #{self.build_dir()}/src/build.sh` }
     end
 
@@ -49,197 +46,33 @@ module UcbDeployer
     end
 
 
+protected
 
-    def cas_logout_url()
-      "/casLogout.action"
-    end
+    def load_tasks()
+      # TODO: Automatically load tasks so we don't have to manually specify each one
+      #
+      #tasks_path = "#{File.expand_path(File.dirname(__FILE__))}/config_tasks/jira/"
+      #Dir.entries(tasks_path).select { |file| file.match(/^[a-z]/) }
+      #tasks.each do |task|
+      #  klass_name = self.file_name_to_class_name(task)
+      #  klass = ::Kernel.const_get("UcbDeployer::ConfigTasks::Jira::#{klass_name}")
+      #  klass.new(self).execute()
+      #end
 
-    ##
-    # Shortcut to jira web.xml file
-    #
-    def web_xml()
-      "#{self.build_dir()}/src/webapp/WEB-INF/web.xml"
-    end
-    
-    def web_xml_token()
-      "<!--This filter is used to determine is there are any Application Errors before any pages are accessed"
-    end
-    
-    ##
-    # Updates the jira web.xml file with the soulwing (CAS library)
-    # authentication configuration
-    #
-    def config_web_xml()
-      web_xml = File.readlines(self.web_xml()).map do |line|
-        if line =~ /#{web_xml_token}/
-          template = File.open("#{DEPLOYER_HOME}/resources/jira_cas_web.xml") { |f| f.read() }
-          line + 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
-    
-    ##
-    # Shortcut to jira entityengine.xml file
-    #
-    def entityengine_xml()
-      "#{self.build_dir()}/src/edit-webapp/WEB-INF/classes/entityengine.xml"
-    end
-    
-    def entityengine_xml_db_token()
-      "field-type-name=\"hsql\""
-    end
-    
-    def entityengine_xml_schema_token()
-      "schema-name=\"PUBLIC\""
-    end
-    
-    def entityengine_db()
-      "field-type-name=\"postgres72\""
-    end
-    
-    def entityengine_schema()
-      "schema-name=\"jira_app\""
-    end
-    
-    ##
-    # Updates the jira entityengine.xml file with the correct database configs
-    #
-    def config_entityengine_xml()
-      ee_xml = File.readlines(self.entityengine_xml()).map do |line|
-        if m = /(#{Regexp.quote(self.entityengine_xml_db_token())})/.match(line)
-          self.debug(m[0])
-          new_str = "#{m.pre_match}#{entityengine_db}#{m.post_match}"
-          self.debug(new_str)
-          new_str
-        elsif m = /(#{Regexp.quote(self.entityengine_xml_schema_token())})/.match(line)
-          self.debug(m[0])
-          new_str = "#{m.pre_match}#{self.entityengine_schema()}#{m.post_match}"
-          self.debug(new_str)
-          new_str
-        else
-          line
-        end
-      end
-      
-      File.open(self.entityengine_xml(), "w") do |io|
-        ee_xml.each { |line| io.puts(line) }
-      end
-    end
-    
-    ##
-    # Shortcut to jira seraph-config.xml file
-    #
-    def seraph_config_xml()
-      "#{self.build_dir()}/src/webapp/WEB-INF/classes/seraph-config.xml"
-    end
-    
-    def seraph_config_xml_auth_class_token()
-      "com.atlassian.jira.security.login.JiraSeraphAuthenticator"
-      # "com.atlassian.jira.security.login.JiraOsUserAuthenticator"
-    end
-    
-    def seraph_config_xml_logout_url_token()
-      "/secure/Logout!default.jspa"
-    end
-    
-    def cas_authenticator_class()
-      "org.soulwing.cas.apps.atlassian.JiraCasAuthenticator"
-    end
-    
-    ##
-    # Updates the jira seraph_config.xml file with the soulwing
-    # authenticator.
-    #
-    def config_seraph_config_xml()
-      seraph_xml = File.readlines(self.seraph_config_xml()).map do |line|
-        if m = /(#{Regexp.quote(self.seraph_config_xml_auth_class_token())})/.match(line)
-          self.debug(m[0])
-          new_str = "#{m.pre_match}#{self.cas_authenticator_class()}#{m.post_match}"
-          self.debug(new_str)
-          new_str
-        elsif m = /(#{Regexp.quote(self.seraph_config_xml_logout_url_token())})/.match(line)
-          self.debug(m[0])
-          new_str = "#{m.pre_match}#{self.cas_server_url()}/logout#{m.post_match}"
-          self.debug(new_str)
-          new_str
-        else
-          line
-        end
-      end
-      
-      File.open(self.seraph_config_xml(), "w") do |io|
-        seraph_xml.each { |line| io.puts(line) }
-      end
-    end
-    
-    ##
-    # Shortcut to jira-application.properties file
-    #
-    def jira_application_properties()
-      "#{self.build_dir()}/src/edit-webapp/WEB-INF/classes/jira-application.properties"
-    end
-    
-    def jira_home_token()
-      "jira.home ="
+      [ UcbDeployer::ConfigTasks::Jira::ConfigIstBanner.new(self),
+        UcbDeployer::ConfigTasks::Jira::ConfigCasAuth.new(self),
+        UcbDeployer::ConfigTasks::Jira::ConfigJiraConfigProperties.new(self),
+        UcbDeployer::ConfigTasks::Jira::ConfigAppProperties.new(self),
+        UcbDeployer::ConfigTasks::Jira::RemoveConflictingJarFiles.new(self), ]
     end
 
-    def jira_projectkey_token()
-      "jira.projectkey.pattern ="
-    end
-
-    ##
-    # Sets the jira.home property in the file: jira-application.properties.
-    #
-    def config_jira_application_properties()
-      jira_props = File.readlines(self.jira_application_properties()).map do |line|
-        if m = /(#{Regexp.quote(jira_home_token)})/.match(line)
-          self.debug(m[0])
-          new_str = "#{self.jira_home_token()} #{self.data_dir()}"
-          self.debug(new_str)
-          new_str
-        elsif m = /(#{Regexp.quote(jira_projectkey_token)})/.match(line)
-          self.debug(m[0])
-          new_str = "#{self.jira_projectkey_token()} ([A-Z][A-Z0-9]+)"
-          self.debug(new_str)
-          new_str
-        else
-          line
-        end
-      end
-      
-      File.open(self.jira_application_properties(), "w") do |io|
-        jira_props.each { |line| io.puts(line) }
-      end
+    def file_name_to_class_name(filename)
+      filename.gsub(/\.rb/, "").split("_").map(&:capitalize).join()
     end
 
-    ##
-    # Places IST banner jpg in imaages directory
-    #
-    def config_ist_banner()
-      FileUtils.cp("#{UcbDeployer::RESOURCES_DIR}/ist_banner.jpg",
-                   "#{self.build_dir()}/src/webapp/images/")
-    end
-    
-    ##
-    # Remove jars from WEB-INF/lib that have been installed at the container
-    # level to avoid conflicts.
-    #
-    def reshuffle_jars()
-      FileUtils.mkdir_p("#{self.build_dir()}/src/edit-webapp/WEB-INF/lib/")
-      FileUtils.cp(Dir["#{UcbDeployer::RESOURCES_DIR}/soulwing-casclient-*"],
-                   "#{self.build_dir()}/src/edit-webapp/WEB-INF/lib/")
-      # These have been placed in $CATALINA_HOME/lib
-      ["mail", "activation", "javamail", "commons-logging", "log4j"].each do |jar_file|
-        FileUtils.rm_rf(Dir["#{self.build_dir()}/src/webapp/WEB-INF/lib/#{jar_file}-*"])
-      end
+    def execute_config_tasks(tasks)
+      tasks.each { |task| task.execute() }
     end
-
   end
 end
 

data/lib/ucb_deployer/version.rb

@@ -1,3 +1,3 @@
 module UcbDeployer
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/ucb_deployer.rb

@@ -5,6 +5,12 @@ require 'ucb_deployer/deployer'
 require 'ucb_deployer/confluence_deployer'
 require 'ucb_deployer/jira_deployer'
 
+require 'ucb_deployer/config_tasks/jira/config_cas_auth'
+require 'ucb_deployer/config_tasks/jira/config_app_properties'
+require 'ucb_deployer/config_tasks/jira/config_jira_config_properties'
+require 'ucb_deployer/config_tasks/jira/config_ist_banner'
+require 'ucb_deployer/config_tasks/jira/remove_conflicting_jar_files'
+
 
 module UcbDeployer
   class ConfigError < RuntimeError; end
@@ -44,7 +50,7 @@ module UcbDeployer
     $stdout.puts(str)
   end
   
-  def self.debug_mode
+  def self.debug_mode()
     @debug_mode || false
   end
 

data/spec/fixtures/jira/entityengine.xml

@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<!DOCTYPE entity-config PUBLIC "-//OFBiz//DTD Entity Engine Config//EN" "http://www.ofbiz.org/dtds/entity-config.dtd">
 <!--
 This file configures the OFBiz Entity Engine which JIRA uses to store persist data in a datasource.
 
@@ -71,44 +70,13 @@ If you not using the 12 preconfigured DBs, you may also need to add your own fie
         <field name="position" type="integer"/> to <field name="position" col-name="POSITION_" type="integer"/>
     -->
     <field-type name="frontbase" loader="maincp" location="entitydefs/fieldtype-frontbase.xml"/>
+    <!--
 
+    DATASOURCE
 
-    <!-- DATASOURCE - You will need to update this tag for your installation.
-
-        1. Update field-type-name attribute to match your database.
-           Possible values include: cloudscape, db2, firebird, frontbase, hsql, mckoidb, mysql, mssql, oracle10g, oracle, postgres, postgres72, sapdb, sybase
-        2. If using Orion or JBoss you will need to customize the <jndi-jdbc> tag.
-           See http://www.atlassian.com/software/jira/docs/latest/servers/
-        3. If using Postgres 7.3+ (schema-aware), use:
-               field-type-name="postgres72"
-           and:
-               schema-name="public"
-           in the datasource attribute list below.
-        4. If using DB2, add:
-             constraint-name-clip-length="15"
-           to the datasource attribute list below, and an appropriate schema-name attribute, eg:
-             schema-name="DB2INST1"
-        5. If not using HSQLDB remove:
-             schema-name="PUBLIC"
-
-        PLEASE DO NOT CHANGE the datasource name from
-        defaultDS unless instructed to by Atlassian Support.
-
-        PLEASE DO NOT set the use-foreign-key* values to "true" as JIRA does not currently support this.
+    You should no longer define a datasource in this file, the database is now configured through the UI at setup time.
+    The only time you would want to configure it here is when you migrate from an older version and need to point the
+    new installation at an existing db. This is considered a legacy method and will not work if dbconfig.xml exists
+    in the home directory.
      -->
-    <datasource name="defaultDS" field-type-name="hsql"
-      schema-name="PUBLIC"
-      helper-class="org.ofbiz.core.entity.GenericHelperDAO"
-      check-on-start="true"
-      use-foreign-keys="false"
-      use-foreign-key-indices="false"
-      check-fks-on-start="false"
-      check-fk-indices-on-start="false"
-      add-missing-on-start="true"
-      check-indices-on-start="true">
-        <jndi-jdbc jndi-server-name="default" jndi-name="java:comp/env/jdbc/JiraDS"/>
-<!-- Orion format: <jndi-jdbc jndi-server-name="default" jndi-name="jdbc/JiraDS"/> -->
-<!-- JBoss format: <jndi-jdbc jndi-server-name="default" jndi-name="java:/DefaultDS"/> -->
-<!-- Weblogic format: <jndi-jdbc jndi-server-name="default" jndi-name="JiraDS"/> -->
-    </datasource>
 </entity-config>