capistrano-psw 1.0.0.pre14 → 1.0.0.pre15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9293e51fbf03bb1b150a6db933509c095f31fa0a
-  data.tar.gz: 1d4f40a98cbe14114f1bd1c51332bb89cd2dad2a
+  metadata.gz: 704228fd3987825ab8d61fe40f62f7bd0f7d8ef0
+  data.tar.gz: b32d6a88e85d4a6da517bdb519fb10fb40e491ae
 SHA512:
-  metadata.gz: e7cbc808073d3e9f485a87a1c70d8ba77eb1bceae5a9cc31a07af6bbc9571f2bd32753f3965123c07488a92470344076981e11799e7570a6bf29c6d1dbd04395
-  data.tar.gz: 4ce1a9110fa48a5b0dc43152a05fa201a34f6528e6ef9566425f897dc966dab6728779242ff454ce070c6270fe53a4690a9f4f5e1c0481cc564366879159020f
+  metadata.gz: 083954d1a8517db6321cf2352d5c81e4d981b3b8a31d1bd19e10380356a292f87d9cd28d02788df54224a616b8378f6f2f1c58247a63de84c2c70704d8e9678f
+  data.tar.gz: 5cf746e7e9f9cbb0f050bd2e8eeca6110fefff44aa90b982f8cc8348c06b01369795649f06537e33dcec40b37df00254cf521950548859ee731301cd93ad3a17

data/README.md

@@ -185,6 +185,34 @@ namespace :deploy do
   before :starting, 'psw_peppr:clear_shared_files'
 end
 ```
+## Nginx-related Tasks
+These tasks are used to interact with the Nginx web server.
+
+### psw_nginx: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_nginx:configure_nginx
+This task task will override the site definition for a specific nginx 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.
+
+```ruby
+before :'psw_nginx:configure_nginx', :set_nginx_options do 
+  set :psw_nginx_site_template, File.expand_path("../../lib/capistrano/templates/nginx/my-site.erb", __FILE__)
+  set :psw_nginx_site_name, "my-site"
+end
+
+before :'psw_nginx:deploy_ssl_certs', :set_nginx_ssl_options do 
+  set :psw_nginx_ssl_cert_file, "#{shared_path}/nginx/ssl/my-cert.crt"
+  set :psw_nginx_ssl_key_file, "#{shared_path}/nginx/ssl/my-cert.key"
+end
+
+after :depoy_and_configure_ssl do
+  Rake::Task['psw_nginx:deploy_ssl_certs'].invoke
+  Rake::Task['psw_nginx:configure_nginx'].invoke(binding)    
+end
+```
 
 ## License
 

data/lib/capistrano/psw/server_utils.rb

@@ -1,9 +1,27 @@
+# == server_utils.rb
+#
+# This module provides methods for reading in a JSON file containing Capistrano server
+# definitions.
+#
+# == Contact
+#
+# Author::    Lexmark International Technology S.A.
+# Copyright:: 2014 Lexmark International Technology S.A.  All rights reserved.
+# License::   3-Clause BSD
+
 require 'capistrano'
 require 'json'
 
 module Capistrano
   module Psw
     class ServerUtils
+
+      # Static method that reads in a JSON file and parses it into a map of Capistrano server
+      # definitions.
+      #
+      # @param [String] filename - JSON file path
+      # @param [String] stage_name - Capistrano stage name
+      # @return [Enumerator] collection of Capistrano server definitions
       def self.get_servers_from_json (filename, stage_name)
         raise ArgumentError, 'missing filename' if filename.nil? || filename.strip == ''
         raise ArgumentError, 'missing stage_name' if stage_name.nil? || stage_name.strip == ''

data/lib/capistrano/psw/task_loader.rb

@@ -12,6 +12,10 @@
 
 module Capistrano
   module Psw
+
+    # Static method for loading Capistrano tasks from 'resources/lib/capistrano/tasks'.
+    #
+    # @return n/a
     def self.load_tasks
       puts "Loading Capistrano V3 tasks..."
 

data/lib/capistrano/psw/version.rb

@@ -10,6 +10,6 @@
 
 module Capistrano
   module Psw
-    VERSION = "1.0.0.pre14"
+    VERSION = "1.0.0.pre15"
   end
 end

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

@@ -0,0 +1,141 @@
+# == psw-nginx.cap
+#
+# Contains the capistrano tasks needed to interact with the Nginx web server
+#
+# == Configuration
+#
+# To use the defined tasks, hook into other tasks.
+#
+# Examples:
+#
+#  after :depoy_and_configure_ssl do
+#    Rake::Task['psw_nginx:deploy_ssl_certs'].invoke
+#    Rake::Task['psw_nginx:configure_nginx'].invoke(binding)    
+#  end
+#
+# == Tasks
+#
+# === psw_nginx: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_nginx:configure_nginx
+# This task task will override the site definition for a specific nginx 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.
+#
+# == Configuration
+# The following configuration options may be set (should be set before the 'stop' task is executed):
+#
+# before :'psw_nginx:configure_nginx', :set_nginx_options do 
+#   set :psw_nginx_site_template, File.expand_path("../../lib/capistrano/templates/nginx/my-site.erb", __FILE__)
+#   set :psw_nginx_site_name, "my-site"
+# end
+#
+# before :'psw_nginx:deploy_ssl_certs', :set_nginx_ssl_options do 
+#   set :psw_nginx_ssl_cert_file, "#{shared_path}/nginx/ssl/my-cert.crt"
+#   set :psw_nginx_ssl_key_file, "#{shared_path}/nginx/ssl/my-cert.key"
+# end
+#
+# before :'psw_nginx:deploy_ssl_certs', :set_nginx_options do  
+#   set :psw_nginx_shared_cert_dir, ""
+# end
+#
+# == Contact
+#
+# Author::    Lexmark International Technology S.A.
+# Copyright:: 2013 Lexmark International Technology S.A.  All rights reserved.
+# License::   3-Clause BSD
+#
+require 'tempfile'
+require 'pathname'
+
+namespace :psw_nginx do
+
+  #ssl cert properties
+  def get_ssl_cert_file
+    fetch(:psw_nginx_ssl_cert_file, "")
+  end
+
+  def get_ssl_key_file
+    fetch(:psw_nginx_ssl_key_file, "")
+  end  
+
+  #config properties
+  def get_nginx_config_dir
+    fetch(:psw_nginx_config_dir, "/config/nginx")
+  end
+
+  def get_nginx_site_template
+    fetch(:psw_nginx_site_template, "")
+  end
+
+  def get_nginx_site_name
+    fetch(:psw_nginx_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 key 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}"
+    end
+  end
+
+  task :configure_nginx, :template_binding do |t, args|
+    on roles(:app) do |host|
+      info "Configuring Nginx..."
+
+      site_template_path = get_nginx_site_template
+      unless site_template_path.nil? || site_template_path.length == 0
+        info "Adding site template #{site_template_path} to Nginx..."
+
+        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_nginx_site_name}-")
+        tmp_site_file.write(site)
+        tmp_site_file.flush
+
+        shared_nginx_config_dir = "#{shared_path}#{get_nginx_config_dir}"
+        info "Creating shared Nginx configuration directory #{shared_nginx_config_dir}..."
+        execute :mkdir, '-p', shared_nginx_config_dir
+
+        info "Uploading Nginx site configuration for site #{get_nginx_site_name}..."
+        shared_nginx_config_file = "#{shared_nginx_config_dir}/#{get_nginx_site_name}"
+        upload! "#{tmp_site_file.path}", "#{shared_nginx_config_file}"
+
+        #symlink to site-enabled
+        info "Creating a symlink for site #{get_nginx_site_name}..."
+        sudo :rm, '-rf', "/etc/nginx/sites-enabled/#{get_nginx_site_name}"
+        sudo :rm, '-rf', "/etc/nginx/sites-available/#{get_nginx_site_name}"
+
+        #can't use 'set :linked_files' because this only allows linking within the Rails app
+        #https://github.com/capistrano/capistrano/blob/dfe25c9436461c395cb7425f8c452ab87ca6b5e0/lib/capistrano/tasks/deploy.rake
+        sudo :ln, '-s', "#{shared_nginx_config_file}", "/etc/nginx/sites-available/#{get_nginx_site_name}"
+        sudo :ln, '-s', "/etc/nginx/sites-available/#{get_nginx_site_name}", "/etc/nginx/sites-enabled/#{get_nginx_site_name}"
+      else
+        info "A site template has not been defined for Nginx"
+      end
+    end
+  end
+end

data/spec/psw-nginx_spec.rb

@@ -0,0 +1,35 @@
+require "rake"
+require File.expand_path('../spec_helper.rb', __FILE__)
+
+
+describe "psw_nginx:" do
+  describe "deploy_ssl_certs" do
+    let(:rake)      { Rake::Application.new }
+    subject         { rake["psw_nginx:deploy_ssl_certs"] }
+    
+    before do
+      Rake.application = rake
+      Rake.application.add_import("./resources/lib/capistrano/tasks/psw-nginx.cap")
+      Rake.application.load_imports()   
+    end
+
+    it "has 'no prerequisites" do
+      subject.prerequisites.should be_empty
+    end 
+  end
+
+  describe "configure_nginx" do
+    let(:rake)      { Rake::Application.new }
+    subject         { rake["psw_nginx:configure_nginx"] }
+    
+    before do
+      Rake.application = rake
+      Rake.application.add_import("./resources/lib/capistrano/tasks/psw-nginx.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.pre14
+  version: 1.0.0.pre15
 platform: ruby
 authors:
 - Lexmark International Technology S.A
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-21 00:00:00.000000000 Z
+date: 2014-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,10 +87,12 @@ files:
 - 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.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_spec.rb
 - spec/psw-repo_spec.rb
 - spec/psw-sidekiq_spec.rb
@@ -124,6 +126,7 @@ specification_version: 4
 summary: Contains Capistrano v3 Deployment Tasks
 test_files:
 - spec/psw-clockwork_spec.rb
+- spec/psw-nginx_spec.rb
 - spec/psw-peppr_spec.rb
 - spec/psw-repo_spec.rb
 - spec/psw-sidekiq_spec.rb