deploy-recipes 0.0.1 → 0.0.2

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3-p194

data/README.md

@@ -1,6 +1,6 @@
 # Deploy::Recipes
 
-TODO: Write a gem description
+This Gem provides deployment helpers and task used by [The Beans Group][1].
 
 ## Installation
 
@@ -17,8 +17,37 @@ Or install it yourself as:
     $ gem install deploy-recipes
 
 ## Usage
+Some tasks and helpers require extra configuration. At the moment the only way of providing the extra configuration options is to set those in the `deploy.rb` sript.  
+The way of setting them is as follows:
 
-TODO: Write usage instructions here
+	set :option_name, option_value
+
+## Capistrano Helper Usage
+This Gem contains some helpers that can be used with capistrano. Helpers generally need to be loaded at the top of the `deploy.rb` script, if not otherwise stated.
+
+### AWS EC2
+The AWS EC2 task is used to dynamically set the web, app and db server valiables in your deploy.rb file.
+For this helper to work properly you need to set the following vaiables in your `deploy.rb` file:
+
+* `access_key_id` (required)      - Your AWS access key id
+* `secret_access_key` (required) - You AWS secret access key
+
+## Capistrano Tasks Usage
+This section describes the tasks made available by this Gem. Tasks are generally (if not otherwise stated) loaded at the end of the `deploy.rb` script.
+
+### Database
+This task can be used to generate the database configuration file for a project. During the execution of this taks it will ask you to enter the password of the database.   
+This tasks will be executed once required in the `deploy.rb` file. For more information when this task will be run please look towards the end of this taks.
+
+### Deploy Automation
+The deploy automation task can be used with Pivotal Tracker and Git to make deployment and managing deploys easier.
+For this task to work properly you need to set the following vaiables in your `deploy.rb` file:
+
+* `pivotal_tracker_token` (required) - This is the API token needed to interact with your PT account
+* `changelog_location` (optional)    - Define the location at which you would like the changelog to be stored. At the moment this has to be within 
+the scope of the Git repository because this task expects to be able to commit the changelog and push it to the remote branch.
+
+This tasks will be executed after the `deploy:cleanup` task, once required in the `deploy.rb` file.
 
 ## Contributing
 
@@ -27,3 +56,5 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+[1]: http://www.thebeansgroup.com "The Beans Group"

data/Rakefile

@@ -1,2 +1,4 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require "bundler/setup"
+Bundler::GemHelper.install_tasks

data/deploy-recipes.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/deploy-recipes/version', __FILE__)
+require File.expand_path('../lib/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Vincent Siebert"]
@@ -14,4 +14,10 @@ Gem::Specification.new do |gem|
   gem.name          = "deploy-recipes"
   gem.require_paths = ["lib"]
   gem.version       = Deploy::Recipes::VERSION
+  
+  gem.add_dependency "capistrano", ">= 2.5.9"
+  gem.add_dependency "pivotal-tracker", ">= 0.5.4"
+  gem.add_dependency "grit", ">= 2.5.0"
+  gem.add_dependency "tinder", ">= 1.8.0"
+  gem.add_dependency "aws-sdk", ">= 1.5.3"
 end

data/lib/common.rb

@@ -0,0 +1,17 @@
+def _cset(name, *args, &block)
+  unless exists?(name)
+    set(name, *args, &block)
+  end
+end
+
+def _cdefault_run_options(key, value)
+  unless default_run_options.has_key? key
+    default_run_options[key] = value
+  end
+end
+
+def _cssh_options(key, value)
+  unless ssh_options.has_key? key
+    ssh_options[key] = value
+  end
+end

data/lib/deploy-recipes.rb

@@ -1,7 +1,5 @@
-require "deploy-recipes/version"
+require 'capistrano'
+require 'capistrano/cli'
+require 'common'
 
-module Deploy
-  module Recipes
-    # Your code goes here...
-  end
-end
+Dir.glob(File.join(File.dirname(__FILE__), '/deploy-recipes/*.rb')).sort.each { |f| load f }

data/lib/deploy-recipes/aws-ec2.rb

@@ -0,0 +1,50 @@
+# load the libraries
+require 'aws'
+# # log requests using the default rails logger
+# AWS.config(:logger => Rails.logger)
+
+def aws_ec2_role(which, *args, &block)
+  
+  options = args.last.is_a?(Hash) ? args.pop : {}
+  
+  # validate EC2 settings
+  _cset(:access_key_id) { Capistrano::CLI.ui.ask("Enter your AWS access key ID: ") }
+  _cset(:secret_access_key) { Capistrano::CLI.ui.ask("Enter your AWS secret key: ") }
+  
+  AWS.config :access_key_id => access_key_id, :secret_access_key => secret_access_key 
+  
+  ec2 = AWS::EC2.new
+  # optionally switch to a non-default region
+  if region = options[:region]
+    region = ec2.regions[region]
+    unless region.exists?
+      raise "Requested region '#{region.name}' does not exist.  Valid regions: \n #{ec2.regions.map(&:name).join("\n  ")}"
+    end
+    # a region acts like the main EC2 interface
+    ec2 = region
+  end
+  
+  query = {}
+  
+  instances = AWS.memoize do
+    query = {}
+    # Filter by tags
+    if tags = options[:tags]      
+      args.delete :tags
+      ec2.instances.select do |i|
+        r = false
+        tags.each do |key, value|
+          if value
+            r = i.tags.to_h[key.to_s] == value
+          else
+           r = i.tags.to_h.has_key? key.to_s
+         end
+        end
+        r
+      end
+    end
+  end
+  # @TODO we need to make sure we merge the dns names with the other args
+  args = instances.map {|i| i.dns_name}
+  role which, *args
+end

data/lib/deploy-recipes/base.rb

@@ -0,0 +1,38 @@
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "capistrano/tbg/deploy requires Capistrano 2"
+end
+
+Capistrano::Configuration.instance.load do
+  # User details
+  _cset :user,          "deploy"
+  _cset(:group)         { user }
+  
+  # @TODO utilise a deployment config file outside the project to be able to DRY the deploy config system
+  _cset :config_file,   "~/.deployment-configs.yml"
+  
+  # Application details
+  _cset(:application)   { abort "Please specify the short name of your application, set :application, 'foo'" }
+  _cset :use_sudo,      false
+
+  # SCM settings
+  _cset(:deploy_to) { "/var/www/apps/#{application}" }
+  _cset :scm,           "git"
+  _cset :branch,        "master"
+  _cset :deploy_via,    "remote_cache"
+
+  # Git settings for Capistrano
+  _cdefault_run_options :pty,   true # needed for git password prompts
+  _cssh_options :forward_agent, true # use the keys for the person running the cap command to check out the append
+  _cssh_options :auth_methods,  ["publickey"]
+  _cssh_options :keys,          [File.join(ENV["HOME"], ".ssh", user)]
+  
+  # If you are using Passenger mod_rails uncomment this:
+  namespace :deploy do
+    task :start do ; end
+    task :stop do ; end
+    task :restart, :roles => :app, :except => { :no_release => true } do
+      run "#{try_sudo} touch #{File.join(current_path,'tmp','restart.txt')}"
+    end
+  end
+  
+end

data/lib/deploy-recipes/database.rb

@@ -0,0 +1,168 @@
+# 
+# = Capistrano database.yml task
+#
+# Provides a couple of tasks for creating the database.yml 
+# configuration file dynamically when deploy:setup is run.
+#
+# Category::    Capistrano
+# Package::     Database
+# Author::      Simone Carletti <weppos@weppos.net>
+# Copyright::   2007-2010 The Authors
+# License::     MIT License
+# Link::        http://www.simonecarletti.com/
+# Source::      http://gist.github.com/2769
+#
+#
+# == Requirements
+#
+# This extension requires the original <tt>config/database.yml</tt> to be excluded
+# from source code checkout. You can easily accomplish this by renaming
+# the file (for example to database.example.yml) and appending <tt>database.yml</tt>
+# value to your SCM ignore list.
+#
+#   # Example for Subversion
+#
+#   $ svn mv config/database.yml config/database.example.yml
+#   $ svn propset svn:ignore 'database.yml' config
+#
+#   # Example for Git
+#
+#   $ git mv config/database.yml config/database.example.yml
+#   $ echo 'config/database.yml' >> .gitignore 
+#
+# 
+# == Usage
+# 
+# Include this file in your <tt>deploy.rb</tt> configuration file.
+# Assuming you saved this recipe as capistrano_database_yml.rb:
+# 
+#   require "capistrano_database_yml"
+# 
+# Now, when <tt>deploy:setup</tt> is called, this script will automatically
+# create the <tt>database.yml</tt> file in the shared folder.
+# Each time you run a deploy, this script will also create a symlink
+# from your application <tt>config/database.yml</tt> pointing to the shared configuration file. 
+# 
+# == Custom template
+# 
+# By default, this script creates an exact copy of the default
+# <tt>database.yml</tt> file shipped with a new Rails 2.x application.
+# If you want to overwrite the default template, simply create a custom Erb template
+# called <tt>database.yml.erb</tt> and save it into <tt>config/deploy</tt> folder.
+# 
+# Although the name of the file can't be changed, you can customize the directory
+# where it is stored defining a variable called <tt>:template_dir</tt>.
+# 
+#   # store your custom template at foo/bar/database.yml.erb
+#   set :template_dir, "foo/bar"
+# 
+#   # example of database template
+#   
+#   base: &base
+#     adapter: sqlite3
+#     timeout: 5000
+#   development:
+#     database: #{shared_path}/db/development.sqlite3
+#     <<: *base
+#   test:
+#     database: #{shared_path}/db/test.sqlite3
+#     <<: *base
+#   production:
+#     adapter: mysql
+#     database: #{application}_production
+#     username: #{user}
+#     password: #{Capistrano::CLI.ui.ask("Enter MySQL database password: ")}
+#     encoding: utf8
+#     timeout: 5000
+#
+# Because this is an Erb template, you can place variables and Ruby scripts
+# within the file.
+# For instance, the template above takes advantage of Capistrano CLI
+# to ask for a MySQL database password instead of hard coding it into the template.
+#
+# === Password prompt
+#
+# For security reasons, in the example below the password is not
+# hard coded (or stored in a variable) but asked on setup.
+# I don't like to store passwords in files under version control
+# because they will live forever in your history.
+# This is why I use the Capistrano::CLI utility.
+#
+
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "This extension requires Capistrano 2"
+end
+
+Capistrano::Configuration.instance.load do
+
+  namespace :deploy do
+
+    namespace :db do
+
+      desc <<-DESC
+        Creates the database.yml configuration file in shared path.
+
+        By default, this task uses a template unless a template \
+        called database.yml.erb is found either is :template_dir \
+        or /config/deploy folders. The default template matches \
+        the template for config/database.yml file shipped with Rails.
+
+        When this recipe is loaded, db:setup is automatically configured \
+        to be invoked after deploy:setup. You can skip this task setting \
+        the variable :skip_db_setup to true. This is especially useful \ 
+        if you are using this recipe in combination with \
+        capistrano-ext/multistaging to avoid multiple db:setup calls \ 
+        when running deploy:setup for all stages one by one.
+      DESC
+      task :setup, :except => { :no_release => true } do
+        default_template = <<-EOF
+# store your custom template at foo/bar/database.yml.erb
+#set :template_dir, "foo/bar"
+#
+# example of database template  
+production:
+  adapter: mysql2
+  encoding: utf8
+  timeout: 5000
+  database: #{application}
+  host: db.thebeansgroup.com
+  pool: 5
+  username: tbg
+  password: #{Capistrano::CLI.ui.ask("Enter MySQL database password: ")}
+        EOF
+
+        location = fetch(:template_dir, "config/deploy") + '/database.yml.erb'
+        template = File.file?(location) ? File.read(location) : default_template
+
+        config = ERB.new(template)
+
+        run "mkdir -p #{shared_path}/db" 
+        run "mkdir -p #{shared_path}/config" 
+        put config.result, "#{shared_path}/config/database.yml"
+      end
+
+      desc <<-DESC
+        [internal] Updates the symlink for database.yml file to the just deployed release.
+      DESC
+      task :symlink, :except => { :no_release => true } do
+        run "ln -nfs #{shared_path}/config/database.yml #{release_path}/config/database.yml" 
+      end
+      
+      desc <<-DESC
+        [internal] Removes the database.yml file after code_update in order for the symlink to work
+      DESC
+      task :remove_config, :except => { :no_release => true } do
+        f = "#{release_path}/config/database.yml"
+        if File.file?(f) then FileUtils.rm_rf(f) end
+      end
+      
+
+    end
+
+    after "deploy:setup",           "deploy:db:setup"         unless fetch(:skip_db_setup, false)
+    after "deploy:code_update",     "deploy:db:remove_config"
+    after "deploy:finalize_update", "deploy:db:symlink"
+
+  end
+
+end

data/lib/deploy-recipes/deploy-automation.rb

@@ -0,0 +1,115 @@
+require "pivotal-tracker"
+require "grit"
+require "tinder"
+
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "This extension requires Capistrano 2"
+end
+
+Capistrano::Configuration.instance.load do
+  namespace :deploy do
+    namespace :automation do
+      desc "Get all referenced pivotal tracker stories"
+      task :create_changelog do
+        
+        # validate Pivotal Tracker settings
+        _cset(:pivotal_tracker_token) { Capistrano::CLI.ui.ask("Enter your Pivotal Tracker tocken: ") }
+      
+        # validate Campfire settings
+        _cset(:pivotal_tracker_token) { Capistrano::CLI.ui.ask("Enter your Pivotal Tracker tocken: ") }
+        _cset(:pivotal_tracker_token) { Capistrano::CLI.ui.ask("Enter your Pivotal Tracker tocken: ") }
+      
+        _cset(:changelog_location) { "#{Rails.root}/CHANGELOG.md" }
+        
+        changelog = {:features => [], :bugs => [], :chores => []}
+        # get current repo
+        repo = Grit::Repo.new Rails.root
+        # last release
+        # last_rel = "REL-2012-06-12_10-38-04"
+        last_rel = repo.git.describe({'abbrev' => 0, 'tags' => true, 'match' => 'REL-*'}).gsub!("\n","")
+        p "LAST RELEASE: #{last_rel}"
+        # validate
+        raise "Could not find previous release tag" unless last_rel
+       
+        # lets tag the new release
+        time = Time.new
+        tag_name = time.to_formatted_s :release_tag
+        repo.git.tag({ 'a' => true,  'm' => "creating release tag for #{tag_name}"}, tag_name)
+        repo.git.push({'tags' => true})
+      
+        # current release
+        cur_rel = repo.git.describe({'abbrev' => 0, 'tags' => true, 'match' => 'REL-*'}).gsub!("\n","")
+        p "CURRENT RELEASE: #{cur_rel}"
+        # validate
+        raise "Could not find latest release tag" unless cur_rel
+        # Now lets get all the commit messages with PT story references
+        commits = repo.git.log({'grep' => "\[[ a-z]*[ ]*#[0-9]+[ ]*\]", 'E' => true, 'i' => true, 'format' => 'format:%s'}, "#{last_rel}...#{cur_rel}")
+        p commits
+        # Only if we have commit do we need to carry on
+        if not commits.blank?
+           # Lets extract the sory references
+          story_ids = commits.scan(/\[[ a-z]*[ ]*#([0-9]+)[ ]*\]/).flatten!.uniq
+          p story_ids
+          # Pivotal Tracker
+          accepted_status = [:started, :finished, :delivered, :accepted]
+          # Manually set API Token
+          PivotalTracker::Client.token = Rails.application.config.pivotal_tracker_token
+          # return all projects
+          projects = PivotalTracker::Project.all
+          # We need to order the projects by the likelyhood of stories being contained within them to speed up the process
+          projects = projects.sort { |p1, p2| p2.last_activity_at <=> p1.last_activity_at }
+          projects.map do |project|
+            break unless story_ids
+            p "checking project #{project.name} for stories"
+            story_ids.each do |id|
+              story = project.stories.find id
+              if story
+                if accepted_status.include? story.current_state.to_sym
+                  changelog[story.story_type.pluralize.to_sym] << story.name
+                  story.update :current_state => :accepted
+                  story.notes.create(:text => "This #{story.story_type} was deployed with release #{tag_name}")	
+                end
+              end
+            end
+          end
+          # Now lets assemble the changelog
+          head = "\n## Release #{tag_name}\nPlease find all changes below.\n"
+          # assemble the features
+          features = "\n### New features deployed:\n"
+          if changelog[:features]
+            changelog[:features].each do |feature|
+              features << "* #{feature}\n"
+            end
+          else
+            features << "**No new features deployed**\n"
+          end
+          # Assemble the bug fixes
+          bugs = "\n### Bug fixes deployed:\n"
+          if changelog[:bugs]
+            changelog[:bugs].each do |bug|
+              bugs << "* #{bug}\n"
+            end
+          else
+            bugs << "**No bug fixes deployed**\n"
+          end
+          # Write the changelog to the changelog file
+          open(changelog_location, 'a') do |f|
+            f << head
+            f << features
+            f << bugs
+          end
+          #  And commit them to the remote
+          # p changelog_location
+          repo.git.add({}, changelog_location)
+          c = repo.git.commit({'m' => "updating changelog for release #{tag_name}"}, changelog_location).scan(/^\[(\w+)[\s]{1}([a-zA-Z0-9]+)\]/).flatten
+          if c.first and c.last
+            repo.git.push({}, "origin", "#{c.last}:#{c.first}")
+          end
+        else
+          p "No commits with story references identified"
+        end
+      end
+    end
+    after "deploy:cleanup", "deploy:automation"
+  end
+end

data/lib/{deploy-recipes/version.rb → version.rb}

@@ -1,5 +1,5 @@
 module Deploy
   module Recipes
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deploy-recipes
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,88 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-14 00:00:00.000000000 Z
-dependencies: []
+date: 2012-07-11 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.5.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.9
+- !ruby/object:Gem::Dependency
+  name: pivotal-tracker
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+- !ruby/object:Gem::Dependency
+  name: grit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: tinder
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
 description: Collection of capistrano deploy recipes
 email:
 - vincent@siebert.im
@@ -19,13 +99,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rvmrc
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - deploy-recipes.gemspec
+- lib/common.rb
 - lib/deploy-recipes.rb
-- lib/deploy-recipes/version.rb
+- lib/deploy-recipes/aws-ec2.rb
+- lib/deploy-recipes/base.rb
+- lib/deploy-recipes/database.rb
+- lib/deploy-recipes/deploy-automation.rb
+- lib/version.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -38,12 +124,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3176994864263131959
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3176994864263131959
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.19