eb_deployer 0.2.4 → 0.2.5

data/lib/eb_deployer.rb

@@ -23,15 +23,15 @@ require 'fileutils'
 
 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)
   #
-
+  # @param [String] key CloudFormation output key
+  # @param [Hash] opts
+  # @option opts [Symbol] :application application name
+  # @option opts [Symbol] :environment environment name (e.g. staging, production)
+  # @option opts [Symbol] :region AWS Region (e.g. "us-west-2", "us-east-1")
+  # 
   def self.query_resource_output(key, opts)
     # AWS.config(:logger => Logger.new($stdout))
     if region = opts[:region]
@@ -45,104 +45,108 @@ module EbDeployer
   end
 
 
-  # #
+  # 
   # Deploy a package to specfied environments on elastic beanstalk
   #
-  # Options available:
-  #
-  # :application (required)
-  # Application name, this used for isolate packages and contribute
-  # to your elastic beanstalk cname for environments
+  # @param [Hash] opts
   #
-  # :environment (required)
-  # Environment for same application, e.g. testing, staging,
-  # production. This will map to 2 elastic beanstalk environments
-  # (env-a-xxx, env-b-xxx) if blue-green deployment strategy specified
+  # @option opts [Symbol] :application *required* Application name, this
+  #   used for isolate packages and contribute to your elastic beanstalk cname
+  #   for environments
   #
-  # :package (required)        package for the application which should be
-  # suitable for elastic beanstalk deploying. For example, a war file
-  # should be provided for java solution stacks and a tar gz file
-  # should be provided for rails stack.
+  # @option opts [Symbol] :environment *required* Environment for same
+  #   application, e.g. testing, staging, production. This will map to 2 elastic
+  #   beanstalk environments (env-a-xxx, env-b-xxx) if blue-green deployment
+  #   strategy specified
   #
-  # :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.
+  # @option opts [Symbol] :package *required* package for the application
+  #   which should be suitable for elastic beanstalk deploying. For example, a
+  #   war file should be provided for java solution stacks and a ZIP file
+  #   should be provided for Rails or Sinatra stack.
   #
-  #     :version_label => ENV['MY_PIPELINE_COUNTER']
-  #                      || "dev-" + Digest::MD5.file(my_package).hexdigest
+  # @option opts [Symbol] :option_settings  (optional) Elastic Beanstalk
+  #   settings that will apply to the environments you deploying. Value should be
+  #   array of hash with format such as:
   #
-  # :solution_stack_name (optional default "64bit Amazon Linux running Tomcat 7")
-  # The elastic beanstalk solution stack you want to deploy on top of.
-  # Current possible values include:
-  #
-  # :option_settings (or :settings)  (optional)
-  # Elastic Beanstalk settings that will apply to the environments you
-  # deploying. Value should be array of hash with format such as:
   #     [{
   #        :namespace => 'aws:autoscaling:launchconfiguration',
   #        :option_name => 'InstanceType',
   #        :value => 'm1.small' }]
-  # When there are many, Using an external yaml file to hold those
-  # configuration is recommended. Such as:
+  #
+  #   When there are many, Using an external yaml file to hold those
+  #   configuration is recommended. Such as:
+  #
   #     YAML.load(File.read("my_settings_file.yml"))
-  # For all available options take a look at
-  # http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html
-  #
-  # :resources (optional)
-  # If :resources specified, EBDeployer will use the CloudFormation
-  # template you provide to create a default CloudFormation stack with
-  # name <application_name>-<env-name> for the environment current
-  # deploying.  Value of resources need to be hash with following
-  # keys:
-  #    :template => CloudFormation template file with JSON format
-  #    :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
-  # elastic beanstalk settings.
-  #    :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
-  # called at the end of the deployment for inplace-update deployment
-  # strategy. For blue-green deployment it will run after inactive
-  # environment update finish and before switching.
-  # Defining a smoke test is high recommended for serious usage. The
-  # simplest one could just be checking the server is up using curl, e.g.
-  #
-  #  :smoke_test => lambda { |host|
-  #    curl_http_code = "curl -k -s -o /dev/null -w \"%{http_code}\" https://#{host}"
-  #    Timeout.timeout(600) do
-  #      while `#{curl_http_code}`.strip != '200'
-  #        sleep 5
-  #      end
-  #    end
-  #  }
   #
+  #   For all available options take a look at
+  #   http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html
   #
+  # @option opts [Symbol] :phoenix_mode (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.
+  #
+  #
+  # @option opts [Symbol] :region set the region for application deployment
+  #   (e.g. "us-west-2", "us-east-1"). See available zones at
+  #   http://aws.amazon.com/elasticbeanstalk/faqs/#regions
+  #
+  # @option opts [Symbol] :resources If :resources specified, EBDeployer will
+  #   use the CloudFormation template you provide to create a default
+  #   CloudFormation stack with name <application_name>-<env-name> for the
+  #   environment current deploying.  Value of resources need to be hash with
+  #   following keys:
+  #
+  #     :template => CloudFormation template file with JSON format
+  #     :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
+  #   elastic beanstalk settings.
+  #
+  #     :capabilities => An array. You need set it to ['CAPABILITY_IAM']
+  #
+  #   if you want to provision IAM Instance Profile.
+  #
+  # @option opts [Symbol] :settings See `option_settings`
+  #
+  # @option opts [Symbol] :smoke_test 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 called at the end of the deployment for
+  #   inplace-update deployment strategy. For blue-green deployment it will run
+  #   after inactive environment update finish and before switching.  Defining a
+  #   smoke test is high recommended for serious usage. The simplest one could
+  #   just be checking the server is up using curl, e.g.
+  #
+  #     :smoke_test => lambda { |host|
+  #       curl_http_code = "curl -k -s -o /dev/null -w \"%{http_code}\" https://#{host}"
+  #       Timeout.timeout(600) do
+  #         while `#{curl_http_code}`.strip != '200'
+  #           sleep 5
+  #         end
+  #       end
+  #     }
+  #
+  # @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.
+  #   inplace-update strategy will only keep one environment, and update the
+  #   version inplace on deploy. this will save resources but will have downtime.
+  #
+  # @option opts [Symbol] :solution_stack_name ("64bit Amazon Linux running Tomcat 7")
+  #   The elastic beanstalk solution stack you want to deploy on top of.
+  #
+  # @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.
+  #
+  #      :version_label => ENV['MY_PIPELINE_COUNTER']
+  #                       || "dev-" + Digest::MD5.file(my_package).hexdigest
   #
-
   def self.deploy(opts)
     # AWS.config(:logger => Logger.new($stdout))
     if region = opts[:region]

data/lib/eb_deployer/deployment_strategy.rb

@@ -58,13 +58,13 @@ module EbDeployer
     end
 
     def self.create(strategy_name, app, env_name, eb_driver, env_creation_opts={})
-      case strategy_name.to_sym
-      when :inplace_update
+      case strategy_name.to_s
+      when 'inplace_update', 'inplace-update'
         InplaceUpdate.new(app, env_name, eb_driver, env_creation_opts)
-      when :blue_green
+      when 'blue_green', 'blue-green'
         BlueGreen.new(app, env_name, eb_driver, env_creation_opts)
       else
-        raise 'strategy_name:' + strategy_name + ' not supported'
+        raise 'strategy_name: ' + strategy_name.to_s + ' not supported'
       end
 
     end

data/lib/eb_deployer/version.rb

@@ -1,3 +1,3 @@
 module EbDeployer
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/test/deploy_test.rb

@@ -97,7 +97,7 @@ class DeployTest < Minitest::Test
   def test_blue_green_deployment_strategy_should_create_blue_env_on_first_deployment
     deploy(:application => 'simple',
            :environment => "production",
-           :strategy => 'blue_green',
+           :strategy => 'blue-green',
            :version_label => 42)
 
     assert @eb_driver.environment_exists?('simple', eb_envname('simple', 'production-a'))
@@ -108,12 +108,12 @@ class DeployTest < Minitest::Test
   def test_blue_green_deployment_should_create_green_env_if_blue_exists
     deploy(:application => 'simple',
            :environment => "production",
-           :strategy => 'blue_green',
+           :strategy => 'blue-green',
            :version_label => 42)
 
     deploy(:application => 'simple',
            :environment => "production",
-           :strategy => 'blue_green',
+           :strategy => 'blue-green',
            :version_label => 43)
 
     assert @eb_driver.environment_exists?('simple', eb_envname('simple', 'production-a'))
@@ -124,12 +124,12 @@ class DeployTest < Minitest::Test
   def test_blue_green_deployment_should_swap_cname_to_make_active_most_recent_updated_env
     deploy(:application => 'simple',
            :environment => "production",
-           :strategy => 'blue_green',
+           :strategy => 'blue-green',
            :version_label => 42)
 
     deploy(:application => 'simple',
            :environment => "production",
-           :strategy => 'blue_green',
+           :strategy => 'blue-green',
            :version_label => 43)
 
     assert_match(/simple-production-inactive/,  @eb_driver.environment_cname_prefix('simple', eb_envname('simple', 'production-a')))
@@ -139,7 +139,7 @@ class DeployTest < Minitest::Test
 
     deploy(:application => 'simple',
            :environment => "production",
-           :strategy => 'blue_green',
+           :strategy => 'blue-green',
            :version_label => 44)
 
     assert_match(/simple-production-inactive/,  @eb_driver.environment_cname_prefix('simple', eb_envname('simple', 'production-b')))
@@ -154,7 +154,7 @@ class DeployTest < Minitest::Test
     [42, 43, 44].each do |version_label|
       deploy(:application => 'simple',
              :environment => "production",
-             :strategy => 'blue_green',
+             :strategy => 'blue-green',
              :smoke_test => smoke_test,
              :version_label => version_label)
     end
@@ -248,13 +248,13 @@ class DeployTest < Minitest::Test
   def test_blue_green_deployment_should_delete_and_recreate_inactive_env_if_phoenix_mode_is_enabled
     deploy(:application => 'simple',
            :environment => "production",
-           :strategy => 'blue_green',
+           :strategy => 'blue-green',
            :version_label => 42,
            :phoenix_mode => true)
 
     deploy(:application => 'simple',
            :environment => "production",
-           :strategy => 'blue_green',
+           :strategy => 'blue-green',
            :version_label => 43,
            :phoenix_mode => true)
 
@@ -266,7 +266,7 @@ class DeployTest < Minitest::Test
 
     deploy(:application => 'simple',
            :environment => "production",
-           :strategy => 'blue_green',
+           :strategy => 'blue-green',
            :version_label => 44,
            :phoenix_mode => true)
 
@@ -295,7 +295,7 @@ class DeployTest < Minitest::Test
 
   def deploy(opts)
     EbDeployer.deploy({:package => @sample_package,
-                        :strategy => :inplace_update,
+                        :strategy => :'inplace-update',
                         :version_label => 1}.merge(opts).merge(stubs))
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eb_deployer
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-29 00:00:00.000000000 Z
+date: 2013-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk