capistrano-tomcat 0.0.3 → 0.0.4

data/HISTORY.txt

@@ -1,3 +1,12 @@
+v0.0.4
+======
+ * Added targets for unpacking WARs
+ * More useful README
+ * Configurable `catalina_executable` for non-RedHat machines
+   (thanks Marc Huffnagle)
+ * HTTPS actually defaults to port 8443 like it was supposed to.
+   (thanks Marc Huffnagle)
+
 v0.0.3
 ======
  * Allows a deployment to add additional environment variables to the

data/README.markdown

@@ -16,8 +16,40 @@ you can use the Capistrano deployment as you would for Passenger.
 
 ## Configuration
 
-`tomcat_base_port` controls the other ports as well.
-`tomcat_http_port`
-`tomcat_https_port`
-`tomcat_ajp_port`
+The default configuration uploads artifacts/yourapp.war to your app
+servers and starts Tomcat on port 8080.
+
+### Ports
+* `tomcat_base_port`: controls the other ports as well. Defaults to 8005.
+* `tomcat_ajp_port`: defaults to 8009 (`tomcat_base_port` + 4)
+* `tomcat_http_port`: defaults to 8080 (`tomcat_base_port` + 75)
+* `tomcat_https_port`: defaults to 8443 (`tomcat_base_port` + 438)
+
+### Directories and files
+* `catalina_home`: location of the base Tomcat installation, defaults to
+  `/usr/share/tomcat6`
+* `catalina_executable`: location of the Tomcat executable, defaults to `/usr/sbin/tomcat6`.  In a standard Tomcat installation this would be `${CATALINA_HOME}/bin/catalina.sh` or `${CATALINA_HOME}/bin/catalina.bat`
+
+For the Tomcat installed with **Red Hat Enterprise Linux** packages,
+the following settings are appropriate:
+
+    cset :catalina_home '/usr/share/tomcat6'
+    cset :catalina_executable, '/usr/sbin/tomcat6'
+
+### Additional pieces
+If you need Tomcat to run with additional environment variables, you can use the `tomcat_runtime_env` setting. For example:
+
+    cset :tomcat_runtime_env, {'MYAPP_DB_HOSTNAME' => 'db.example.com'}
+
+If you are using the Java keystore for SSL, you can set the password
+with `keystore_password`.
+
+### Unpacking the WAR
+
+Some tasks and applications rely on the standard Rails files being
+available on the filesystem. If you need to explode the WAR before
+Tomcat gets to it, you can include the following lines in your recipe:
+
+    after "deploy:update_code", "tomcat:unpack_war"
+    after "tomcat:unpack_war", "tomcat:finalize_unpacked_war"
 

data/capistrano-tomcat.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Capistrano::Tomcat::VERSION
   s.authors     = ["Rob Hunter"]
   s.email       = ["rhunter@thoughtworks.com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/rhunter/capistrano-tomcat"
   s.summary     = %q{Deployment recipes for deploying to Tomcat at OVE}
   s.description = %q{Apache Tomcat, a Java servlet container, runs WARs
 

data/lib/capistrano/tomcat.rb

@@ -7,9 +7,10 @@ configuration.load do
   _cset :tomcat_base_port, 8005
   _cset(:tomcat_ajp_port) { tomcat_base_port + 4 } #8009
   _cset(:tomcat_http_port) { tomcat_base_port + 75 } #8080
-  _cset(:tomcat_https_port) { tomcat_base_port + 443 } #8443
+  _cset(:tomcat_https_port) { tomcat_base_port + 438 } #8443
   _cset :keystore_password, nil
   _cset :catalina_home, '/usr/share/tomcat6'
+  _cset :catalina_executable, '/usr/sbin/tomcat6'
   _cset(:tomcat_runtime_env, {})
 
   namespace :deploy do
@@ -24,6 +25,7 @@ configuration.load do
 
     task :finalize_update do
       # no finalization necessary with a WAR deployment
+      # although it might be if you unpack the war with tomcat:unpack_war
     end
 
     task :start, :roles => :app do
@@ -45,7 +47,7 @@ configuration.load do
         "CATALINA_BASE" => current_path,
         "CATALINA_TMPDIR" => tmpdir
       }
-      run "/usr/sbin/tomcat6 #{cmd} #{log}", :env => base_env.merge(tomcat_runtime_env)
+      run "#{catalina_executable} #{cmd} #{log}", :env => base_env.merge(tomcat_runtime_env)
     end
   end
 
@@ -75,5 +77,39 @@ configuration.load do
     result = ERB.new(template).result(binding)
     put result, destination_path, :mode => 0644
   end
+
+  namespace :tomcat do
+    desc "Unpack a WAR for tools that need the individual files"
+    task :unpack_war, :roles => [:app, :worker] do
+      target_webapps_path = File.join(release_path, 'webapps')
+      target_war_path = File.join(target_webapps_path, war_filename)
+      target_unpacked_war_path = unpacked_war_path_under release_path
+
+      on_rollback { run "rm -rf -- \"#{target_unpacked_war_path}\"" }
+      run %{unzip -q "#{target_war_path}" -d "#{target_unpacked_war_path}"}
+    end
+
+    desc "Touch up an unpacked WAR to look like a regular Rails app"
+    task :finalize_unpacked_war, :roles => [:app, :worker] do
+      unpacked_war_path = unpacked_war_path_under release_path
+      app_path = File.join unpacked_war_path, 'WEB-INF'
+      # code duplicated from capistrano's deploy recipe:
+      # (lib/capistrano/recipes/deploy.rb)
+      run <<-CMD
+      rm -rf #{app_path}/log #{app_path}/public/system #{app_path}/tmp/pids &&
+      mkdir -p #{app_path}/public &&
+      mkdir -p #{app_path}/tmp &&
+      ln -s #{shared_path}/log #{app_path}/log &&
+      ln -s #{shared_path}/system #{app_path}/public/system &&
+      ln -s #{shared_path}/pids #{app_path}/tmp/pids
+      CMD
+    end
+
+    def unpacked_war_path_under(release_path)
+      webapps_path = File.join(release_path, 'webapps')
+      war_path = File.join(webapps_path, war_filename)
+      unpacked_war_path = File.join(webapps_path, File.basename(war_filename, '.war'))
+    end
+  end
 end
 

data/lib/capistrano/tomcat/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Tomcat
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-tomcat
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-31 00:00:00.000000000 Z
+date: 2012-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
-  requirement: &70196232739240 !ruby/object:Gem::Requirement
+  requirement: &70239769475380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70196232739240
+  version_requirements: *70239769475380
 description: ! "Apache Tomcat, a Java servlet container, runs WARs\n\n    These deployment
   recipes help to run a Tomcat instance with your\n    own WAR files from Capistrano.\n
   \ "
@@ -41,7 +41,7 @@ files:
 - lib/capistrano/tomcat/templates/server.xml.erb
 - lib/capistrano/tomcat/templates/web.xml.erb
 - lib/capistrano/tomcat/version.rb
-homepage: ''
+homepage: https://github.com/rhunter/capistrano-tomcat
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -66,3 +66,4 @@ signing_key:
 specification_version: 3
 summary: Deployment recipes for deploying to Tomcat at OVE
 test_files: []
+has_rdoc: