aws-ec2 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4c5bf33bed4b038a859606fca1faf595e8fca5455f3ae4e3c07f3c2329d7c3b
-  data.tar.gz: f57b5c4305db3141a8f8dd1c540669ed2d666403df7d05af6a3ddb36f1d79280
+  metadata.gz: 9b159b7648562e89bf4552a9f42b81ebdda0fca33d979c7f5ae6a5ef38f29ca7
+  data.tar.gz: f3a261914d4442d75af1afd00f9ee7e1dd4e6bf2d155168ddc80b1fcbe2d8e61
 SHA512:
-  metadata.gz: 0ab78f966ab1614ebe690b16f04d9e053803df832103542686d7697cc60af3e81ea341af447bb42c9fc181b599ac2cfdf268f665138441662a72d683e2da74bb
-  data.tar.gz: 787504de7fb53ae1c7656a420cbede3ae3c44844d21315b488ebd9fe6e005b06256800a6fd03d219ecd28f7e4c50192b9faad59e5ae9be1c6bf99a06d347058f
+  metadata.gz: e6f2c2ccfe42c46ce64049ec6b04bb1bad648a252e6a7f071829cd4f8f52d97b4372a0c7889c6ead9726bc0d4b0f27acb9fc64bc8948e1f5f7c52ac2e3d63f8d
+  data.tar.gz: d82ba0ed306f5024fb262d018fd9fe7a76b8a25ff242cc1a5a4c78d4edf122eb3b444625c45d256eaaf84d1be17ddd6ac7885c8eb0297b8c7f0b5c7b13ce8572

data/CHANGELOG.md

@@ -3,6 +3,19 @@
 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.
 
+## [0.4.0]
+- aws-ec2 ami command
+- create: add --source-ami options
+- compile_scripts command
+- custom helper support
+- dotenv support
+- hook support
+- latest_ami helper
+- partial support
+- starter specs: spec for ami
+- remove aws-ec2 spot command
+- remove aws-ec2 userdata command, sanity rspec passing
+
 ## [0.3.0]
 - Do not merge profile to default profile.  This was pretty confusing usage.
 - Add --ami option which result in automatically creating an ami at the end of

data/Gemfile.lock

@@ -1,88 +1,120 @@
 PATH
   remote: .
   specs:
-    aws_ec2 (0.0.1)
+    aws-ec2 (0.3.0)
+      activesupport
+      aws-sdk-ec2
       colorize
+      dotenv
       hashie
       thor
 
 GEM
   remote: https://rubygems.org/
   specs:
-    celluloid (0.16.0)
-      timers (~> 4.0.0)
-    codeclimate-test-reporter (0.4.4)
-      simplecov (>= 0.7.1, < 1.0.0)
-    coderay (1.1.0)
-    colorize (0.7.5)
-    diff-lcs (1.2.5)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    aws-partitions (1.57.0)
+    aws-sdk-core (3.14.0)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-ec2 (1.25.0)
+      aws-sdk-core (~> 3)
+      aws-sigv4 (~> 1.0)
+    aws-sigv4 (1.0.2)
+    byebug (9.1.0)
+    codeclimate-test-reporter (1.0.8)
+      simplecov (<= 0.13)
+    coderay (1.1.2)
+    colorize (0.8.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
     docile (1.1.5)
-    ffi (1.9.6)
+    dotenv (2.2.1)
+    ffi (1.9.18)
     formatador (0.2.5)
-    guard (2.10.5)
+    guard (2.14.2)
       formatador (>= 0.2.4)
-      listen (~> 2.7)
-      lumberjack (~> 1.0)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
+      notiffany (~> 0.0)
       pry (>= 0.9.12)
+      shellany (~> 0.0)
       thor (>= 0.18.1)
     guard-bundler (2.1.0)
       bundler (~> 1.0)
       guard (~> 2.2)
       guard-compat (~> 1.1)
-    guard-compat (1.2.0)
-    guard-rspec (4.5.0)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    hashie (3.3.2)
-    hitimes (1.2.2)
-    listen (2.8.4)
-      celluloid (>= 0.15.2)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    lumberjack (1.0.9)
-    method_source (0.8.2)
-    multi_json (1.10.1)
-    nenv (0.1.1)
-    pry (0.10.1)
+    hashie (3.5.7)
+    i18n (0.9.3)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.3.1)
+    json (2.1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.12)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.11.3)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rake (10.4.2)
-    rb-fsevent (0.9.4)
-    rb-inotify (0.9.5)
-      ffi (>= 0.5.0)
-    rspec (3.1.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.7)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.2)
+      method_source (~> 0.9.0)
+    rake (12.3.0)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-mocks (3.1.3)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.2)
-    simplecov (0.9.1)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    simplecov (0.13.0)
       docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-    slop (3.6.0)
-    thor (0.19.1)
-    timers (4.0.1)
-      hitimes
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.3)
+  aws-ec2!
+  bundler
+  byebug
   codeclimate-test-reporter
   guard
   guard-bundler
   guard-rspec
   rake
-  aws_ec2!
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -31,9 +31,9 @@ aws-ec2 create myserver
 
 ## User-Data
 
-You can provide user-data script to customize the server upon launch.  The user-data scripts are under the profiles/user-data folder.
+You can provide user-data script to customize the server upon launch.  The user-data scripts are under the app/user-data folder.
 
-* profiles/user-data/myserver.yml
+* app/user-data/myserver.yml
 
 The user-data script is generated on the machine that is running the aws-ec2 command. If this is your local macosx machine, then the context is your local macosx machine is available. To see the generated user-data script, you can use the `aws userdata NAME`.  Example:
 
@@ -47,7 +47,7 @@ You can set a config file and define variables in there that are available to in
 
 ## Noop mode
 
-You can do a test run with the `--noop` flag.  This will print out what settings will be used to launch the instance.
+You can do a test run with the `--noop` flag.  This will print out what settings will be used to launch the instance.  This is a good way to inspect the generated user-data script.
 
 ```sh
 aws-ec2 create myserver --profile myserver --noop
@@ -65,7 +65,6 @@ Spot instance support natively supported by the AWS run_instances command.  Simp
 ```sh
 aws-ec2 create help
 aws-ec2 userdata help
-aws-ec2 spot help
 aws-ec2 help # general help
 ```
 

data/aws-ec2.gemspec

@@ -22,6 +22,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "thor"
   spec.add_dependency "hashie"
   spec.add_dependency "colorize"
+  spec.add_dependency "dotenv"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "aws-sdk-ec2"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"

data/lib/aws-ec2.rb

@@ -7,14 +7,17 @@ module AwsEc2
   autoload :Command, "aws_ec2/command"
   autoload :CLI, "aws_ec2/cli"
   autoload :AwsServices, "aws_ec2/aws_services"
-  autoload :Util, "aws_ec2/util"
   autoload :Create, "aws_ec2/create"
-  autoload :Spot, "aws_ec2/spot"
-  autoload :TemplateHelper, "aws_ec2/template_helper"
-  autoload :UserData, "aws_ec2/user_data"
   autoload :Ami, "aws_ec2/ami"
+  autoload :TemplateHelper, "aws_ec2/template_helper"
+  autoload :Script, "aws_ec2/script"
   autoload :Config, "aws_ec2/config"
   autoload :Core, "aws_ec2/core"
+  autoload :Dotenv, "aws_ec2/dotenv"
+  autoload :Hook, "aws_ec2/hook"
+  autoload :CompileScripts, "aws_ec2/compile_scripts"
 
   extend Core
 end
+
+AwsEc2::Dotenv.load!

data/lib/aws_ec2/ami.rb

@@ -1,15 +1,14 @@
 module AwsEc2
   class Ami
-    def initialize(ami_name)
-      @ami_name = ami_name
+    def initialize(options)
+      @options = options.clone
     end
 
-    def user_data_snippet
-      region = `aws configure get region`.strip rescue 'us-east-1'
-      # the shebang line is here in case there's currently an
-      # empty user-data script.  If there is not, then it wont hurt.
-      template = IO.read(File.expand_path("../scripts/ami_creation.sh", __FILE__))
-      ERB.new(template, nil, "-").result(binding)
+    def run
+      # Delegates to the Create command.
+      # So we just have to set up the option for it.
+      @options[:ami_name] = @options[:name]
+      Create.new(@options).run
     end
   end
 end

data/lib/aws_ec2/cli.rb

@@ -5,23 +5,25 @@ module AwsEc2
     class_option :profile, desc: "profile name to use"
 
     desc "create NAME", "create ec2 instance"
-    option :ami, desc: "ami name, if specified an ami will be created at the end of user data"
     long_desc Help.text(:create)
+    option :ami_name, desc: "when specified, an ami creation script is appended to the user-data script"
+    option :auto_terminate, type: :boolean, default: false, desc: "automatically terminate the instance at the end of user-data"
+    option :source_ami, desc: "override the source image_id in profile"
     def create(name)
       Create.new(options.merge(name: name)).run
     end
 
-    desc "spot NAME", "create spot ec2 instance"
-    long_desc Help.text(:spot)
-    def spot(name)
-      Spot.new(options.merge(name: name)).run
+    desc "ami NAME", "launches instance and uses it create AMI"
+    long_desc Help.text(:ami)
+    option :auto_terminate, type: :boolean, default: true, desc: "automatically terminate the instance at the end of user-data"
+    def ami(name)
+      Ami.new(options.merge(name: name)).run
     end
 
-    desc "userdata NAME", "displays generated userdata script"
-    option :ami, desc: "ami name, if specified an ami will be created at the end of user data"
-    long_desc Help.text(:user_data)
-    def userdata(name)
-      UserData.new(options.merge(name: name)).run
+    desc "compile_scripts", "compiles app/scripts into tmp/app/scripts"
+    long_desc Help.text(:compile_scripts)
+    def compile_scripts
+      CompileScripts.new(options).compile
     end
   end
 end

data/lib/aws_ec2/command.rb

@@ -1,5 +1,18 @@
 require "thor"
 
+# Override thor's long_desc identation behavior
+# https://github.com/erikhuda/thor/issues/398
+class Thor
+  module Shell
+    class Basic
+      def print_wrapped(message, options = {})
+        message = "\n#{message}" unless message[0] == "\n"
+        stdout.puts message
+      end
+    end
+  end
+end
+
 module AwsEc2
   class Command < Thor
     class << self

data/lib/aws_ec2/compile_scripts.rb

@@ -0,0 +1,30 @@
+require 'fileutils'
+
+module AwsEc2
+  class CompileScripts
+    include TemplateHelper
+    BUILD_ROOT = "tmp"
+
+    def initialize(options)
+      @options = options
+    end
+
+    def compile
+      puts "Compiling app/scripts to..."
+      clean
+      Dir.glob("#{AwsEc2.root}/app/scripts/**/*").each do |path|
+        next if File.directory?(path)
+        result = erb_result(path)
+        tmp_path = path.sub(%r{.*/app/}, "#{BUILD_ROOT}/app/")
+        puts "  #{tmp_path}"
+        FileUtils.mkdir_p(File.dirname(tmp_path))
+        IO.write(tmp_path, result)
+      end
+      puts "Compiled app/scripts."
+    end
+
+    def clean
+      FileUtils.rm_rf(BUILD_ROOT)
+    end
+  end
+end

data/lib/aws_ec2/core.rb

@@ -1,3 +1,5 @@
+require 'pathname'
+
 module AwsEc2
   module Core
     @@config = nil
@@ -10,7 +12,8 @@ module AwsEc2
     end
 
     def root
-      ENV['AWS_EC2_ROOT'] || '.'
+      path = ENV['AWS_EC2_ROOT'] || '.'
+      Pathname.new(path)
     end
   end
 end

data/lib/aws_ec2/create.rb

@@ -3,8 +3,8 @@ require 'active_support/core_ext/hash'
 
 module AwsEc2
   class Create
+    autoload :Params, "aws_ec2/create/params"
     include AwsServices
-    include Util
 
     def initialize(options)
       @options = options
@@ -18,6 +18,7 @@ module AwsEc2
         return
       end
 
+      Hook.run(:before_run_instances, @options)
       resp = ec2.run_instances(params)
       puts "EC2 instance #{@options[:name]} created! 🎉"
       puts "Visit https://console.aws.amazon.com/ec2/home to check on the status"
@@ -25,89 +26,7 @@ module AwsEc2
 
     # params are main derived from profile files
     def params
-      params = load_profiles(profile_name)
-      decorate_params(params)
-      normalize_launch_template(params).deep_symbolize_keys
-    end
-
-    def decorate_params(params)
-      upsert_name_tag(params)
-      params
-    end
-
-    # Adds instance ec2 tag if not already provided
-    def upsert_name_tag(params)
-      specs = params["tag_specifications"] || []
-
-      # insert an empty spec placeholder if one not found
-      spec = specs.find do |s|
-        s["resource_type"] == "instance"
-      end
-      unless spec
-        spec = {
-            "resource_type" => "instance",
-            "tags" => []
-          }
-        specs << spec
-      end
-      # guaranteed there's a tag_specifications with resource_type instance at this point
-
-      tags = spec["tags"] || []
-
-      unless tags.map { |t| t["key"] }.include?("Name")
-        tags << { "key" => "Name", "value" => @options[:name] }
-      end
-
-      specs = specs.map do |s|
-        # replace the name tag value
-        if s["resource_type"] == "instance"
-          {
-            "resource_type" => "instance",
-            "tags" => tags
-          }
-        else
-          s
-        end
-      end
-
-      params["tag_specifications"] = specs
-      params
-    end
-
-    # Allow adding launch template as a simple string.
-    #
-    # Standard structure:
-    # {
-    #   launch_template: { launch_template_name: "TestLaunchTemplate" },
-    # }
-    #
-    # Simple string:
-    # {
-    #   launch_template: "TestLaunchTemplate",
-    # }
-    #
-    # When launch_template is a simple String it will get transformed to the
-    # standard structure.
-    def normalize_launch_template(params)
-      if params["launch_template"].is_a?(String)
-        launch_template_identifier = params["launch_template"]
-        launch_template = if launch_template_identifier =~ /^lt-/
-            { "launch_template_id" => launch_template_identifier }
-          else
-            { "launch_template_name" => launch_template_identifier }
-          end
-        params["launch_template"] = launch_template
-      end
-      params
-    end
-
-    # Hard coded sensible defaults.
-    # Can be overridden easily with profiles
-    def defaults
-      {
-        max_count: 1,
-        min_count: 1,
-      }
+      @params ||= Params.new(@options).generate
     end
 
     def display_info
@@ -137,5 +56,16 @@ module AwsEc2
       puts "Please double check that it exists."
       exit
     end
+
+    def pretty_display(data)
+      data = data.deep_stringify_keys
+
+      if data["user_data"]
+        message = "base64-encoded: cat /tmp/aws-ec2/user-data.txt to view"
+        data["user_data"] = message
+      end
+
+      puts YAML.dump(data)
+    end
   end
 end