capistrano-psw 1.0.0.pre31 → 1.0.0.pre32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd93a3a13b6a7b943b03a86c1fbf33cf1fba0f46
-  data.tar.gz: 1f660e61bc1d7bf18464b597fc812de1b8f93250
+  metadata.gz: d01081943f864d84807135605d48b146cd5c2b45
+  data.tar.gz: ea7389d436a56f1303dc9ac45d1b109365296adc
 SHA512:
-  metadata.gz: a11b713479c75689af16183353e0e73235bc40543232d8a82b3ec773253bd70b675af2d3bb72fbf374e558ab56aedea9f5771fd766915136f995959deea55719
-  data.tar.gz: 9528508ec5d5f4784bf45ffefec64cf78bf5f8eb75d1412ff67ec21a62896f4ab927d3c485b0ac2b910e0bc53363165b73d609df9d5e23d4713b70abb31c6536
+  metadata.gz: 1fd791a3ddfd38e29adcf83ee113baf39a8cd79f5f1ab949e2f59eadb9738cecc628d14d3e6820a140d6649bcd603de5673c4a0c6bd85e5593dd27d9f7711b94
+  data.tar.gz: 6e45dd4eea06315d013629b44e7b99d32700b4dd042cadd05f9ea4d35462b8aad690264a309ef0892b0995319acfb9ae7f36d3b812401b51217afc04ee27f53f

data/README.md

@@ -232,6 +232,20 @@ by peppr. Note: This should only be used if peppr is deploying the
 application. However, if the environment files do not exist, they
 will not be uploaded.
 
+### psw_peppr_app_deploy:upload_artifacts
+This task will upload your application's associated artifacts to the correct folder
+on the remote machine.
+
+### psw_peppr_app_deploy:remove_existing_source_repo
+This task will remove existing Capistrano source repo on the remote machine.
+
+### psw_peppr_app_deploy:set_deploy_revision
+This task will update Capistrano branch environment to point to the Peppr branch.
+
+### psw_peppr_app_deploy:link_artifacts
+This task will create a symbolic link from the remote artifacts directory to the current
+release directory as "/artifacts"
+
 ```ruby
 #set psw app deploy prefs
 before 'psw_peppr_app_deploy:default', :set_app_deploy_options do  
@@ -282,6 +296,15 @@ before :'psw_apache2:deploy_ssl_certs', :set_apache2_options do
   set :psw_apache2_shared_cert_dir, ""
 end
 ```
+## Java EE-related Tasks
+These tasks are needed to facilitate Java EE deployments.
+
+
+### psw_javaee:explode_war_file
+This task will explode a WAR file into a specified directory.  
+Parameters:
+*explode_directory [String] - The directory to which the exploded contents will be written
+*war_file_location [String] - The absolute path of the WAR file.
 
 ## License
 

data/lib/capistrano/psw/peppr_app_deploy_file_utils.rb

@@ -16,6 +16,7 @@ module PepprAppDeployFileUtils
   PEPPR_RELATIVE_TMP_DIR = "/tmp"
   PEPPR_RELATIVE_ENVIRONMENTS_DIR = "/environments"
   PEPPR_RELATIVE_SHARED_FILE_DIR = "/shared_files"
+  PEPPR_RELATIVE_ARTIFACTS_DIR = "/artifacts"
     
   module Local
     # Method for verifying that Peppr's application deployment file structure exists on the
@@ -32,6 +33,7 @@ module PepprAppDeployFileUtils
         execute :mkdir, '-p', PepprAppDeployFileUtils::Local::get_deployment_tmp_dir
         execute :mkdir, '-p', PepprAppDeployFileUtils::Local::get_deployment_environments_dir
         execute :mkdir, '-p', PepprAppDeployFileUtils::Local::get_deployment_shared_files_dir
+        execute :mkdir, '-p', PepprAppDeployFileUtils::Local::get_deployment_artifacts_dir
       end    
     end
 
@@ -89,9 +91,19 @@ module PepprAppDeployFileUtils
       PepprAppDeployFileUtils::Local::get_deployment_dir(PEPPR_RELATIVE_ENVIRONMENTS_DIR)
     end   
 
+    # Method for retrieving the Peppr application deployment shared files directory
+    #
+    # @return [String] the fully-qualified local shared files directory
     def self.get_deployment_shared_files_dir
       "#{PepprAppDeployFileUtils::Local::get_deployment_environments_dir()}/#{fetch(:stage)}#{PEPPR_RELATIVE_SHARED_FILE_DIR}"
-    end       
+    end
+
+    # Method for retrieving the Peppr application deployment artifacts directory
+    #
+    # @return [String] the fully-qualified local artifacts directory
+    def self.get_deployment_artifacts_dir
+      PepprAppDeployFileUtils::Local::get_deployment_dir(PEPPR_RELATIVE_ARTIFACTS_DIR)
+    end
   end
 
   module Remote
@@ -109,7 +121,8 @@ module PepprAppDeployFileUtils
         execute :mkdir, '-p', PepprAppDeployFileUtils::Remote::get_deployment_scripts_dir
         execute :mkdir, '-p', PepprAppDeployFileUtils::Remote::get_deployment_tmp_dir
         execute :mkdir, '-p', PepprAppDeployFileUtils::Remote::get_deployment_environments_dir
-        execute :mkdir, '-p', PepprAppDeployFileUtils::Remote::get_deployment_shared_files_dir        
+        execute :mkdir, '-p', PepprAppDeployFileUtils::Remote::get_deployment_shared_files_dir   
+        execute :mkdir, '-p', PepprAppDeployFileUtils::Remote::get_deployment_artifacts_dir     
       end    
     end
 
@@ -167,12 +180,19 @@ module PepprAppDeployFileUtils
       PepprAppDeployFileUtils::Remote::get_deployment_dir(PEPPR_RELATIVE_ENVIRONMENTS_DIR)
     end
 
-    # Method for retrieving the Peppr application deployment environments directory
+    # Method for retrieving the Peppr application deployment shared files directory
     #
     # @return [String] the fully-qualified remote shared files directory
     def self.get_deployment_shared_files_dir
       "#{PepprAppDeployFileUtils::Remote::get_deployment_environments_dir()}/#{fetch(:stage)}#{PEPPR_RELATIVE_SHARED_FILE_DIR}"
-    end     
+    end
+
+    # Method for retrieving the Peppr application deployment artifacts directory
+    #
+    # @return [String] the fully-qualified remote artifacts directory
+    def self.get_deployment_artifacts_dir
+      PepprAppDeployFileUtils::Remote::get_deployment_dir(PEPPR_RELATIVE_ARTIFACTS_DIR)
+    end    
   end
 
   # Method to compress, upload, and extract a local directory using the following procedure:

data/lib/capistrano/psw/version.rb

@@ -10,6 +10,6 @@
 
 module Capistrano
   module Psw
-    VERSION = "1.0.0.pre31"
+    VERSION = "1.0.0.pre32"
   end
 end

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

@@ -0,0 +1,33 @@
+# == psw-javaee.cap
+#
+# Contains the capistrano tasks needed to facilitate Java EE deployments.
+#
+# == Configuration
+#
+# == Tasks
+#
+# === psw_javaee:explode_war_file
+# This task will explode a WAR file into a specified directory.  
+# Parameters:
+# *explode_directory [String] - The directory to which the exploded contents will be written
+# *war_file_location [String] - The absolute path of the WAR file.
+#
+# == Contact
+#
+# Author::    Lexmark International Technology S.A.
+# Copyright:: 2014 Lexmark International Technology S.A.  All rights reserved.
+# License::   3-Clause BSD
+#
+require 'capistrano/psw/peppr_app_deploy_file_utils'
+  
+namespace :psw_javaee do
+
+	desc 'Explodes a WAR file into a specified directory'
+  task :explode_war_file, :explode_directory, :war_file_location do |t, args|
+    on roles(:app) do |host|
+     puts "Exploding WAR file #{args[:war_file_location]} to #{args[:explode_directory]}..."
+     execute :mkdir, '-p', args[:explode_directory]
+     execute("cd #{args[:explode_directory]} ; /usr/bin/jar xf #{args[:war_file_location]}")
+    end
+  end
+end

data/resources/lib/capistrano/tasks/psw-peppr-app-deploy.cap

@@ -29,6 +29,17 @@
 # application. However, if the environment files do not exist, they
 # will not be uploaded.
 #
+# === psw_peppr_app_deploy:upload_artifacts
+# This task will upload your application's associated artifacts to the correct folder
+# on the remote machine.
+#
+# === psw_peppr_app_deploy:set_deploy_revision
+# This task will update Capistrano branch environment to point to the Peppr branch.
+#
+# === psw_peppr_app_deploy:link_artifacts
+# This task will create a symbolic link from the remote artifacts directory to the current
+# release directory as "/artifacts"
+#
 # == Contact
 #
 # Author::    Lexmark International Technology S.A.
@@ -116,7 +127,18 @@ namespace :psw_peppr_app_deploy do
         info "The shared files path, #{local_shared_files_path} does not exist."
       end
     end
-  end  
+  end
+
+  desc 'Upload application source repository to remote server'
+  task :upload_artifacts do
+    on roles(:all) do |host|
+      local_dir = PepprAppDeployFileUtils::Local::get_deployment_artifacts_dir
+      remote_dir = PepprAppDeployFileUtils::Remote::get_deployment_artifacts_dir
+
+      info "Uploading #{local_dir} (local) to #{remote_dir} on remote server #{host}..."
+      PepprAppDeployFileUtils::upload_compressed_local_dir(local_dir, remote_dir)
+    end
+  end
 
   desc 'Remove existing Capistrano source repo'
   task :remove_existing_source_repo do
@@ -126,6 +148,7 @@ namespace :psw_peppr_app_deploy do
     end
   end
 
+  desc 'Update Capistrano branch environment to point to the Peppr branch'
   task :set_deploy_revision do
     on roles(:all) do
       unless ENV['branch'].nil?
@@ -137,7 +160,21 @@ namespace :psw_peppr_app_deploy do
     end
   end
 
-  desc "Deploy private repository to remote server(s)"
-  task default: [:'set_deploy_revision', :'create_deployment_directories', :'upload_app_source_repo', :'upload_environment_files', :'remove_existing_source_repo'] do
+  desc "Deploy a Peppr application to the remote server(s)"
+  task default: [:'set_deploy_revision', :'create_deployment_directories', :'upload_app_source_repo', :'upload_environment_files', :'upload_artifacts', :'remove_existing_source_repo'] do 
+  end
+
+  desc 'Task to create a symlink from the artifacts directory to the release directory'
+  task :link_artifacts do
+    on roles(:all) do |host|
+      remote_dir = PepprAppDeployFileUtils::Remote::get_deployment_artifacts_dir
+
+      info "Creating a symlink from the artifacts directory (#{remote_dir}) in the current release directory #{fetch(:release_path)}/artifacts on remote server #{host}..."
+      sudo :ln, '-s', "#{remote_dir}", "#{fetch(:release_path)}/artifacts"
+    end
+  end
+
+  desc "Optional steps to execute a Peppr deployment after a Capistrano deploy has finished"
+  task post_deploy_steps: [:'link_artifacts'] do
   end
-end
+end

data/spec/psw-javaee_spec.rb

@@ -0,0 +1,20 @@
+require "rake"
+require File.expand_path('../spec_helper.rb', __FILE__)
+
+
+describe "psw_javaee:" do
+  describe "explode_war_file" do
+    let(:rake)      { Rake::Application.new }
+    subject         { rake["psw_javaee:explode_war_file"] }
+    
+    before do
+      Rake.application = rake
+      Rake.application.add_import("./resources/lib/capistrano/tasks/psw-javaee.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.pre31
+  version: 1.0.0.pre32
 platform: ruby
 authors:
 - Lexmark International Technology S.A
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-29 00:00:00.000000000 Z
+date: 2014-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,6 +89,7 @@ files:
 - lib/capistrano/psw/version.rb
 - resources/lib/capistrano/tasks/psw-apache2.cap
 - resources/lib/capistrano/tasks/psw-clockwork.cap
+- resources/lib/capistrano/tasks/psw-javaee.cap
 - resources/lib/capistrano/tasks/psw-nginx.cap
 - resources/lib/capistrano/tasks/psw-peppr-app-deploy.cap
 - resources/lib/capistrano/tasks/psw-peppr.cap
@@ -96,6 +97,7 @@ files:
 - resources/lib/capistrano/tasks/psw-sidekiq.cap
 - spec/psw-apache2_spec.rb
 - spec/psw-clockwork_spec.rb
+- spec/psw-javaee_spec.rb
 - spec/psw-nginx_spec.rb
 - spec/psw-peppr-app-deploy_spec.rb
 - spec/psw-peppr_spec.rb
@@ -132,6 +134,7 @@ summary: Contains Capistrano v3 Deployment Tasks
 test_files:
 - spec/psw-apache2_spec.rb
 - spec/psw-clockwork_spec.rb
+- spec/psw-javaee_spec.rb
 - spec/psw-nginx_spec.rb
 - spec/psw-peppr-app-deploy_spec.rb
 - spec/psw-peppr_spec.rb