eb_deployer 0.6.5 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a3bf432fbdd44e7326eaf9e78be738e88e9f3e4
-  data.tar.gz: 2098b1afc36775fde413f58dd89aabd885e12dd3
+  metadata.gz: 61bce2cf3c9e823994645f76257fe43b360f3dfa
+  data.tar.gz: 0446b95ef9b12a138b495fd847118981c22452cf
 SHA512:
-  metadata.gz: 1de31e8970e914b8cea087335e455356294144327b4d905b2ad1f5fe28cbfafb62134b1b2408a8178927f7dfd99880aba589d05092a0b0df7cb9b05fae3fac77
-  data.tar.gz: 3faefb2b6faf8ec5caec1ac861828fe95394f81dce54d4ff94b1cec3b02d7275c86872da33e2908f5206ace6868c3b2fa2a56e4f911b48d675709377ad21660a
+  metadata.gz: 86ab2af9a6e5beaa906486a9929f75914a4f425169d39dd32c077ea63310951ea7c83ca93ff4e3c7aec11fe4bcf00b7ee5b0e5675bc1b01175776eaa6021d8ee
+  data.tar.gz: a699f697841d6e07c2d1b0ee7b682d65431f2d24b1e26a4602e7bb72303eead2866ce9e7014e7652052005a9b30d151481c4909f290e2d97e9b8f63f16777d53

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+0.6.6
+=====
+
+* Add support for specifying (and overriding) a [stack policy](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) for the CloudFormation resource stack
+* Fix issue where deployment hangs if resource stack update fails and stack is rolled back, deployment will now fail when the resource stack update fails
+
 0.6.5
 =====
 

data/lib/eb_deployer.rb

@@ -56,7 +56,7 @@ module EbDeployer
 
 
   #
-  # Deploy a package to specfied environments on elastic beanstalk
+  # Deploy a package to specified environments on elastic beanstalk
   #
   # @param [Hash] opts
   #
@@ -101,7 +101,7 @@ module EbDeployer
   #   deploy. For blue-green deployment it terminate the inactive environment
   #   first then recreate it. This is useful to avoiding configuration drift and
   #   accumulating state on the EC2 instances. Also it has the benefit of keeping
-  #   your EC2 instance system package upto date, because everytime EC2 instance
+  #   your EC2 instance system package upto date, because every time EC2 instance
   #   boot up from AMI it does a system update.
   #
   #
@@ -116,6 +116,10 @@ module EbDeployer
   #   following keys:
   #
   #     :template => CloudFormation template file with JSON format
+  #     :policy => CloudFormation policy file with JSON format
+  #     :override_policy => (false) If override_policy is true and a policy file is provided then the
+  #   policy will temporarily override any existing policy on the resource stack during this update,
+  #   otherwise the provided policy will replace any existing policy on the resource stack
   #     :parameters (or :inputs) => A Hash, input values for the CloudFormation template
   #     :transforms => A Hash with key map to your CloudFormation
   #   template outputs and value as lambda that return a single or array of
@@ -151,7 +155,7 @@ module EbDeployer
   #
   # @option opts [Symbol] :strategy (:blue-green) There are two options:
   #   blue-green or inplace-update. Blue green keep two elastic beanstalk
-  #   environments and always deploy to inactive one, to achive zero downtime.
+  #   environments and always deploy to inactive one, to achieve zero downtime.
   #   inplace-update strategy will only keep one environment, and update the
   #   version inplace on deploy. this will save resources but will have downtime.
   #
@@ -164,8 +168,8 @@ module EbDeployer
   # @option opts [Symbol] :version_label *required*. Version label give the
   #   package uploaded a unique identifier.  Should use something related to
   #   pipeline counter if you have build pipeline setup to build the installer.
-  #   For the convient of dev we recommend use md5 digest of the installer so
-  #   that everytime you upload new installer it forms a new version. e.g.
+  #   For the convenience of dev we recommend use md5 digest of the installer so
+  #   that every time you upload new installer it forms a new version. e.g.
   #
   #      :version_label => ENV['MY_PIPELINE_COUNTER']
   #                       || "dev-" + Digest::MD5.file(my_package).hexdigest
@@ -178,6 +182,9 @@ module EbDeployer
   #   keep.  Older versions are removed and deleted from the S3 source bucket as well.
   #   If specified as zero or not specified, all versions will be kept.  If a
   #   version_prefix is given, only removes version starting with the prefix.
+  #
+  # @option opts [Symbol] :template_name. Specifies the environement template you wish
+  #   to use to build your environment.
   def self.deploy(opts)
     if region = opts[:region]
       Aws.config.update(:region => region)
@@ -205,6 +212,7 @@ module EbDeployer
       env.settings = opts[:option_settings] || opts[:settings] || []
       env.inactive_settings = opts[:inactive_settings] || []
       env.creation_opts = {
+        :template_name => opts[:template_name],
         :solution_stack => opts[:solution_stack_name],
         :cname_prefix =>  opts[:cname_prefix],
         :smoke_test => opts[:smoke_test],

data/lib/eb_deployer/aws_driver/beanstalk.rb

@@ -25,12 +25,16 @@ module EbDeployer
         @client.update_environment(:environment_id => env_id, :option_settings => settings)
       end
 
-      def update_environment(app_name, env_name, version, tier, settings)
+      def update_environment(app_name, env_name, version, tier, settings, template_name)
         env_id = convert_env_name_to_id(app_name, [env_name]).first
-        @client.update_environment(:environment_id => env_id,
-                                   :version_label => version,
-                                   :option_settings => settings,
-                                   :tier => environment_tier(tier))
+        request = reject_nil({
+          :environment_id => env_id,
+          :version_label => version,
+          :option_settings => settings,
+          :tier => environment_tier(tier),
+          :template_name => template_name
+        })
+        @client.update_environment(request)
       end
 
       def environment_exists?(app_name, env_name)
@@ -41,7 +45,7 @@ module EbDeployer
         alive_envs(app_name).collect { |env| env[:environment_name] }
       end
 
-      def create_environment(app_name, env_name, stack_name, cname_prefix, version, tier, tags, settings)
+      def create_environment(app_name, env_name, stack_name, cname_prefix, version, tier, tags, settings, template_name)
         request = reject_nil({
           :application_name => app_name,
           :environment_name => env_name,
@@ -50,7 +54,8 @@ module EbDeployer
           :option_settings => settings,
           :tier => environment_tier(tier),
           :cname_prefix => cname_prefix,
-          :tags => tags
+          :tags => tags,
+          :template_name => template_name
         })
         @client.create_environment(request)
       end

data/lib/eb_deployer/cloud_formation_provisioner.rb

@@ -4,7 +4,7 @@ module EbDeployer
 
   class CloudFormationProvisioner
     SUCCESS_STATS = ["CREATE_COMPLETE", "UPDATE_COMPLETE"]
-    FAILED_STATS = ["CREATE_FAILED", "UPDATE_FAILED"]
+    FAILED_STATS = ["CREATE_FAILED", "UPDATE_FAILED", "UPDATE_ROLLBACK_COMPLETE"]
 
     def initialize(stack_name, cf_driver)
       @stack_name = stack_name
@@ -17,13 +17,15 @@ module EbDeployer
       template = File.read(resources[:template])
       capabilities = resources[:capabilities] || []
       params = resources[:inputs] || resources[:parameters] || {}
+      policy = File.read(resources[:policy]) if resources[:policy]
+      override_policy = resources[:override_policy] || false
       anchor = nil
       begin
         if stack_exists?
           anchor = @poller.get_anchor
-          update_stack(template, params, capabilities)
+          update_stack(template, params, capabilities, policy, override_policy)
         else
-          create_stack(template, params, capabilities)
+          create_stack(template, params, capabilities, policy)
         end
       rescue Aws::CloudFormation::Errors::ValidationError => e
         if e.message =~ /No updates are to be performed/
@@ -65,21 +67,26 @@ module EbDeployer
       end
     end
 
-    def update_stack(template, params, capabilities)
-      @cf_driver.update_stack(@stack_name, template,
-                              :capabilities => capabilities,
-                              :parameters => params)
+    def update_stack(template, params, capabilities, policy, override_policy)
+      opts = {:capabilities => capabilities, :parameters => params}
+      if (policy)
+        opts[:stack_policy_during_update_body] = policy if override_policy
+        log("Using temporary stack policy to apply resource stack updates") if override_policy
+        opts[:stack_policy_body] = policy unless override_policy
+        log("Applying new stack policy to existing resource stack") unless override_policy
+      end
+      @cf_driver.update_stack(@stack_name, template, opts)
     end
 
     def stack_exists?
       @cf_driver.stack_exists?(@stack_name)
     end
 
-    def create_stack(template, params, capabilities)
-      @cf_driver.create_stack(@stack_name, template,
-                              :disable_rollback => true,
-                              :capabilities => capabilities,
-                              :parameters => params)
+    def create_stack(template, params, capabilities, policy)
+      opts = {:disable_rollback => true, :capabilities => capabilities, :parameters => params}
+      opts[:stack_policy_body] = policy if policy
+      log("Applying stack policy to new resource stack") if policy
+      @cf_driver.create_stack(@stack_name, template, opts)
     end
 
     def transform_output_to_settings(transforms)

data/lib/eb_deployer/default_config.yml

@@ -122,6 +122,9 @@ common:
   # options settings.
   # keys:
   #    template => CloudFormation template file with JSON format
+  #    policy => CloudFormation policy file with JSON format
+  #    override_policy => (false) If override_policy is true and a policy file is provided then the policy will temporarily override any existing policy on the resource stack during this update,
+  #                       otherwise the provided policy will replace any existing policy on the resource stack
   #    inputs => A Hash, input values for the CloudFormation template
   #    outputs => A Hash with key map to your CloudFormation template outputs and value as elastic beanstalk settings namespace and option_name.
   #    capabilities => An array. You need set it to ['CAPABILITY_IAM'] if the

data/lib/eb_deployer/eb_environment.rb

@@ -73,6 +73,10 @@ module EbDeployer
       @creation_opts[:tier]
     end
 
+    def template_name
+      @creation_opts[:template_name]
+    end
+
     def has_cname?
       !configured_tier || configured_tier.downcase == 'webserver'
     end
@@ -93,7 +97,8 @@ module EbDeployer
                                version_label,
                                configured_tier,
                                tags,
-                               settings)
+                               settings,
+                               template_name)
       end
     end
 
@@ -103,7 +108,8 @@ module EbDeployer
                                @name,
                                version_label,
                                configured_tier,
-                               settings)
+                               settings,
+                               template_name)
       end
     end
 

data/lib/eb_deployer/version.rb

@@ -1,3 +1,3 @@
 module EbDeployer
-  VERSION = "0.6.5"
+  VERSION = "0.6.6"
 end

data/lib/generators/eb_deployer/install/templates/eb_deployer.yml.erb

@@ -137,6 +137,9 @@ common:
   # options settings.
   # keys:
   #    template => CloudFormation template file with JSON format
+  #    policy => CloudFormation policy file with JSON format
+  #    override_policy => (false) If override_policy is true and a policy file is provided then the policy will temporarily override any existing policy on the resource stack during this update,
+  #                       otherwise the provided policy will replace any existing policy on the resource stack
   #    inputs => A Hash, input values for the CloudFormation template
   #    outputs => A Hash with key map to your CloudFormation template outputs and value as elastic beanstalk settings namespace and option_name.
   #    capabilities => An array. You need set it to ['CAPABILITY_IAM'] if the

data/test/aws_driver_stubs.rb

@@ -24,7 +24,7 @@ class EBStub
     @apps.include?(app)
   end
 
-  def create_environment(app, env, solution_stack, cname_prefix, version, tier, tags, settings)
+  def create_environment(app, env, solution_stack, cname_prefix, version, tier, tags, settings, template_name)
     raise 'cname prefix is not avaible' if @envs.values.detect { |env| env[:cname_prefix] == cname_prefix }
     raise "env name #{env} is longer than 23 chars" if env.size > 23
     raise "app not exists" unless application_exists?(app)
@@ -36,7 +36,8 @@ class EBStub
       :cname_prefix => cname_prefix,
       :tier => tier,
       :tags => tags,
-      :settings => settings }
+      :settings => settings,
+      :template_name => template_name }
     set_env_ready(app, env, false)
   end
 
@@ -52,9 +53,9 @@ class EBStub
   end
 
 
-  def update_environment(app, env, version, tier, settings)
+  def update_environment(app, env, version, tier, settings, template_name)
     raise "not in ready state, consider waiting for previous action finish by pulling envents" unless env_ready?(app, env)
-    @envs[env_key(app, env)].merge!(:version => version, :settings => settings, :tier => tier)
+    @envs[env_key(app, env)].merge!(:version => version, :settings => settings, :tier => tier, :template_name => template_name)
     set_env_ready(app, env, false)
   end
 
@@ -220,6 +221,10 @@ class EBStub
     @versions_deleted[app_name]
   end
 
+  def template_name(app_name, env_name)
+    @envs[env_key(app_name, env_name)][:template_name]
+  end
+
   private
 
   def set_env_ready(app, env, ready)

data/test/resources_deploy_test.rb

@@ -11,6 +11,61 @@ class ResourcesDeployTest < DeployTest
     assert @cf_driver.stack_exists?('simple-production')
     assert_equal({},  @cf_driver.stack_config('simple-production')[:parameters])
     assert_equal([],  @cf_driver.stack_config('simple-production')[:capabilities])
+    assert_nil(@cf_driver.stack_config('simple-production')[:stack_policy_body])
+  end
+
+  def test_deploy_with_resources_declared_will_create_a_cf_stack_for_env_with_policy
+    cf_template = temp_file(JSON.dump({'Resources' => {'R1' => {}}}))
+    cf_policy = sample_file("sample_policy.json", JSON.dump({'Policy' => {'P1' => {}}}))
+    deploy(:application => 'simple', :environment => "production",
+           :resources => {
+               :template => cf_template,
+               :policy => cf_policy
+           })
+    assert @cf_driver.stack_exists?('simple-production')
+    assert_equal({},  @cf_driver.stack_config('simple-production')[:parameters])
+    assert_equal([],  @cf_driver.stack_config('simple-production')[:capabilities])
+    assert_equal("{\"Policy\":{\"P1\":{}}}", @cf_driver.stack_config('simple-production')[:stack_policy_body])
+  end
+
+  def test_deploy_with_resources_declared_will_update_a_cf_stack_for_env_with_policy
+    cf_template = temp_file(JSON.dump({'Resources' => {'R1' => {}}}))
+    cf_policy = sample_file("sample_policy.json", JSON.dump({'Policy' => {'P1' => {}}}))
+    deploy(:application => 'simple', :environment => "production",
+           :resources => {
+               :template => cf_template,
+               :policy => cf_policy
+           })
+    assert @cf_driver.stack_exists?('simple-production')
+    deploy(:application => 'simple', :environment => "production",
+           :resources => {
+               :template => cf_template,
+               :policy => cf_policy,
+               :override_policy => false
+           })
+    assert_equal({},  @cf_driver.stack_config('simple-production')[:parameters])
+    assert_equal([],  @cf_driver.stack_config('simple-production')[:capabilities])
+    assert_equal("{\"Policy\":{\"P1\":{}}}", @cf_driver.stack_config('simple-production')[:stack_policy_body])
+  end
+
+  def test_deploy_with_resources_declared_will_update_a_cf_stack_for_env_with_temp_policy
+    cf_template = temp_file(JSON.dump({'Resources' => {'R1' => {}}}))
+    cf_policy = sample_file("sample_policy.json", JSON.dump({'Policy' => {'P1' => {}}}))
+    deploy(:application => 'simple', :environment => "production",
+           :resources => {
+               :template => cf_template,
+               :policy => cf_policy
+           })
+    assert @cf_driver.stack_exists?('simple-production')
+    deploy(:application => 'simple', :environment => "production",
+           :resources => {
+               :template => cf_template,
+               :policy => cf_policy,
+               :override_policy => true
+           })
+    assert_equal({},  @cf_driver.stack_config('simple-production')[:parameters])
+    assert_equal([],  @cf_driver.stack_config('simple-production')[:capabilities])
+    assert_equal("{\"Policy\":{\"P1\":{}}}", @cf_driver.stack_config('simple-production')[:stack_policy_during_update_body])
   end
 
   def test_provision_resources_with_capacities

data/test/template_deploy_test.rb

@@ -0,0 +1,13 @@
+require 'deploy_test'
+
+class TemplateDeployTest < DeployTest
+  def test_default_no_template
+    deploy(:application => 'simple', :environment => "production")
+    assert_equal nil, @eb.template_name('simple', t('production', 'simple'))
+  end
+
+  def test_can_set_a_template
+    deploy(:application => 'simple', :environment => "production", :template_name => 'SomeTemplate')
+    assert_equal 'SomeTemplate', @eb.template_name('simple', t('production', 'simple'))
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eb_deployer
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.6
 platform: ruby
 authors:
 - wpc
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-22 00:00:00.000000000 Z
+date: 2016-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -103,6 +103,7 @@ files:
 - test/rails_generators_test.rb
 - test/resources_deploy_test.rb
 - test/smoke_test_test.rb
+- test/template_deploy_test.rb
 - test/test_helper.rb
 - test/tier_setting_deploy_test.rb
 - test/versions_deploy_test.rb
@@ -148,6 +149,7 @@ test_files:
 - test/rails_generators_test.rb
 - test/resources_deploy_test.rb
 - test/smoke_test_test.rb
+- test/template_deploy_test.rb
 - test/test_helper.rb
 - test/tier_setting_deploy_test.rb
 - test/versions_deploy_test.rb