simple_deploy 0.6.0 → 0.6.1

data/CHANGELOG

@@ -1,3 +1,9 @@
+## v0.6.1
+
+* Corrected the clone command so it accepts new attributes
+* Added ability to pass config data into Config class which avoids having to have a .simple_deploy.yml file.
+* Config file reads SIMPLE_DEPLOY_CONFIG_FILE for alternate config file location.
+
 ## v0.6.0
 
 * Updated so it no longer caches simpledb attributes so it works better with stackster changes

data/README.md

@@ -1,28 +1,30 @@
 [![Build Status](https://secure.travis-ci.org/intuit/simple_deploy.png)](http://travis-ci.org/intuit/simple_deploy)
 
-I use the stackster to manage stacks, however I understand how to connect to different regions / accounts as well as kick off a deployment on instances.
+Simple Deploy is an opinionated gem that helps manage and perform directed deployments to AWS Cloud Formation Stacks.
 
-Getting Started
----------------
+Prerequisites
+-------------
+
+* Ruby version 1.9.2 or higher installed.
+* AWS account access key and secret key.
+
+Installation
+------------
 
 Install the gem
 
 ```
-gem install simple_deploy
+gem install simple_deploy --no-ri --no-rdoc
 ```
 
 Create a file **~/.simple_deploy.yml** and include within it:
 
 ```
 environments:
-  preprod_shared_us_west_1:
+  preprod:
     access_key: XXX
     secret_key: yyy
     region: us-west-1
-
-notifications:
-  campfire:
-    token: XXX
 ```
 
 Notifications
@@ -30,21 +32,31 @@ Notifications
 
 Currently Simple Deploy only supports Campfire for notifications.  To enable them, add your token, which can be obtained on the 'My Info' screen of Campfire in the notifications yaml above.  If you don't want notificaitons, omit this section.
 
-Advaned Configurations
-----------------------
-
-The configuration file supports additional optional deployment parameters. 
+To enable notifications on deployment to a Campfire room. Append the below to the **~/.simple_deploy.yml**.
 
-Deploy can have a ssh **user** and **key** set.  These will be used to connect to both the gateway and tunnel through to instances.
+```
+notifications:
+  campfire:
+    token: XXX
+```
 
 Commands
 --------
 
-For a list of commands, run simple_deploy -h.  To get more information about each subcommand, append a -h after the subcomand.  For example: **simple_deploy deploy -h**.
+For a list of commands, run **simple_deploy -h**.  To get more information about each subcommand, append a -h after the subcomand.  For example: **simple_deploy deploy -h**.
 
 Deploying
 ---------
 
 By default simple deploy will use your user name and id_rsa key for deployments.  To override either these, set the **SIMPLE_DEPLOY_SSH_USER** & **SIMPLE_DEPLOY_SSH_KEY** respectively.
 
-The deployment gateway is ready from the **ssh_gateway** attribute for that stack.
+```
+export SIMPLE_DEPLOY_SSH_USER=user
+export SIMPLE_DEPLOY_SSH_KEY=path_to_ssh_key
+```
+
+An alternate config file can be supplied by setting the **SIMPLE_DEPLOY_CONFIG_FILE** variable.
+
+```
+export SIMPLE_DEPLOY_CONFIG_FILE=/secret/my-config.yml
+```

data/lib/simple_deploy/cli/clone.rb

@@ -31,6 +31,7 @@ EOS
 
         cloned_attributes = filter_attributes source_stack.attributes
         new_attributes = merge_attributes cloned_attributes, override_attributes
+        new_attributes += add_attributes cloned_attributes, override_attributes
 
         if @opts[:template]
           template_file = @opts[:template]
@@ -58,6 +59,14 @@ EOS
         end
       end
 
+      def add_attributes(cloned_attributes, override_attributes)
+        override_attributes.map do |override|
+          key = override.keys.first
+          clone = cloned_attributes.find { |c| c.has_key? key }
+          clone ? nil : override
+        end.compact
+      end
+
       def config
         @config ||= Config.new.environment @opts[:environment]
       end

data/lib/simple_deploy/config.rb

@@ -4,7 +4,7 @@ module SimpleDeploy
     attr_accessor :config, :logger
 
     def initialize(args = {})
-      load_config_file
+      self.config = args.fetch(:config) { load_config_file }
       self.logger = args[:logger] ||= SimpleDeployLogger.new
     end
 
@@ -24,7 +24,7 @@ module SimpleDeploy
                           'app'       => 'AppArtifactURL',
                           'cookbooks' => 'CookbooksURL' }
       name_to_url_map[artifact]
-    end 
+    end
 
     def deploy_script
       '/opt/intu/admin/bin/configure.sh'
@@ -50,10 +50,8 @@ module SimpleDeploy
     private
 
     def load_config_file
-      config_file = "#{ENV['HOME']}/.simple_deploy.yml"
-
       begin
-        self.config = YAML::load( File.open( config_file ) )
+        YAML::load( File.open( config_file ) )
       rescue Errno::ENOENT
         raise "#{config_file} not found"
       rescue Psych::SyntaxError => e
@@ -62,11 +60,27 @@ module SimpleDeploy
     end
 
     def env_home
-      ENV['HOME']
+      env.load 'HOME'
     end
 
     def env_user
-      ENV['USER']
+      env.load 'USER'
+    end
+
+    def config_file
+      env_config_file || default_config_file
+    end
+
+    def env_config_file
+      env.load 'SIMPLE_DEPLOY_CONFIG_FILE'
+    end
+
+    def default_config_file
+      "#{env.load 'HOME'}/.simple_deploy.yml"
+    end
+
+    def env
+      @env ||= SimpleDeploy::Env.new
     end
 
   end

data/lib/simple_deploy/env.rb

@@ -0,0 +1,9 @@
+module SimpleDeploy
+  class Env
+
+    def load(var)
+      ENV.fetch var, nil
+    end
+
+  end
+end

data/lib/simple_deploy/version.rb

@@ -1,3 +1,3 @@
 module SimpleDeploy
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/lib/simple_deploy.rb

@@ -1,3 +1,4 @@
+require 'simple_deploy/env'
 require 'simple_deploy/config'
 require 'simple_deploy/artifact'
 require 'simple_deploy/stack'

data/spec/cli/clone_spec.rb

@@ -19,7 +19,6 @@ describe SimpleDeploy::CLI::Clone do
 
       it 'should filter out deployment attributes' do
         new_attributes = subject.send(:filter_attributes, @source_attributes)
-
         new_attributes.size.should == 6
 
         new_attributes[0].has_key?('AmiId').should be_true
@@ -57,7 +56,6 @@ describe SimpleDeploy::CLI::Clone do
 
       it 'should merge the override attributes' do
         merged_attributes = subject.send(:merge_attributes, @cloned_attributes, @override_attributes)
-
         merged_attributes.size.should == 7
 
         merged_attributes[0].has_key?('AmiId').should be_true
@@ -77,6 +75,46 @@ describe SimpleDeploy::CLI::Clone do
       end
     end
 
+    context 'add_attributes' do
+      before do
+        @cloned_attributes = [
+          { 'AmiId' => 'ami-7b6a4e3e' },
+          { 'AppEnv' => 'pod-2-cd-1' },
+          { 'MaximumAppInstances' => 1 },
+          { 'MinimumAppInstances' => 1 },
+          { 'chef_repo_bucket_prefix' => 'intu-lc' },
+          { 'chef_repo_domain' => 'live_community_chef_repo' },
+          { 'deployment_user' => 'rmendes' }
+        ]
+
+        @new_attributes = [
+          { 'chef_repo_bucket_prefix' => 'updated-intu-lc' },
+          { 'SolrClientTrafficContainer' => 'solr-client-traffic-container' },
+          { 'SolrReplicationTrafficContainer' => 'solr-replication-traffic-container' }
+        ]
+      end
+
+      it 'should add new override attributes' do
+        add_attributes = subject.send(:add_attributes, @cloned_attributes, @new_attributes)
+        add_attributes.size.should == 2
+
+        add_attributes[0].has_key?('SolrClientTrafficContainer').should be_true
+        add_attributes[0]['SolrClientTrafficContainer'].should == 'solr-client-traffic-container'
+        add_attributes[1].has_key?('SolrReplicationTrafficContainer').should be_true
+        add_attributes[1]['SolrReplicationTrafficContainer'].should == 'solr-replication-traffic-container'
+      end
+
+      it 'should return an empty array if there are no new attributes' do
+        new_attributes = [
+          { 'chef_repo_bucket_prefix' => 'updated-intu-lc' },
+          { 'chef_repo_domain' => 'updated_community_chef_repo' }
+        ]
+
+        add_attributes = subject.send(:add_attributes, @cloned_attributes, new_attributes)
+        add_attributes.should be_empty
+      end
+    end
+
     context 'stack creation' do
       before do
         @config  = mock 'config'
@@ -85,7 +123,9 @@ describe SimpleDeploy::CLI::Clone do
                      :log_level   => 'debug',
                      :source_name => 'source_stack',
                      :new_name    => 'new_stack',
-                     :attributes  => ['chef_repo_bucket_prefix=updated-intu-lc', 'chef_repo_domain=updated_community_chef_repo'] }
+                     :attributes  => ['chef_repo_bucket_prefix=updated-intu-lc',
+                                      'chef_repo_domain=updated_community_chef_repo',
+                                      'SolrClientTrafficContainer=solr-client-traffic-container'] }
 
         @source_stack   = stub :attributes => {
           'AmiId' => 'ami-7b6a4e3e',
@@ -118,7 +158,7 @@ describe SimpleDeploy::CLI::Clone do
                                       and_return(@new_stack)
       end
       
-      it 'should create the new stack using the filtered and merged attributes' do
+      it 'should create the new stack using the filtered, merged and added attributes' do
         SimpleDeploy::CLI::Shared.should_receive(:valid_options?).
                                  with(:provided => @options,
                                       :required => [:environment, :source_name, :new_name])
@@ -130,7 +170,8 @@ describe SimpleDeploy::CLI::Clone do
                                           { 'MaximumAppInstances' => 1 },
                                           { 'MinimumAppInstances' => 1 },
                                           { 'chef_repo_bucket_prefix' => 'updated-intu-lc' },
-                                          { 'chef_repo_domain' => 'updated_community_chef_repo' }]
+                                          { 'chef_repo_domain' => 'updated_community_chef_repo' },
+                                          { 'SolrClientTrafficContainer' => 'solr-client-traffic-container' }]
           options[:template].should match /new_stack_template.json/
         end
 
@@ -151,7 +192,8 @@ describe SimpleDeploy::CLI::Clone do
                                           { 'MaximumAppInstances' => 1 },
                                           { 'MinimumAppInstances' => 1 },
                                           { 'chef_repo_bucket_prefix' => 'updated-intu-lc' },
-                                          { 'chef_repo_domain' => 'updated_community_chef_repo' }]
+                                          { 'chef_repo_domain' => 'updated_community_chef_repo' },
+                                          { 'SolrClientTrafficContainer' => 'solr-client-traffic-container' }]
           options[:template].should match /brand_new_template.json/
         end
 

data/spec/config_spec.rb

@@ -1,33 +1,51 @@
 require 'spec_helper'
 
 describe SimpleDeploy do
+  let(:config_data) do
+    { 'environments' => {
+        'test_env' => {
+          'secret_key' => 'secret',
+          'access_key' => 'access',
+          'region'     => 'us-west-1'
+      } },
+      'notifications' => {
+        'campfire' => {
+          'token' => 'my_token'
+      } } }
+  end
 
-  describe "after creating a configuration" do
-    before do
-      @config_data = { 'artifacts' => { 
-                         'test_repo' => {
-                           'bucket_prefix' => 'test_prefix',
-                           'domain' => 'test_domain'
-                          },
-                         'test_repo2' => { },
-                        },
-                        'environments' => {
-                          'test_env' => { 
-                            'secret_key' => 'secret',
-                            'access_key' => 'access',
-                            'region'     => 'us-west-1'
-                          }
-                        },
-                        'notifications' => {
-                          'campfire' => {
-                            'token' => 'my_token' 
-                          }
-                        }
-                      }
+  describe 'new' do
+    it 'should accept config data as an argument' do
+      YAML.should_not_receive(:load)
 
+      @config = SimpleDeploy::Config.new :config => config_data
+      @config.config.should == config_data
+    end
+
+    it 'should load the config from ~/.simple_deploy.yml by default' do
       File.should_receive(:open).with("#{ENV['HOME']}/.simple_deploy.yml").
-                                 and_return(@config_data.to_yaml)
+                                 and_return(config_data.to_yaml)
+      @config = SimpleDeploy::Config.new
+      @config.config.should == config_data
+    end
+
+    it 'should load the config from SIMPLE_DEPLOY_CONFIG_FILE if supplied' do
+      File.should_receive(:open).with("/my/config/file").
+                                 and_return(config_data.to_yaml)
+      env_mock = mock 'env'
+      SimpleDeploy::Env.stub :new => env_mock
+      env_mock.should_receive(:load).
+               with('SIMPLE_DEPLOY_CONFIG_FILE').
+               and_return "/my/config/file"
       @config = SimpleDeploy::Config.new
+      @config.config.should == config_data
+    end
+
+  end
+
+  describe "after creating a configuration" do
+    before do
+      @config = SimpleDeploy::Config.new :config => config_data
     end
 
     it "should return the default artifacts to deploy" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_deploy
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-01 00:00:00.000000000 Z
+date: 2012-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70363065994720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,15 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70363065994720
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70363066009920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -37,76 +32,51 @@ dependencies:
         version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.11.0
+  version_requirements: *70363066009920
 - !ruby/object:Gem::Dependency
   name: capistrano
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70363066009000 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - =
       - !ruby/object:Gem::Version
         version: 2.13.5
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.13.5
+  version_requirements: *70363066009000
 - !ruby/object:Gem::Dependency
   name: stackster
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70363066008120 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - =
       - !ruby/object:Gem::Version
         version: 0.3.2
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.3.2
+  version_requirements: *70363066008120
 - !ruby/object:Gem::Dependency
   name: tinder
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70363066006760 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - =
       - !ruby/object:Gem::Version
         version: 1.9.1
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.9.1
+  version_requirements: *70363066006760
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70363066005780 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - =
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '2.0'
+  version_requirements: *70363066005780
 description: I am designed to deploy artifacts uploaded by Heirloom
 email:
 - brett@weav.net
@@ -147,6 +117,7 @@ files:
 - lib/simple_deploy/cli/template.rb
 - lib/simple_deploy/cli/update.rb
 - lib/simple_deploy/config.rb
+- lib/simple_deploy/env.rb
 - lib/simple_deploy/logger.rb
 - lib/simple_deploy/notifier.rb
 - lib/simple_deploy/notifier/campfire.rb
@@ -192,7 +163,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2753799311552570386
+      hash: -1601352363388167763
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -201,10 +172,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2753799311552570386
+      hash: -1601352363388167763
 requirements: []
 rubyforge_project: simple_deploy
-rubygems_version: 1.8.24
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: I help with deployments