capistrano-multiyaml 1.0.0

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2013 Daniel Silverman <me@agperson.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+YAML Multistage Extensions for Capistrano
+=========================================
+
+This extension is an alternative to Jamis Buck's multistage extension for Capistrano that stores multistage configuration in a single YAML file rather than in multiple Ruby files.  It provides a simple and straightforward way to specify variables, callbacks, and roles for different deployment stages, and the file can be manipulated by any script that understands YAML.  Even if the file is only managed by humans, there are still several benefits including centralizing stage/role configuration in one file, discouraging per-stage logic in deference to properly hooked before/after callbacks, and simplified configuration reuse.'
+
+For more information about the general idea of multistage deployment, see the [docs for the original module](https://github.com/capistrano/capistrano/wiki/2.x-Multistage-Extension/).
+
+## Installation
+
+1.  Install the **capistrano-multiyaml** gem using RubyGems, Bundler, or your preferred system.
+2.  Modify your `Capfile` or `deploy.rb` to set a few variables and include the gem:
+
+        set :stages, %w(integration staging production)
+        set :default_stage, "staging"
+        set :multiyaml_stages, "config/stages.yaml"`
+
+    **Note:** `:default_stage` is optional, and `:multiyaml_stages` only needs to be set if you are using a location other than `config/stages.yaml`.
+
+## Configure Stages
+
+The easiest way to understand the capabilities of the YAML file is to see a complete one.  This example incorporates all of the possible configuration options, and also uses YAML anchor/alias to avoid repetition. Note that while before/after callback hooks can be used to evaluate code, this is not recommended because the goal of this setup is to avoid putting deploy logic in the stage configuration file.
+
+```ruby
+--- # stages for application "fooapp"
+integration:
+  roles:
+    app:
+      'bobsmith-vm.foocorp.com':
+staging: 
+  variables: &vars
+    :data_path:    '/nfs/#{application}/#{stage}'
+    :clean_script: '#{deploy_to}/bin/clean-cache.sh'
+  tasks: &tasks
+    - type  : after_callback
+      target: 'deploy:setup'
+      action: 'fooapp:link_data_path'
+    - type  : before_callback
+      target: 'deploy:restart'
+      action: 'fooapp:run_scripts'
+  roles: 
+    web:
+      'lb-stage1.foocorp.com':
+    db:
+      'sql-stage1.db.foocorp.com':
+    app: 
+      'app-stage1.foocorp.com': { :primary: true }
+      'app-stage2.foocorp.com':
+production:
+  variables: *vars
+  tasks: *tasks
+  roles: 
+    web:
+      'lb-prod1.foocorp.com':
+      'lb-prod2.foocorp.com':
+    db:
+      'sql-prod1.db.foocorp.com':
+    app:
+      'app-prod1.foocorp.com': { :primary: true }
+      'app-prod2.foocorp.com':
+      'app-prod3.foocorp.com':
+      'app-prod4.foocorp.com': { :read_only: true }
+```
+
+* Variable keys are symbols
+* Other Capistrano variables can be interpreted within variables
+* Tasks can be one of `after_callback` (using the "after" hook) or `before_callback` (using the "before" hook).  Action can be either another task or a code block to be evaluated.
+* Additional parameters can be passed to servers in an array
+
+## Running Deploy Actions
+
+Prefix deploy actions with the name of the stage, i.e. `cap production TASK`.  If you do not set a stage and `default_stage` is set, it will be used instead.
+
+## Caveats
+
+* Don't name your stage "stage", as this is a reserved word under the multistage extension (deploys won't do anything and in fact it will cause an infinite loop).

data/capistrano-multiyaml.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name        = 'capistrano-multiyaml'
+  s.version     = '1.0.0'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Daniel Silverman"]
+  s.email       = 'me@agperson.com'
+  s.homepage    = 'http://github.com/agperson/capistrano-multiyaml'
+  s.summary     = 'Capistrano plugin for storing multistage configuration in a YAML file.'
+  s.description = 'This plugin simplifies and clarifies the multistage deploy process by reading settings from a simple YAML file that can be updated programatically. Even if the file is only managed by humans, there are still several benefits including centralizing stage/role configuration in one file, discouraging per-stage logic in deference to properly hooked before/after callbacks, and simplified configuration reuse.'
+
+  s.add_runtime_dependency "capistrano",        "~>2"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/capistrano-multiyaml.rb

@@ -0,0 +1,101 @@
+require 'fileutils'
+require 'yaml'
+
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "capistrano/multiyaml requires Capistrano 2"
+end
+
+
+# Variable interpolation mechanism stolen from Ruby Facets 2.9.3 rather than
+# requiring the whole library
+def String.interpolate(&str)
+  eval "%{#{str.call}}", str.binding
+end
+
+Capistrano::Configuration.instance.load do
+  begin
+    yamlfile = YAML.load_file(fetch(:multiyaml_stages, "config/stages.yaml"))
+  rescue
+    abort "Multistage deployment configuration file missing. Populate config/stages.yaml or set :multiyaml_stages to another location to use capistrano/multiyaml for multistage deployment."
+  end
+
+  stages = fetch(:stages, %w(staging production))
+
+  # Loop through YAML configuration file and create a task for each stage.
+  stages.each do |name| 
+    desc "Set the target stage to `#{name}'."
+    task(name) do 
+      set(:stage, name.to_sym)
+      set(:rails_env, name.to_s)
+      logger.important "Setting stage to #{name}"
+
+      # Load the corresponding stage's YAML configuration and iterate through,
+      # setting roles, variables, and callbacks as specified.
+      config = yamlfile[name.to_s]
+      abort "Invalid or missing stage configuration for #{name}." if config.nil?
+
+      config.each do |section, contents|
+        case section.to_s
+
+        when "variables"
+          contents.each do |key, value|
+            if key.is_a?(Symbol) and not value.nil? then
+              set(key, String.interpolate{value.to_s})
+            end
+          end
+
+        when "tasks"
+          contents.each do |task|
+            target = task['target'].to_s
+            action = task['action'].to_s
+            if not target.nil? and not action.nil? then
+              before(target, action) if task['type'] == "before_callback"
+              after( target, action) if task['type'] == "after_callback"
+            end
+          end
+
+        when "roles"
+          contents.each do |rolename, hosts|
+            hosts.each do |hostname, options|
+              logger.info "Processing host settings for #{hostname} (#{name})"
+              if options.is_a?(Hash) then
+                role(rolename.to_sym, hostname.to_s, options)
+              else
+                role(rolename.to_sym, hostname.to_s)
+              end
+            end
+          end
+
+        else
+          logger.info "Multistage YAML configuration section #{section.to_s} ignored by capistrano/multiyaml."
+        end
+      end
+    end 
+  end 
+
+  on :load do
+    if stages.include?(ARGV.first)
+      # Execute the specified stage so that recipes required in stage can contribute to task list
+      find_and_execute_task(ARGV.first) if ARGV.any?{ |option| option =~ /-T|--tasks|-e|--explain/ }
+    else
+      # Execute the default stage so that recipes required in stage can contribute tasks
+      find_and_execute_task(default_stage) if exists?(:default_stage)
+    end
+  end
+
+  namespace :multiyaml do
+    desc "[internal] Ensure that a stage has been selected."
+    task :ensure do
+      if !exists?(:stage)
+        if exists?(:default_stage)
+          logger.important "Defaulting to `#{default_stage}'"
+          find_and_execute_task(default_stage)
+        else
+          abort "No stage specified. Please specify one of: #{stages.join(', ')} (e.g. `cap #{stages.first} #{ARGV.last}')"
+        end
+      end 
+    end
+  end
+
+  on :start, "multiyaml:ensure", :except => stages
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-multiyaml
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Daniel Silverman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+description: This plugin simplifies and clarifies the multistage deploy process by
+  reading settings from a simple YAML file that can be updated programatically. Even
+  if the file is only managed by humans, there are still several benefits including
+  centralizing stage/role configuration in one file, discouraging per-stage logic
+  in deference to properly hooked before/after callbacks, and simplified configuration
+  reuse.
+email: me@agperson.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- capistrano-multiyaml.gemspec
+- lib/capistrano-multiyaml.rb
+homepage: http://github.com/agperson/capistrano-multiyaml
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Capistrano plugin for storing multistage configuration in a YAML file.
+test_files: []