elastic-beanstalk 1.0.1 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjU1YWI4M2E0MDRhNGVkNTE5OGZlYTZmOWU0YTE1NmNlZGFlODRlYg==
+    MmUxODBiMDgxNjY5MGY3YzUwN2IxMDcwM2U3NDYwMWU2NGMxNzg5MA==
   data.tar.gz: !binary |-
-    NWFhYzg0MjE3MjI0OGU3MzVmODRjMDEyMGJhYTBmNjExM2YwN2VkYQ==
+    NWNlNjFkZmJmM2UzNjkyZWNmYTIyOTIxZjk0MjFlMDQ1NTFhZmRlNQ==
 SHA512:
   metadata.gz: !binary |-
-    MTY0YTU4Yjc0NjY2MDEyNzhiMmZhMDg0YmM0ODQ3YzhlZDY2ZmMzNGU1MGIx
-    M2YxN2UyNzIxYmU4OGIxZGRmOTE5ZDJkOWU4YWNiMGVjYTRiMTk2YjQ4NGVj
-    ZjZiM2JkZTZhZTMzNTBlYTYxYTY3NDI3MzA1YzllOTExNDBiYjU=
+    ZTE2NGRhODY1OWI0YzVlNGMyYjlhNjczYzgzNzg2ZmY0ZDg1YWY5YjJmZDVi
+    YjZiOTkxZjExM2IxYmExNDJiYWI2N2EyMTYxZTU0OWIxZmQ2NzllYTBmZjY0
+    N2VhOTdhNWI0MDM2NmJkZDc1OGIzYzVkZjNkZjA4YzYzNGRkMDk=
   data.tar.gz: !binary |-
-    NGI2ZWQ0Y2U0MDhiMjI3MzJiNzY0MDA3YmZmN2U3NjMxYzZhOWVmZTIxNzMw
-    NDIyMWYwYjY3Y2M0N2QyZWMyZTc4ZGMwYjUyNjVlZDFmMDE3ODdjMmNiNDIx
-    Nzc5MTY5NzAxZDY0YzkzMDU5M2FmYzA1MmZlZGQwNTBiZjk4YWU=
+    MWVjMmUyMmYwZDg4NzkxYjdlNDU5Y2EwODkyZGU5MGNlNjA2NzJkODRhNmMz
+    NmZlMzU1MjBkNDAwZmVmNzMwODU4ZWVmZGU2ZWZkN2VhMzRlN2ZhOGQzZDNj
+    MTA3MDI4M2UxYTY0MzdjZTljZWRlMWI4NjMxZDEwMWRlNjgwM2I=

data/README.md

@@ -63,7 +63,7 @@ Something like this should get you started
           InstanceType: t1.small
 
 ### Step 3. Package and deploy
-The default is the 'development' environment, change this via command line by prefixing with i.e. RAILS_ENV=production
+The default is the 'development' environment, change this via command line arguments
 
     $ rake eb:package eb:deploy
 
@@ -92,11 +92,42 @@ For example, this would create a snapshot prior to the deployment (and migration
 
     rake eb:rds:create_snapshot[acme, pre-1.1.0] eb:deploy[1.1.0]
 
+## Command line
+
+### RAILS_ENV vs :environment:  
+Some people prefer to use `RAILS_ENV`, others prefer to use the `:environment` argument.  Both are accepted. Depending on the use case, each one can be DRYer than the other. 
+Where the task specifies `[:environment, :version]`, consider the `:environment` optional if you want to use the default of `development` or utilize the `RAILS_ENV` instead.  
+
+**NOTE:** if using the argument `:environment`, you **must** specify it for **both** the `eb:package` and `eb:deploy`, as `eb:package` is responsible for injecting the `RACK_ENV` and `RAILS_ENV` 
+in `aws:elasticbeanstalk:application:environment` section of the `.ebextensions` file.
+     
+### :version 
+If not specified, version will be auto-generated via and MD5 hash of the package file. If specified to the `eb:package` task, the version will be available as the `APP_VERSION` 
+environment variable, specified in the `aws:elasticbeanstalk:application:environment` section of the `.ebextensions` file.  
+
+
 ## A real-world example
 
-Deploy version 1.1.3 of acme to production
+Deploy version 1.1.3 of acme to production using the `:environment` parameter
+
+    $ rake eb:package[production,1.1.3] eb:deploy[production,1.1.3]
+
+Deploy version 1.1.3 of acme to production using `RAILS_ENV`
 
-    $ RAILS_ENV=production rake eb:package eb:deploy[1.1.3]
+    $ RAILS_ENV=production rake eb:package[1.1.3] eb:deploy[1.1.3]
+    
+Deploy an MD5 hashed version of acme to production using the `:environment` parameter
+
+    $ rake eb:package[production] eb:deploy[production]
+
+Deploy an MD5 hashed version of acme to production using `RAILS_ENV`
+
+    $ RAILS_ENV=production rake eb:package eb:deploy
+    
+Deploy an MD5 hashed version of acme to development
+
+    $ rake eb:package eb:deploy
+        
 
 config/eb.yml
 
@@ -237,4 +268,4 @@ Please contribute! While this is working great, a greater scope of functionality
 
 ## Copyright
 
-Copyright (c) 2014 AlienFast. See LICENSE.txt for further details.
+Copyright (c) 2014 AlienFast, LLC. See LICENSE.txt for further details.

data/elastic-beanstalk.gemspec

@@ -3,38 +3,38 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'elastic/beanstalk/version'
 
-Gem::Specification.new do |spec|
-  spec.name = 'elastic-beanstalk'
-  spec.version = Elastic::Beanstalk::VERSION
-  spec.authors = ['Kevin Ross']
-  spec.email = ['kevin.ross@alienfast.com']
-  spec.description = <<-TEXT
+Gem::Specification.new do |s|
+  s.name = 'elastic-beanstalk'
+  s.version = Elastic::Beanstalk::VERSION
+  s.authors = ['Kevin Ross']
+  s.email = ['kevin.ross@alienfast.com']
+  s.description = <<-TEXT
     The simplest way to configure and deploy an Elastic Beanstalk application via rake.
   TEXT
-  spec.summary = <<-TEXT
+  s.summary = <<-TEXT
     Configure and deploy a rails app to Elastic Beanstalk via rake in 60 seconds.
     Maintain multiple environment DRY configurations and .ebextensions in one easy
     to use configuration file.
   TEXT
-  spec.homepage = 'https://github.com/alienfast/elastic-beanstalk'
-  spec.license = 'MIT'
+  s.homepage = 'https://github.com/alienfast/elastic-beanstalk'
+  s.license = 'MIT'
 
-  spec.files = `git ls-files`.split($/).reject { |f| f =~ /^samples\// }
-  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  s.files = `git ls-files`.split($/).reject { |f| f =~ /^samples\// }
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
 
   # development
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '>= 2.14.1'
+  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '>= 2.14.1'
 
   # runtime
-  spec.add_runtime_dependency 'railties', '>= 3.2'
-  spec.add_runtime_dependency 'eb_deployer', '>= 0.4.4'
-  spec.add_runtime_dependency 'awesome_print'
-  spec.add_runtime_dependency 'time_diff'
-  spec.add_runtime_dependency 'rubyzip'
-  spec.add_runtime_dependency 'table_print'
-  spec.add_runtime_dependency 'nokogiri'
+  s.add_runtime_dependency 'railties', '>= 3.2'
+  s.add_runtime_dependency 'eb_deployer', '>= 0.4.4'
+  s.add_runtime_dependency 'awesome_print'
+  s.add_runtime_dependency 'time_diff'
+  s.add_runtime_dependency 'rubyzip'
+  s.add_runtime_dependency 'table_print'
+  s.add_runtime_dependency 'nokogiri'
 end

data/lib/elastic/beanstalk/tasks/eb.rake

@@ -126,27 +126,65 @@ namespace :eb do
   desc 'Setup AWS.config and merge/override environments into one resolved configuration'
   task :config do |t, args|
 
-    # set the default environment to be development
-    #env = ENV['RAILS_ENV'] || Rails.env || 'development'
-    env = ENV['RAILS_ENV'] || 'development'
+
+    #-------------------------------------------------------------------------------
+    # Resolve arguments in a backwards compatibile way (see https://github.com/alienfast/elastic-beanstalk/issues/12)
+    #   This allows both the use of RAILS_ENV or the :environment parameter
+    #
+    #   Previously, we relied solely on the environment to be passed in as RAILS_ENV.  It is _sometimes_ more convenient to allow it to be passed as the :environment parameter.
+    #   Since :environment is first, and :version used to be first, check the :environment against a version number regex and adjust as necessary.
+    bc_arg_environment = args[:environment]
+    unless /^(?:(\d+)\.)?(?:(\d+)\.)?(\*|\d+)$/.match(bc_arg_environment).nil?
+
+      arg_version = args[:version]
+      raise "Found version[#{bc_arg_environment}] passed as :environment, but also found a value for :version[#{arg_version}].  Please adjust arguments to be [:environment, :version] or use RAILS_ENV with a single [:version] argument" unless arg_version.nil?
+
+      # version was passed as :environment, adjust it.
+      arg_version = bc_arg_environment
+      arg_environment = nil
+
+      # puts "NOTE: Manipulated :environment argument to :version[#{bc_arg_environment}]."
+    else
+      # normal resolution of argements
+      arg_environment = args[:environment]
+      arg_version = args[:version]
+    end
+
+
+    # set the default environment to be development if not otherwise resolved
+    environment = arg_environment || ENV['RAILS_ENV'] || 'development'
 
     # load the configuration from same dir (for standalone CI purposes) or from the rails config dir if within the rails project
     filename = EbConfig.resolve_path('eb.yml')
     unless File.exists? filename
       filename = EbConfig.resolve_path('config/eb.yml')
     end
-    EbConfig.load!(env, filename)
+    EbConfig.load!(environment, filename)
 
     # Let's be explicit regardless of 'production' being the eb's default shall we? Set RACK_ENV and RAILS_ENV based on the given environment
     EbConfig.set_option(:'aws:elasticbeanstalk:application:environment', 'RACK_ENV', "#{EbConfig.environment}")
     EbConfig.set_option(:'aws:elasticbeanstalk:application:environment', 'RAILS_ENV', "#{EbConfig.environment}")
 
+    #-------------------------------------------------------------------------------
     # resolve the version and set the APP_VERSION environment variable
-    resolve_version(args)
 
+    # try to use from task argument first
+    version = arg_version
+    file = resolve_absolute_package_file
+    if version.nil? && File.exists?(file)
+      # otherwise use the MD5 hash of the package file
+      version = Digest::MD5.file(file).hexdigest
+    end
+
+    # set the var, depending on the sequence of calls, this may be nil
+    #   (i.e. :show_config with no :version argument) so omit it until we have something worthwhile.
+    EbConfig.set_option(:'aws:elasticbeanstalk:application:environment', 'APP_VERSION', "#{version}") unless version.nil?
+
+    #-------------------------------------------------------------------------------
     # configure aws credentials.  Depending on the called task, this may not be necessary parent task should call #credentials! for validation.
     AWS.config(credentials) unless credentials.nil?
 
+    #-------------------------------------------------------------------------------
     # configure aws region if specified in the eb.yml
     AWS.config(region: EbConfig.region) unless EbConfig.region.nil?
   end
@@ -156,12 +194,9 @@ namespace :eb do
   #
   #
   desc 'Show resolved configuration without doing anything.'
-  task :show_config, [:version] => [:config] do |t, args|
-
+  task :show_config, [:environment, :version] => [:config] do |t, args|
 
     puts "Working Directory: #{Rake.original_dir}"
-
-    resolve_version(args)
     print_config
   end
 
@@ -182,8 +217,8 @@ namespace :eb do
   #   root of the archive, not under a top level folder.  Include this package task to make
   #   sure we don't need to learn about this again through long deploy cycles!
   #
-  desc 'Package zip source bundle for Elastic Beanstalk and generate external Rakefile'
-  task :package => [:clobber, :config] do |t, args|
+  desc 'Package zip source bundle for Elastic Beanstalk and generate external Rakefile. (optional) specify the :version arg to make it available to the elastic beanstalk app dynamically via the APP_VERSION environment varable'
+  task :package, [:environment, :version] => [:clobber, :config] do |t, args|
 
     begin
       # write .ebextensions
@@ -240,7 +275,15 @@ namespace :eb do
   #
   #
   desc 'Deploy to Elastic Beanstalk'
-  task :deploy, [:version] => [:config] do |t, args|
+  task :deploy, [:environment, :version] => [:config] do |t, args|
+
+    # If called individually, this is not necessary, but if called in succession to eb:package, we may need to re-resolve an MD5 hashed name.
+    #  Since we allow variable use of arguments, it is easiest just to quickly re-enable and re-run the eb:config task since all the resolution
+    #  of values is contained there.
+    Rake::Task['eb:config'].reenable
+    Rake::Task['eb:config'].invoke
+
+
     # Leave off the dependency of :package, we need to package this in the build phase and save
     #   the artifact on bamboo. The deploy plan will handle this separately.
     from_time = Time.now
@@ -256,8 +299,6 @@ namespace :eb do
     # Don't deploy to test or cucumber (or whatever is specified by :disallow_environments)
     raise "#{EbConfig.environment} is one of the #{EbConfig.disallow_environments} disallowed environments.  Configure it by changing the :disallow_environments in the eb.yml" if EbConfig.disallow_environments.include? EbConfig.environment
 
-    # Use the version if given, otherwise use the MD5 hash.  Make available via the eb environment variable
-    version = resolve_version(args)
     print_config
 
     # Avoid known problems
@@ -269,7 +310,7 @@ namespace :eb do
     options = {
         application: EbConfig.app,
         environment: EbConfig.environment,
-        version_label: version,
+        version_label: find_option_app_version,
         solution_stack_name: EbConfig.solution_stack_name,
         settings: EbConfig.option_settings,
         strategy: EbConfig.strategy.to_sym,
@@ -284,7 +325,7 @@ namespace :eb do
       options[:smoke_test] = eval EbConfig.smoke_test
     end
 
-    EbDeployer.deploy(options)
+    # EbDeployer.deploy(options)
 
     puts "\nDeployment finished in #{Time.diff(from_time, Time.now, '%N %S')[:diff]}.\n"
   end
@@ -313,30 +354,20 @@ namespace :eb do
   private
 
   # Use the version if given, otherwise use the MD5 hash.  Make available via the eb APP_VERSION environment variable
-  def resolve_version(args)
+  def find_option_app_version
 
     # if already set by a dependency call to :config, get out early
     version = EbConfig.find_option_setting_value('APP_VERSION')
     return version unless version.nil?
-
-    # try to grab from task argument first
-    version = args[:version]
-    file = resolve_absolute_package_file
-    if version.nil? && File.exists?(file)
-      # otherwise use the MD5 hash of the package file
-      version = Digest::MD5.file(file).hexdigest
-    end
-
-    # set the var, depending on the sequence of calls, this may be nil
-    #   (i.e. :show_config with no :version argument) so omit it until we have something worthwhile.
-    EbConfig.set_option(:'aws:elasticbeanstalk:application:environment', 'APP_VERSION', "#{version}") unless version.nil?
   end
 
   def print_config
     # display helpful for figuring out problems later in the deployment logs.
     puts "\n----------------------------------------------------------------------------------"
     puts 'Elastic Beanstalk configuration:'
-    puts "\t:access_key_id: #{credentials['access_key_id']}"
+    puts "\taccess_key_id: #{credentials['access_key_id']}"
+    puts "\tenvironment: #{EbConfig.environment}"
+    puts "\tversion: #{find_option_app_version}"
 
     # pretty print things that will be useful to see in the deploy logs and omit clutter that usually doesn't cause us problems.
     h = EbConfig.configuration.dup
@@ -399,4 +430,4 @@ namespace :eb do
   def aws_secrets_file
     File.expand_path("#{EbConfig.secrets_dir}/#{EbConfig.app}.yml")
   end
-end
+end

data/lib/elastic/beanstalk/version.rb

@@ -1,5 +1,5 @@
 module Elastic
   module Beanstalk
-    VERSION = '1.0.1'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-beanstalk
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Kevin Ross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2014-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler