aws-ec2 1.0.0 → 1.1.0

data/lib/aws_ec2/setting.rb

@@ -18,7 +18,8 @@ module AwsEc2
       end
 
       all_envs = load_file(project_settings_path)
-      @@data = all_envs[AwsEc2.env]
+      all_envs = merge_base(all_envs)
+      @@data = all_envs[AwsEc2.env] || all_envs["base"] || {}
     end
 
   private
@@ -27,13 +28,23 @@ module AwsEc2
 
       content = RenderMePretty.result(path)
       data = YAML.load(content)
-      # ensure no nil values
-      data.each do |key, value|
-        data[key] = {} if value.nil?
+      # If key is is accidentally set to nil it screws up the merge_base later.
+      # So ensure that all keys with nil value are set to {}
+      data.each do |env, _setting|
+        data[env] ||= {}
       end
       data
     end
 
+    # automatically add base settings to the rest of the environments
+    def merge_base(all_envs)
+      base = all_envs["base"] || {}
+      all_envs.each do |env, settings|
+        all_envs[env] = base.merge(settings) unless env == "base"
+      end
+      all_envs
+    end
+
     def project_settings_path
       "#{AwsEc2.root}/config/settings.yml"
     end

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

@@ -2,6 +2,7 @@ require "base64"
 require "erb"
 
 module AwsEc2::Template::Helper::CoreHelper
+  # assuming user-data script is a bash script for simplicity for now
   def user_data(name, base64:true, layout:"default")
     # allow user to specify the path also
     if File.exist?(name)
@@ -12,7 +13,15 @@ module AwsEc2::Template::Helper::CoreHelper
     layout_path = layout_path(layout)
     path = "#{AwsEc2.root}/app/user-data/#{name}.sh"
     result = RenderMePretty.result(path, context: self, layout: layout_path)
-    result = append_scripts(result)
+    # Must prepend and append scripts in user_data here because we need to
+    # encode the user_data script for valid yaml to load in the profile.
+    # Tried moving this logic to the params but that is too late and produces
+    # invalid yaml.  Unless we want to encode and dedode twice.
+    scripts = [result]
+    scripts = prepend_scripts(scripts)
+    scripts = append_scripts(scripts)
+    divider = "\n############################## DIVIDER ##############################\n"
+    result = scripts.join(divider)
 
     # save the unencoded user-data script for easy debugging
     temp_path = "#{AwsEc2.root}/tmp/user-data.txt"
@@ -67,12 +76,42 @@ module AwsEc2::Template::Helper::CoreHelper
   end
 
 private
-  def append_scripts(user_data)
-    # assuming user-data script is a bash script for simplicity
-    script = AwsEc2::Script.new(@options)
-    user_data += script.auto_terminate if @options[:auto_terminate]
-    user_data += script.create_ami if @options[:ami_name]
-    user_data
+  # TODO: move script combining logic into class
+  def prepend_scripts(scripts)
+    scripts.unshift(script.cloudwatch) if @options[:cloudwatch]
+    scripts.unshift(script.auto_terminate_after_timeout) if @options[:auto_terminate]
+    add_setup_script(scripts, :prepend)
+    scripts
+  end
+
+  def append_scripts(scripts)
+    add_setup_script(scripts, :append)
+    scripts << script.auto_terminate if @options[:auto_terminate]
+    scripts << script.create_ami if @options[:ami_name]
+    scripts
+  end
+
+  def add_setup_script(scripts, how)
+    return if @already_setup
+    @already_setup = true
+
+    requires_setup = @options[:cloudwatch] ||
+                     @options[:auto_terminate] ||
+                     @options[:ami_name]
+
+    return unless requires_setup
+
+    if how == :prepend
+      scripts.unshift(script.extract_aws_ec2_scripts)
+    else
+      scripts << script.extract_aws_ec2_scripts
+    end
+
+    scripts
+  end
+
+  def script
+    @script ||= AwsEc2::Script.new(@options)
   end
 
   # Load custom helper methods from the project repo

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

@@ -13,7 +13,7 @@ chown #{user}:#{user} /home/#{user}/.ssh/authorized_keys
 SCRIPT
     else
       <<-SCRIPT
-# WARN: unable to find a ~/.ssh/id_rsa.pub locally on your machine.  user: #{ENV}['USER']
+# WARN: unable to find a ~/.ssh/id_rsa.pub locally on your machine.  user: #{ENV['USER']}
 # Unable to automatically add the public key
 SCRIPT
     end

data/lib/aws_ec2/version.rb

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

data/spec/fixtures/demo_project/config/settings.yml

@@ -0,0 +1,22 @@
+---
+# Settings control internal aws-ec2 behavior.
+# Settings are different from the config files.  The config files are meant to
+# expose config variables that you can use in your ERB code.
+# There are separate files to separate user defined variables and internal
+# setting configs.
+development:
+  # By setting s3_folder, aws-ec2 will automatically tarball and upload your scripts
+  # to set. You then can then use the extract_scripts helper method to download
+  # the scripts onto the server.
+  # s3_folder: mybucket/path/to/folder # simple string
+  # compile_clean: true # uncomment to clean
+  # extract_scripts:
+  #   to: "/opt"
+  #   as: "ec2-user"
+  # aws_profiles:
+  #   - profile1
+
+production:
+  # s3_folder: mybucket/folder
+  # aws_profiles:
+  #   - profile2

data/spec/lib/cli_spec.rb

@@ -1,10 +1,3 @@
-require "spec_helper"
-
-# to run specs with what"s remembered from vcr
-#   $ rake
-#
-# to run specs with new fresh data from aws api calls
-#   $ rake clean:vcr ; time rake
 describe AwsEc2::CLI do
   before(:all) do
     @args = "--noop"

data/spec/lib/params_spec.rb

@@ -0,0 +1,71 @@
+describe AwsEc2::Create::Params do
+  let(:param) { AwsEc2::Create::Params.new(name: "myserver") }
+
+  context "completely empty" do
+    it '#upsert_name_tag!' do
+      params = {}
+      result = param.upsert_name_tag!(params)
+      # puts "params: #{params.inspect}" # uncomment to see and debug
+      expect(result).to eq(
+        {"tag_specifications"=>
+          [{"resource_type"=>"instance",
+            "tags"=>[{"key"=>"Name", "value"=>"myserver"}]}]}
+      )
+    end
+  end
+
+  context "empty tag_specifications" do
+    it '#upsert_name_tag!' do
+      params = {"tag_specifications" => []}
+      result = param.upsert_name_tag!(params)
+      # puts "params: #{params.inspect}" # uncomment to see and debug
+      expect(result).to eq(
+        {"tag_specifications"=>
+          [{"resource_type"=>"instance",
+            "tags"=>[{"key"=>"Name", "value"=>"myserver"}]}]}
+      )
+    end
+  end
+
+  context "contains 1 instance with name" do
+    it '#upsert_name_tag!' do
+      params = { "tag_specifications" =>
+        [{
+          "resource_type"=>"instance",
+          "tags"=> [{"key"=>"Name", "value"=>"override-myserver"} ]
+        }]
+      }
+      result = param.upsert_name_tag!(params)
+      # puts "params: #{params.inspect}" # uncomment to see and debug
+      expect(result).to eq(
+        {"tag_specifications"=>
+          [{"resource_type"=>"instance",
+            "tags"=>[{"key"=>"Name", "value"=>"override-myserver"}]}]}
+      )
+    end
+  end
+
+  context "contains 1 instance with non-name tag" do
+    it '#upsert_name_tag!' do
+      params = { "tag_specifications" =>
+        [{
+          "resource_type"=>"instance",
+          "tags"=> [{"key"=>"Os", "value"=>"amazonlinux"} ]
+        }]
+      }
+      result = param.upsert_name_tag!(params)
+      # puts "params: #{params.inspect}" # uncomment to see and debug
+      expect(result).to eq(
+        { "tag_specifications" =>
+          [{
+            "resource_type"=>"instance",
+            "tags"=> [
+              {"key"=>"Os", "value"=>"amazonlinux"},
+              {"key"=>"Name", "value"=>"myserver"},
+            ]
+          }]
+        }
+      )
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-ec2
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-27 00:00:00.000000000 Z
+date: 2018-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -262,9 +262,23 @@ files:
 - lib/aws_ec2/script.rb
 - lib/aws_ec2/script/compile.rb
 - lib/aws_ec2/script/compress.rb
+- lib/aws_ec2/script/templates/ami_creation.sh
+- lib/aws_ec2/script/templates/auto_terminate.sh
+- lib/aws_ec2/script/templates/auto_terminate_after_timeout.sh
+- lib/aws_ec2/script/templates/cloudwatch.sh
+- lib/aws_ec2/script/templates/extract_aws_ec2_scripts.sh
 - lib/aws_ec2/script/upload.rb
-- lib/aws_ec2/scripts/ami_creation.sh
 - lib/aws_ec2/scripts/auto_terminate.sh
+- lib/aws_ec2/scripts/auto_terminate/after_timeout.sh
+- lib/aws_ec2/scripts/auto_terminate/functions.sh
+- lib/aws_ec2/scripts/auto_terminate/functions/amazonlinux2.sh
+- lib/aws_ec2/scripts/auto_terminate/functions/ubuntu.sh
+- lib/aws_ec2/scripts/auto_terminate/setup.sh
+- lib/aws_ec2/scripts/cloudwatch.sh
+- lib/aws_ec2/scripts/cloudwatch/configure.sh
+- lib/aws_ec2/scripts/cloudwatch/install.sh
+- lib/aws_ec2/scripts/cloudwatch/service.sh
+- lib/aws_ec2/scripts/shared/functions.sh
 - lib/aws_ec2/setting.rb
 - lib/aws_ec2/template.rb
 - lib/aws_ec2/template/context.rb
@@ -275,9 +289,11 @@ files:
 - lib/aws_ec2/template/helper/script_helper.rb
 - lib/aws_ec2/template/helper/ssh_key_helper.rb
 - lib/aws_ec2/version.rb
+- spec/fixtures/demo_project/config/settings.yml
 - spec/fixtures/demo_project/config/test.yml
 - spec/fixtures/demo_project/profiles/default.yml
 - spec/lib/cli_spec.rb
+- spec/lib/params_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/tongueroo/aws-ec2
 licenses:
@@ -304,7 +320,9 @@ signing_key:
 specification_version: 4
 summary: Simple tool to create AWS ec2 instances
 test_files:
+- spec/fixtures/demo_project/config/settings.yml
 - spec/fixtures/demo_project/config/test.yml
 - spec/fixtures/demo_project/profiles/default.yml
 - spec/lib/cli_spec.rb
+- spec/lib/params_spec.rb
 - spec/spec_helper.rb

data/lib/aws_ec2/scripts/ami_creation.sh

@@ -1,35 +0,0 @@
-#!/bin/bash -exu
-# The shebang line is here in case there's is currently an empty user-data script.
-# It wont hurt if already there.
-######################################
-# ami_creation.sh: added to the end of user-data automatically.
-function configure_aws_cli() {
-  local home_dir=$1
-  # Configure aws cli in case it is not yet configured
-  mkdir -p $home_dir/.aws
-  if [ ! -f $home_dir/.aws/config ]; then
-    cat >$home_dir/.aws/config <<EOL
-[default]
-region = <%= @region %>
-output = json
-EOL
-  fi
-}
-
-configure_aws_cli /home/ec2-user
-configure_aws_cli /root
-
-echo "############################################" >> /var/log/user-data.log
-echo "# Logs above is from the original AMI baking at: $(date)" >> /var/log/user-data.log
-echo "# New logs below" >> /var/log/user-data.log
-echo "############################################" >> /var/log/user-data.log
-
-# Create AMI Bundle
-AMI_NAME="<%= @ami_name %>"
-INSTANCE_ID=$(wget -q -O - http://169.254.169.254/latest/meta-data/instance-id)
-REGION=$(aws configure get region)
-# Note this will cause the instance to reboot.  Not using the --no-reboot flag
-# to ensure consistent AMI creation.
-SOURCE_AMI_ID=$(wget -q -O - http://169.254.169.254/latest/meta-data/ami-id)
-echo $SOURCE_AMI_ID > /var/log/source-ami-id.txt
-aws ec2 create-image --name $AMI_NAME --instance-id $INSTANCE_ID --region $REGION