capistrano-clouddeploy 1.0.1

data/.gitignore

@@ -0,0 +1,12 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+doc
+.yardoc
+pkg
+.idea
+.bundle
+.rvmrc
+perftools
+

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-clouddeploy.gemspec
+gemspec
+
+gem 'amazon-ec2', :git => "git://github.com/rrollins/amazon-ec2.git"

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Royce Rollins
+
+MIT License
+
+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,102 @@
+# Capistrano::Clouddeploy
+
+Use Capistrano Cloud Deploy Gem to deploy your Amazon EC2 instances.
+Tag your instances with the the roles they get then on deployment Capistrano Cloud Deploy can
+figure out the roles and load into the capistrano configuration.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-clouddeploy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-clouddeploy
+
+## Usage
+Within deploy.rb or whatever multistage cap config file place:
+
+    require 'capistrano-clouddeploy'
+    cloud_config_roles = []
+    cloud_required_roles = [ :app, :db, :web ]
+    stage = <STAGE> 
+    configuration = YAML.load(File.open(File.dirname(__FILE__) + "/amazon_ec2.yml"))[stage]
+    set :deploy_manager, CapistranoCloudDeploy::AWSManager.new(self, application, stage, configuration)
+    deploy_manager.set_cap_roles cloud_required_roles, cloud_config_roles
+
+
+
+To List Roles:
+    bundle exec cap deploy:list_roles
+
+You'll see output similar to the following:
+
+     * executing `deploy:list_roles'
+    ** ROLES:
+    ** 
+    ** role: web
+    ** ec2-23-**-27-232.compute-1.amazonaws.com
+    ** 
+    ** role: db
+    ** ec2-23-**-27-232.compute-1.amazonaws.com
+    ** 
+    ** role: app
+    ** ec2-23-**-27-232.compute-1.amazonaws.com
+
+
+or if you're using multistage-ext  you can type
+
+    bundle exec cap <STAGE> deploy:list_roles
+
+
+Cloud deploy will use either the public dns or fall back to
+elastic ip address of an ec2 instance
+
+
+To get last deployed tag:
+    bundle exec cap deploy:last_deploy_tag 
+
+You'll see output similar to the following:
+
+     * executing `production_ec2'
+     triggering start callbacks for `deploy:last_deploy_tag'
+    * executing `multistage:ensure'
+    * executing `deploy:last_deploy_tag'
+    ** last deploy tag: 1.0
+
+
+or if you're using multistage-ext  you can type
+
+    bundle exec cap <STAGE> deploy:last_deploy_tag
+
+
+Tag Machines in Amazon with the following:  (Name and Value)
+
+    <APP_NAME_AS_DEFINED_IN_CAPISTRANO>/enabled (true | false)
+    If set to false capistrano will ignore
+
+
+    <APP_NAME_AS_DEFINED_IN_CAPISTRANO>/multistage/environment (<STAGE_NAME>)
+    Stage is the stage that this instance applies to
+
+
+    <APP_NAME_AS_DEFINED_IN_CAPISTRANO>/capistrano/roles (web,db,app, ROLE, ...)
+    <APP_NAME_AS_DEFINED_IN_CAPISTRANO>/capistrano/roles  is a comma separated list of roles that the machine has
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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
+
+
+

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+
+task :default => :test

data/capistrano-clouddeploy.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/capistrano-clouddeploy/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-clouddeploy"
+  gem.version       = CapistranoCloudDeploy::VERSION
+  gem.authors         = ["Masahji Stewart", "Royce Rollins"]
+  gem.email           = ["masahji@synctree.com", "royce@synctree.com"]
+  gem.homepage        = "http://github.com/synctree/capistrano-clouddeploy"
+  gem.summary         = "Cloud Deployment and configuration for Amazon EC2"
+  gem.description = "A Ruby library for capturing deployment configuration info from ec2 and future cloud services"
+
+  gem.add_development_dependency('mocha', '>= 0.9.9')
+  gem.add_development_dependency('test-unit', '>= 2.1.2')
+  gem.add_development_dependency('test-spec', '>= 0.10.0')
+  gem.add_development_dependency('ruby-debug19', '>= 0.11.6')
+
+  gem.add_dependency(%q<capistrano>)
+  gem.add_dependency(%q<aws-s3>)
+  gem.add_dependency(%q<amazon-ec2>)
+
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+end

data/lib/capistrano-clouddeploy/aws_manager.rb

@@ -0,0 +1,145 @@
+require 'AWS'
+require 'aws/s3'
+
+module CapistranoCloudDeploy
+  class AWSManager
+    def initialize(cap, application, stage, aws_config )
+      @application = application
+      @stage = stage
+      @deploy_config_bucket = aws_config['deploy_config_bucket']
+
+      @aws_opts = {
+        :access_key_id      => aws_config['access_key_id'] || ENV['AWS_ACCESS_KEY_ID'],
+        :secret_access_key  => aws_config['secret_access_key'] || ENV['AWS_SECRET_ACCESS_KEY'],
+        :server             => (
+          aws_config['server'] || "#{aws_config['region']}.ec2.amazonaws.com"
+        )
+      }
+
+      @ec2 = AWS::EC2::Base.new(@aws_opts)
+      #@as  = AWS::Autoscaling::Base.new(@aws_opts)   #future support for autoscaling
+      @cap = cap
+    end
+
+    def record_build(branch)
+      s3put("#{@application}/#{@stage}/latest-build", branch,  @deploy_config_bucket)
+    end
+
+    def retrieve_build
+      begin
+        s3get("#{@application}/#{@stage}/latest-build",  @deploy_config_bucket).value
+      rescue AWS::S3::NoSuchKey
+        nil
+      end
+    end
+
+
+    def each_role
+      roles = {}
+  
+      @ec2.describe_instances['reservationSet']['item'].each do |reservation_set|
+        reservation_set['instancesSet']['item'].each do |instance|
+          tags = instance['tagSet'] && instance['tagSet']['item'].kind_of?(Array) ? 
+            Hash[instance['tagSet']['item'].collect { |i| [i['key'],i['value'] ]}] : {}
+
+          # if we don't have an application tag then we will pull the application tag
+          # information from user-data if there is anything
+          if tags["#{@application}/enabled"].nil?
+            user_data = @ec2.describe_instance_attribute(
+              :instance_id => instance['instanceId'], 
+              :attribute => 'userData'
+            )['userData']
+  
+            begin
+              if user_data and user_data['value']
+                tags.update(YAML.load Base64.decode64(user_data['value']))
+              end
+            rescue Exception => ex
+              STDERR.puts("#{ex}")
+            end
+          end
+  
+          next unless tags["#{@application}/enabled"] == "true" &&
+                      tags["#{@application}/multistage/environment"] == @stage.to_s
+  
+          instance_roles = (tags["#{@application}/capistrano/roles"] || "").split(/[,\|]/)
+          instance_roles.each do |role_name| roles[role_name] ||= []
+            roles[role_name].push(instance)
+          end
+        end
+      end
+  
+      roles.each_pair do |role_name, instances|
+        role_name = role_name.to_sym
+        yield(role_name, instances)
+      end
+  
+    end
+
+
+    def s3put(dest, string_or_stream, bucket, 
+                options = { :access => :public_read })
+      # Copy this file to S3
+      AWS::S3::Base.establish_connection!(
+       :access_key_id     => @aws_opts[:access_key_id],
+       :secret_access_key => @aws_opts[:secret_access_key]
+      )
+ 
+      AWS::S3::S3Object.store(dest, string_or_stream, bucket, options)
+    end
+  
+    def s3get(path, bucket)
+      AWS::S3::Base.establish_connection!(
+       :access_key_id     => @aws_opts[:access_key_id],
+       :secret_access_key => @aws_opts[:secret_access_key]
+      )
+
+      AWS::S3::S3Object.find(path, bucket)
+    end
+
+    def public_address(instance) 
+      return instance['vpcId'] ? instance['privateIpAddress'] : (
+        instance['dnsName'] || instance['ipAddress']
+      )
+    end
+
+    def set_cap_roles(required_roles = [], config_roles = [])
+      each_role do |role_name, instances|
+        if config_roles.include?(role_name)
+          @cap.set role_name, instances.first['privateDnsName'] 
+        elsif role_name == :db
+          if instances.size == 1
+            #use public dns or elastic ip address
+            public_addy = public_address(instances.first)
+            @cap.role role_name, public_addy, :primary => true
+          else
+            raise "You have more than one machine set to the db role:\n #{
+              instances.delete_if { |i| public_address(i).nil? }.
+                        collect   { |i| public_address(i) }.
+                        join(",")
+            }\nand we don't know which one is primary"
+          end
+        else
+          @cap.role role_name do
+            instances.delete_if { |i| public_address(i).nil? }.
+                      collect   { |i| public_address(i) }
+          end
+        end
+      end
+  
+      config_roles.each do |role_name|
+        @cap.set role_name, nil unless @cap.respond_to?(role_name)
+      end
+      required_roles.each do |role_name|
+        if @cap.role(role_name).size == 0
+          @cap.role role_name do [] end
+        end
+      end
+    end
+
+  end
+end
+
+
+
+

data/lib/capistrano-clouddeploy/cap_tasks.rb

@@ -0,0 +1,79 @@
+require File.dirname(__FILE__) + '/aws_manager'
+
+configuration = Capistrano::Configuration.respond_to?(:instance) ?
+  Capistrano::Configuration.instance(:must_exist) : Capistrano.configuration(:must_exist)
+
+configuration.load do
+  namespace :deploy do
+
+    task :list_roles do
+
+      #TODO: auto discovery of roles
+      #
+      logger.info "ROLES:"
+      roles.keys.each do |role|
+        logger.info "\nrole: #{role}"
+        find_servers(:roles => role).each do |s|
+          logger.info "\t#{s}"
+        end 
+      end
+    end
+
+    task :record_build, :roles => [:manager] do
+      if !respond_to?(:bootstrapping) && deploy_manager
+        deploy_manager.record_build(branch)
+        logger.info("recording #{branch}\n")
+      else
+        logger.info("bootstrapping so skipping record_build\n")
+      end
+    end
+
+    task :last_deploy_tag, :roles => [:manager] do
+      if !respond_to?(:bootstrapping) && deploy_manager
+        t = deploy_manager.retrieve_build
+        if t
+          logger.info("last deploy tag: #{t}\n")
+        else
+         logger.info("last deploy tag not set\n")
+        end
+      else
+        logger.info("bootstrapping or deploy manager not set")
+      end
+ 
+    end
+
+    task :bootstrap do
+      set :bootstrapping, true
+      set :bootstrap, true
+      stop
+      cold
+      nginx.restart
+      cleanup
+    end
+
+  end
+
+  set :bootstrapping, bootstrap if respond_to?(:bootstrap)
+  after "deploy:symlink", "deploy:record_build"
+
+  set :branch do
+    default_tag = deploy_manager.retrieve_build if deploy_manager
+    if respond_to?(:deploy_tag)
+      tag = deploy_tag
+
+    elsif respond_to?(:bootstrap) && default_tag
+      tag = default_tag
+
+    else
+      default_tag ||= `git tag`.split("\n").last
+
+      tag = Capistrano::CLI.ui.ask "Tag to deploy (make sure to push the tag first): [#{default_tag}] "
+      tag = default_tag if tag.empty?
+    end
+    logger.info("branch is #{tag}")
+    tag
+  end
+
+end
+
+

data/lib/capistrano-clouddeploy/version.rb

@@ -0,0 +1,3 @@
+module CapistranoCloudDeploy
+    VERSION = "1.0.1"
+end

data/lib/capistrano-clouddeploy.rb

@@ -0,0 +1 @@
+require 'capistrano-clouddeploy/aws_manager.rb'

data/test/amazon_ec2.yml

@@ -0,0 +1,11 @@
+
+blank_environment:   #Leave this environment blank
+  bucket_name:       ''
+  access_key_id:     ''
+  secret_access_key: ''
+  region:            'us-east-1'
+test:
+  bucket_name:       'dfasfd'
+  access_key_id:     'asdfadsf'
+  secret_access_key: 'asdfasdf'
+  region:            'us-east-1'

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require "bundler/setup"
+#require 'bundler'
+#Bundler.setup
+gem 'test-unit'
+
+%w[ test/unit test/spec mocha ].each { |f|
+  begin
+    require f
+  rescue LoadError
+    abort "Unable to load required gem for test: #{f}"
+  end
+}
+
+require File.dirname(__FILE__) + '/../lib/capistrano-clouddeploy/aws_manager'
+
+
+
+

data/test/test_me.rb

@@ -0,0 +1,100 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+describe 'Cloud Deploy' do
+
+  setup do
+
+    #mock capistrano
+    @cap = mock()
+    @cap.stubs(:set)
+    @cap.stubs(:role)
+
+
+
+    #Config File
+    @aws_config = YAML.load(File.open(File.dirname(__FILE__) + "/amazon_ec2.yml"))['test']
+
+    @application = "capistrano_test_app"
+    @stage = "test"  
+    @deploy_manager = CapistranoCloudDeploy::AWSManager.new(@cap, @application, @stage, @aws_config)
+  end
+
+  specify "throws error if not in config file" do
+    aws_config = YAML.load(File.open(File.dirname(__FILE__) + "/amazon_ec2.yml"))['blank_environment']
+    assert_raise do 
+      CapistranoCloudDeploy::AWSManager.new(@cap, @application, @stage, aws_config)
+    end
+  end 
+
+
+  describe  'configuring environment' do
+
+    setup do
+      #mock amazon response
+      @amazon_response = { 'reservationSet' => {
+                            'item' => [
+                              { 'instancesSet' => {
+                                  'item' => [ 
+                                    { 'tagSet' => {
+                                        'item' => [ 
+                                          {'key' => "#{@application}/enabled", 'value' => "true"}, 
+                                          {'key' => "#{@application}/multistage/environment", 
+                                                    'value' => @stage
+                                          },
+                                          {'key' => "#{@application}/capistrano/roles", 
+                                                    'value' => "web"
+                                          }
+                                        ]
+                                      },
+                                      "dnsName" => "web.localhost"
+                                    },
+                                    { 'tagSet' => {
+                                        'item' => [ 
+                                          {'key' => "#{@application}/enabled", 'value' => "true"}, 
+                                          {'key' => "#{@application}/multistage/environment", 
+                                                    'value' => @stage
+                                          },
+                                          {'key' => "#{@application}/capistrano/roles", 
+                                                    'value' => "db"
+                                          }
+                                        ]
+                                      },
+                                      "dnsName" => "db.localhost"
+                                    }
+
+                                  ] 
+                                } 
+                              } 
+                            ]
+                          } 
+                        }
+   
+
+      
+    end
+
+
+    it "should be able to get env info" do
+      required_roles = [:web]
+      config_roles = [];
+      AWS::EC2::Base.any_instance.stubs(:describe_instances).returns(@amazon_response)
+
+      @cap.expects(:role).returns(["", ""])
+      @cap.expects(:role).with(:web)
+      @cap.expects(:role).with(:db)
+      
+      @deploy_manager = CapistranoCloudDeploy::AWSManager.new(@cap, @application, @stage, @aws_config)
+
+      @deploy_manager.set_cap_roles required_roles, config_roles
+      
+ 
+    end
+
+    #functional test 
+    #test it hits amazon and gets the key info
+    #mock out ec2 and cap on manager
+
+  end
+
+end
+

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-clouddeploy
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Masahji Stewart
+- Royce Rollins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: test-spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.6
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-s3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: amazon-ec2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby library for capturing deployment configuration info from ec2 and
+  future cloud services
+email:
+- masahji@synctree.com
+- royce@synctree.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-clouddeploy.gemspec
+- lib/capistrano-clouddeploy.rb
+- lib/capistrano-clouddeploy/aws_manager.rb
+- lib/capistrano-clouddeploy/cap_tasks.rb
+- lib/capistrano-clouddeploy/version.rb
+- test/amazon_ec2.yml
+- test/test_helper.rb
+- test/test_me.rb
+homepage: http://github.com/synctree/capistrano-clouddeploy
+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.23
+signing_key: 
+specification_version: 3
+summary: Cloud Deployment and configuration for Amazon EC2
+test_files:
+- test/amazon_ec2.yml
+- test/test_helper.rb
+- test/test_me.rb