forger 1.5.0

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

@@ -0,0 +1,71 @@
+module Forger::Template::Helper::PartialHelper
+  def partial_exist?(path)
+    path = partial_path_for(path)
+    path = auto_add_format(path)
+    path && File.exist?(path)
+  end
+
+  # The partial's path is a relative path given without the extension and
+  #
+  # Example:
+  # Given: file in app/partials/mypartial.sh
+  # The path should be: mypartial
+  #
+  # If the user specifies the extension then use that instead of auto-adding
+  # the detected format.
+  def partial(path,vars={}, options={})
+    path = partial_path_for(path)
+    path = auto_add_format(path)
+
+    result = RenderMePretty.result(path, context: self)
+    result = indent(result, options[:indent]) if options[:indent]
+    if options[:indent]
+      # Add empty line at beginning because empty lines gets stripped during
+      # processing anyway. This allows the user to call partial without having
+      # to put the partial call at very beginning of the line.
+      # This only should happen if user is using indent option.
+      ["\n", result].join("\n")
+    else
+      result
+    end
+  end
+
+  # add indentation
+  def indent(text, indentation_amount)
+    text.split("\n").map do |line|
+      " " * indentation_amount + line
+    end.join("\n")
+  end
+
+private
+  def partial_path_for(path)
+    "#{Forger.root}/app/partials/#{path}"
+  end
+
+  def auto_add_format(path)
+    # Return immediately if user provided explicit extension
+    extension = File.extname(path) # current extension
+    return path if !extension.empty?
+
+    # Else let's auto detect
+    paths = Dir.glob("#{path}.*")
+
+    if paths.size == 1 # non-ambiguous match
+      return paths.first
+    end
+
+    if paths.size > 1 # ambiguous match
+      puts "ERROR: Multiple possible partials found:".colorize(:red)
+      paths.each do |path|
+        puts "  #{path}"
+      end
+      puts "Please specify an extension in the name to remove the ambiguity.".colorize(:green)
+      exit 1
+    end
+
+    # Account for case when user wants to include a file with no extension at all
+    return path if File.exist?(path) && !File.directory?(path)
+
+    path # original path if this point is reached
+  end
+end

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

@@ -0,0 +1,53 @@
+module Forger::Template::Helper::ScriptHelper
+  # Bash code that is meant to included in user-data
+  def extract_scripts(options={})
+    check_s3_folder_settings!
+
+    settings_options = settings["extract_scripts"] || {}
+    options = settings_options.merge(options)
+    # defaults also here in case they are removed from settings
+    to = options[:to] || "/opt"
+    user = options[:as] || "ec2-user"
+
+    if Dir.glob("#{Forger.root}/app/scripts*").empty?
+      puts "WARN: you are using the extract_scripts helper method but you do not have any app/scripts.".colorize(:yellow)
+      calling_line = caller[0].split(':')[0..1].join(':')
+      puts "Called from: #{calling_line}"
+      return ""
+    end
+
+    <<-BASH_CODE
+# Generated from the forger extract_scripts helper.
+# Downloads scripts from s3, extract them, and setup.
+mkdir -p #{to}
+aws s3 cp #{scripts_s3_path} #{to}/
+(
+  cd #{to}
+  tar zxf #{to}/#{scripts_name}
+  chmod -R a+x #{to}/scripts
+  chown -R #{user}:#{user} #{to}/scripts
+)
+BASH_CODE
+  end
+
+private
+  def check_s3_folder_settings!
+    return if settings["s3_folder"]
+
+    puts "Helper method called that requires the s3_folder to be set at:"
+    lines = caller.reject { |l| l =~ %r{lib/forger} } # hide internal forger trace
+    puts "  #{lines[0]}"
+
+    puts "Please configure your config/settings.yml with an s3_folder.".colorize(:red)
+    exit 1
+  end
+
+  def scripts_name
+    File.basename(scripts_s3_path)
+  end
+
+  def scripts_s3_path
+    upload = Forger::Script::Upload.new
+    upload.s3_dest
+  end
+end

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

@@ -0,0 +1,21 @@
+module Forger::Template::Helper::SshKeyHelper
+  def add_ssh_key(user="ec2-user")
+    key_path = "#{ENV['HOME']}/.ssh/id_rsa.pub"
+    if File.exist?(key_path)
+      public_key = IO.read(key_path).strip
+    end
+    if public_key
+      <<-SCRIPT
+# Automatically add user's public key from #{key_path}
+cp /home/#{user}/.ssh/authorized_keys{,.bak}
+echo #{public_key} >> /home/#{user}/.ssh/authorized_keys
+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']}
+# Unable to automatically add the public key
+SCRIPT
+    end
+  end
+end

data/lib/forger/version.rb

@@ -0,0 +1,3 @@
+module Forger
+  VERSION = "1.5.0"
+end

data/lib/forger/wait.rb

@@ -0,0 +1,12 @@
+module Forger
+  autoload :Waiter, 'forger/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/forger/waiter.rb

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

data/lib/forger/waiter/ami.rb

@@ -0,0 +1,61 @@
+module Forger::Waiter
+  class Ami < Forger::Base
+    include Forger::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
+      puts
+
+      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
+    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/fixtures/demo_project/config/settings.yml

@@ -0,0 +1,22 @@
+---
+# Settings control internal forger 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, forger 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/fixtures/demo_project/config/test.yml

@@ -0,0 +1,9 @@
+---
+vpc_id: vpc-123
+db_subnet_group_name: default # default db subnet group associated with default vpc
+subnets:
+  - subnet-123
+  - subnet-456
+security_group_ids:
+  - sg-123 # test-single-instance
+s3_bucket: my-bucket # for the user-data shared scripts

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

@@ -0,0 +1,33 @@
+---
+# image_id: ami-97785bed # Amazon Linux AMI
+image_id: ami-4fffc834 # Amazon Lambda AMI
+  # https://docs.aws.amazon.com/lambda/latest/dg/current-supported-versions.html
+instance_type: t2.medium
+key_name: default
+max_count: 1
+min_count: 1
+user_data:
+iam_instance_profile:
+  name: DevLinux
+# public network settings
+security_group_ids: <%= config["security_group_ids"].inspect %>
+subnet_id: <%= config["subnets"].shuffle.first %>
+block_device_mappings:
+  - device_name: /dev/xvda
+    ebs:
+      volume_size: 20
+instance_market_options:
+  market_type: spot
+  # https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateSpotMarketOptionsRequest.html
+  # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/Types/SpotMarketOptions.html
+  spot_options:
+    max_price: "0.018" # $0.020/hr = $14.40/mo
+                       # $0.018/hr = $12.96/mo
+    # valid combinations:
+    #   spot_instance_type: persistent
+    #   instance_interruption_behavior: hibernate
+    # or
+    #   spot_instance_type: one-time
+    # More info: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-interruptions.html
+    spot_instance_type: persistent
+    instance_interruption_behavior: hibernate

data/spec/lib/cli_spec.rb

@@ -0,0 +1,41 @@
+describe Forger::CLI do
+  before(:all) do
+    @args = "--noop"
+  end
+
+  describe "forger" do
+    it "create" do
+      out = execute("exe/forger create server #{@args}")
+      expect(out).to include("Creating EC2 instance")
+    end
+
+    it "ami" do
+      out = execute("exe/forger ami myimage #{@args}")
+      expect(out).to include("Creating EC2 instance")
+    end
+
+    it "wait ami" do
+      out = execute("exe/forger wait ami myimage")
+      expect(out).to include("Waiting for")
+    end
+
+    it "clean ami" do
+      out = execute("exe/forger clean ami imagebasename")
+      expect(out).to include("Cleaning out old AMIs")
+    end
+
+    commands = {
+      "am" => "ami",
+      "compile" => "--profile",
+      "create -" =>  "--profile",
+      "create" => "name",
+      "create name --" => "--profile",
+    }
+    commands.each do |command, expected_word|
+      it "completion #{command}" do
+        out = execute("exe/forger completion #{command}")
+        expect(out).to include(expected_word) # only checking for one word for simplicity
+      end
+    end
+  end
+end

data/spec/lib/params_spec.rb

@@ -0,0 +1,71 @@
+describe Forger::Create::Params do
+  let(:param) { Forger::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

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+ENV["TEST"] = "1"
+ENV["AWS_EC2_ENV"] = "test"
+ENV["AWS_EC2_ROOT"] = "spec/fixtures/demo_project"
+# Ensures aws api never called. Fixture home folder does not contain ~/.aws/credentails
+ENV['HOME'] = "spec/fixtures/home"
+
+# CodeClimate test coverage: https://docs.codeclimate.com/docs/configuring-test-coverage
+# require 'simplecov'
+# SimpleCov.start
+
+require "pp"
+require "byebug"
+root = File.expand_path("../", File.dirname(__FILE__))
+require "#{root}/lib/forger"
+
+module Helper
+  def execute(cmd)
+    puts "Running: #{cmd}" if show_command?
+    out = `#{cmd}`
+    puts out if show_command?
+    out
+  end
+
+  # Added SHOW_COMMAND because DEBUG is also used by other libraries like
+  # bundler and it shows its internal debugging logging also.
+  def show_command?
+    ENV['DEBUG'] || ENV['SHOW_COMMAND']
+  end
+end
+
+RSpec.configure do |c|
+  c.include Helper
+end