aws-ec2 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 479b890e45d465cd48dad82e9063f5b9ef3074ca05a47461f68ed93ce8b0fd55
-  data.tar.gz: 062a19ef9048e2ff0e284f97b1e1a21a7c44034642ac5639dfef53581f61c23a
+  metadata.gz: 1868534625988933a50ea50d14c3ed0d0b13a825d4d29a6e5feab301fd0d969a
+  data.tar.gz: ae53a49329501b81a4bc3283e4685e05da78b16da9e3bf79e2927ca067f7bcc4
 SHA512:
-  metadata.gz: 7e0452f43bb90b093a39e889a65b581620532ac7dc8803e70d74c5b2a0dc56da645273bcf7814aee9de09d666cc61f05305ab94132e7d745d0b69994b27d3cf3
-  data.tar.gz: 3731a44ca9cd7597fbee6f36cb62817ce801fb9404c26f05a7c98f8ade9303f487eca36df301e1c27f0e92d405f8e4f44ac10527fcb1ed32137c3454f865e73d
+  metadata.gz: 9efa949c751ffb52b187a722519b4c22ab0d3714a84a1cec7f96288557eb686dba403365e5b3e5a99719f7f5523417487856f3969e7f49d028397b4ec35ab49a
+  data.tar.gz: 1e8da07ac54e0f09236a84c9a8bb839ef64df6eead452b4a0a511112b2eea857c125341ec087debab54eeb73a2048066ecb584b603ee19b7c77c750450c69567

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/render_me_pretty"]
+	path = vendor/render_me_pretty
+	url = https://github.com/tongueroo/render_me_pretty

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [1.2.0]
+- Merge pull request #6 from tongueroo/wait: aws-ec2 wait ami command
+- Fix dependencies: add aws-sdk-s3 dependency
+- require render_me_pretty as vendor submodule for now
+
 ## [1.1.0]
 - Merge pull request #5 from tongueroo/auto-terminate
 - allow AWS_RDS_CODE_VERSION env variable

data/Gemfile.lock

@@ -1,15 +1,16 @@
 PATH
   remote: .
   specs:
-    aws-ec2 (0.9.0)
+    aws-ec2 (1.1.0)
       activesupport
       aws-sdk-ec2
+      aws-sdk-s3
       colorize
       dotenv
       filesize
       hashie
-      render_me_pretty
       thor
+      tilt
 
 GEM
   remote: https://rubygems.org/
@@ -19,16 +20,23 @@ GEM
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    aws-partitions (1.67.0)
-    aws-sdk-core (3.17.0)
+    aws-partitions (1.72.0)
+    aws-sdk-core (3.17.1)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)
       jmespath (~> 1.0)
-    aws-sdk-ec2 (1.28.0)
+    aws-sdk-ec2 (1.29.0)
+      aws-sdk-core (~> 3)
+      aws-sigv4 (~> 1.0)
+    aws-sdk-kms (1.5.0)
+      aws-sdk-core (~> 3)
+      aws-sigv4 (~> 1.0)
+    aws-sdk-s3 (1.8.2)
       aws-sdk-core (~> 3)
+      aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.0)
     aws-sigv4 (1.0.2)
-    byebug (10.0.0)
+    byebug (10.0.1)
     codeclimate-test-reporter (1.0.8)
       simplecov (<= 0.13)
     coderay (1.1.2)
@@ -77,14 +85,10 @@ GEM
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rake (12.3.0)
-    rb-fsevent (0.10.2)
+    rake (12.3.1)
+    rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
-    render_me_pretty (0.8.0)
-      activesupport
-      colorize
-      tilt
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)

data/aws-ec2.gemspec

@@ -21,13 +21,19 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activesupport"
   spec.add_dependency "aws-sdk-ec2"
+  spec.add_dependency "aws-sdk-s3"
   spec.add_dependency "colorize"
   spec.add_dependency "dotenv"
   spec.add_dependency "filesize"
   spec.add_dependency "hashie"
-  spec.add_dependency "render_me_pretty"
   spec.add_dependency "thor"
 
+  # spec.add_dependency "render_me_pretty"
+  # render_me_pretty dependencies since temporarily added it as vendored submodule
+  # spec.add_dependency "activesupport" # dup
+  # spec.add_dependency "colorize" # dup
+  spec.add_dependency "tilt"
+
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "guard"

data/lib/aws-ec2.rb

@@ -1,17 +1,20 @@
 $:.unshift(File.expand_path("../", __FILE__))
 require "aws_ec2/version"
 require "colorize"
+
+$:.unshift(File.expand_path("../../vendor/render_me_pretty/lib", __FILE__))
 require "render_me_pretty"
 
 module AwsEc2
   autoload :Help, "aws_ec2/help"
   autoload :Command, "aws_ec2/command"
   autoload :CLI, "aws_ec2/cli"
-  autoload :AwsServices, "aws_ec2/aws_services"
+  autoload :AwsService, "aws_ec2/aws_service"
   autoload :Profile, "aws_ec2/profile"
   autoload :Base, "aws_ec2/base"
   autoload :Create, "aws_ec2/create"
   autoload :Ami, "aws_ec2/ami"
+  autoload :Wait, "aws_ec2/wait"
   autoload :Template, "aws_ec2/template"
   autoload :Script, "aws_ec2/script"
   autoload :Config, "aws_ec2/config"

data/lib/aws_ec2/{aws_services.rb → aws_service.rb}

@@ -1,6 +1,6 @@
 require 'aws-sdk-ec2'
 
-module AwsEc2::AwsServices
+module AwsEc2::AwsService
   def ec2
     @ec2 ||= Aws::EC2::Client.new
   end

data/lib/aws_ec2/cli.rb

@@ -3,6 +3,10 @@ module AwsEc2
     class_option :noop, type: :boolean
     class_option :profile, desc: "profile name to use"
 
+    desc "wait SUBCOMMAND", "wait subcommands"
+    long_desc Help.text(:wait)
+    subcommand "wait", Wait
+
     common_options = Proc.new do
       option :auto_terminate, type: :boolean, default: false, desc: "automatically terminate the instance at the end of user-data"
       option :cloudwatch, type: :boolean, default: false, desc: "enable cloudwatch logging, only supported for amazonlinux"

data/lib/aws_ec2/create.rb

@@ -6,7 +6,7 @@ module AwsEc2
     autoload :Params, "aws_ec2/create/params"
     autoload :ErrorMessages, "aws_ec2/create/error_messages"
 
-    include AwsServices
+    include AwsService
     include ErrorMessages
 
     def run

data/lib/aws_ec2/help/ami.md

@@ -1,12 +1,12 @@
 Examples:
 
-  $ aws-ec2 ami myrubyami --profile ruby --noop
+    $ aws-ec2 ami myrubyami --profile ruby --noop
 
 Launches an EC2 instance to create an AMI.  An AMI creation script is appended to the end of the user-data script. The AMI creation script calls `aws ec2 create-image` and causes the instance to reboot at the end.
 
 It is useful to include to timestamp as a part of the AMI name with the date command.
 
-  $ aws-ec2 ami ruby-2.5.0_$(date "+%Y-%m-%d-%H-%M") --profile ruby --noop
+    $ aws-ec2 ami ruby-2.5.0_$(date "+%Y-%m-%d-%H-%M") --profile ruby --noop
 
 The instance also automatically gets terminated and cleaned up by a termination script appended to user-data.
 

data/lib/aws_ec2/help/compile.md

@@ -1,5 +1,5 @@
 Examples:
 
-  $ aws-ec2 compile
+    $ aws-ec2 compile
 
 Compiles app/scripts and app/user-data files to the tmp folder. Useful for inspection.

data/lib/aws_ec2/help/completion.md

@@ -1,22 +1,22 @@
 Example:
 
-  aws-ec2 completion
+    aws-ec2 completion
 
 Prints words for TAB auto-completion.
 
 Examples:
 
-  aws-ec2 completion
-  aws-ec2 completion hello
-  aws-ec2 completion hello name
+    aws-ec2 completion
+    aws-ec2 completion hello
+    aws-ec2 completion hello name
 
 To enable, TAB auto-completion add the following to your profile:
 
-  eval $(aws-ec2 completion_script)
+    eval $(aws-ec2 completion_script)
 
 Auto-completion example usage:
 
-  aws-ec2 [TAB]
-  aws-ec2 hello [TAB]
-  aws-ec2 hello name [TAB]
-  aws-ec2 hello name --[TAB]
+    aws-ec2 [TAB]
+    aws-ec2 hello [TAB]
+    aws-ec2 hello name [TAB]
+    aws-ec2 hello name --[TAB]

data/lib/aws_ec2/help/create.md

@@ -1,7 +1,7 @@
 Examples:
 
-  $ aws-ec2 create my-instance
+    $ aws-ec2 create my-instance
 
 To see the snippet of code that gets added to the user-data script you can use the `--noop` option and then view the generated tmp/user-data.txt.
 
-  $ aws-ec2 create myscript --noop
+    $ aws-ec2 create myscript --noop

data/lib/aws_ec2/help/upload.md

@@ -1,6 +1,6 @@
 Examples:
 
-  $ aws-ec2 upload
+    $ aws-ec2 upload
 
 Compiles the app/scripts and app/user-data files to the tmp folder. Then uploads the files to an s3 bucket that is configured in config/settings.yml.  Example s3_folder setting:
 

data/lib/aws_ec2/help/wait/ami.md

@@ -0,0 +1,12 @@
+Examples:
+
+    $ aws-ec2 wait ami ruby-2.5.0_2018-03-24-17-07
+    $ aws-ec2 wait ami ami-b0138dc8
+
+Polls the AMI with the given AMI name or id until AMI is found and available.
+
+### Timeout
+
+Command times out after 30 mins by default.  You can control the timeout with the `--timeout` flag.  The timeout is specified in seconds.
+
+    $ aws-ec2 wait ami --id ami-b0138dc8 --timeout 3600

data/lib/aws_ec2/template/helper/ami_helper.rb

@@ -1,5 +1,5 @@
 module AwsEc2::Template::Helper::AmiHelper
-  include AwsEc2::AwsServices
+  include AwsEc2::AwsService
 
   # Example:
   #
@@ -25,7 +25,8 @@ module AwsEc2::Template::Helper::AmiHelper
     ec2.describe_images(
       owners: owners,
       filters: [
-        {name: "name", values: [query]}
+        {name: "name", values: [query]},
+        {name: "state", values: ["available"]}
       ]
     ).images
   end

data/lib/aws_ec2/version.rb

@@ -1,3 +1,3 @@
 module AwsEc2
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/aws_ec2/wait.rb

@@ -0,0 +1,13 @@
+module AwsEc2
+  autoload :Waiter, 'aws_ec2/waiter'
+
+  class Wait < Command
+
+    desc "ami", "Wait until AMI available."
+    long_desc Help.text("wait:ami")
+    option :timeout, type: :numeric, default: 1800, desc: "Timeout in seconds."
+    def ami(name)
+      Waiter::Ami.new(options.merge(name: name)).wait
+    end
+  end
+end

data/lib/aws_ec2/waiter.rb

@@ -0,0 +1,5 @@
+module AwsEc2
+  module Waiter
+    autoload :Ami, 'aws_ec2/waiter/ami'
+  end
+end

data/lib/aws_ec2/waiter/ami.rb

@@ -0,0 +1,61 @@
+module AwsEc2::Waiter
+  class Ami < AwsEc2::Base
+    include AwsEc2::AwsService
+
+    def wait
+      delay = 30
+      timeout = @options[:timeout]
+      max_attempts = timeout / delay
+      current_time = 0
+
+      puts "Waiting for #{@options[:name]} to be available. Delay: #{delay}s. Timeout: #{timeout}s"
+      puts "Current time: #{Time.now}"
+      return if ENV['TEST']
+
+      # Using while loop because of issues with ruby's Timeout module
+      # http://www.mikeperham.com/2015/05/08/timeout-rubys-most-dangerous-api/
+      detected = detect_ami
+      until detected || current_time > timeout
+        print '.'
+        sleep delay
+        current_time += 30
+        detected = detect_ami
+      end
+
+      if current_time > timeout
+        puts "ERROR: Timeout. Unable to detect and available ami: #{@options[:name]}"
+        exit 1
+      else
+        puts "Found available AMI: #{@options[:name]}"
+      end
+      puts
+    end
+
+  private
+    # Using custom detect_ami instead of ec2.wait_until(:image_availalbe, ...)
+    # because we start checking for the ami even before we've called
+    # create_ami.  We start checking right after we launch the instance
+    # which will create the ami at the end.
+    def detect_ami(owners=["self"])
+      images = ec2.describe_images(
+        owners: owners,
+        filters: filters
+      ).images
+      detected = images.first
+      !!detected
+    end
+
+    def filters
+      name_is_ami_id = @options[:name] =~ /^ami-/
+
+      filters = [{name: "state", values: ["available"]}]
+      filters << if name_is_ami_id
+          {name: "image-id", values: [@options[:name]]}
+        else
+          {name: "name", values: [@options[:name]]}
+        end
+
+      filters
+    end
+  end
+end

data/spec/lib/cli_spec.rb

@@ -14,6 +14,11 @@ describe AwsEc2::CLI do
       expect(out).to include("Creating EC2 instance")
     end
 
+    it "wait ami" do
+      out = execute("exe/aws-ec2 wait ami myimage")
+      expect(out).to include("Waiting for")
+    end
+
     commands = {
       "am" => "ami",
       "compile" => "--profile",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-ec2
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-23 00:00:00.000000000 Z
+date: 2018-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: render_me_pretty
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -237,7 +251,7 @@ files:
 - exe/aws-ec2
 - lib/aws-ec2.rb
 - lib/aws_ec2/ami.rb
-- lib/aws_ec2/aws_services.rb
+- lib/aws_ec2/aws_service.rb
 - lib/aws_ec2/base.rb
 - lib/aws_ec2/cli.rb
 - lib/aws_ec2/command.rb
@@ -257,6 +271,7 @@ files:
 - lib/aws_ec2/help/completion_script.md
 - lib/aws_ec2/help/create.md
 - lib/aws_ec2/help/upload.md
+- lib/aws_ec2/help/wait/ami.md
 - lib/aws_ec2/hook.rb
 - lib/aws_ec2/profile.rb
 - lib/aws_ec2/script.rb
@@ -289,6 +304,9 @@ files:
 - lib/aws_ec2/template/helper/script_helper.rb
 - lib/aws_ec2/template/helper/ssh_key_helper.rb
 - lib/aws_ec2/version.rb
+- lib/aws_ec2/wait.rb
+- lib/aws_ec2/waiter.rb
+- lib/aws_ec2/waiter/ami.rb
 - spec/fixtures/demo_project/config/settings.yml
 - spec/fixtures/demo_project/config/test.yml
 - spec/fixtures/demo_project/profiles/default.yml