eb_deployer 0.1.0 → 0.1.1

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in eb_deployer.gemspec
 gemspec
+
+gem 'redcarpet'
+gem 'yard'
+

data/lib/eb_deployer.rb

@@ -16,6 +16,16 @@ require 'timeout'
 require 'aws-sdk'
 
 module EbDeployer
+
+  ##
+  # Query ouput value of the cloud formation stack
+  # arguments:
+  #  key:    CloudFormation ouput key
+  #  options: a hash
+  #     :application     application name
+  #     :environment     environment name (e.g. staging, production)
+  #
+
   def self.query_resource_output(key, opts)
     # AWS.config(:logger => Logger.new($stdout))
     if region = opts[:region]
@@ -88,6 +98,22 @@ module EbDeployer
   #    :capabilities => An array. You need set it to ['CAPABILITY_IAM']
   # if you want to provision IAM Instance Profile.
   #
+  # :strategy (optional default :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. inplace-update strategy
+  # will only keep one environment, and update the version inplace on
+  # deploy. this will save resources but will have downtime.
+  #
+  # :phoenix_mode (optional default false)
+  # If phoenix mode is turn on, it will terminate the old elastic
+  # beanstalk environment and recreate on 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 benifit of
+  # keeping your ec2 instance system package upto date, because everytime ec2
+  # instance boot up from AMI it does a system update.
+  #
   # :smoke_test (optional)
   # Value should be a proc or a lambda which accept single argument that will
   # passed in as environment DNS name. Smoke test proc or lambda will be
@@ -128,6 +154,7 @@ module EbDeployer
     strategy_name = opts[:strategy] || :blue_green
     cname_prefix = opts[:cname_prefix] || [app, env_name].join('-')
     smoke_test = opts[:smoke_test] || Proc.new {}
+    phoenix_mode = opts[:phoenix_mode]
 
     application = Application.new(app, bs, s3)
 
@@ -136,7 +163,8 @@ module EbDeployer
     strategy = DeploymentStrategy.create(strategy_name, app, env_name, bs,
                                          :solution_stack => stack_name,
                                          :cname_prefix => cname_prefix,
-                                         :smoke_test => smoke_test)
+                                         :smoke_test => smoke_test,
+                                         :phoenix_mode => phoenix_mode)
 
     if resources = opts[:resources]
       env_settings += cf.provision(resources)

data/lib/eb_deployer/deployment_strategy.rb

@@ -19,9 +19,8 @@ module EbDeployer
         @app = app
         @env_name = env_name
         @eb_driver = eb_driver
+        @env_creation_opts = env_creation_opts
         @major_cname_prefix = env_creation_opts[:cname_prefix]
-        @solution_stack = env_creation_opts[:solution_stack]
-        @smoke_test = env_creation_opts[:smoke_test]
       end
 
       def deploy(version_label, env_settings)
@@ -48,10 +47,9 @@ module EbDeployer
       end
 
       def env(suffix, cname_prefix=nil)
-        Environment.new(@app, @env_name + '-' + suffix, @eb_driver,
-                        :solution_stack => @solution_stack,
-                        :cname_prefix => cname_prefix || inactive_cname_prefix,
-                        :smoke_test => @smoke_test)
+        Environment.new(@app, @env_name + '-' + suffix,
+                        @eb_driver,
+                        @env_creation_opts.merge({:cname_prefix => cname_prefix || inactive_cname_prefix}))
       end
 
       def inactive_cname_prefix

data/lib/eb_deployer/environment.rb

@@ -13,12 +13,11 @@ module EbDeployer
       @name = self.class.unique_ebenv_name(app, env_name)
       @bs = eb_driver
       @creation_opts = creation_opts
-      @poller = EventPoller.new(@app, @name, @bs)
     end
 
     def deploy(version_label, settings)
+      terminate if @creation_opts[:phoenix_mode]
       create_or_update_env(version_label, settings)
-      poll_events
       smoke_test
       wait_for_env_become_healthy
     end
@@ -37,7 +36,6 @@ module EbDeployer
 
     private
 
-
     def shorten(str, max_length, digest_length=5)
       raise "max length (#{max_length}) should be larger than digest_length (#{digest_length})" if max_length < digest_length
       return self if str.size <= max_length
@@ -45,11 +43,23 @@ module EbDeployer
       sha1[0..(digest_length - 1)] + str[(max_length - digest_length - 1)..-1]
     end
 
+    def terminate
+      if @bs.environment_exists?(@app, @name)
+        with_polling_events(/terminateEnvironment completed successfully/i) do
+          @bs.delete_environment(@app, @name)
+        end
+      end
+    end
+
     def create_or_update_env(version_label, settings)
       if @bs.environment_exists?(@app, @name)
-        @bs.update_environment(@app, @name, version_label, settings)
+        with_polling_events(/Environment update completed successfully/i) do
+          @bs.update_environment(@app, @name, version_label, settings)
+        end
       else
-        @bs.create_environment(@app, @name, @creation_opts[:solution_stack], @creation_opts[:cname_prefix], version_label, settings)
+        with_polling_events(/Successfully launched environment/i) do
+          @bs.create_environment(@app, @name, @creation_opts[:solution_stack], @creation_opts[:cname_prefix], version_label, settings)
+        end
       end
     end
 
@@ -62,13 +72,14 @@ module EbDeployer
       end
     end
 
-    def poll_events
-      @poller.poll do |event|
+    def with_polling_events(terminate_pattern, &block)
+      event_start_time = Time.now
+      yield
+      EventPoller.new(@app, @name, @bs).poll(event_start_time) do |event|
         raise event[:message] if event[:message] =~ /Failed to deploy application/
 
         log_event(event)
-        break if event[:message] =~ /Environment update completed successfully/ ||
-          event[:message] =~ /Successfully launched environment/
+        break if event[:message] =~ terminate_pattern
       end
     end
 

data/lib/eb_deployer/event_poller.rb

@@ -1,13 +1,13 @@
 module EbDeployer
   class EventPoller
     def initialize(app, env, beanstalk)
-      @app, @env, @beanstalk, @start_time = app, env, beanstalk, Time.now
+      @app, @env, @beanstalk = app, env, beanstalk
     end
 
-    def poll(&block)
+    def poll(start_time = Time.now, &block)
       handled = Set.new
       loop do
-        fetch_events do |events|
+        fetch_events(start_time) do |events|
           new_events = events.reject { |e| handled.include?(digest(e)) }
           handle(new_events, &block)
           handled += new_events.map { |e| digest(e) }
@@ -16,6 +16,7 @@ module EbDeployer
       end
     end
 
+
     private
 
     def digest(event)
@@ -26,8 +27,8 @@ module EbDeployer
       events.reverse.each(&block)
     end
 
-    def fetch_events(&block)
-      events, next_token = @beanstalk.fetch_events(@app, @env, :start_time => @start_time.iso8601)
+    def fetch_events(start_time, &block)
+      events, next_token = @beanstalk.fetch_events(@app, @env, :start_time => start_time.iso8601)
       yield(events)
       fetch_next(next_token, &block) if next_token
     end

data/lib/eb_deployer/version.rb

@@ -1,3 +1,3 @@
 module EbDeployer
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/aws_driver_stubs.rb

@@ -3,6 +3,7 @@ class EBStub
     @apps = []
     @envs = {}
     @versions = {}
+    @envs_been_deleted = {}
   end
 
   def create_application(app)
@@ -33,6 +34,8 @@ class EBStub
 
   def delete_environment(app, env)
     @envs.delete(env)
+    @envs_been_deleted[app] ||= []
+    @envs_been_deleted[app] << env
   end
 
   def update_environment(app, env, version, settings)
@@ -54,7 +57,12 @@ class EBStub
 
   def fetch_events(app_name, env_name, options={})
     [[{:event_date => Time.now.utc,
-        :message => 'Environment update completed successfully'}],
+        :message => 'Environment update completed successfully'},
+      {:event_date => Time.now.utc,
+        :message => 'terminateEnvironment completed successfully'},
+      {:event_date => Time.now.utc,
+        :message => 'Successfully launched environment'}
+     ],
      nil]
   end
 
@@ -80,6 +88,7 @@ class EBStub
     'Green'
   end
 
+
   #test only
   def environment_verion_label(app_name, env_name)
     @envs[env_key(app_name, env_name)][:version]
@@ -97,6 +106,10 @@ class EBStub
     end
   end
 
+  def environments_been_deleted(app)
+    @envs_been_deleted[app] || []
+  end
+
   private
 
   def env_key(app, name)

data/test/deploy_test.rb

@@ -88,8 +88,6 @@ class DeployTest < Minitest::Test
     assert_equal 'foobar.elasticbeanstalk.com', host_for_smoke_test
   end
 
-
-
   def test_blue_green_deployment_strategy_should_create_blue_env_on_first_deployment
     deploy(:application => 'simple',
            :environment => "production",
@@ -233,6 +231,44 @@ class DeployTest < Minitest::Test
     end
   end
 
+  def test_should_terminate_old_environment_if_phoenix_mode_is_enabled
+    deploy(:application => 'simple', :environment => "production", :phoenix_mode => true)
+    assert @eb_driver.environment_exists?('simple', eb_envname('simple', 'production'))
+    deploy(:application => 'simple', :environment => "production", :phoenix_mode => true)
+    assert @eb_driver.environments_been_deleted('simple').include?(eb_envname('simple', 'production'))
+    assert @eb_driver.environment_exists?('simple', eb_envname('simple', 'production'))
+  end
+
+  def test_blue_green_deployment_should_delete_and_recreate_inactive_env_if_phoenix_mode_is_enabled
+    deploy(:application => 'simple',
+           :environment => "production",
+           :strategy => 'blue_green',
+           :version_label => 42,
+           :phoenix_mode => true)
+
+    deploy(:application => 'simple',
+           :environment => "production",
+           :strategy => 'blue_green',
+           :version_label => 43,
+           :phoenix_mode => true)
+
+    assert_equal [],  @eb_driver.environments_been_deleted('simple')
+
+    inactive_env = eb_envname('simple', 'production-a')
+    assert_match(/inactive/,  @eb_driver.environment_cname_prefix('simple', inactive_env))
+
+
+    deploy(:application => 'simple',
+           :environment => "production",
+           :strategy => 'blue_green',
+           :version_label => 44,
+           :phoenix_mode => true)
+
+    assert_equal [inactive_env], @eb_driver.environments_been_deleted('simple')
+
+    assert_equal 'simple-production',  @eb_driver.environment_cname_prefix('simple', inactive_env)
+  end
+
   private
 
   def temp_file(content)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eb_deployer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-01 00:00:00.000000000 Z
+date: 2013-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -91,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Low friction deployments should be a breeze. Elastic Beanstalk provides a
@@ -100,3 +100,4 @@ summary: Low friction deployments should be a breeze. Elastic Beanstalk provides
 test_files:
 - test/aws_driver_stubs.rb
 - test/deploy_test.rb
+has_rdoc: