capitomcat 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05fb97e5443b9a5ed772b29b91acc43e45ebafb7
+  data.tar.gz: 7ac4dbeaaf93dfd4499cb598e9a7150a94d26c2a
+SHA512:
+  metadata.gz: 62dc7e70f831b737bf5539c381731d7b368fa32e110a69269d10142fd28353ee017156e6326ec2e10387650aa82695ddaf5f1b5ccd2fba5ec7f832a630e1805f
+  data.tar.gz: 259bc148df4060b929ca8606a902e6734aa4858cd542b03186499471f0d48743d16fe1d555bedcf5a645daf7281863a0393b8e1450c00519cb42a558304dde72

data/.gitignore

@@ -0,0 +1,37 @@
+# CVS Files #
+.cvsignore
+CVS
+
+# Eclipse Project Files #
+.settings
+target
+.classpath
+.project
+
+# Intellij Project Files #
+.idea
+*.iml
+
+# Mac Directory #
+.DS_Store
+
+# Ruby
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+

data/README.md

@@ -0,0 +1,277 @@
+Capistrano Recipe for Tomcat
+========================
+
+##Installation
+To use Capitomcat in your Capistrano script, you need install as RubyGem
+
+###Install Ruby
+Please refer to [Download Ruby](http://www.ruby-lang.org/en/downloads/) page on the Ruby official website.
+###Install RubyGems
+Please refer to [Download RubyGems](http://rubygems.org/pages/download) page on the RubyGems official website.
+###Install Capistrano
+<pre>
+$ gem install capistrano
+$ gem install capistrano-ext
+</pre>
+###Install Capitomcat
+* Check-out the source code
+<pre>
+$ git clone git@github.com:sunggun-yu/capitomcat.git
+</pre>
+* Build gem
+<pre>
+$ cd capitomcat
+$ gem build capitomcat.gemspec
+</pre>
+* Install gem
+<pre>
+$ gem install capitomcat
+</pre>
+
+##Configuration
+You have to add the following options in your `Capfile` or `deploy.rb`
+<pre>
+role :app
+set  :user
+set  :password
+set  :tomcat_user
+set  :tomcat_cmd_user
+set  :tomcat_port
+set  :local_war_file
+set  :context_template_file
+set  :context_name`
+set  :remote_docBase
+set  :remote_context_file 
+set  :remote_tomcat_cmd
+set  :remote_tomcat_work_dir
+set  :stages
+</pre>
+* `:app` - The application servers that you want to deploy
+* `:user` - User name which is going to run Capistrano script.
+* `:password` - Password of `:user`.
+* `:tomcat_user` - The owner of Tomcat home directory.
+* `:tomcat_cmd_user` - The user that runs tomcat scripts : ex) /etc/init.d/tomcat
+* `:tomcat_port` - Port number of Tomcat server. this value is needed to check whether Tomcat process is running.
+* `:local_war_file` - The WAR file which will upload to remote tomcat server.
+* `:context_template_file` - Path for the template file in your local, which is application's Tomcat context. also, following ERB variable are should be included in the template file.
+	* context.xml.erb
+<pre>
+&lt;Context path="/<%= context_name %>" docBase="<%= remote_docBase %>" /&gt;
+</pre>
+ * `<%= context_name %>` - This variable is for the ***path*** attribute in the context file. It will be replaced to `:context_name`
+ * `<%= remote_docBase %>` - This variable is for the ***docBase*** attribute in the context file.It will be replaced to `:remote_docBase`
+- `:context_name` - Root context name of application.
+- `:remote_docBase` -  The pathname to the web application archive file (if this web application is being executed directly from the WAR file)
+- `:remote_context_file` -  Application's context file path for Tomcat on your remote servers. basically, context file is located in `/your/tomcat/home/conf/Catalina/localhost/appname.xml`
+- `:remote_tomcat_cmd` -  Tomcat's star, stop command. for example, `/etc/init.d/tomcat` or `/your/tomcat/home/bin/catalina.sh` can be used. please make sure not to include `start` or `stop` parameter.
+- `:remote_tomcat_work_dir` - Tomcat work directory for application. this directory will be used at `capitomcat:cleanWorkDir` task
+
+### Multistage setting
+If you want to use Multistage deployment, You should add following option in your `Capfile` or `deploy.rb`
+also, please refer to [Multistage Extension](https://github.com/capistrano/capistrano/wiki/2.x-Multistage-Extension).
+- `:stages` -  
+<pre>
+# Application Stage Section
+set :stages, %w(dev stg prod)
+</pre>
+
+### Examples
+#### Single Stage
+/your/capistrano/project/***Capfile***
+```
+require 'capitomcat'
+
+# Application host section
+role  :app, "dev01", "dev02"
+
+# User section
+set   :user, "stg"
+set   :password, "password"
+set   :tomcat_user, "tomcat"
+set   :tomcat_cmd_user, "root"
+
+# Local file section
+set   :local_war_file, "/tmp/app.war"
+set   :context_template_file, "./template/context.xml.erb"
+
+# Remote setting section
+set   :context_name, "app"
+set   :remote_docBase, "/tmp/test/earl/war/abc.war"
+set   :remote_context_file, "/tmp/test/tomcat/conf/Catalina/localhost/app.xml"
+set   :remote_tomcat_cmd, "/tmp/test/etc/init.d/tomcat7"
+set   :remote_tomcat_work_dir, "/opt/tomcat/work/Catalina/localhost/app"
+```
+
+#### Multi Stage
+Project structure.
+```
+/ your/capistrano/project/
+|-- config
+|   |-- deploy
+|   |   |-- dev.rb
+|   |   |-- stg.rb
+|   |   `-- prod.rb
+|   `-- deploy.rb
+`-- Capfile
+```
+Also, the file name under config/deploy are should be matched in  `set :stages`
+
+* /your/capistrano/project/***Capfile***
+
+  ```
+  require 'capitomcat'
+  require 'capistrano/ext/multistage'
+
+  # Application Stage Section
+  set :stages, %w(dev stg prod)
+
+  # User section
+  set   :user, "stg"
+  set   :password, "password"
+  set   :tomcat_user, "tomcat"
+  set   :tomcat_cmd_user, "root"
+
+  # Local file section
+  set   :local_war_file, "/tmp/app.war"
+  set   :context_template_file, "./template/context.xml.erb"
+
+  # Remote setting section
+  set   :context_name, "app"
+  set   :remote_docBase, "/tmp/test/earl/war/abc.war"
+  set   :remote_context_file, "/tmp/test/tomcat/conf/Catalina/localhost/app.xml"
+  set   :remote_tomcat_cmd, "/tmp/test/etc/init.d/tomcat7"
+  set   :remote_tomcat_work_dir, "/opt/tomcat/work/Catalina/localhost/app"
+  ```
+
+* /your/capistrano/project/***config/deploy/dev.rb***
+
+  ```
+  # Application host section for DEV
+  role  :app, "dev-host-1", "dev-host-2"
+  ```
+
+*  /your/capistrano/project/***config/deploy/stg.rb***
+
+  ```
+  # Application host section for stg
+  role  :app, "stg-host-1", "stg-host-2"
+  ```
+
+* /your/capistrano/project/***config/deploy/prod.rb***
+
+  ```
+  # Application host section for Production
+   role  :app, "prod-host-1", "prod-host-2"
+ ```
+
+##Available Tasks
+To get a list of all capistrano tasks, run `cap -T` with user password:
+<pre>
+cap capitomcat:cleanWorkDir  # Cleaning-up Tomcat work directory
+cap capitomcat:start         # Start capitomcat.
+cap capitomcat:stop          # Stop capitomcat.
+cap capitomcat:updateContext # Update and upload context file
+cap capitomcat:uploadWar     # Upload WAR file
+</pre>
+
+### capitomcat:cleanWorkDir
+This Task will remove Application's Tomcat work directory. Please make sure you should start/restart Tomcat after this task has executed.
+### capitomcat:start
+This Task will start your Tomcat server using `:remote_tomcat_cmd` command.
+If you have `set :remote_tomcat_cmd, '/etc/init.d/tomcat7'` and `set :tomcat_cmd_user, 'root'` in your Capfile or deploy.rb file then the Task will execute `sudo -p <:password> -u root /etc/init.d/tomcat7 start` commnad on your remote servers which are setted in `role :app`.
+### capitomcat:stop
+This Task will stop your Tomcat server using `:remote_tomcat_cmd` command.
+If you have `set :remote_tomcat_cmd, '/user/local/tomcat7/bin/catalina.sh'` and `set :tomcat_cmd_user, 'tomcat'` in your Capfile or deploy.rb file then the Task will execute `sudo -p <:password> -u tomcat /user/local/tomcat7/bin/catalina.sh stop` commnad on your remote servers which are setted in `role :app`.
+### capitomcat:updateContext
+This Task will generate context file from your context template file. and Upload the generated context file to `:remote_context_file`
+### capitomcat:uploadWar
+This Task will upload the `:local_war_file` to `:remote_docBase` 
+
+##Usage
+To use capitomcat gem, You need to create your own Capistrano script.
+You can create Capistrano project structure and default files from scratch to run `capify .`
+```
+$ mkdir -p /your/capistrano/project
+$ cd /your/capistrano/project
+$ capify .
+$ tree
+
+/ your/capistrano/project/
+|-- config
+|   `-- deploy.rb
+`-- Capfile
+```
+add settings into your Capfile or deploy.rb file. and you can execute capitomcat recipe like this.
+```
+$ cap capitomcat:stop
+```
+
+Also, you can combine tasks as a one task by creating new task inside the your Capfile or deploy.rb file.
+```
+require 'capitomcat'
+
+desc "Release Task for myjob"
+namespace :myapp do
+  task :release, :roles => :app do
+    capitomcat.stop
+    capitomcat.uploadWar
+    capitomcat.updateContext
+    capitomcat.cleanWorkDir
+    capitomcat.start
+  end
+end
+```
+
+### Execute tasks serially
+Capistrano performs the task parallel, So in the above case, if you have multiple server each task will be performed for each servers.
+```
+# host1, host2
+
+stop ==> host1
+stop ==> host2
+
+uploadWar ==> host1
+uploadWar ==> host2
+
+...
+```
+
+if you do perform release like below, use serial_task function.
+```
+# host1, host2
+
+stop ==> host1
+uploadWar ==> host1
+updateContext ==> host1
+start ==> host1
+
+stop ==> host2
+uploadWar ==> host2
+updateContext ==> host2
+start ==> host2
+```
+
+```
+require 'capitomcat'
+
+desc "Release Task for myjob"
+namespace :myapp do
+  task :release, :roles => :app do
+    serial_task do
+      capitomcat.stop
+      capitomcat.uploadWar
+      capitomcat.updateContext
+      capitomcat.cleanWorkDir
+      capitomcat.start
+    end
+  end
+end
+```
+
+### Perform multistage task
+If you have multistage setting, you can perform the task as like below.
+```
+cap prod myapp:release
+```
+
+&hearts;For more details, please refer to example projects.&hearts;

data/Rakefile

@@ -0,0 +1,5 @@
+#!/usr/bin/env rake
+
+# Author:: Sunggun Yu
+
+require "bundler/gem_tasks"

data/capitomcat.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+# Author:: Sunggun Yu
+
+$:.push File.expand_path("lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "capitomcat"
+  s.version     = "0.0.2"
+
+  s.authors     = ["Sunggun Yu"]
+  s.email       = ["sunggun.dev@gmail.com"]
+  s.licenses    = ['Apache 2.0']
+  s.date        = %q{2013-12-27} 
+  s.homepage    = "https://github.com/sunggun-yu/capitomcat"
+  s.summary     = %q{Capistrano Recipe for Tomcat}
+  s.description = %q{You can deploy your war file to multiple remote tomcat servers through this Capistrano recipe.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency('capistrano')
+  s.add_development_dependency('rake')
+end

data/examples/README.md

@@ -0,0 +1 @@
+# Sample project for single stage deployment

data/examples/multistage/Capfile

@@ -0,0 +1,24 @@
+# Author:: Sunggun Yu
+
+require 'capistrano/ext/multistage'
+load 'config/deploy.rb'
+
+# Application Stage Section
+set :stages, %w(dev stg prod)
+
+# User section
+set   :user, "deploy"
+set   :password, "#{password}" #Set password from parameter.
+set   :tomcat_user, "tomcat"
+set   :tomcat_cmd_user, "root"
+
+# Local file section
+set   :local_war_file, "/tmp/app.war"
+set   :context_template_file, "./template/context.xml.erb"
+
+# Remote setting section
+set   :context_name, "app"
+set   :remote_docBase, "/tmp/test/earl/war/abc.war"
+set   :remote_context_file, "/tmp/test/tomcat/conf/Catalina/localhost/app.xml"
+set   :remote_tomcat_cmd, "/tmp/test/etc/init.d/tomcat7"
+set   :remote_tomcat_work_dir, "/opt/tomcat/work/Catalina/localhost/app"

data/examples/multistage/README.md

@@ -0,0 +1 @@
+# Sample project for multi stage deployment 

data/examples/multistage/config/deploy/dev.rb

@@ -0,0 +1,4 @@
+# Author:: Sunggun Yu
+
+# Application host section for DEV
+role  :app, "dev01", "dev02"

data/examples/multistage/config/deploy/prod.rb

@@ -0,0 +1,4 @@
+# Author:: Sunggun Yu
+
+# Application host section for Production
+role  :app, "prod01", "prod02"

data/examples/multistage/config/deploy/stg.rb

@@ -0,0 +1,4 @@
+# Author:: Sunggun Yu
+
+# Application host section for Staging
+role  :app, "stg01", "stg02"

data/examples/multistage/config/deploy.rb

@@ -0,0 +1,16 @@
+# Author:: Sunggun Yu
+
+require 'capitomcat'
+
+desc "Release Task for myjob"
+namespace :myapp do
+  task :release, :roles => :app do
+    serial_task do
+      capitomcat.uploadWar
+      capitomcat.stop
+      capitomcat.updateContext
+      capitomcat.cleanWorkDir
+      capitomcat.start
+    end
+  end
+end

data/examples/multistage/template/context.xml.erb

@@ -0,0 +1 @@
+<Context path="/<%= context_name %>" docBase="<%= remote_docBase %>" />

data/examples/singlestage/Capfile

@@ -0,0 +1,23 @@
+# Author:: Sunggun Yu
+
+load 'config/deploy.rb'
+
+# Application host section for DEV
+role  :app, "dev01"
+
+# User section
+set   :user, "deploy"
+set   :password, "#{password}" #Set password from parameter.
+set   :tomcat_user, "tomcat"
+set   :tomcat_cmd_user, "root"
+
+# Local file section
+set   :local_war_file, "/tmp/app.war"
+set   :context_template_file, "./template/context.xml.erb"
+
+# Remote setting section
+set   :context_name, "app"
+set   :remote_docBase, "/tmp/test/earl/war/abc.war"
+set   :remote_context_file, "/tmp/test/tomcat/conf/Catalina/localhost/app.xml"
+set   :remote_tomcat_cmd, "/tmp/test/etc/init.d/tomcat7"
+set   :remote_tomcat_work_dir, "/opt/tomcat/work/Catalina/localhost/app"

data/examples/singlestage/config/deploy.rb

@@ -0,0 +1,16 @@
+# Author:: Sunggun Yu
+
+require 'capitomcat'
+
+desc "Release Task for myjob"
+namespace :myapp do
+  task :release, :roles => :app do
+    serial_task do
+      capitomcat.uploadWar
+      capitomcat.stop
+      capitomcat.updateContext
+      capitomcat.cleanWorkDir
+      capitomcat.start
+    end
+  end
+end

data/examples/singlestage/template/context.xml.erb

@@ -0,0 +1 @@
+<Context path="/<%= context_name %>" docBase="<%= remote_docBase %>" />

data/lib/capitomcat.rb

@@ -0,0 +1,106 @@
+# Author:: Sunggun Yu
+
+configuration = Capistrano::Configuration.respond_to?(:instance) ?
+  Capistrano::Configuration.instance(:must_exist) :
+  Capistrano.configuration(:must_exist)
+
+configuration.load do
+
+  default_run_options[:pty] = true
+  default_run_options[:shell] = '/bin/sh'
+
+  set :tmp_dir, "/tmp"
+
+  desc "Capistrano Recipe for Tomcat"
+  namespace :capitomcat do
+    desc "Stop Tomcat"
+    task :stop, :roles => :app do
+      run "#{sudo :as => tomcat_cmd_user} #{remote_tomcat_cmd} stop", :pty => true
+    end
+
+    desc "Start Tomcat"
+    task :start, :roles => :app do
+      run "echo `nohup #{sudo :as => tomcat_cmd_user} #{remote_tomcat_cmd} start&` && sleep 1", :pty => true
+      run("for i in {0..360}; do echo \"Waiting for Tomcat to start\"; if [[ \"\" != \"$\(netstat -an | grep #{tomcat_port}\)\" ]]; then break; fi; sleep 30; done")
+      run("netstat -an | grep #{tomcat_port}")
+    end
+
+    desc "Upload WAR file"
+    task :uploadWar, :roles => :app do
+      set(:war_file_name) { File.basename(remote_docBase) }
+      set :tmp_war_file, "#{tmp_dir}/#{war_file_name}"
+      # Clean remote file before upload
+      remove_file_if_exist('root', tmp_war_file)
+      # Upload WAR file to temp dir
+      upload(local_war_file, tmp_war_file, :via => :scp, :pty => true)
+      begin
+        # Change uploaded WAR file's owner
+        run "#{sudo :as => 'root'} chown #{tomcat_user}:#{tomcat_user} #{tmp_war_file}"
+        # Move tmp WAR fiel to actual path
+        run "#{sudo :as => tomcat_user} cp #{tmp_war_file} #{remote_docBase}", :mode => 0644
+        # Clean remote file after task finished
+        remove_file_if_exist('root', tmp_war_file)
+      rescue
+        run "#{sudo :as => 'root'} rm #{tmp_war_file}"
+      end
+    end
+
+    desc "Update and upload context file"
+    task :updateContext, :roles => :app do
+      set(:context_file_name) { File.basename(remote_context_file) }
+      set :tmp_context_file, "#{tmp_dir}/#{context_file_name}"
+      # Clean remote file before upload
+      remove_file_if_exist('root', tmp_context_file)
+      # Generate context file from template and upload to temp dir on the remote server
+      generate_config(context_template_file, tmp_context_file)
+      begin
+        # Change uploaded context file's owner
+        run "#{sudo :as => 'root'} chown #{tomcat_user}:#{tomcat_user} #{tmp_context_file}"
+        # Move tmp WAR fiel to actual path
+        run "#{sudo :as => tomcat_user} cp #{tmp_context_file} #{remote_context_file}", :mode => 0644
+        # Clean remote file after task finished
+        remove_file_if_exist('root', tmp_context_file)
+      rescue
+        run "#{sudo :as => 'root'} rm #{tmp_context_file}"
+      end
+    end
+
+    desc "Cleaning-up Tomcat work directory"
+    task :cleanWorkDir, :roles => :app do
+      set :remote_tomcat_work_dir, "#{remote_tomcat_work_dir}"
+      run "#{sudo :as => tomcat_user} rm -rf #{remote_tomcat_work_dir}"
+    end
+  end
+
+  # Copy context.xml template to remote server
+  def parse_config(file)
+    require 'erb'
+    template=File.read(file)
+    return ERB.new(template).result(binding)
+  end
+
+  # Generate config file from erb template
+  def generate_config(local_file,remote_file)
+    temp_file = '/tmp/' + File.basename(local_file)
+    buffer    = parse_config(local_file)
+    File.open(temp_file, 'w+') { |f| f << buffer }
+    upload temp_file, remote_file, :via => :scp
+    `rm #{temp_file}`
+  end
+
+  # Remove file if exist
+  def remove_file_if_exist exc_user, file
+    run "if [ -e #{file} ]; then #{sudo :as => exc_user} rm -f #{file}; fi"
+  end
+end
+
+# Excute multiple task by serial
+def serial_task(&block)
+  original = ENV['HOSTS']
+  find_servers_for_task(self.current_task).each do |server|
+    ENV['HOSTS'] = server.host
+    yield
+  end
+ensure
+  ENV['HOSTS'] = original
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: capitomcat
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Sunggun Yu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: You can deploy your war file to multiple remote tomcat servers through
+  this Capistrano recipe.
+email:
+- sunggun.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- Rakefile
+- capitomcat.gemspec
+- examples/README.md
+- examples/multistage/Capfile
+- examples/multistage/README.md
+- examples/multistage/config/deploy.rb
+- examples/multistage/config/deploy/dev.rb
+- examples/multistage/config/deploy/prod.rb
+- examples/multistage/config/deploy/stg.rb
+- examples/multistage/template/context.xml.erb
+- examples/singlestage/Capfile
+- examples/singlestage/config/deploy.rb
+- examples/singlestage/template/context.xml.erb
+- lib/capitomcat.rb
+homepage: https://github.com/sunggun-yu/capitomcat
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Capistrano Recipe for Tomcat
+test_files: []