eb_deployer 0.4.7.beta1 → 0.4.8

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+0.4.8
+====
+* Raise an error if the environment launched with problems (contributed by kmanning)
+* Add --stack-name option that let's use choose the name of the cloud
+  formation stack to operate on (contributed by NET-A-PORTER)
+* Document typo/grammar fix (contributed by stig)
+* Retry on AWS API throttling error when operating on versions
+
+0.4.7
+====
+* Added blue-only deployment strategy (a variant of blue-green) that
+  skips the cname swap so that the newly deployed code remains on the
+  inactive "blue" instance. (contributed by jlabrecque)
+
 0.4.6
 ====
 * Make elasticbeanstalk event polling robust against clock shifting problem.

data/lib/eb_deployer/application.rb

@@ -67,7 +67,7 @@ module EbDeployer
         begin
           log("Removing #{version}")
           @eb_driver.delete_application_version(@name, version, delete_from_s3)
-        rescue AWS::ElasticBeanstalk::Errors::SourceBundleDeletionFailure, AWS::ElasticBeanstalk::Errors::OperationInProgressFailure => e
+        rescue AWS::ElasticBeanstalk::Errors::SourceBundleDeletionFailure => e
           log(e.message)
         end
       end

data/lib/eb_deployer/default_config.yml

@@ -12,9 +12,12 @@ common:
   # AWS region to deploy. Default to us-east-1
   # region: us-west-1
 
-  # There are two deployment strategies: 'blue-green' or 'inplace-update'.
+  # There are three deployment strategies: 'blue-green', 'blue-only', or 'inplace-update'.
   # Blue green deployments keep two elastic beanstalk environments and always deploy to
   # inactive one, to achieve zero downtime.
+  # Blue only deployments do everything that the blue green deployments do except for the final
+  # inactive to active CNAME swap leaving the newly deployed application on the inactive
+  # "blue" instance.
   # Inplace-update strategy will only keep one environment, and update the version inplace on
   # deploy. Inplace-update will save resources but will suffer from downtime.
   # (All old environments need be destroyed when you switching between strategies.)

data/lib/eb_deployer/deployment_strategy/blue_only.rb

@@ -0,0 +1,39 @@
+module EbDeployer
+  module DeploymentStrategy
+    class BlueOnly
+      def initialize(env)
+        @env = env
+      end
+
+      def deploy(version_label, env_settings, inactive_settings=[])
+        if !ebenvs.any?(&method(:active_ebenv?))
+          ebenv('a', @env.cname_prefix).
+            deploy(version_label, env_settings)
+          return
+        end
+
+        active_ebenv = ebenvs.detect(&method(:active_ebenv?))
+        inactive_ebenv = ebenvs.reject(&method(:active_ebenv?)).first
+
+        inactive_ebenv.deploy(version_label, env_settings)
+      end
+
+      private
+      def active_ebenv?(ebenv)
+        ebenv.cname_prefix == @env.cname_prefix
+      end
+
+      def ebenvs
+        [ebenv('a'), ebenv('b')]
+      end
+
+      def ebenv(suffix, cname_prefix=nil)
+        @env.new_eb_env(suffix, cname_prefix || inactive_cname_prefix)
+      end
+
+      def inactive_cname_prefix
+        "#{@env.cname_prefix}-inactive"
+      end
+    end
+  end
+end

data/lib/eb_deployer/deployment_strategy.rb

@@ -1,5 +1,6 @@
 require 'eb_deployer/deployment_strategy/inplace_update'
 require 'eb_deployer/deployment_strategy/blue_green'
+require 'eb_deployer/deployment_strategy/blue_only'
 
 module EbDeployer
   module DeploymentStrategy
@@ -9,6 +10,8 @@ module EbDeployer
         InplaceUpdate.new(env)
       when 'blue_green', 'blue-green'
         BlueGreen.new(env)
+      when 'blue_only', 'blue-only'
+        BlueOnly.new(env)
       else
         raise 'strategy_name: ' + strategy_name.to_s + ' not supported'
       end

data/lib/eb_deployer/eb_environment.rb

@@ -100,6 +100,10 @@ module EbDeployer
           raise "Elasticbeanstalk instance provision failed (maybe a problem with your .ebextension files). The original message: #{event[:message]}"
         end
 
+        if event[:message] =~ /However, there were issues during launch\. See event log for details\./
+          raise "Environment launched, but with errors.  The original message: #{event[:message]}"
+        end
+
         log_event(event)
         break if event[:message] =~ terminate_pattern
       end

data/lib/eb_deployer/environment.rb

@@ -7,9 +7,10 @@ module EbDeployer
 
     attr_reader :name
 
-    def initialize(app, name, eb_driver, &block)
+    def initialize(app, name, stack_name, eb_driver, &block)
       @app = app
       @name = name
+      @stack_name = stack_name
       @eb_driver = eb_driver
       @creation_opts = {}
       @settings = []
@@ -26,7 +27,7 @@ module EbDeployer
     end
 
     def deploy(version_label)
-      resource_settings = @resource_stacks.provision(resource_stack_name)
+      resource_settings = @resource_stacks.provision(@stack_name)
       components_to_deploy.each do |component|
         component.deploy(version_label, @settings + resource_settings, @inactive_settings)
       end
@@ -54,9 +55,5 @@ module EbDeployer
     def component_named(name)
       @components.detect { |c| c.name == name }
     end
-
-    def resource_stack_name
-      "#{app_name}-#{@name}"
-    end
   end
 end

data/lib/eb_deployer/version.rb

@@ -1,3 +1,3 @@
 module EbDeployer
-  VERSION = "0.4.7.beta1"
+  VERSION = "0.4.8"
 end

data/lib/eb_deployer.rb

@@ -45,7 +45,8 @@ module EbDeployer
     app = opts[:application]
     env_name = opts[:environment]
     cf = opts[:cf_driver] || AWSDriver::CloudFormationDriver.new
-    provisioner = CloudFormationProvisioner.new("#{app}-#{env_name}", cf)
+    stack_name = opts[:stack_name] || "#{app}-#{env_name}"
+    provisioner = CloudFormationProvisioner.new(stack_name, cf)
     provisioner.output(key)
   end
 
@@ -174,10 +175,12 @@ module EbDeployer
     end
 
     bs = opts[:bs_driver] || AWSDriver::Beanstalk.new
+    bs = ThrottlingHandling.new(bs, AWS::ElasticBeanstalk::Errors::Throttling)
     s3 = opts[:s3_driver] || AWSDriver::S3Driver.new
     cf = opts[:cf_driver] || AWSDriver::CloudFormationDriver.new
 
     app_name = opts[:application]
+    env_name = opts[:environment]
     version_prefix = opts[:version_prefix].to_s.strip
     version_label = "#{version_prefix}#{opts[:version_label].to_s.strip}"
 
@@ -185,8 +188,10 @@ module EbDeployer
     resource_stacks = ResourceStacks.new(opts[:resources],
                                          cf,
                                          opts[:skip_resource_stack_update])
-    bs = ThrottlingHandling.new(bs, AWS::ElasticBeanstalk::Errors::Throttling)
-    environment = Environment.new(application, opts[:environment], bs) do |env|
+
+    stack_name = opts[:stack_name] || "#{app_name}-#{env_name}"
+
+    environment = Environment.new(application, env_name, stack_name, bs) do |env|
       env.resource_stacks = resource_stacks
       env.settings = opts[:option_settings] || opts[:settings] || []
       env.inactive_settings = opts[:inactive_settings] || []
@@ -255,7 +260,7 @@ module EbDeployer
   def self.cli_parser(options)
     OptionParser.new do |opts|
       opts.banner = "Usage: eb_deployer [options]"
-      opts.on("-p", "--package [FILE/S3_OBJECT]", "Package to deploy, can be a war file for java application, or yaml specification for package location on S3, or a S3 object with bucket name saperated by colon, e.g. bucket_name:key_name") do |v|
+      opts.on("-p", "--package [FILE/S3_OBJECT]", "Package to deploy, can be a war file for java application, or yaml specification for package location on S3, or a S3 object & bucket name separated by colon, e.g. bucket_name:key_name") do |v|
         options[:package] = v
       end
 
@@ -271,6 +276,10 @@ module EbDeployer
         options[:action] = :destroy
       end
 
+      opts.on("-s", "--stack-name [STACK_NAME]", "CloudFormation stack name to use. If not specified, defaults to {app}-{env_name}") do |v|
+        options[:stack_name] = v
+      end
+
       opts.on("--skip-resource-stack-update", "Skip cloud-formation stack update. (only for extreme situation like hitting a cloudformation bug)") do |v|
         options[:skip_resource_stack_update] = true
       end

data/test/blue_only_deploy_test.rb

@@ -0,0 +1,78 @@
+require 'deploy_test'
+
+class BlueOnlyDeployTest < DeployTest
+  def test_blue_only_deployment_strategy_should_create_blue_env_on_first_deployment
+    do_deploy(42)
+    assert @eb.environment_exists?('simple', t('production-a', 'simple'))
+    assert_equal 'simple-production',  @eb.environment_cname_prefix('simple', t('production-a', 'simple'))
+  end
+
+
+  def test_blue_only_deployment_should_create_green_env_if_blue_exists
+    do_deploy(42)
+    do_deploy(43)
+    assert @eb.environment_exists?('simple', t('production-a', 'simple'))
+    assert @eb.environment_exists?('simple', t('production-b', 'simple'))
+  end
+
+
+  def test_blue_only_deployment_should_not_swap_cname_to_make_active_most_recent_updated_env
+    do_deploy(42)
+    assert_equal 'simple-production',  @eb.environment_cname_prefix('simple', t('production-a', 'simple'))
+    assert_nil(@eb.environment_cname_prefix('simple', t('production-b', 'simple')))
+    do_deploy(43)
+    assert_equal 'simple-production',  @eb.environment_cname_prefix('simple', t('production-a', 'simple'))
+    assert_match(/simple-production-inactive/,  @eb.environment_cname_prefix('simple', t('production-b', 'simple')))
+    do_deploy(44)
+    assert_equal 'simple-production',  @eb.environment_cname_prefix('simple', t('production-a', 'simple'))
+    assert_match(/simple-production-inactive/,  @eb.environment_cname_prefix('simple', t('production-b', 'simple')))
+  end
+
+
+  def test_blue_only_deploy_should_run_smoke_test_before_cname_switch
+    smoked_host = []
+    smoke_test = lambda { |host| smoked_host << host }
+    [42, 43, 44].each do |version_label|
+      do_deploy(version_label, :smoke_test => smoke_test)
+    end
+
+    assert_equal ['simple-production.elasticbeanstalk.com',
+                  'simple-production-inactive.elasticbeanstalk.com',
+                  'simple-production-inactive.elasticbeanstalk.com'], smoked_host
+  end
+
+
+  def test_blue_only_deployment_should_delete_and_recreate_inactive_env_if_phoenix_mode_is_enabled
+    do_deploy(42, :phoenix_mode => true)
+    do_deploy(43, :phoenix_mode => true)
+    assert_equal [],  @eb.environments_been_deleted('simple')
+
+    inactive_env = t('production-b', 'simple')
+    assert_match(/inactive/,  @eb.environment_cname_prefix('simple', inactive_env))
+
+    do_deploy(44, :phoenix_mode => true)
+    assert_equal [inactive_env], @eb.environments_been_deleted('simple')
+
+    assert_match(/inactive/,  @eb.environment_cname_prefix('simple', inactive_env))
+  end
+
+  def test_destroy_should_clean_up_env
+    [42, 44].each do |version|
+      do_deploy(version)
+    end
+
+    destroy(:application => 'simple', :environment => 'production')
+    assert !@eb.environment_exists?('simple', t('production-a', 'simple'))
+    assert !@eb.environment_exists?('simple', t('production-b', 'simple'))
+  end
+
+  private
+
+  def do_deploy(version_label, options={})
+    deploy( {:application => 'simple',
+              :environment => "production",
+              :strategy => 'blue-only',
+            }.merge(options).merge(:version_label => version_label))
+  end
+
+end

data/test/eb_environment_test.rb

@@ -61,6 +61,17 @@ class EbEnvironmentTest < MiniTest::Unit::TestCase
     assert_raises(RuntimeError) { env.deploy("version 1") }
   end
 
+  def test_should_raise_runtime_error_when_issues_during_launch
+    env = EbDeployer::EbEnvironment.new("myapp", "production", @eb_driver)
+    @eb_driver.set_events("myapp", t("production", 'myapp'),
+                          [],
+                          ["start deploying",
+                           "create environment",
+                           "Launched environment: dev-a-1234567. However, there were issues during launch. See event log for details."])
+
+    assert_raises(RuntimeError) { env.deploy("version 1") }
+  end
+
   def test_terminate_should_delete_environment
     env = EbDeployer::EbEnvironment.new("myapp", "production", @eb_driver)
     env.deploy("version1")

data/test/resources_deploy_test.rb

@@ -119,4 +119,18 @@ class ResourcesDeployTest < DeployTest
                             :environment => "production")
     end
   end
+
+  def test_custom_stack_name
+    cf_template = temp_file(JSON.dump({
+                                        'Resources' => {'R1' => {}},
+                                        'Outputs' => {'O1' => {}, 'O2' => {}}
+                                      }))
+    deploy(:application => 'simple',
+           :environment => "production",
+           :resources => { :template => cf_template },
+           :stack_name => 'my-lovely-stack')
+
+    assert !@cf_driver.stack_exists?('simple-production')
+    assert @cf_driver.stack_exists?('my-lovely-stack')
+  end
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: eb_deployer
 version: !ruby/object:Gem::Version
-  version: 0.4.7.beta1
-  prerelease: 6
+  version: 0.4.8
+  prerelease: 
 platform: ruby
 authors:
 - wpc
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-03 00:00:00.000000000 Z
+date: 2014-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -63,6 +63,7 @@ files:
 - lib/eb_deployer/default_config.yml
 - lib/eb_deployer/deployment_strategy.rb
 - lib/eb_deployer/deployment_strategy/blue_green.rb
+- lib/eb_deployer/deployment_strategy/blue_only.rb
 - lib/eb_deployer/deployment_strategy/inplace_update.rb
 - lib/eb_deployer/eb_environment.rb
 - lib/eb_deployer/environment.rb
@@ -81,6 +82,7 @@ files:
 - lib/generators/eb_deployer/install/templates/postgres_rds.json
 - test/aws_driver_stubs.rb
 - test/blue_green_deploy_test.rb
+- test/blue_only_deploy_test.rb
 - test/cloud_formation_provisioner_test.rb
 - test/config_loader_test.rb
 - test/deploy_test.rb
@@ -110,9 +112,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -124,6 +126,7 @@ summary: Low friction deployments should be a breeze. Elastic Beanstalk provides
 test_files:
 - test/aws_driver_stubs.rb
 - test/blue_green_deploy_test.rb
+- test/blue_only_deploy_test.rb
 - test/cloud_formation_provisioner_test.rb
 - test/config_loader_test.rb
 - test/deploy_test.rb