forger 1.5.2 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b27c0f4d04ea641ac7dc7be07704f21b7b36cace82c20e3d50764badbccb390
-  data.tar.gz: adfdfb01b9500b142ec34fd9c3623bcb29c2e8994d05f33402e49f434a2ed780
+  metadata.gz: 76857772ac7cbd2c550b7506d1a2521abd062fa81db597cb3bb7668f4748d4e8
+  data.tar.gz: 1629ca2594868f7613be0cedfa8d0365f7be0c2944d22d6beb91f3723eccaa9b
 SHA512:
-  metadata.gz: fc3040ab22124d40436638e283bf47f8e8442d55c3f5e4c6c804801c7b2827dccdaea3f24141fc2d09255398cb992b07089068f453dd0c3707d9b7fd3fa2d0e9
-  data.tar.gz: 0f758fc77521872611434426a99afeca52745ab1e881daeed9f727673f23145fb1072e8f882b6c295d37c3064f1c0ed1cf9c7e2a55609829da09aac578f9e304
+  metadata.gz: 607c651c3253855fbaec49322962a49108c0c9861d2e84cc61c2a6dc611d21c3bd39b35ab132206b1713762982d5801a893ccaa091a8ea80d176e664bdfa7836
+  data.tar.gz: b1a1b5922611f071985aecaab00b56c0b36dcf1368b220056439a403d389006bece6cc17351b79a449b5d12c225a4583a126b3709463bb3356715990669c2c10

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.5.3]
+- Merge pull request #9 from tongueroo/erb-support-for-config-env-files
+- ERB support for config env files
+- rename AWS_EC2 to FORGER
+
 ## [1.5.2]
 - add back user-data.txt script to cloudwatch
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    forger (1.5.1)
+    forger (1.5.2)
       activesupport
       aws-sdk-ec2
       aws-sdk-s3

data/README.md

@@ -57,7 +57,7 @@ app/partials  | Your partials that can to be included in other scripts.  This is
 app/scripts  | Where you define common scripts that can be used to configure the server. These scripts can be automatically uploaded to an s3 bucket for later downloading in your user-data script by setting the `s3_folder` settings option.
 app/user-data  | Your user-data scripts that are used to bootstrap EC2 instance.
 app/user-data/layouts  | user-data scripts support layouts. You user-data layouts go in here.
-config/[AWS_EC2_ENV].yml  | The config file where you set configs that you want available in your templating logic.  Examples are: `config/development.yml` and `config/production.yml`. You access the config variables with the `<%= config["var"] %>` helper.
+config/[FORGER_ENV].yml  | The config file where you set configs that you want available in your templating logic.  Examples are: `config/development.yml` and `config/production.yml`. You access the config variables with the `<%= config["var"] %>` helper.
 profiles  | Your profile files.  These files mainly contain parameters that are passed to the aws-sdk run_instances API method.
 tmp  | Where the generated scripts get compiled to. You can manually invoke the compilation via `forger compile` to inspect what is generated.  This is automatically done as part of the `forger` create command.
 

data/forger.gemspec

@@ -8,8 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Forger::VERSION
   spec.authors       = ["Tung Nguyen"]
   spec.email         = ["tongueroo@gmail.com"]
-  spec.description   = %q{Simple tool to create AWS ec2 instances consistently with pre-configured settings}
-  spec.summary       = %q{Simple tool to create AWS ec2 instances}
+  spec.summary       = "Tool to create AWS ec2 instances"
   spec.homepage      = "https://github.com/tongueroo/forger"
   spec.license       = "MIT"
 

data/lib/forger/config.rb

@@ -1,7 +1,10 @@
 require 'yaml'
+require 'render_me_pretty'
 
 module Forger
   class Config < Base
+    include Forger::Template
+
     def initialize(options={})
       super
       @path = options[:path] || "#{Forger.root}/config/#{Forger.env}.yml"
@@ -10,7 +13,9 @@ module Forger
     @@data = nil
     def data
       return @@data if @@data
-      @@data = YAML.load_file(@path)
+
+      text = RenderMePretty.result(@path, context: context)
+      @@data = YAML.load(text)
     rescue Errno::ENOENT => e
       puts e.message
       puts "The #{@path} does not exist. Please double check that it exists."

data/lib/forger/core.rb

@@ -13,7 +13,7 @@ module Forger
     end
 
     def root
-      path = ENV['AWS_EC2_ROOT'] || '.'
+      path = ENV['FORGER_ROOT'] || '.'
       Pathname.new(path)
     end
 
@@ -28,7 +28,7 @@ module Forger
     def env
       return @@env if @@env
       env = env_from_profile(ENV['AWS_PROFILE']) || 'development'
-      env = ENV['AWS_EC2_ENV'] if ENV['AWS_EC2_ENV'] # highest precedence
+      env = ENV['FORGER_ENV'] if ENV['FORGER_ENV'] # highest precedence
       @@env = env
     end
 

data/lib/forger/create.rb

@@ -90,22 +90,22 @@ module Forger
     def display_cloudwatch_info(instance_id)
       return unless @options[:cloudwatch]
 
-      region = get_region
+      region = cloudwatch_log_region
       stream = "#{instance_id}/var/log/cloud-init-output.log"
       url = "https://#{region}.console.aws.amazon.com/cloudwatch/home?region=#{region}#logEventViewer:group=ec2;stream=#{stream}"
       cw_init_log = "cw tail -f ec2 #{stream}"
       puts "To view instance's cloudwatch logs visit:"
       puts "  #{url}"
 
-      puts "  #{cw_init_log}" if ENV['AWS_EC2_CW']
-      if ENV['AWS_EC2_CW'] && @options[:auto_terminate]
+      puts "  #{cw_init_log}" if ENV['FORGER_CW']
+      if ENV['FORGER_CW'] && @options[:auto_terminate]
         cw_terminate_log = "cw tail -f ec2 #{instance_id}/var/log/auto-terminate.log"
         puts "  #{cw_terminate_log}"
       end
 
       puts "Note: It takes a little time for the instance to launch and report logs."
 
-      paste_command = ENV['AWS_EC2_CW'] ? cw_init_log : url
+      paste_command = ENV['FORGER_CW'] ? cw_init_log : url
       add_to_clipboard(paste_command)
     end
 
@@ -117,10 +117,15 @@ module Forger
       puts "Pro tip: The CloudWatch Console Link has been added to your copy-and-paste clipboard."
     end
 
-    def get_region
-      # Highest precedence: AWS_EC2_REGION env variable. Only really used here.
-      if ENV['AWS_EC2_REGION']
-        return ENV['AWS_EC2_REGION']
+    def cloudwatch_log_region
+      # Highest precedence: FORGER_REGION env variable. Only really used here.
+      # This is useful to be able to override when running tool in codebuild.
+      # Codebuild can be running in different region then the region which the
+      # instance is launched in.
+      # Getting the region from the the profile and metadata doesnt work in
+      # this case.
+      if ENV['FORGER_REGION']
+        return ENV['FORGER_REGION']
       end
 
       # Pretty high in precedence: AWS_PROFILE and ~/.aws/config and

data/lib/forger/dotenv.rb

@@ -24,7 +24,7 @@ class Forger::Dotenv
     end
 
     def root
-      Forger.root || Pathname.new(ENV["AWS_EC2_ROOT"] || Dir.pwd)
+      Forger.root || Pathname.new(ENV["FORGER_ROOT"] || Dir.pwd)
     end
   end
 end

data/lib/forger/script.rb

@@ -29,7 +29,8 @@ module Forger
     def create_ami
       # set variables for the template
       @ami_name = @options[:ami_name]
-      @region = `aws configure get region`.strip rescue 'us-east-1'
+      @region = 'us-east-1' if ENV['TEST']
+      @region ||= `aws configure get region`.strip rescue 'us-east-1'
       load_template("ami_creation.sh")
     end
 

data/lib/forger/script/templates/extract_forger_scripts.sh

@@ -21,13 +21,13 @@ function extract_forger_scripts() {
 
   <%
     # Examples:
-    #   AWS_EC2_CODE=v1.0.0
-    #   AWS_EC2_CODE=master
-    #   AWS_EC2_CODE=branch-name
+    #   FORGER_CODE=v1.0.0
+    #   FORGER_CODE=master
+    #   FORGER_CODE=branch-name
     #
     #   https://github.com/tongueroo/forger/archive/v1.0.0.tar.gz
     #   https://github.com/tongueroo/forger/archive/master.tar.gz
-    code_version = ENV['AWS_EC2_CODE']
+    code_version = ENV['FORGER_CODE']
     code_version ||= "v#{Forger::VERSION}"
   %>
     url="https://github.com/tongueroo/forger/archive/<%= code_version %>.tar.gz"

data/lib/forger/template/context.rb

@@ -18,10 +18,10 @@ module Forger::Template
         filename = path.sub(%r{.*/},'').sub('.rb','')
         module_name = filename.classify
 
-        # Prepend a period so require works AWS_EC2_ROOT is set to a relative path
+        # Prepend a period so require works FORGER_ROOT is set to a relative path
         # without a period.
         #
-        # Example: AWS_EC2_ROOT=tmp/project
+        # Example: FORGER_ROOT=tmp/project
         first_char = path[0..0]
         path = "./#{path}" unless %w[. /].include?(first_char)
         require path

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

@@ -58,8 +58,8 @@ module Forger::Template::Helper::CoreHelper
   end
 
   # provides access to config/* settings as variables
-  #   AWS_EC2_ENV=development => config/development.yml
-  #   AWS_EC2_ENV=production => config/production.yml
+  #   FORGER_ENV=development => config/development.yml
+  #   FORGER_ENV=production => config/production.yml
   def config
     Forger.config
   end

data/lib/forger/version.rb

@@ -1,3 +1,3 @@
 module Forger
-  VERSION = "1.5.2"
+  VERSION = "1.5.3"
 end

data/spec/fixtures/demo_project/.env.test

@@ -0,0 +1,2 @@
+IAM_INSTANCE_PROFILE=test-iam-profile
+TEST_KEY=test-key-value

data/spec/fixtures/demo_project/app/user-data/bootstrap.sh

@@ -0,0 +1,4 @@
+#!/bin/bash -exu
+
+# test env variables from config/[ENV].yml file
+# test_key: <%= config["test_key"] %>

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

@@ -5,3 +5,4 @@ subnets:
 security_group_ids:
   - sg-123 # test-single-instance
 s3_bucket: my-bucket # for the user-data shared scripts
+test_key: <%= ENV['TEST_KEY'] %>

data/spec/fixtures/demo_project/profiles/default.yml

@@ -6,9 +6,9 @@ instance_type: t2.medium
 key_name: default
 max_count: 1
 min_count: 1
-user_data:
+user_data: "<%= user_data("bootstrap.sh") %>"
 iam_instance_profile:
-  name: DevLinux
+  name: <%= ENV['IAM_INSTANCE_PROFILE'] %>
 # public network settings
 security_group_ids: <%= config["security_group_ids"].inspect %>
 subnet_id: <%= config["subnets"].shuffle.first %>

data/spec/lib/cli_spec.rb

@@ -9,6 +9,13 @@ describe Forger::CLI do
       expect(out).to include("Creating EC2 instance")
     end
 
+    it "ERB evaluates dotenv files" do
+      out = execute("exe/forger create server #{@args}")
+      user_data = IO.readlines("spec/fixtures/demo_project/tmp/user-data.txt")
+      found = !user_data.select { |l| l =~ /test_key: test-key-value/ }.empty?
+      expect(found).to be true
+    end
+
     it "ami" do
       out = execute("exe/forger ami myimage #{@args}")
       expect(out).to include("Creating EC2 instance")

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 ENV["TEST"] = "1"
-ENV["AWS_EC2_ENV"] = "test"
-ENV["AWS_EC2_ROOT"] = "spec/fixtures/demo_project"
+ENV["FORGER_ENV"] = "test"
+ENV["FORGER_ROOT"] = "spec/fixtures/demo_project"
 # Ensures aws api never called. Fixture home folder does not contain ~/.aws/credentails
 ENV['HOME'] = "spec/fixtures/home"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forger
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.5.3
 platform: ruby
 authors:
 - Tung Nguyen
@@ -220,8 +220,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Simple tool to create AWS ec2 instances consistently with pre-configured
-  settings
+description: 
 email:
 - tongueroo@gmail.com
 executables:
@@ -315,6 +314,8 @@ files:
 - lib/forger/wait.rb
 - lib/forger/waiter.rb
 - lib/forger/waiter/ami.rb
+- spec/fixtures/demo_project/.env.test
+- spec/fixtures/demo_project/app/user-data/bootstrap.sh
 - spec/fixtures/demo_project/config/settings.yml
 - spec/fixtures/demo_project/config/test.yml
 - spec/fixtures/demo_project/profiles/default.yml
@@ -344,8 +345,10 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: Simple tool to create AWS ec2 instances
+summary: Tool to create AWS ec2 instances
 test_files:
+- spec/fixtures/demo_project/.env.test
+- spec/fixtures/demo_project/app/user-data/bootstrap.sh
 - spec/fixtures/demo_project/config/settings.yml
 - spec/fixtures/demo_project/config/test.yml
 - spec/fixtures/demo_project/profiles/default.yml