capistrano-psw 1.0.0.pre38 → 1.0.0.pre39

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97ed93489efaaaa150e01f7f4cf0e6640fe98c48
-  data.tar.gz: bb22c0367f1ed2b9c654f6decfca88d6f66f5044
+  metadata.gz: 61844376dd74db07e8d369866efce6a3baec4860
+  data.tar.gz: 24cbc7d057ceb1de58284ad4ab6a82208198de45
 SHA512:
-  metadata.gz: d74fff8e564f71a1ecfaa1b7eedbb3c8d77bc92af5e1cc4e67caf6b1d6bb23d7983e804b634d4aff79c0d2f86ec8280d507818b0ebd254a5e71c2ada60c42523
-  data.tar.gz: e6ce5d9bda42f8857bca156d494352d3aae80398180c882db7c6c71b1156333987197b8255a2b2e8688aef1f40478313122c2371cf48be5fab6357b177aa6015
+  metadata.gz: 4f99b1ee1b09f685e7b1799b52c91dd1f9ea848aa59314506e642caafcbc6affb2f6404d4624575d6106967555ff2cc5edd68da6be7c7575a15f321f3d193226
+  data.tar.gz: 29690b4288ded75556ee8bf4ceb3687a84fe09718d426bffc68193d6943f772541fae28eb157bbf364199437809efd4b727a4d10f36e6e85995061e99a376d13

data/README.md

@@ -246,6 +246,10 @@ This task will update Capistrano branch environment to point to the Peppr branch
 This task will create a symbolic link from the remote artifacts directory to the current
 release directory as "/artifacts"
 
+### psw_peppr_app_deploy:cleanup_old_deployments
+This task (hooked after deploy:cleanup) will delete any old deployment directories on
+the Peppr build slave as well as the remote host machine
+
 ```ruby
 #set psw app deploy prefs
 before 'psw_peppr_app_deploy:default', :set_app_deploy_options do  

data/lib/capistrano/psw/peppr_app_deploy_file_utils.rb

@@ -18,6 +18,9 @@ module PepprAppDeployFileUtils
   PEPPR_RELATIVE_SHARED_FILE_DIR = "/shared_files"
   PEPPR_RELATIVE_ARTIFACTS_DIR = "/artifacts"
 
+    # Method to determine if Peppr is executing this deployment
+    #
+    # @return [Boolean] true if Peppr executed Capistrano
   def self.peppr_deployment?
     application_id = ENV['peppr_application_id'].to_i
     application_deployment = ENV['peppr_application_deployment_id'].to_i
@@ -25,8 +28,25 @@ module PepprAppDeployFileUtils
     
     false
   end
+
+  # Method to retrieve the current application identifier (if the deployment
+  # was executed from Peppr)
+  #
+  # @return [Integer] if Peppr executed Capistrano (null otherwise)
+  def self.get_application_id
+    ENV['peppr_application_id'].to_i
+  end
+
+  # Method to retrieve the current deployment number (if the deployment
+  # was executed from Peppr)
+  #
+  # @return [Integer] if Peppr executed Capistrano (null otherwise)
+  def self.get_deployment_number
+    ENV['peppr_application_deployment_id'].to_i
+  end
     
   module Local
+
     # Method for verifying that Peppr's application deployment file structure exists on the
     # local machine.
     #
@@ -45,16 +65,24 @@ module PepprAppDeployFileUtils
       end    
     end
 
+    # Method to build the deployment directory path for a specific deployment
+    #
+    # @param [String] application_id - application identifier
+    # @return [String] deployment_number - deployment number
+    def self.build_deployment_dir(application_id, deployment_number)
+      "/tmp/peppr_deployments/applications/#{application_id}/deployments/#{deployment_number}"      
+    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
+      application_id = PepprAppDeployFileUtils::get_application_id
+      deployment_number = PepprAppDeployFileUtils::get_deployment_number
 
-      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}"
+      raise ArgumentError.new("peppr_application_id and peppr_application_deployment_id must be defined as part of the Capistrano deployment!") unless application_id > 0 && deployment_number > 0
+      "#{PepprAppDeployFileUtils::Local::build_deployment_dir(application_id, deployment_number)}#{relative_dir}"
     end
 
     # Method for retrieving the Peppr application deployment source directory
@@ -134,16 +162,24 @@ module PepprAppDeployFileUtils
       end    
     end
 
+    # Method to build the deployment directory path for a specific deployment
+    #
+    # @param [String] application_id - application identifier
+    # @return [String] deployment_number - deployment number
+    def self.build_deployment_dir(application_id, deployment_number)
+      "/tmp/peppr_deployments_remote/applications/#{application_id}/deployments/#{deployment_number}"      
+    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    
+      application_id = PepprAppDeployFileUtils::get_application_id
+      deployment_number = PepprAppDeployFileUtils::get_deployment_number   
 
-      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}"
+      raise ArgumentError.new("peppr_application_id and peppr_application_deployment_id must be defined as part of the Capistrano deployment!") unless application_id > 0 && deployment_number > 0
+      "#{PepprAppDeployFileUtils::Remote::build_deployment_dir(application_id, deployment_number)}#{relative_dir}"
     end
 
     # Method for retrieving the Peppr application deployment source directory

data/lib/capistrano/psw/version.rb

@@ -10,6 +10,6 @@
 
 module Capistrano
   module Psw
-    VERSION = "1.0.0.pre38"
+    VERSION = "1.0.0.pre39"
   end
 end

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

@@ -40,6 +40,14 @@
 # This task will create a symbolic link from the remote artifacts directory to the current
 # release directory as "/artifacts"
 #
+# === psw_peppr_app_deploy:symlink_env_files
+# This task (hooked after deploy:check:directories) will create symlinks for any environment
+# files to Capistrano's shared directory
+#
+# === psw_peppr_app_deploy:cleanup_old_deployments
+# This task (hooked after deploy:cleanup) will delete any old deployment directories on
+# the Peppr build slave as well as the remote host machine
+#
 # == Contact
 #
 # Author::    Lexmark International Technology S.A.
@@ -47,6 +55,8 @@
 # License::   3-Clause BSD
 require 'capistrano/psw/peppr_app_deploy_file_utils'
 require 'capistrano/dsl'
+
+#required for task 'deploy:check:directories' and task 'deploy:cleanup'
 require 'capistrano/deploy'
 
 namespace :psw_peppr_app_deploy do
@@ -235,4 +245,32 @@ namespace :psw_peppr_app_deploy do
   #(https://github.com/capistrano/capistrano/blob/6353a02ed63dfe7f16921650e3b6e6d6317f0711/lib/capistrano/tasks/deploy.rake)
   after 'deploy:check:directories', 'psw_peppr_app_deploy:symlink_env_files'
 
+  desc "Deletes deployments older than the Capistrano keep_releases flag"
+  task :cleanup_old_deployments do
+    #only delete previous peppr deployments
+    if PepprAppDeployFileUtils::peppr_deployment?
+      keep_releases = fetch(:keep_releases, 5)
+
+      application_id = PepprAppDeployFileUtils::get_application_id
+      current_deployment = PepprAppDeployFileUtils::get_deployment_number
+      unless current_deployment.nil? || current_deployment < keep_releases
+        oldest_release_to_keep = current_deployment - keep_releases
+        while oldest_release_to_keep > 0 do
+          on roles(:app) do |host|
+            info "Removing remote deployment directories for application #{application_id}, deployment #{oldest_release_to_keep}..."
+            sudo :rm, '-rf', PepprAppDeployFileUtils::Remote::build_deployment_dir(application_id, oldest_release_to_keep)
+          end
+
+          run_locally do
+            info "Removing local deployment directories for application #{application_id}, deployment #{oldest_release_to_keep}..."
+            sudo :rm, '-rf', PepprAppDeployFileUtils::Local::build_deployment_dir(application_id, oldest_release_to_keep)
+          end          
+          oldest_release_to_keep = oldest_release_to_keep - 1
+        end
+      end
+    end
+  end
+  #To save space (locally and remotely), delete deployments that are no longer referenced.
+  after 'deploy:cleanup', 'psw_peppr_app_deploy:cleanup_old_deployments'
+
 end

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

@@ -12,51 +12,65 @@ namespace :check do
 end
 
 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
+  before(:all) do
+    Rake.application = Rake::Application.new
+    Rake.application.add_import("./resources/lib/capistrano/tasks/psw-peppr-app-deploy.cap")
+    Rake.application.load_imports()   
+  end
 
+  describe "#create_deployment_directories" do
     it "has 'no prerequisites" do
+      subject = Rake.application["psw_peppr_app_deploy:create_deployment_directories"]
       subject.prerequisites.should be_empty
     end 
   end
+ 
+  describe "#upload_app_source_repo" do
+    it "has 'no prerequisites" do
+      subject = Rake.application["psw_peppr_app_deploy:upload_app_source_repo"]
+      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::Task.define_task('deploy:check:directories')
-      Rake.application.add_import("./resources/lib/capistrano/tasks/psw-peppr-app-deploy.cap")
-      Rake.application.load_imports()   
-    end
+  describe "#upload_environment_files" do
+    it "has 'no prerequisites" do
+      subject = Rake.application["psw_peppr_app_deploy:upload_environment_files"]
+      subject.prerequisites.should be_empty
+    end    
+  end
 
+  describe "#upload_artifacts" do
     it "has 'no prerequisites" do
+      subject = Rake.application["psw_peppr_app_deploy:upload_artifacts"]
       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::Task.define_task('deploy:check:directories')
-      Rake.application.add_import("./resources/lib/capistrano/tasks/psw-peppr-app-deploy.cap")
-      Rake.application.load_imports()   
-    end
+    end    
+  end
 
+  describe "#set_deploy_revision" do
     it "has 'no prerequisites" do
+      subject = Rake.application["psw_peppr_app_deploy:set_deploy_revision"]
       subject.prerequisites.should be_empty
-    end 
-  end   
+    end    
+  end
+
+  describe "#link_artifacts" do
+    it "has 'no prerequisites" do
+      subject = Rake.application["psw_peppr_app_deploy:link_artifacts"]
+      subject.prerequisites.should be_empty
+    end    
+  end
+
+  describe "#symlink_env_files" do
+    it "has 'no prerequisites" do
+      subject = Rake.application["psw_peppr_app_deploy:symlink_env_files"]
+      subject.prerequisites.should be_empty
+    end    
+  end
+
+  describe "#cleanup_old_deployments" do
+    it "has 'no prerequisites" do
+      subject = Rake.application["psw_peppr_app_deploy:cleanup_old_deployments"]
+      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.pre38
+  version: 1.0.0.pre39
 platform: ruby
 authors:
 - Lexmark International Technology S.A
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-29 00:00:00.000000000 Z
+date: 2014-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler