projectdx_pipeline 0.2.0 → 1.0.0

data/Gemfile

@@ -1,10 +1,7 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+gem 'capistrano', '~> 2.9.0'
+gem 'capistrano-ext', '~> 1.2.1'
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "rspec", "~> 2.3.0"
   gem "bundler", "~> 1.0.0"

data/Gemfile.lock

@@ -1,12 +1,28 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    capistrano (2.9.0)
+      highline
+      net-scp (>= 1.0.0)
+      net-sftp (>= 2.0.0)
+      net-ssh (>= 2.0.14)
+      net-ssh-gateway (>= 1.1.0)
+    capistrano-ext (1.2.1)
+      capistrano (>= 1.0.0)
     diff-lcs (1.1.3)
     git (1.2.5)
+    highline (1.6.8)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-sftp (2.0.5)
+      net-ssh (>= 2.0.9)
+    net-ssh (2.2.1)
+    net-ssh-gateway (1.1.0)
+      net-ssh (>= 1.99.1)
     rake (0.9.2.2)
     rcov (0.9.11)
     rspec (2.3.0)
@@ -23,6 +39,8 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.0.0)
+  capistrano (~> 2.9.0)
+  capistrano-ext (~> 1.2.1)
   jeweler (~> 1.6.4)
   rcov
   rspec (~> 2.3.0)

data/VERSION

@@ -1 +1 @@
-0.2.0
+1.0.0

data/lib/projectdx_pipeline/capistrano.rb

@@ -0,0 +1,59 @@
+
+Capistrano::Configuration.instance.load do
+  ######################
+  ## Multistage setup ##
+  ######################
+  
+  set(:stages, %w[alpha beta staging production])
+
+  # branches that must ask for a commit, and have that commit in their history
+  set(:branch_stages, %w[staging production])
+
+  # stages that will reset the database to a reference database before running
+  # migrations
+  set(:reference_db_stages, %w[alpha beta staging])
+
+  desc "This task is just for testing loading of the recipes and multistage requirements in an app"
+  task :testing do
+    puts "You are testing task loading for #{stage}. #{stage_loaded}"
+  end
+
+  ####################
+  # General Settings #
+  ####################
+
+  set(:use_sudo, false)
+  set(:deploy_via, :remote_cache)
+  set(:ssh_options, {:forward_agent => true})
+  set(:scm, :git)
+  set(:copy_exclude, %w[.git])
+  set(:repository) { "git@github.com:projectdx/#{application}.git" }
+  set(:user) { application }
+  set(:deploy_to) { "/var/www/#{application}" }
+  set(:db_username) { application }
+  set(:db_server, 'db1.renewfund.com')
+  set(:db_password) { abort "You must set the database password for this application with `set :db_password, 'foo'." }
+  set(:db_port, '5432')
+  set(:db_name) { application }
+  set(:rails_env) { stage }
+
+  #############
+  # Callbacks #
+  #############
+
+  before 'deploy:update', 'deploy:get_revision'
+  after 'deploy:update_code', 'deploy:migrate'
+
+  ############################
+  # Additional Files to Load #
+  ############################
+   
+  load_paths << File.expand_path(File.join(File.dirname(__FILE__), 'capistrano'))
+  require 'bundler/capistrano'
+  require 'capistrano/ext/multistage'
+  load 'passenger'
+  load 'database_configuration'
+  load 'git_revision'
+  load 'deploy/assets'
+  load 'maintenance'
+end

data/lib/projectdx_pipeline/capistrano/config/deploy/alpha.rb

@@ -0,0 +1,5 @@
+set :stage_loaded, 'The alpha stage was loaded.'
+
+role :app, 'alpha1.renewfund.com'
+role :web, 'alpha1.renewfund.com'
+role :db, 'alpha1.renewfund.com', :primary => true, :source => true

data/lib/projectdx_pipeline/capistrano/config/deploy/beta.rb

@@ -0,0 +1,7 @@
+set :stage_loaded, 'The beta stage was loaded.'
+set :db_server, 'prod-db1.renewfund.com'
+set :db_port, '5433'
+
+role :app, 'beta1.renewfund.com'
+role :web, 'beta1.renewfund.com'
+role :db, 'beta1.renewfund.com', :primary => true, :source => true

data/lib/projectdx_pipeline/capistrano/config/deploy/production.rb

@@ -0,0 +1 @@
+set :stage_loaded, 'The production stage was loaded.'

data/lib/projectdx_pipeline/capistrano/config/deploy/staging.rb

@@ -0,0 +1 @@
+set :stage_loaded, 'The staging stage was loaded.'

data/lib/projectdx_pipeline/capistrano/database_configuration.rb

@@ -0,0 +1,83 @@
+set(:db_defaults) do
+  {
+    'username' => db_username,
+    'password' => db_password,
+    'adapter' => 'postgresql',
+    'encoding' => 'UTF8',
+    'host' => db_server,
+    'database' => db_name,
+    'port' => db_port
+  }
+end
+
+namespace :deploy do
+  def with_tempfile_on_remote_server(&block)
+    tempfile_name = capture('mktemp -t preparedb.XXXXXXXX').strip
+
+    yield tempfile_name
+  ensure
+    run "rm #{tempfile_name}"
+  end
+
+  def db_connection
+    fetch(:db_connection, {})
+  end
+
+  def dbinfo
+    @dbinfo ||= db_defaults.merge(db_connection)
+    unless stage == :production
+      @dbinfo['database'] = '%s-%s' % [db_name, stage]
+    end
+    @dbinfo
+  end
+
+  def run_with_password(cmd, pwd)
+    once = false
+    run cmd do |ch, stream, data|
+      $stdout.write(data)
+      unless once
+        ch.send_data pwd + "\n"
+        $stdout.write('[not shown]')
+        once = true
+      end
+    end
+  end
+
+  namespace :db do
+    desc "Regenerate deployment database.yml"
+    task :copy_database_yml do
+      put({ rails_env.to_s => dbinfo }.to_yaml, "#{release_path}/config/database.yml")
+    end
+
+    desc "Drop and recreate stage DB"
+    task :create do
+      if reference_db_stages.include? stage.to_s
+        puts "Cloning reference database!"
+        raise "Your database name #{dbinfo['database']} looks wrong" unless dbinfo['database'] =~ /^[\w-]+-#{stage}$/
+
+        with_tempfile_on_remote_server do |tf|
+          referencedb = "%s-reference" % db_name
+
+          popt = [['host', 'h'], ['username', 'U'], ['port', 'p']].
+            select { |key, flag| dbinfo[key] }.
+            map { |key, flag| '-%s "%s"' % [flag, dbinfo[key]] } * ' ' +
+            ' -W'
+
+          sql = <<-SQL % [referencedb, dbinfo['database'], dbinfo['database']]
+            select killusers('%s','%s');
+            drop database "%s";
+            SQL
+          put sql, tf
+
+          run_with_password %{psql postgres #{popt} -a -f #{tf} 2>&1}, dbinfo['password']
+          run_with_password %{createdb "#{dbinfo['database']}" #{popt} -T "#{referencedb}" 2>&1}, dbinfo['password']
+        end 
+      else
+        puts "Not cloning reference database, because the #{stage} stage is not in reference_db_stages (#{reference_db_stages})."
+      end
+    end 
+  end
+end
+
+before 'deploy:migrate', 'deploy:db:copy_database_yml'
+before 'deploy:migrate', 'deploy:db:create'

data/lib/projectdx_pipeline/capistrano/git_revision.rb

@@ -0,0 +1,69 @@
+namespace :deploy do
+  desc "Return SHA-1 commit ID of deployed branch"
+  task :show_revision do
+    puts capture("cat #{deploy_to}/current/REVISION")
+  end
+
+  desc "Determine commit to use (may default to HEAD)."
+  task :get_revision do
+    def stage
+      variables[:stage] && variables[:stage].to_s
+    end
+
+    def changed_in_git(filename)
+      `git diff --name-only`.grep(/^#{filename}$/).length > 0 ? true : false
+    end
+
+    def commit_of_rev(branch)
+      x=`git rev-parse --revs-only #{branch}`.chomp
+      return nil if x.empty?
+      return x
+    end
+
+    def commit_in_remote_branch?(commit,branch)
+      return false if commit.nil?
+      if  %x{git branch -r --contains #{commit}}.grep(/^\s*origin\/#{branch}/).empty?
+          puts ""
+          puts "no rev matches #{commit} in the remote #{branch} branch(es)"
+          return false
+      end
+      true
+    end
+
+    def valid_commit?(commit)
+      return false if commit.nil?
+      if branch_stages.include? stage.to_s
+        return false unless commit_in_remote_branch?(commit,fetch(:deploy_branch, stage.to_s))
+      end
+      return true
+    end
+
+    # returns the actual branch name, if it exists.  nil if it does not
+    def remote_branch_name(branch)
+      return nil if branch.nil?
+      rem_branch = `git branch -r`.grep(/^\s*origin\/(v|)#{branch}$/)[0]
+      return nil if rem_branch.nil?
+      return rem_branch.sub(/^\s*origin\//, '').chomp
+    end
+
+    set :revision, begin
+      deploy_version = ENV[ 'DEPLOY_VERSION' ]
+      deploy_version ||= 'HEAD' unless branch_stages.include?(stage.to_s)
+      
+      commit = commit_of_rev(deploy_version)
+      until valid_commit?(commit) do
+        deploy_version=Capistrano::CLI.ui.ask( 'Enter release number to deploy: ' )
+        commit = commit_of_rev(deploy_version)
+      end
+      commit
+    end
+
+    set :branch do
+      revision
+    end
+
+    set :release_commit do
+      branch
+    end
+  end
+end

data/lib/projectdx_pipeline/capistrano/maintenance.rb

@@ -0,0 +1,53 @@
+namespace :deploy do
+  namespace :web do
+    set(:maint_files) {["#{shared_path}/system/maintenance.html"]}
+
+    desc <<-DESC
+      Present a maintenance page to visitors. Disables your application's web \
+      interface by writing a "maintenance.html" file to each web server. The \
+      servers must be configured to detect the presence of this file, and if \
+      it is present, always display it instead of performing the request.
+
+      By default, the maintenance page will just say the site is down for \
+      "maintenance", and will be back "shortly", but you can customize the \
+      page by specifying the REASON environment variable:
+
+        $ cap deploy:web:disable \\
+              REASON="hardware upgrade"
+
+      Further customization will require that you write your own task.
+    DESC
+    task :disable, :roles => :web, :except => { :no_release => true } do
+      require 'erb'
+      on_rollback { maint_files.each do |file|
+                      run "if [ -e #{file} ]; then rm #{file}; fi"
+                    end
+                  }
+
+      reason = ENV['REASON']
+
+      template = File.read("public/maintenance.rhtml")
+      result = ERB.new(template).result(binding)
+      maint_files.each do |file|
+        dir=File.dirname(file)
+        tmpfile=%x{mktemp -u /tmp/capXXXXXXXX} # this seems like the quickest way to just get a name.
+        tmpfile.chomp!
+        put result, tmpfile, :mode => 0644
+        run "if [ -d #{dir} -a \! -e #{file} ]; then mv #{tmpfile} #{file}; fi"
+        run "chcon -t httpd_sys_content_t  #{file}; true" # we ignore this since some hosts have home on nfs
+      end
+    end
+
+    desc <<-DESC
+      Makes the application web-accessible again. Removes the \
+      "maintenance.html" page generated by deploy:web:disable, which (if your \
+      web servers are configured correctly) will make your application \
+      web-accessible again.
+    DESC
+    task :enable, :roles => :web, :except => { :no_release => true } do
+      maint_files.each do |file|
+        run "if [ -e #{file} ]; then  rm #{file}; fi"
+      end
+    end
+  end
+end

data/lib/projectdx_pipeline/capistrano/passenger.rb

@@ -0,0 +1,8 @@
+namespace :deploy do
+  task :start do ; end
+  task :stop do ; end
+  task :restart, :roles => :app, :except => { :no_release => true } do
+    puts "Telling Passenger to restart the app."
+    run "#{try_sudo} touch #{File.join(current_path,'tmp','restart.txt')}"
+  end
+end

data/projectdx_pipeline.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{projectdx_pipeline}
-  s.version = "0.2.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Renewable Funding"]
-  s.date = %q{2011-12-07}
+  s.date = %q{2011-12-14}
   s.description = %q{Common pipeline tasks and libraries to be used for all components of the ProjectDX platform}
   s.email = %q{devteam@renewfund.com}
   s.extra_rdoc_files = [
@@ -27,6 +27,15 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/projectdx_pipeline.rb",
+    "lib/projectdx_pipeline/capistrano.rb",
+    "lib/projectdx_pipeline/capistrano/config/deploy/alpha.rb",
+    "lib/projectdx_pipeline/capistrano/config/deploy/beta.rb",
+    "lib/projectdx_pipeline/capistrano/config/deploy/production.rb",
+    "lib/projectdx_pipeline/capistrano/config/deploy/staging.rb",
+    "lib/projectdx_pipeline/capistrano/database_configuration.rb",
+    "lib/projectdx_pipeline/capistrano/git_revision.rb",
+    "lib/projectdx_pipeline/capistrano/maintenance.rb",
+    "lib/projectdx_pipeline/capistrano/passenger.rb",
     "lib/projectdx_pipeline/database_configuration_template.rb",
     "lib/projectdx_pipeline/file.rb",
     "lib/projectdx_pipeline/railtie.rb",
@@ -47,17 +56,23 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<capistrano>, ["~> 2.9.0"])
+      s.add_runtime_dependency(%q<capistrano-ext>, ["~> 1.2.1"])
       s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
+      s.add_dependency(%q<capistrano>, ["~> 2.9.0"])
+      s.add_dependency(%q<capistrano-ext>, ["~> 1.2.1"])
       s.add_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
+    s.add_dependency(%q<capistrano>, ["~> 2.9.0"])
+    s.add_dependency(%q<capistrano-ext>, ["~> 1.2.1"])
     s.add_dependency(%q<rspec>, ["~> 2.3.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])

metadata

@@ -4,10 +4,10 @@ version: !ruby/object:Gem::Version
   hash: 23
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 2
   - 0
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Renewable Funding
@@ -15,14 +15,46 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-07 00:00:00 -08:00
+date: 2011-12-14 00:00:00 -08:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: capistrano
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 2
+        - 9
+        - 0
+        version: 2.9.0
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: capistrano-ext
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 2
+        - 1
+        version: 1.2.1
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
   name: rspec
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -33,12 +65,12 @@ dependencies:
         - 3
         - 0
         version: 2.3.0
-  requirement: *id001
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
   name: bundler
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -49,12 +81,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  requirement: *id002
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
   name: jeweler
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -65,12 +97,12 @@ dependencies:
         - 6
         - 4
         version: 1.6.4
-  requirement: *id003
+  requirement: *id005
 - !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
   name: rcov
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -79,7 +111,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id004
+  requirement: *id006
 description: Common pipeline tasks and libraries to be used for all components of the ProjectDX platform
 email: devteam@renewfund.com
 executables: []
@@ -100,6 +132,15 @@ files:
 - Rakefile
 - VERSION
 - lib/projectdx_pipeline.rb
+- lib/projectdx_pipeline/capistrano.rb
+- lib/projectdx_pipeline/capistrano/config/deploy/alpha.rb
+- lib/projectdx_pipeline/capistrano/config/deploy/beta.rb
+- lib/projectdx_pipeline/capistrano/config/deploy/production.rb
+- lib/projectdx_pipeline/capistrano/config/deploy/staging.rb
+- lib/projectdx_pipeline/capistrano/database_configuration.rb
+- lib/projectdx_pipeline/capistrano/git_revision.rb
+- lib/projectdx_pipeline/capistrano/maintenance.rb
+- lib/projectdx_pipeline/capistrano/passenger.rb
 - lib/projectdx_pipeline/database_configuration_template.rb
 - lib/projectdx_pipeline/file.rb
 - lib/projectdx_pipeline/railtie.rb