capistrano-psw 1.0.0.pre19 → 1.0.0.pre20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bcad68fd6f61bdd7ccc802f0685331649698595
-  data.tar.gz: e4fac297e8c3f57ad0c9746ce0f14acbfacc5594
+  metadata.gz: fac3821682e68f811796d48840f4745551939f17
+  data.tar.gz: e7655a4df532093aa1b0473753b64542d4c21917
 SHA512:
-  metadata.gz: d1ab45f7e01ac05a071e615075c569c33c465b9c8716bde444edb7f95c92af20eeb59620037c329aaa9160505e6da171fffb81eed34e6f162b9ae494dcaa3ed6
-  data.tar.gz: aea76262b7bf000a000e2cb024ea73cb22a97ff8789d3def110625002a6f705928216ec2e24b755581ed84f29805f370d60eec56082e6dc18bd50d179d03ab1c
+  metadata.gz: e663383874c35092d3607508334189aa6cd5daec2bf932863ed36fdcb2147706622b83e627394800a13d68096eee05492be74d61730149eef73db81e43f7c170
+  data.tar.gz: ced44af859b0983624f96cb001c9434c91b06b27020bc2d60f451425ce3f6bfe69ffbf319304f24a30ba583abde7367ab1346a29bff08458711957b439e66d16

data/README.md

@@ -241,6 +241,48 @@ end
 before :starting, 'psw_peppr_app_deploy:default'
 ```
 
+## apache2-related Tasks
+These tasks are used to interact with the apache2 web server.
+
+
+### psw_apache2:deploy_ssl_certs
+This task will copy SSL certificates defined in the application's shared directory
+to /etc/ssl/certs and /etc/ssl/private.
+
+### psw_apache2:configure_apache2
+This task task will override the site definition for a specific apache2 virtual site
+and enable it via a symlink in sites-enabled.  This method allows consumers to define an
+ERB template as well as pass in a ruby binding to populate it.
+
+### psw_apache2:upload_symlink_script
+Once the code is on the remote server, we'll need to provide apache a symlink
+to access the current version.  Because the apache configuration is varies from
+OS to OS, a bash script is needed to determine the apache DocumentRoot and 
+generate the appropriate symlink.  This task will copy a script to the remote
+server to generate the symlink.
+
+### psw_apache2:upload_apache_ctrl_script
+After code deployment, the apache2 server will need to be manipulated.
+Because the apache configuration is varies from OS to OS, a bash script is needed
+to execute commands.  This task will copy a script to the remote server to execute
+apache2 server commands.
+
+```ruby
+before :'psw_apache2:configure_apache2', :set_apache2_options do 
+  set :psw_apache2_site_template, File.expand_path("../../lib/capistrano/templates/apache2/my-site.erb", __FILE__)
+  set :psw_apache2_site_name, "my-site"
+end
+
+before :'psw_apache2:deploy_ssl_certs', :set_apache2_ssl_options do 
+  set :psw_apache2_ssl_cert_file, "#{shared_path}/apache2/ssl/my-cert.crt"
+  set :psw_apache2_ssl_key_file, "#{shared_path}/apache2/ssl/my-cert.key"
+end
+
+before :'psw_apache2:deploy_ssl_certs', :set_apache2_options do  
+  set :psw_apache2_shared_cert_dir, ""
+end
+```
+
 ## License
 
 2014 Lexmark International Technology S.A.  All rights reserved.

data/lib/capistrano/psw/version.rb

@@ -10,6 +10,6 @@
 
 module Capistrano
   module Psw
-    VERSION = "1.0.0.pre19"
+    VERSION = "1.0.0.pre20"
   end
 end

data/resources/lib/capistrano/tasks/psw-apache2.cap

@@ -0,0 +1,289 @@
+# == psw-apache2.cap
+#
+# Contains the capistrano tasks needed to interact with the apache2 web server
+#
+# == Configuration
+#
+# To use the defined tasks, hook into other tasks.
+#
+# Examples:
+#
+#  after :depoy_and_configure_ssl do
+#    Rake::Task['psw_apache2:deploy_ssl_certs'].invoke
+#    Rake::Task['psw_apache2:configure_apache2'].invoke(binding)    
+#  end
+#
+# == Tasks
+#
+# === psw_apache2:deploy_ssl_certs
+# This task will copy SSL certificates defined in the application's shared directory
+# to /etc/ssl/certs and /etc/ssl/private.
+#
+# === psw_apache2:configure_apache2
+# This task task will override the site definition for a specific apache2 virtual site
+# and enable it via a symlink in sites-enabled.  This method allows consumers to define an
+# ERB template as well as pass in a ruby binding to populate it.
+#
+# === psw_apache2:upload_symlink_script
+# Once the code is on the remote server, we'll need to provide apache a symlink
+# to access the current version.  Because the apache configuration is varies from
+# OS to OS, a bash script is needed to determine the apache DocumentRoot and 
+# generate the appropriate symlink.  This task will copy a script to the remote
+# server to generate the symlink.
+#
+# === psw_apache2:upload_apache_ctrl_script
+# After code deployment, the apache2 server will need to be manipulated.
+# Because the apache configuration is varies from OS to OS, a bash script is needed
+# to execute commands.  This task will copy a script to the remote server to execute
+# apache2 server commands.
+#
+# == Configuration
+# The following configuration options may be set (should be set before the 'stop' task is executed):
+#
+# before :'psw_apache2:configure_apache2', :set_apache2_options do 
+#   set :psw_apache2_site_template, File.expand_path("../../lib/capistrano/templates/apache2/my-site.erb", __FILE__)
+#   set :psw_apache2_site_name, "my-site"
+# end
+#
+# before :'psw_apache2:deploy_ssl_certs', :set_apache2_ssl_options do 
+#   set :psw_apache2_ssl_cert_file, "#{shared_path}/apache2/ssl/my-cert.crt"
+#   set :psw_apache2_ssl_key_file, "#{shared_path}/apache2/ssl/my-cert.key"
+# end
+#
+# before :'psw_apache2:deploy_ssl_certs', :set_apache2_options do  
+#   set :psw_apache2_shared_cert_dir, ""
+# end
+#
+# == Contact
+#
+# Author::    Lexmark International Technology S.A.
+# Copyright:: 2014 Lexmark International Technology S.A.  All rights reserved.
+# License::   3-Clause BSD
+#
+require 'tempfile'
+require 'pathname'
+require 'capistrano/psw/peppr_app_deploy_file_utils'
+ 
+namespace :psw_apache2 do
+
+  #ssl cert properties
+  def get_ssl_cert_file
+    fetch(:psw_apache2_ssl_cert_file, "")
+  end
+
+  def get_ssl_key_file
+    fetch(:psw_apache2_ssl_key_file, "")
+  end
+
+  def get_ssl_chain_file
+    fetch(:psw_apache2_ssl_chain_file, "")
+  end  
+
+  #config properties
+  def get_apache2_config_dir
+    fetch(:psw_apache2_config_dir, "/config/apache2")
+  end
+
+  def get_apache2_site_template
+    fetch(:psw_apache2_site_template, "")
+  end
+
+  def get_apache2_site_name
+    fetch(:psw_apache2x_site_name, "")
+  end
+
+  task :deploy_ssl_certs do
+    on roles(:app) do |host|
+      info "Creating cert directory..."
+      ssl_cert_dir = "/etc/ssl/certs"
+      sudo :mkdir, '-p', ssl_cert_dir
+
+      ssl_private_dir = "/etc/ssl/private"
+      info "Creating cert key directory..."
+      sudo :mkdir, '-p', ssl_private_dir
+
+      ssl_cert_file = "#{get_ssl_cert_file}"
+      ssl_cert_filename = Pathname.new(ssl_cert_file).basename
+      info "Copying certificate (#{ssl_cert_file}) to cert directory..."
+      sudo :rm, "-rf", "#{ssl_cert_dir}/#{ssl_cert_filename}"
+      sudo :cp, ssl_cert_file, ssl_cert_dir
+      sudo :chmod, '600', "#{ssl_cert_dir}/#{ssl_cert_filename}"
+
+      ssl_key_file = "#{get_ssl_key_file}"
+      ssl_key_filename = Pathname.new(ssl_key_file).basename
+      info "Copying certificate key (#{ssl_key_file}) to key directory..."
+      sudo :rm, '-rf', "#{ssl_private_dir}/#{ssl_key_filename}"
+      sudo :cp, ssl_key_file, ssl_private_dir
+      sudo :chmod, '600', "#{ssl_private_dir}/#{ssl_key_filename}"
+
+      ssl_chain_file = "#{get_ssl_chain_file}"
+      ssl_chain_filename = Pathname.new(ssl_chain_file).basename
+      info "Copying certificate key (#{ssl_chain_file}) to cert directory..."
+      sudo :rm, '-rf', "#{ssl_cert_dir}/#{ssl_chain_filename}"
+      sudo :cp, ssl_chain_file, ssl_cert_dir
+      sudo :chmod, '600', "#{ssl_cert_dir}/#{ssl_chain_filename}"      
+    end
+  end
+
+  task :configure_apache2, :template_binding do |t, args|
+    on roles(:app) do |host|
+      info "Configuring apache2..."
+
+      site_template_path = get_apache2_site_template
+      unless site_template_path.nil? || site_template_path.length == 0
+        info "Adding site template #{site_template_path} to apache2..."
+
+        site_template = ERB.new File.new(site_template_path).read, nil, "%"
+        template_binding = (!args[:template_binding].nil? && args[:template_binding]) || binding
+        site = site_template.result(template_binding)
+        
+        tmp_site_file = Tempfile.new("#{get_apache2_site_name}-")
+        tmp_site_file.write(site)
+        tmp_site_file.flush
+
+        shared_apache2_config_dir = "#{shared_path}#{get_apache2_config_dir}"
+        info "Creating shared apache2 configuration directory #{shared_apache2_config_dir}..."
+        execute :mkdir, '-p', shared_apache2_config_dir
+
+        info "Uploading apache2 site configuration for site #{get_apache2_site_name}..."
+        shared_apache2_config_file = "#{shared_apache2_config_dir}/#{get_apache2_site_name}"
+        upload! "#{tmp_site_file.path}", "#{shared_apache2_config_file}"
+
+        #symlink to site-enabled
+        #note that /etc/apache2 is ubuntu specific
+        info "Creating a symlink for site #{get_apache2_site_name}..."
+        sudo :rm, '-rf', "/etc/apache2/sites-enabled/#{get_apache2_site_name}"
+        sudo :rm, '-rf', "/etc/apache2/sites-available/#{get_apache2_site_name}"
+
+        sudo :mkdir, '-p', "/etc/apache2/sites-available/"
+        sudo :ln, '-s', "#{shared_apache2_config_file}", "/etc/apache2/sites-available/#{get_apache2_site_name}"
+
+        sudo :mkdir, '-p', "/etc/apache2/sites-enabled/"
+        sudo :ln, '-s', "/etc/apache2/sites-available/#{get_apache2_site_name}", "/etc/apache2/sites-enabled/#{get_apache2_site_name}"
+      else
+        info "A site template has not been defined for apache2"
+      end
+    end
+  end
+
+  desc 'Upload a bash script that can create the appropriate apache document symlink...'
+  task :upload_symlink_script do
+    bash_script = <<-eos
+      #!/bin/bash
+      # Create link in apache2's DocumentRoot to current peppr deployment
+
+      peppr_current_location=$1
+      if [ -z "$peppr_current_location" ]; then
+        echo "Peppr current location not specified!"
+        exit 0
+      fi
+      echo "Current peppr location:  $peppr_current_location"
+
+      echo "Determining the Apache service name..."
+      os_version=$(lsb_release -r)
+      if [[ "$os_version" == *Release:* ]]; then
+        echo "Running on a debian system.  Using service name apache2"
+        apache_service_name="apache2"
+      else
+        echo "Running on a non-debian system.  Using service name httpd"
+        apache_service_name="httpd"
+      fi
+
+      apache_config_location=$($apache_service_name -V | grep -i " -D HTTPD_ROOT=")
+      if [ -z "$apache_config_location" ]; then
+        echo "No apache configuration location has been defined!"
+        exit 0
+      fi
+      apache_config_location=${apache_config_location:16}
+      apache_config_location=${apache_config_location%?}
+      echo "Apache2 Config Location: $apache_config_location"
+
+      apache_config_file==$($apache_service_name -V | grep -i " -D SERVER_CONFIG_FILE=")
+      if [ -z "$apache_config_location" ]; then
+        echo "No apache configuration file has been defined!"
+        exit 0
+      fi
+      apache_config_file=${apache_config_file:25}
+      apache_config_file=${apache_config_file%?}
+      apache_config_file_location="$apache_config_location/$apache_config_file"
+      echo "Apache2 Config File Location: $apache_config_file_location"
+
+      apache_docroot_dir=$(grep -i 'DocumentRoot ' $apache_config_file_location)
+      if [ -z "$apache_docroot_dir" ]; then
+        echo "Unable to find apache's DocumentRoot!"
+        exit 0
+      fi
+      apache_docroot_dir=${apache_docroot_dir:14}
+      apache_docroot_dir=${apache_docroot_dir%?}
+      echo "Apache2 DocRoot: $apache_docroot_dir"
+      result=$(sudo rm -rf $apache_docroot_dir)
+
+      peppr_docroot="$apache_docroot_dir"
+      echo "Peppr DocRoot:  $peppr_docroot"
+      echo "Creating link $peppr_docroot to directory $peppr_current_location..."
+      echo "Executing:  sudo ln -nsf $peppr_current_location $peppr_docroot"
+      result=$(sudo rm -rf $peppr_docroot)
+      result=$(sudo ln -nsf $peppr_current_location $peppr_docroot)
+
+      link_listing=$(ls -la $peppr_docroot)
+      echo "Resulting Link: $link_listing"
+      echo "Script completed!"     
+    eos
+
+    local_script_dir= PepprAppDeployFileUtils::Local::get_deployment_scripts_dir
+    symlink_script_name = "apache-symlink.sh"
+    local_symlink_file = "#{local_script_dir}/#{symlink_script_name}"
+    File.open(local_symlink_file, 'w') {|f| f.write(bash_script) }
+
+    remote_ctrl_dir = PepprAppDeployFileUtils::Remote::get_deployment_scripts_dir
+    remote_symlink_file = "#{remote_ctrl_dir}/#{symlink_script_name}"
+    on roles(:all) do |host|
+      info "Uploading #{local_symlink_file} to #{remote_symlink_file} on remote server #{host}..."
+      execute :rm, '-rf', "#{remote_symlink_file}"
+      execute :mkdir, '-p', "#{remote_ctrl_dir}"
+      upload! "#{local_symlink_file}", "#{remote_symlink_file}"
+    end
+  end
+
+  desc 'Upload a bash script that can execute OS-agnostic apache server commands...'
+  task :upload_apache_ctrl_script do
+    bash_script = <<-eos
+      #!/bin/bash
+      # Script to execute OS-agnostic apache server commands
+
+      server_command=$1
+      if [ -z "$server_command" ]; then
+        echo "No server command specified!"
+        exit 0
+      fi
+
+      echo "Determining the Apache service name..."
+      os_version=$(lsb_release -r)
+      if [[ "$os_version" == *Release:* ]]; then
+        echo "Running on a debian system.  Using service name apache2"
+        apache_service_name="apache2"
+      else
+        echo "Running on a non-debian system.  Using service name httpd"
+        apache_service_name="httpd"
+      fi
+
+      echo "Executing command:  sudo /etc/init.d/$apache_service_name $server_command"
+      result=$(sudo /etc/init.d/$apache_service_name $server_command)    
+      echo "Script completed!"
+    eos
+
+    local_script_dir= PepprAppDeployFileUtils::Local::get_deployment_scripts_dir
+    apache_ctrl_script_name = "apache-ctrl.sh"
+    local_ctrl_file = "#{local_script_dir}/#{apache_ctrl_script_name}"
+    File.open(local_ctrl_file, 'w') {|f| f.write(bash_script) }
+
+    remote_ctrl_dir = PepprAppDeployFileUtils::Remote::get_deployment_scripts_dir
+    remote_ctrl_file = "#{remote_ctrl_dir}/#{apache_ctrl_script_name}"
+    on roles(:all) do |host|
+      info "Uploading #{local_ctrl_file} to #{remote_ctrl_file} on remote server #{host}..."
+      execute :rm, '-rf', "#{remote_ctrl_file}"
+      execute :mkdir, '-p', "#{remote_ctrl_dir}"
+      upload! "#{local_ctrl_file}", "#{remote_ctrl_file}"
+    end
+  end  
+end

data/spec/psw-apache2_spec.rb

@@ -0,0 +1,65 @@
+require "rake"
+require File.expand_path('../spec_helper.rb', __FILE__)
+
+
+describe "psw_apache2:" do
+  describe "deploy_ssl_certs" do
+    let(:rake)      { Rake::Application.new }
+    subject         { rake["psw_apache2:deploy_ssl_certs"] }
+    
+    before do
+      Rake.application = rake
+      Rake.application.add_import("./resources/lib/capistrano/tasks/psw-apache2.cap")
+      Rake.application.load_imports()   
+    end
+
+    it "has 'no prerequisites" do
+      subject.prerequisites.should be_empty
+    end 
+  end
+
+  describe "configure_apache2" do
+    let(:rake)      { Rake::Application.new }
+    subject         { rake["psw_apache2:configure_apache2"] }
+    
+    before do
+      Rake.application = rake
+      Rake.application.add_import("./resources/lib/capistrano/tasks/psw-apache2.cap")
+      Rake.application.load_imports()   
+    end
+
+    it "has 'no prerequisites" do
+      subject.prerequisites.should be_empty
+    end 
+  end    
+
+  describe "upload_symlink_script" do
+    let(:rake)      { Rake::Application.new }
+    subject         { rake["psw_apache2:upload_symlink_script"] }
+    
+    before do
+      Rake.application = rake
+      Rake.application.add_import("./resources/lib/capistrano/tasks/psw-apache2.cap")
+      Rake.application.load_imports()   
+    end
+
+    it "has 'no prerequisites" do
+      subject.prerequisites.should be_empty
+    end 
+  end   
+
+  describe "upload_apache_ctrl_script" do
+    let(:rake)      { Rake::Application.new }
+    subject         { rake["psw_apache2:upload_apache_ctrl_script"] }
+    
+    before do
+      Rake.application = rake
+      Rake.application.add_import("./resources/lib/capistrano/tasks/psw-apache2.cap")
+      Rake.application.load_imports()   
+    end
+
+    it "has 'no prerequisites" do
+      subject.prerequisites.should be_empty
+    end 
+  end   
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-psw
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre19
+  version: 1.0.0.pre20
 platform: ruby
 authors:
 - Lexmark International Technology S.A
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-06 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,12 +87,14 @@ files:
 - lib/capistrano/psw/server_utils.rb
 - lib/capistrano/psw/task_loader.rb
 - lib/capistrano/psw/version.rb
+- resources/lib/capistrano/tasks/psw-apache2.cap
 - resources/lib/capistrano/tasks/psw-clockwork.cap
 - resources/lib/capistrano/tasks/psw-nginx.cap
 - resources/lib/capistrano/tasks/psw-peppr-app-deploy.cap
 - resources/lib/capistrano/tasks/psw-peppr.cap
 - resources/lib/capistrano/tasks/psw-repo.cap
 - resources/lib/capistrano/tasks/psw-sidekiq.cap
+- spec/psw-apache2_spec.rb
 - spec/psw-clockwork_spec.rb
 - spec/psw-nginx_spec.rb
 - spec/psw-peppr-app-deploy_spec.rb
@@ -128,6 +130,7 @@ signing_key:
 specification_version: 4
 summary: Contains Capistrano v3 Deployment Tasks
 test_files:
+- spec/psw-apache2_spec.rb
 - spec/psw-clockwork_spec.rb
 - spec/psw-nginx_spec.rb
 - spec/psw-peppr-app-deploy_spec.rb