capitomcat 0.0.3 → 1.0.0

data/examples/native/lib/native/application.rb

@@ -0,0 +1,80 @@
+require 'rake'
+require 'capistrano/all'
+require 'capistrano/setup'
+require 'capistrano/deploy'
+
+class Application
+
+  def self.doCap
+
+    set :stage, :dev
+
+    set :format, :pretty
+    set :log_level, :info
+    set :pty, true
+    set :use_sudo, true
+
+    # Server definition section
+    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, false
+    set :use_context_update, false
+
+    capistrano = Capistrano::Application.new
+    require 'capitomcat'
+    capistrano.invoke('capitomcat:deploy')
+
+    capistrano = Capistrano::Application.new
+    capistrano.add_import('../lib/native/tasks/tomcat_webapp.cap')
+    capistrano.load_imports
+    capistrano.invoke('tomcat:deploy')
+  end
+
+  def self.do_customized_cap
+
+    set :stage, :dev
+
+    set :format, :pretty
+    set :log_level, :info
+    set :pty, true
+    set :use_sudo, true
+
+    # Server definition section
+    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, false
+
+    capistrano = Capistrano::Application.new
+    capistrano.add_import('../lib/native/tasks/tomcat_webapp.cap')
+    capistrano.load_imports
+    capistrano.invoke('tomcat:deploy')
+  end
+end

data/examples/native/lib/native/tasks/tomcat_webapp.cap

@@ -0,0 +1,26 @@
+# Capitomcat
+require 'capitomcat'
+
+namespace :tomcat do
+  desc 'Tomcat WebApp Deployment with context.xml file updating'
+  task :deploy do
+    puts fetch(:context_template_file)
+    on roles(:app), in: get_parallelism, wait: 5 do |hosts|
+      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
+    end
+  end
+end

data/examples/native/lib/native.rb

@@ -0,0 +1,3 @@
+require_relative 'native/application'
+
+Application.doCap

data/examples/native/templates/context.xml.erb

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

data/examples/recipe/customizing/Capfile

@@ -0,0 +1,26 @@
+# Load DSL and Setup Up Stages
+require 'capistrano/setup'
+
+# Includes default deployment tasks
+require 'capistrano/deploy'
+
+# Includes tasks from other gems included in your Gemfile
+#
+# For documentation on these, see for example:
+#
+#   https://github.com/capistrano/rvm
+#   https://github.com/capistrano/rbenv
+#   https://github.com/capistrano/chruby
+#   https://github.com/capistrano/bundler
+#   https://github.com/capistrano/rails/tree/master/assets
+#   https://github.com/capistrano/rails/tree/master/migrations
+#
+# require 'capistrano/rvm'
+# require 'capistrano/rbenv'
+# require 'capistrano/chruby'
+# require 'capistrano/bundler'
+# require 'capistrano/rails/assets'
+# require 'capistrano/rails/migrations'
+
+# Loads custom tasks from `lib/capistrano/tasks' if you have any defined.
+Dir.glob('lib/capistrano/tasks/*.cap').each { |r| import r }

data/examples/recipe/customizing/README.md

@@ -0,0 +1 @@
+# Example Recipe for multi stage tomcat web-app deployment

data/examples/recipe/customizing/config/deploy/dev.rb

@@ -0,0 +1,39 @@
+set :stage, :dev
+
+# Simple Role Syntax
+# ==================
+# Supports bulk-adding hosts to roles, the primary
+# server in each group is considered to be the first
+# unless any hosts have the primary property set.
+role :app, %w{deploy@dev01 deploy@dev02}
+
+# Extended Server Syntax
+# ======================
+# This can be used to drop a more detailed server
+# definition into the server list. The second argument
+# something that quacks like a hash can be used to set
+# extended properties on the server.
+
+# you can set custom ssh options
+# it's possible to pass any option but you need to keep in mind that net/ssh understand limited list of options
+# you can see them in [net/ssh documentation](http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start)
+# set it globally
+#  set :ssh_options, {
+#    keys: %w(/home/rlisowski/.ssh/id_rsa),
+#    forward_agent: false,
+#    auth_methods: %w(password)
+#  }
+# and/or per server
+# server 'example.com',
+#   user: 'user_name',
+#   roles: %w{web app},
+#   ssh_options: {
+#     user: 'user_name', # overrides user setting above
+#     keys: %w(/home/user_name/.ssh/id_rsa),
+#     forward_agent: false,
+#     auth_methods: %w(publickey password)
+#     # password: 'please use keys'
+#   }
+# setting per server overrides global ssh_options
+
+# fetch(:default_env).merge!(rails_env: :production)

data/examples/recipe/customizing/config/deploy/production.rb

@@ -0,0 +1,39 @@
+set :stage, :production
+
+# Simple Role Syntax
+# ==================
+# Supports bulk-adding hosts to roles, the primary
+# server in each group is considered to be the first
+# unless any hosts have the primary property set.
+role :app, %w{deploy@prod01 deploy@prod02}
+
+# Extended Server Syntax
+# ======================
+# This can be used to drop a more detailed server
+# definition into the server list. The second argument
+# something that quacks like a hash can be used to set
+# extended properties on the server.
+
+# you can set custom ssh options
+# it's possible to pass any option but you need to keep in mind that net/ssh understand limited list of options
+# you can see them in [net/ssh documentation](http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start)
+# set it globally
+#  set :ssh_options, {
+#    keys: %w(/home/rlisowski/.ssh/id_rsa),
+#    forward_agent: false,
+#    auth_methods: %w(password)
+#  }
+# and/or per server
+# server 'example.com',
+#   user: 'user_name',
+#   roles: %w{web app},
+#   ssh_options: {
+#     user: 'user_name', # overrides user setting above
+#     keys: %w(/home/user_name/.ssh/id_rsa),
+#     forward_agent: false,
+#     auth_methods: %w(publickey password)
+#     # password: 'please use keys'
+#   }
+# setting per server overrides global ssh_options
+
+# fetch(:default_env).merge!(rails_env: :production)

data/examples/recipe/customizing/config/deploy/staging.rb

@@ -0,0 +1,39 @@
+set :stage, :staging
+
+# Simple Role Syntax
+# ==================
+# Supports bulk-adding hosts to roles, the primary
+# server in each group is considered to be the first
+# unless any hosts have the primary property set.
+role :app, %w{deploy@stg01 deploy@stg02}
+
+# Extended Server Syntax
+# ======================
+# This can be used to drop a more detailed server
+# definition into the server list. The second argument
+# something that quacks like a hash can be used to set
+# extended properties on the server.
+
+# you can set custom ssh options
+# it's possible to pass any option but you need to keep in mind that net/ssh understand limited list of options
+# you can see them in [net/ssh documentation](http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start)
+# set it globally
+#  set :ssh_options, {
+#    keys: %w(/home/rlisowski/.ssh/id_rsa),
+#    forward_agent: false,
+#    auth_methods: %w(password)
+#  }
+# and/or per server
+# server 'example.com',
+#   user: 'user_name',
+#   roles: %w{web app},
+#   ssh_options: {
+#     user: 'user_name', # overrides user setting above
+#     keys: %w(/home/user_name/.ssh/id_rsa),
+#     forward_agent: false,
+#     auth_methods: %w(publickey password)
+#     # password: 'please use keys'
+#   }
+# setting per server overrides global ssh_options
+
+# fetch(:default_env).merge!(rails_env: :staging)

data/examples/recipe/customizing/config/deploy.rb

@@ -0,0 +1,40 @@
+set :application, 'my_app_name'
+set :repo_url, 'git@example.com:me/my_repo.git'
+
+# ask :branch, proc { `git rev-parse --abbrev-ref HEAD`.chomp }
+
+# set :deploy_to, '/var/www/my_app'
+# set :scm, :git
+
+# set :format, :pretty
+# set :log_level, :debug
+# set :pty, true
+
+# set :linked_files, %w{config/database.yml}
+# set :linked_dirs, %w{bin log tmp/pids tmp/cache tmp/sockets vendor/bundle public/system}
+
+# set :default_env, { path: "/opt/ruby/bin:$PATH" }
+# set :keep_releases, 5
+
+namespace :deploy do
+
+  desc 'Restart application'
+  task :restart do
+    on roles(:app), in: :sequence, wait: 5 do
+      # Your restart mechanism here, for example:
+      # execute :touch, release_path.join('tmp/restart.txt')
+    end
+  end
+
+  after :restart, :clear_cache do
+    on roles(:web), in: :groups, limit: 3, wait: 10 do
+      # Here we can do anything such as:
+      # within release_path do
+      #   execute :rake, 'cache:clear'
+      # end
+    end
+  end
+
+  after :finishing, 'deploy:cleanup'
+
+end

data/examples/recipe/customizing/lib/capistrano/tasks/tomcat_webapp.cap

@@ -0,0 +1,49 @@
+# Capitomcat
+require 'capitomcat'
+
+set :format, :pretty
+set :log_level, :info
+set :pty, true
+set :use_sudo, true
+
+# 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
+
+
+namespace :my_tomcat_recipe do
+  desc <<-DESC
+    Also, you can make your own tomcat recipe with method of Capitomcat
+  DESC
+  task :my_task do
+    on roles(:app), in: get_parallelism, wait: 5 do |hosts|
+      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
+    end
+  end
+end

data/examples/recipe/customizing/templates/context.xml.erb

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

data/examples/recipe/multistage/Capfile

@@ -0,0 +1,26 @@
+# Load DSL and Setup Up Stages
+require 'capistrano/setup'
+
+# Includes default deployment tasks
+require 'capistrano/deploy'
+
+# Includes tasks from other gems included in your Gemfile
+#
+# For documentation on these, see for example:
+#
+#   https://github.com/capistrano/rvm
+#   https://github.com/capistrano/rbenv
+#   https://github.com/capistrano/chruby
+#   https://github.com/capistrano/bundler
+#   https://github.com/capistrano/rails/tree/master/assets
+#   https://github.com/capistrano/rails/tree/master/migrations
+#
+# require 'capistrano/rvm'
+# require 'capistrano/rbenv'
+# require 'capistrano/chruby'
+# require 'capistrano/bundler'
+# require 'capistrano/rails/assets'
+# require 'capistrano/rails/migrations'
+
+# Loads custom tasks from `lib/capistrano/tasks' if you have any defined.
+Dir.glob('lib/capistrano/tasks/*.cap').each { |r| import r }

data/examples/recipe/multistage/README.md

@@ -0,0 +1 @@
+# Example Recipe for multi stage tomcat web-app deployment

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

@@ -0,0 +1,39 @@
+set :stage, :dev
+
+# Simple Role Syntax
+# ==================
+# Supports bulk-adding hosts to roles, the primary
+# server in each group is considered to be the first
+# unless any hosts have the primary property set.
+role :app, %w{deploy@dev01 deploy@dev02}
+
+# Extended Server Syntax
+# ======================
+# This can be used to drop a more detailed server
+# definition into the server list. The second argument
+# something that quacks like a hash can be used to set
+# extended properties on the server.
+
+# you can set custom ssh options
+# it's possible to pass any option but you need to keep in mind that net/ssh understand limited list of options
+# you can see them in [net/ssh documentation](http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start)
+# set it globally
+#  set :ssh_options, {
+#    keys: %w(/home/rlisowski/.ssh/id_rsa),
+#    forward_agent: false,
+#    auth_methods: %w(password)
+#  }
+# and/or per server
+# server 'example.com',
+#   user: 'user_name',
+#   roles: %w{web app},
+#   ssh_options: {
+#     user: 'user_name', # overrides user setting above
+#     keys: %w(/home/user_name/.ssh/id_rsa),
+#     forward_agent: false,
+#     auth_methods: %w(publickey password)
+#     # password: 'please use keys'
+#   }
+# setting per server overrides global ssh_options
+
+# fetch(:default_env).merge!(rails_env: :production)

data/examples/recipe/multistage/config/deploy/production.rb

@@ -0,0 +1,39 @@
+set :stage, :production
+
+# Simple Role Syntax
+# ==================
+# Supports bulk-adding hosts to roles, the primary
+# server in each group is considered to be the first
+# unless any hosts have the primary property set.
+role :app, %w{deploy@prod01 deploy@prod02}
+
+# Extended Server Syntax
+# ======================
+# This can be used to drop a more detailed server
+# definition into the server list. The second argument
+# something that quacks like a hash can be used to set
+# extended properties on the server.
+
+# you can set custom ssh options
+# it's possible to pass any option but you need to keep in mind that net/ssh understand limited list of options
+# you can see them in [net/ssh documentation](http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start)
+# set it globally
+#  set :ssh_options, {
+#    keys: %w(/home/rlisowski/.ssh/id_rsa),
+#    forward_agent: false,
+#    auth_methods: %w(password)
+#  }
+# and/or per server
+# server 'example.com',
+#   user: 'user_name',
+#   roles: %w{web app},
+#   ssh_options: {
+#     user: 'user_name', # overrides user setting above
+#     keys: %w(/home/user_name/.ssh/id_rsa),
+#     forward_agent: false,
+#     auth_methods: %w(publickey password)
+#     # password: 'please use keys'
+#   }
+# setting per server overrides global ssh_options
+
+# fetch(:default_env).merge!(rails_env: :production)

data/examples/recipe/multistage/config/deploy/staging.rb

@@ -0,0 +1,39 @@
+set :stage, :staging
+
+# Simple Role Syntax
+# ==================
+# Supports bulk-adding hosts to roles, the primary
+# server in each group is considered to be the first
+# unless any hosts have the primary property set.
+role :app, %w{deploy@stg01 deploy@stg02}
+
+# Extended Server Syntax
+# ======================
+# This can be used to drop a more detailed server
+# definition into the server list. The second argument
+# something that quacks like a hash can be used to set
+# extended properties on the server.
+
+# you can set custom ssh options
+# it's possible to pass any option but you need to keep in mind that net/ssh understand limited list of options
+# you can see them in [net/ssh documentation](http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start)
+# set it globally
+#  set :ssh_options, {
+#    keys: %w(/home/rlisowski/.ssh/id_rsa),
+#    forward_agent: false,
+#    auth_methods: %w(password)
+#  }
+# and/or per server
+# server 'example.com',
+#   user: 'user_name',
+#   roles: %w{web app},
+#   ssh_options: {
+#     user: 'user_name', # overrides user setting above
+#     keys: %w(/home/user_name/.ssh/id_rsa),
+#     forward_agent: false,
+#     auth_methods: %w(publickey password)
+#     # password: 'please use keys'
+#   }
+# setting per server overrides global ssh_options
+
+# fetch(:default_env).merge!(rails_env: :staging)

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

@@ -0,0 +1,40 @@
+set :application, 'my_app_name'
+set :repo_url, 'git@example.com:me/my_repo.git'
+
+# ask :branch, proc { `git rev-parse --abbrev-ref HEAD`.chomp }
+
+# set :deploy_to, '/var/www/my_app'
+# set :scm, :git
+
+# set :format, :pretty
+# set :log_level, :debug
+# set :pty, true
+
+# set :linked_files, %w{config/database.yml}
+# set :linked_dirs, %w{bin log tmp/pids tmp/cache tmp/sockets vendor/bundle public/system}
+
+# set :default_env, { path: "/opt/ruby/bin:$PATH" }
+# set :keep_releases, 5
+
+namespace :deploy do
+
+  desc 'Restart application'
+  task :restart do
+    on roles(:app), in: :sequence, wait: 5 do
+      # Your restart mechanism here, for example:
+      # execute :touch, release_path.join('tmp/restart.txt')
+    end
+  end
+
+  after :restart, :clear_cache do
+    on roles(:web), in: :groups, limit: 3, wait: 10 do
+      # Here we can do anything such as:
+      # within release_path do
+      #   execute :rake, 'cache:clear'
+      # end
+    end
+  end
+
+  after :finishing, 'deploy:cleanup'
+
+end

data/examples/recipe/multistage/lib/capistrano/tasks/tomcat_webapp.cap

@@ -0,0 +1,23 @@
+# Capitomcat
+require 'capitomcat'
+
+set :format, :pretty
+set :log_level, :info
+set :pty, true
+set :use_sudo, true
+
+# 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

data/examples/recipe/multistage/templates/context.xml.erb

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

data/examples/recipe/singlestage/Capfile

@@ -0,0 +1,26 @@
+# Load DSL and Setup Up Stages
+require 'capistrano/setup'
+
+# Includes default deployment tasks
+require 'capistrano/deploy'
+
+# Includes tasks from other gems included in your Gemfile
+#
+# For documentation on these, see for example:
+#
+#   https://github.com/capistrano/rvm
+#   https://github.com/capistrano/rbenv
+#   https://github.com/capistrano/chruby
+#   https://github.com/capistrano/bundler
+#   https://github.com/capistrano/rails/tree/master/assets
+#   https://github.com/capistrano/rails/tree/master/migrations
+#
+# require 'capistrano/rvm'
+# require 'capistrano/rbenv'
+# require 'capistrano/chruby'
+# require 'capistrano/bundler'
+# require 'capistrano/rails/assets'
+# require 'capistrano/rails/migrations'
+
+# Loads custom tasks from `lib/capistrano/tasks' if you have any defined.
+Dir.glob('lib/capistrano/tasks/*.cap').each { |r| import r }

data/examples/recipe/singlestage/README.md

@@ -0,0 +1 @@
+# Example Recipe for single stage tomcat web-app deployment

data/examples/recipe/singlestage/lib/capistrano/tasks/tomcat_webapp.cap

@@ -0,0 +1,29 @@
+# Capitomcat
+require 'capitomcat'
+
+set :stage, :dev
+
+set :format, :pretty
+set :log_level, :info
+set :pty, true
+set :use_sudo, true
+
+# Server definition section
+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, false

data/examples/recipe/singlestage/templates/context.xml.erb

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

data/lib/capitomcat/deploy.rb

@@ -0,0 +1 @@
+load File.expand_path('../tasks/deploy.cap', __FILE__)