capistrano-psw 1.0.0.pre16 → 1.0.0.pre17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62f251fcd42ad327b38073d97e92d287b13eae9c
-  data.tar.gz: 5fcc70c1c08e94f41b4863cd19597e2661edfc85
+  metadata.gz: 3f3a1a48b849ee4b1ec7e83e1b23dcbd132f88a9
+  data.tar.gz: 3ee950684c97c014ce7660b6e073416a3b731d23
 SHA512:
-  metadata.gz: 37bedeca93357a000f7cf7e491bcedcae18e3f356ddfce71d78f835d087287ee8e680436598b9dd90145feb44c9d78b980a3afbb92c7faf9dc63b72fa029c5ac
-  data.tar.gz: 20204eb5075ed68b824465678ef25e62ece901f5312197ffa7ae7320a9c1ae04cd9fa16734600b34339aa1ac054dce885c7dab85746e0f23f9711828b9e06e79
+  metadata.gz: 53522940a4d83dccaf8f0b18a3ec8c765d16687334d45502273acb9919f88861e5cff7d9b588aac0671a6b96d666b652781f1eff2ab502c883fa982fbf91c7f1
+  data.tar.gz: c55b21be245f5bf7dbe371db20a406c8104b944f707e7916f14fa8a18bbb0ab8ce0b2ac1e9e61b3a82cdb5259d67febfea8a57c92bbf530aded39361ce621a3a

data/README.md

@@ -214,6 +214,33 @@ after :depoy_and_configure_ssl do
 end
 ```
 
+## Peppr Application Deployment-related Tasks
+These tasks are needed to deploy an application using peppr.  It's recommended to execute these 
+tasks before any project-specific tasks are executed.
+
+### psw_peppr_app_deploy:create_deployment_directories
+This task will ensure that the proper local and remote directories exist
+for an application to be deployed via peppr.
+
+### psw_peppr_app_deploy:upload_app_source_repo
+This task will upload your application source code to the correct folder
+on the remote machine.
+
+### psw_peppr_app_deploy:upload_environment_files
+This task will upload environment files that were downloaded locally
+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.
+
+```ruby
+#set psw app deploy prefs
+before 'psw_peppr_app_deploy:default', :set_app_deploy_options do  
+  set :psw_peppr_app_deploy_debug, true
+end
+
+before :starting, 'psw_peppr_app_deploy:default'
+```
+
 ## License
 
-2013 Lexmark International Technology S.A.  All rights reserved.
+2014 Lexmark International Technology S.A.  All rights reserved.

data/lib/capistrano/psw/peppr_app_deploy_file_utils.rb

@@ -0,0 +1,204 @@
+# == peppr_app_deploy_file_utils.rb
+#
+# This module contains helper methods for accessing Peppr's application deployment file structure
+#
+# == Contact
+#
+# Author::    Matt Sawka (matt.sawka@perceptivesoftware.com)
+# Copyright:: 2014 Lexmark International Technology S.A.  All rights reserved.
+# License::   n/a
+
+module PepprAppDeployFileUtils
+  PEPPR_RELATIVE_LOG_DIR = "/log"
+  PEPPR_RELATIVE_SRC_DIR = "/source"
+  PEPPR_RELATIVE_SCRIPTS_DIR = "/scripts"
+  PEPPR_RELATIVE_TMP_DIR = "/tmp"
+  PEPPR_RELATIVE_ENVIRONMENTS_DIR = "/environments"
+  PEPPR_RELATIVE_SHARED_FILE_DIR = "/shared_files"
+    
+  module Local
+    # Method for verifying that Peppr's application deployment file structure exists on the
+    # local machine.
+    #
+    # @return n/a
+    def self.create_deployment_directories
+      run_locally do
+        info "Creating deployment directories on locally..."
+        execute :mkdir, '-p', PepprAppDeployFileUtils::Local::get_deployment_log_dir
+        execute :mkdir, '-p', PepprAppDeployFileUtils::Local::get_deployment_src_dir
+        execute :mkdir, '-p', PepprAppDeployFileUtils::Local::get_deployment_scripts_dir
+        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
+      end    
+    end
+
+    # Method for retrieving the base or relative Peppr application deployment directory
+    #
+    # @param [String] relative_dir - relative deployment sub-directory
+    # @return [String] the fully-qualified local directory
+    def self.get_deployment_dir(relative_dir="")
+      application_id = ENV['peppr_application_id'].to_i
+      application_deployment = ENV['peppr_application_deployment_id'].to_i    
+
+      raise ArgumentError.new("peppr_application_id and peppr_application_deployment_id must be defined as part of the Capistrano deployment!") unless application_id > 0 && application_deployment > 0
+      "/tmp/peppr_deployments/applications/#{application_id}/deployments/#{application_deployment}#{relative_dir}"
+    end
+
+    # Method for retrieving the Peppr application deployment source directory
+    #
+    # @return [String] the fully-qualified local source directory
+    def self.get_deployment_src_dir
+      PepprAppDeployFileUtils::Local::get_deployment_dir(PEPPR_RELATIVE_SRC_DIR)
+    end
+
+    # Method for retrieving the Peppr application deployment temp directory
+    #
+    # @return [String] the fully-qualified local temp directory
+    def self.get_deployment_tmp_dir
+      PepprAppDeployFileUtils::Local::get_deployment_dir(PEPPR_RELATIVE_TMP_DIR)
+    end
+
+    # Method for retrieving the Peppr application deployment log directory
+    #
+    # @return [String] the fully-qualified local log directory
+    def self.get_deployment_log_dir
+      PepprAppDeployFileUtils::Local::get_deployment_dir(PEPPR_RELATIVE_LOG_DIR)
+    end
+
+    # Method for retrieving the Peppr application deployment scripts directory
+    #
+    # @return [String] the fully-qualified local scripts directory
+    def self.get_deployment_scripts_dir
+      PepprAppDeployFileUtils::Local::get_deployment_dir(PEPPR_RELATIVE_SCRIPTS_DIR)
+    end  
+
+    # Method for retrieving the Peppr application deployment environments directory
+    #
+    # @return [String] the fully-qualified local environments directory
+    def self.get_deployment_environments_dir
+      PepprAppDeployFileUtils::Local::get_deployment_dir(PEPPR_RELATIVE_ENVIRONMENTS_DIR)
+    end   
+
+    def self.get_deployment_shared_files_dir
+      PepprAppDeployFileUtils::Local::get_deployment_dir(PEPPR_RELATIVE_SHARED_FILE_DIR)
+    end       
+  end
+
+  module Remote
+    # Method for verifying that Peppr's application deployment file structure exists on the
+    # local machine.
+    #
+    # @return n/a
+    def self.create_deployment_directories
+      on roles(:all) do |host|
+        info "Creating deployment directories on host #{host}..."
+        execute :mkdir, '-p', PepprAppDeployFileUtils::Remote::get_deployment_dir
+        execute :mkdir, '-p', PepprAppDeployFileUtils::Remote::get_deployment_log_dir
+        execute :mkdir, '-p', PepprAppDeployFileUtils::Remote::get_deployment_src_dir
+        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        
+      end    
+    end
+
+    # Method for retrieving the base or relative Peppr application deployment directory
+    #
+    # @param [String] relative_dir - relative deployment sub-directory
+    # @return [String] the fully-qualified local directory
+    def self.get_deployment_dir(relative_dir="")
+      application_id = ENV['peppr_application_id'].to_i
+      application_deployment = ENV['peppr_application_deployment_id'].to_i    
+
+      raise ArgumentError.new("peppr_application_id and peppr_application_deployment_id must be defined as part of the Capistrano deployment!") unless application_id > 0 && application_deployment > 0
+      "/tmp/peppr_deployments_remote/applications/#{application_id}/deployments/#{application_deployment}#{relative_dir}"
+    end
+
+    # Method for retrieving the Peppr application deployment source directory
+    #
+    # @return [String] the fully-qualified remote source directory
+    def self.get_deployment_src_dir
+      PepprAppDeployFileUtils::Remote::get_deployment_dir(PEPPR_RELATIVE_SRC_DIR)
+    end
+
+    # Method for retrieving the Peppr application deployment source directory
+    #
+    # @return [String] the fully-qualified remote source directory
+    def self.get_deployment_src_dir_as_file
+      "file://#{PepprAppDeployFileUtils::Remote::get_deployment_dir(PEPPR_RELATIVE_SRC_DIR)}"
+    end
+
+    # Method for retrieving the Peppr application deployment temp directory
+    #
+    # @return [String] the fully-qualified remote temp directory
+    def self.get_deployment_tmp_dir
+      PepprAppDeployFileUtils::Remote::get_deployment_dir(PEPPR_RELATIVE_TMP_DIR)
+    end
+
+    # Method for retrieving the Peppr application deployment log directory
+    #
+    # @return [String] the fully-qualified remote log directory
+    def self.get_deployment_log_dir
+      PepprAppDeployFileUtils::Remote::get_deployment_dir(PEPPR_RELATIVE_LOG_DIR)
+    end
+
+    # Method for retrieving the Peppr application deployment scripts directory
+    #
+    # @return [String] the fully-qualified remote scripts directory
+    def self.get_deployment_scripts_dir
+      PepprAppDeployFileUtils::Remote::get_deployment_dir(PEPPR_RELATIVE_SCRIPTS_DIR)
+    end  
+
+    # Method for retrieving the Peppr application deployment environments directory
+    #
+    # @return [String] the fully-qualified remote environments directory
+    def self.get_deployment_environments_dir
+      PepprAppDeployFileUtils::Remote::get_deployment_dir(PEPPR_RELATIVE_ENVIRONMENTS_DIR)
+    end
+
+    # Method for retrieving the Peppr application deployment environments directory
+    #
+    # @return [String] the fully-qualified remote shared files directory
+    def self.get_deployment_shared_files_dir
+      PepprAppDeployFileUtils::Remote::get_deployment_dir(PEPPR_RELATIVE_SHARED_FILE_DIR)
+    end     
+  end
+
+  # Method to compress, upload, and extract a local directory using the following procedure:
+  # *create a tarball of the local directory
+  # *upload the tarball
+  # *extract the tarball
+  # *copy the extracted contents to the correct location
+  #
+  # @param [String] local_dir - local directory to copy from
+  # @param [String] remote_target_dir - remote directory to copy to
+  # @return n/a
+  def self.upload_compressed_local_dir(local_dir, remote_target_dir)
+    #create a local tarball
+    local_tmp_dir = PepprAppDeployFileUtils::Local::get_deployment_tmp_dir
+    remote_tmp_dir = PepprAppDeployFileUtils::Remote::get_deployment_tmp_dir
+    tar_name = "#{SecureRandom.hex}.tar.gz"
+    run_locally do
+      info "Compressing local directory #{local_dir}..."
+      execute :rm, '-rf', "#{local_tmp_dir}/#{tar_name}"
+
+      tar_cmd = "tar -czf"
+      tar_cmd = tar_cmd + "v" if fetch(:psw_peppr_app_deploy_debug)
+      execute("cd #{local_dir} && #{tar_cmd} #{local_tmp_dir}/#{tar_name} .")          
+    end
+
+    on roles(:all) do |host|
+      #upload tarball to remote host
+      upload! "#{local_tmp_dir}/#{tar_name}", "#{remote_tmp_dir}/#{tar_name}"
+
+      #extract tarball to end location    
+      execute :rm, '-rf', "#{remote_target_dir}"
+      execute :mkdir, '-p', "#{remote_target_dir}"
+
+      tar_cmd = "tar -xzf"
+      tar_cmd = tar_cmd + "v" if fetch(:psw_peppr_app_deploy_debug)
+      execute("cd #{remote_tmp_dir} && #{tar_cmd} #{remote_tmp_dir}/#{tar_name} -C #{remote_target_dir}")
+    end
+  end 
+end

data/lib/capistrano/psw/version.rb

@@ -10,6 +10,6 @@
 
 module Capistrano
   module Psw
-    VERSION = "1.0.0.pre16"
+    VERSION = "1.0.0.pre17"
   end
 end

data/lib/capistrano/psw.rb

@@ -1,5 +1,6 @@
 require "capistrano/psw/version"
 require "capistrano/psw/task_loader"
+require "capistrano/psw/peppr_app_deploy_file_utils"
 
 module Capistrano
   module Psw

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

@@ -0,0 +1,115 @@
+# == psw-peppr-app-deploy.cap
+#
+# Contains the capistrano tasks needed to deploy an application using peppr
+#
+# == Configuration
+#
+# To use the defined tasks, hook into other tasks.
+#
+# Examples:
+#
+# #set psw app deploy prefs
+# before 'psw_peppr_app_deploy:default', :set_app_deploy_options do  
+#   set :psw_peppr_app_deploy_debug, true
+# end
+#
+# == Tasks
+#
+# === psw_peppr_app_deploy:create_deployment_directories
+# This task will ensure that the proper local and remote directories exist
+# for an application to be deployed via peppr.
+#
+# === psw_peppr_app_deploy:upload_app_source_repo
+# This task will upload your application source code to the correct folder
+# on the remote machine.
+#
+# === psw_peppr_app_deploy:upload_environment_files
+# This task will upload environment files that were downloaded locally
+# 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.
+#
+# == Contact
+#
+# Author::    Lexmark International Technology S.A.
+# Copyright:: 2013 Lexmark International Technology S.A.  All rights reserved.
+# License::   3-Clause BSD
+require 'capistrano/psw/peppr_app_deploy_file_utils'
+
+namespace :psw_peppr_app_deploy do
+
+  desc 'Create deployment directories on local and remote host.'
+  task :create_deployment_directories do
+    #the Peppr application deployment worker should have created these already, but this
+    #will ensure that at least the directories will exist
+    PepprAppDeployFileUtils::Local::create_deployment_directories
+
+    #On the remote machines, make sure that this directory is fresh
+    on roles(:all) do |host|
+      execute :rm, '-rf', PepprAppDeployFileUtils::Remote::get_deployment_dir
+    end
+    PepprAppDeployFileUtils::Remote::create_deployment_directories
+  end
+
+  desc 'Upload application source repository to remote server'
+  task :upload_app_source_repo do
+    on roles(:all) do |host|
+      local_src_dir = PepprAppDeployFileUtils::Local::get_deployment_src_dir
+      remote_src_dir = PepprAppDeployFileUtils::Remote::get_deployment_src_dir
+
+      info "Uploading #{local_src_dir} (local) to #{remote_src_dir} on remote server #{host}..."
+      PepprAppDeployFileUtils::upload_compressed_local_dir(local_src_dir, remote_src_dir)
+
+      #sets the Capistrano github task's URL
+      set :repo_url, "file://#{remote_src_dir}"      
+    end
+  end
+
+  desc 'Copy application enviroment files to remote machine'
+  task :upload_environment_files do
+    on roles(:app) do |host|     
+      info 'Preparing to upload environment files (if applicable)...'
+      local_shared_files_path = PepprAppDeployFileUtils::Local::get_deployment_shared_files_dir
+
+      if File.exist? local_shared_files_path
+        info "Uploading environment files..."
+        files = Find.find(local_shared_files_path)
+
+        absolute_path_files, shared_files = files.partition { |f| f.start_with? "#{local_shared_files_path}/.absolute_paths" }
+
+        shared_files.each do |file|
+          relative_path = file.gsub("#{local_shared_files_path}/", '')
+
+          debug "Inspecting: #{relative_path}" if fetch(:psw_peppr_app_deploy_debug)
+
+          if File.directory?(file) && relative_path.strip != ''
+            execute :mkdir, '-p', "#{shared_path}/#{relative_path}"
+          elsif relative_path.gsub(/\s+/, '') != '' and relative_path != '.' and relative_path != '..'
+            debug "Uploading environment file #{relative_path}..." if fetch(:psw_peppr_app_deploy_debug)
+            upload! file, "#{shared_path}/#{relative_path}"
+          end
+        end
+
+        info 'Uploading absolute path environment files...'
+        absolute_path_files.each do |file|
+          relative_path = file.gsub("#{local_shared_files_path}/.absolute_paths", '')
+
+          debug "Inspecting: #{relative_path}" if fetch(:psw_peppr_app_deploy_debug)
+
+          if File.directory?(file) && relative_path.strip != ''
+            execute :mkdir, '-p', relative_path
+          elsif relative_path.gsub(/\s+/, '') != '' and relative_path != '.' and relative_path != '..'
+            debug "Uploading environment file #{relative_path}..." if fetch(:psw_peppr_app_deploy_debug)
+            upload! file, relative_path
+          end
+        end
+      else
+        info "The shared files path, #{local_shared_files_path} does not exist."
+      end
+    end
+  end  
+
+  desc "Deploy private repository to remote server(s)"
+  task default: [:'create_deployment_directories', :'upload_app_source_repo', :'upload_environment_files'] do
+  end  
+end

data/spec/psw-peppr-app-deploy_spec.rb

@@ -0,0 +1,50 @@
+require "rake"
+require File.expand_path('../spec_helper.rb', __FILE__)
+
+
+describe "psw_peppr_app_deploy:" do
+  describe "create_deployment_directories" do
+    let(:rake)      { Rake::Application.new }
+    subject         { rake["psw_peppr_app_deploy:create_deployment_directories"] }
+    
+    before do
+      Rake.application = rake
+      Rake.application.add_import("./resources/lib/capistrano/tasks/psw-peppr-app-deploy.cap")
+      Rake.application.load_imports()   
+    end
+
+    it "has 'no prerequisites" do
+      subject.prerequisites.should be_empty
+    end 
+  end
+
+  describe "upload_app_source_repo" do
+    let(:rake)      { Rake::Application.new }
+    subject         { rake["psw_peppr_app_deploy:upload_app_source_repo"] }
+    
+    before do
+      Rake.application = rake
+      Rake.application.add_import("./resources/lib/capistrano/tasks/psw-peppr-app-deploy.cap")
+      Rake.application.load_imports()   
+    end
+
+    it "has 'no prerequisites" do
+      subject.prerequisites.should be_empty
+    end 
+  end    
+
+  describe "upload_environment_files" do
+    let(:rake)      { Rake::Application.new }
+    subject         { rake["psw_peppr_app_deploy:upload_environment_files"] }
+    
+    before do
+      Rake.application = rake
+      Rake.application.add_import("./resources/lib/capistrano/tasks/psw-peppr-app-deploy.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.pre16
+  version: 1.0.0.pre17
 platform: ruby
 authors:
 - Lexmark International Technology S.A
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-25 00:00:00.000000000 Z
+date: 2014-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,16 +83,19 @@ files:
 - capistrano-psw.gemspec
 - ci/pipeline-config.json
 - lib/capistrano/psw.rb
+- lib/capistrano/psw/peppr_app_deploy_file_utils.rb
 - lib/capistrano/psw/server_utils.rb
 - lib/capistrano/psw/task_loader.rb
 - lib/capistrano/psw/version.rb
 - 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-clockwork_spec.rb
 - spec/psw-nginx_spec.rb
+- spec/psw-peppr-app-deploy_spec.rb
 - spec/psw-peppr_spec.rb
 - spec/psw-repo_spec.rb
 - spec/psw-sidekiq_spec.rb
@@ -127,6 +130,7 @@ summary: Contains Capistrano v3 Deployment Tasks
 test_files:
 - spec/psw-clockwork_spec.rb
 - spec/psw-nginx_spec.rb
+- spec/psw-peppr-app-deploy_spec.rb
 - spec/psw-peppr_spec.rb
 - spec/psw-repo_spec.rb
 - spec/psw-sidekiq_spec.rb