capitomcat 0.0.3 → 1.0.0

data/lib/capitomcat/tasks/deploy.cap

@@ -0,0 +1,226 @@
+require 'capistrano'
+
+# Author:: Sunggun Yu
+
+# Capistrano 3 Recipe for Tomcat web application deployment.'
+namespace :capitomcat do
+  desc <<-DESC
+    Capitomcat Recipe for Tomcat web application deployment.
+
+    Required Configurations
+
+    set :use_sudo, true
+    role :app, %w{deploy@dev01 deploy@dev02}
+
+    # Remote Tomcat server setting section
+    set   :tomcat_user, 'tomcat7'
+    set   :tomcat_user_group, 'tomcat7'
+    set   :tomcat_port, '8080'
+    set   :tomcat_cmd, '/etc/init.d/tomcat7'
+    set   :use_tomcat_user_cmd, false
+    set   :tomcat_war_file, '/var/app/war/test-web.war'
+    set   :tomcat_context_path, '/test-web'
+    set   :tomcat_context_file, '/var/lib/tomcat7/conf/Catalina/localhost/test-web.xml'
+    set   :tomcat_work_dir, '/var/lib/tomcat7/work/Catalina/localhost/test-web'
+
+    # Deploy setting section
+    set   :local_war_file, '/tmp/test-web.war'
+    set   :context_template_file, File.expand_path('../templates/context.xml.erb', __FILE__).to_s
+    set   :use_parallel, true
+    set   :use_context_update, true
+  DESC
+  task :deploy do
+    on roles(:app), in: get_parallelism, wait: 5 do |hosts|
+      if fetch(:use_context_update) then
+        info 'Upload WAR file'
+        upload_war_file
+
+        info 'Stop Tomcat'
+        stop_tomcat
+
+        info 'Update Context'
+        upload_context_file
+
+        info 'Clean Work directory'
+        cleanup_work_dir
+
+        info 'Start Tomcat'
+        start_tomcat
+        check_tomcat_started
+      else
+        info 'Stop Tomcat'
+        stop_tomcat
+
+        info 'Upload WAR file'
+        upload_war_file
+
+        info 'Clean Work directory'
+        cleanup_work_dir
+
+        info 'Start Tomcat'
+        start_tomcat
+        check_tomcat_started
+      end
+    end
+  end
+
+  # Start Tomcat server
+  def start_tomcat
+    # local variables
+    tomcat_cmd = fetch(:tomcat_cmd)
+
+    puts capture(:sudo, get_sudo_user_tomcat_cmd, "#{tomcat_cmd} start")
+  end
+
+  # Check status whether started
+  def check_tomcat_started
+    # local variables
+    tomcat_port = fetch(:tomcat_port)
+
+    execute "for i in {0..180}; do echo \"Waiting for Tomcat to start\"; if [ \"\" != \"$(netstat -an | grep #{tomcat_port})\" ]; then break; fi; sleep 30; done"
+    puts capture("netstat -an | grep #{tomcat_port}")
+  end
+
+  # Stop Tomcat server
+  def stop_tomcat
+    # local variables
+    tomcat_cmd = fetch(:tomcat_cmd)
+
+    puts capture(:sudo, get_sudo_user_tomcat_cmd, "#{tomcat_cmd} stop")
+  end
+
+  # Upload the WAR file
+  def upload_war_file
+    # local variables
+    upload_user = fetch(:user)
+    local_war_file = fetch(:local_war_file)
+    tomcat_war_file = fetch(:tomcat_war_file)
+    tomcat_user = fetch(:tomcat_user)
+    tomcat_user_group = fetch(:tomcat_user_group)
+
+    if File.exists?(local_war_file)
+      # Setup file name
+      temp_dir = Pathname.new('/tmp')
+      temp_file = File.basename(tomcat_war_file)
+      tmp_war_file = temp_dir.join(temp_file)
+
+      # Clean remote file before uploading
+      remove_file_if_exist(upload_user, tmp_war_file)
+      # Upload WAR file into temp dir
+      upload! local_war_file, tmp_war_file
+      # Move tmp WAR file to actual path
+      change_owner_and_move(tmp_war_file, tomcat_war_file, tomcat_user, tomcat_user_group)
+    else
+      error("Local WAR file does not existing. : #{local_war_file}")
+      exit(1)
+    end
+  end
+
+  # Generate context.xml file string from ERB template file and bindings
+  def get_context_template
+    # local variables
+    context_template_file = fetch(:context_template_file)
+
+    if !File.exists?(context_template_file)
+      error('Context template file does not existing.')
+      exit(1)
+    end
+
+    # local variables for erb file
+    tomcat_context_path = fetch(:tomcat_context_path)
+    tomcat_war_file = fetch(:tomcat_war_file)
+    info ("#{tomcat_context_path}, #{tomcat_war_file}")
+
+    template_file = File.read(File.expand_path(context_template_file, __FILE__))
+    template = ERB.new(template_file)
+    return template.result(binding)
+  end
+
+  # Upload context template string to remote server
+  def upload_context_file
+    # local variables
+    upload_user = fetch(:user)
+    tomcat_context_file = fetch(:tomcat_context_file)
+    tomcat_user = fetch(:tomcat_user)
+    tomcat_user_group = fetch(:tomcat_user_group)
+    context_template = get_context_template
+
+    temp_upload_file = '/tmp/' + File.basename(tomcat_context_file)
+    remove_file_if_exist upload_user, temp_upload_file
+    contents = StringIO.new(context_template)
+    upload! contents, temp_upload_file
+    change_owner_and_move(temp_upload_file, tomcat_context_file, tomcat_user, tomcat_user_group)
+  end
+
+  # Clean-up work directory
+  def cleanup_work_dir
+    # local variables
+    tomcat_work_dir = fetch(:tomcat_work_dir)
+    tomcat_user = fetch(:tomcat_user)
+
+    if test "[ -d #{tomcat_work_dir} ]"
+      within(tomcat_work_dir) do
+        execute :sudo, '- u', tomcat_user, 'rm -rf', tomcat_work_dir
+      end
+    else
+      warn('Tomcat work directory does not existing.')
+    end
+  end
+
+  # Get Parallelism
+  # @return :parallel or :sequence
+  def get_parallelism
+    if fetch(:use_parallel) == true then
+      return :parallel
+    else
+      return :sequence
+    end
+  end
+
+  # Get sudo user for tomcat command
+  # @return -u and sudo user name for tomcat command. if :use_tomcat_user_cmd is false, it will return '-u root'
+  def get_sudo_user_tomcat_cmd
+    if fetch(:use_tomcat_user_cmd) == true then
+      return "-u #{fetch(:tomcat_user)}"
+    else
+      return '-u root'
+    end
+  end
+
+  # Change owner and move file
+  # @param [String] file
+  # @param [String] destination file name with its path
+  # @param [String] user
+  # @param [String] group
+  def change_owner_and_move (file, destination, user, group)
+    # Change file's owner
+    puts user
+    execute :sudo, :chown, "#{user}:#{group}", file
+
+    # Move file to destination
+    target_dir = File.dirname(destination)
+    if test "[ -d #{target_dir} ]"
+      within target_dir do
+        execute :sudo, '-u', user, :mv, '-f', file, destination
+      end
+    else
+      warn("Target directory is not existing. Capitomcat will try mkdir for target directory. : #{target_dir}")
+      execute :sudo, '-u', user, :mkdir, '-p', target_dir
+      within(target_dir) do
+        execute :sudo, '-u', user, :mv, '-f', file, destination
+      end
+    end
+  end
+
+  # Remove file if exist
+  # @param [String] user
+  # @param [String] file
+  def remove_file_if_exist (user, file)
+    if test "[ -e #{file} ]"
+      execute :sudo, :chown, user, file
+      execute :rm, '-f', file
+    else
+      warn('Target file to remove is not existing.')
+    end
+  end
+end

data/lib/capitomcat/version.rb

@@ -0,0 +1,3 @@
+module Capitomcat
+  VERSION = '1.0.0'
+end

data/lib/capitomcat.rb

@@ -1,106 +1,5 @@
-# Author:: Sunggun Yu
+require 'capitomcat/deploy'
+require 'capitomcat/version'
 
-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..180}; 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
+module Capitomcat
 end

data/template/context.xml.erb

@@ -0,0 +1 @@
+<Context path="<%= tomcat_context_path %>" docBase="<%= tomcat_war_file %>" />

metadata

@@ -1,67 +1,98 @@
 --- !ruby/object:Gem::Specification
 name: capitomcat
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Sunggun Yu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-27 00:00:00.000000000 Z
+date: 2014-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.1
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: capistrano-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 1.1.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: You can deploy your war file to multiple remote tomcat servers through
-  this Capistrano recipe.
+        version: 1.1.1
+description: Capitomcat is the Capistrano 3 recipe for Tomcat web application deployment.
 email:
 - sunggun.dev@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- Gemfile
+- LICENSE.md
 - 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
+- examples/native/Gemfile
+- examples/native/README.md
+- examples/native/lib/native.rb
+- examples/native/lib/native/application.rb
+- examples/native/lib/native/tasks/tomcat_webapp.cap
+- examples/native/templates/context.xml.erb
+- examples/recipe/customizing/Capfile
+- examples/recipe/customizing/README.md
+- examples/recipe/customizing/config/deploy.rb
+- examples/recipe/customizing/config/deploy/dev.rb
+- examples/recipe/customizing/config/deploy/production.rb
+- examples/recipe/customizing/config/deploy/staging.rb
+- examples/recipe/customizing/lib/capistrano/tasks/tomcat_webapp.cap
+- examples/recipe/customizing/templates/context.xml.erb
+- examples/recipe/multistage/Capfile
+- examples/recipe/multistage/README.md
+- examples/recipe/multistage/config/deploy.rb
+- examples/recipe/multistage/config/deploy/dev.rb
+- examples/recipe/multistage/config/deploy/production.rb
+- examples/recipe/multistage/config/deploy/staging.rb
+- examples/recipe/multistage/lib/capistrano/tasks/tomcat_webapp.cap
+- examples/recipe/multistage/templates/context.xml.erb
+- examples/recipe/singlestage/Capfile
+- examples/recipe/singlestage/README.md
+- examples/recipe/singlestage/lib/capistrano/tasks/tomcat_webapp.cap
+- examples/recipe/singlestage/templates/context.xml.erb
 - lib/capitomcat.rb
+- lib/capitomcat/deploy.rb
+- lib/capitomcat/tasks/deploy.cap
+- lib/capitomcat/version.rb
+- template/context.xml.erb
 homepage: http://sunggun-yu.github.io/capitomcat/
 licenses:
 - Apache 2.0
@@ -72,18 +103,18 @@ 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
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
-summary: Capistrano Recipe for Tomcat
+summary: Capistrano 3 recipe for Tomcat web application deployment
 test_files: []

data/Rakefile

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

data/examples/README.md

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

data/examples/multistage/Capfile

@@ -1,25 +0,0 @@
-# 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"
-set   :tomcat_port, "8080"
-
-# Local file section
-set   :local_war_file, "/your-local-directory/app.war"
-set   :context_template_file, "./template/context.xml.erb"
-
-# Remote setting section
-set   :context_name, "app"
-set(  :remote_docBase) {"/your-remote-directory-to-save-war-file/"+File.basename(local_war_file)} unless exists?(:remote_docBase)
-set   :remote_context_file, "/var/lib/tomcat7/conf/Catalina/localhost/app.xml"
-set   :remote_tomcat_cmd, "/etc/init.d/tomcat7"
-set   :remote_tomcat_work_dir, "/var/lib/tomcat7/work/Catalina/localhost/app"

data/examples/multistage/README.md

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

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

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

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

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

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

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

data/examples/multistage/config/deploy.rb

@@ -1,16 +0,0 @@
-# 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

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

data/examples/singlestage/Capfile

@@ -1,24 +0,0 @@
-# Author:: Sunggun Yu
-
-load 'config/deploy.rb'
-
-# Application host section for DEV
-role  :app, "dev01"
-
-# User section
-set   :user, "user"
-set   :password, "#{password}" #Set password from parameter.
-set   :tomcat_user, "root"
-set   :tomcat_cmd_user, "root"
-set   :tomcat_port, "8080"
-
-# Local file section
-set   :local_war_file, "/your-local-directory/app.war"
-set   :context_template_file, "./template/context.xml.erb"
-
-# Remote setting section
-set   :context_name, "app"
-set(  :remote_docBase) {"/your-remote-directory-to-save-war-file/"+File.basename(local_war_file)} unless exists?(:remote_docBase)
-set   :remote_context_file, "/var/lib/tomcat7/conf/Catalina/localhost/app.xml"
-set   :remote_tomcat_cmd, "/etc/init.d/tomcat7"
-set   :remote_tomcat_work_dir, "/var/lib/tomcat7/work/Catalina/localhost/app"

data/examples/singlestage/config/deploy.rb

@@ -1,16 +0,0 @@
-# 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

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