forger 1.5.0

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task default: :spec
+
+RSpec::Core::RakeTask.new

data/docs/example/.env

@@ -0,0 +1,2 @@
+# Example .env, meant to be updated.
+# Variables in here are available and shared across all environments: development, production, etc.

data/docs/example/.env.development

@@ -0,0 +1,2 @@
+# Example .env.development, meant to be updated.
+ENV_DEVELOPMENT_KEY=example1

data/docs/example/.env.production

@@ -0,0 +1,3 @@
+# Example .env.production, meant to be updated.
+# This file is normally .gitignore.
+MYKEY=example1

data/docs/example/app/scripts/hello.sh

@@ -0,0 +1,3 @@
+#!/bin/bash -exu
+
+echo "hello world"

data/docs/example/app/user-data/bootstrap.sh

@@ -0,0 +1,35 @@
+#!/bin/bash -exu
+
+export HOME=/root # user-data env runs in weird shell where user is root but HOME is not set
+
+sudo yum install -y postgresql
+
+# https://gist.github.com/juno/1330165
+# Install developer tools
+yum install -y git gcc make readline-devel openssl-devel
+
+# Install ruby-build system-widely
+git clone git://github.com/sstephenson/ruby-build.git /tmp/ruby-build
+cd /tmp/ruby-build
+./install.sh
+echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.bashrc
+
+# Install rbenv for root
+git clone git://github.com/sstephenson/rbenv.git ~/.rbenv
+echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
+echo 'eval "$(rbenv init -)"' >> ~/.bashrc
+set +u
+source ~/.bashrc
+set -u
+
+# Install and enable ruby
+rbenv install 2.5.0
+
+# Install ruby for ec2-user also
+cp -R ~/.rbenv /home/ec2-user/
+chown -R ec2-user:ec2-user /home/ec2-user/.rbenv
+echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> /home/ec2-user/.bashrc
+echo 'eval "$(rbenv init -)"' >> /home/ec2-user/.bashrc
+echo '2.5.0' > /home/ec2-user/.ruby-version
+
+uptime | tee /var/log/boot-time.log

data/docs/example/config/development.yml

@@ -0,0 +1,8 @@
+---
+vpc_id: vpc-111
+subnets:
+  - subnet-111
+  - subnet-222
+  - subnet-333
+security_group_ids:
+  - sg-111

data/docs/example/profiles/default.yml

@@ -0,0 +1,11 @@
+---
+image_id: ami-97785bed
+instance_type: t2.medium
+key_name: default
+max_count: 1
+min_count: 1
+security_group_ids: <%= config["security_group_ids"] %>
+subnet_id: <%= config["subnets"].shuffle.first %>
+user_data: "<%= user_data("bootstrap") %>"
+iam_instance_profile:
+  name: IAMProfileName

data/docs/example/profiles/spot.yml

@@ -0,0 +1,20 @@
+---
+image_id: ami-97785bed
+instance_type: t2.medium
+key_name: default
+max_count: 1
+min_count: 1
+security_group_ids:
+- sg-111
+subnet_id: <%= %w[subnet-111 subnet-222].shuffle.first %>
+user_data: "<%= user_data("dev") %>"
+iam_instance_profile:
+  name: IAMProfileName
+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.02"
+    spot_instance_type: one-time
+    # instance_interruption_behavior: hibernate

data/exe/forger

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# Trap ^C
+Signal.trap("INT") {
+  puts "\nCtrl-C detected. Exiting..."
+  sleep 1
+  exit
+}
+
+$:.unshift(File.expand_path("../../lib", __FILE__))
+require "forger"
+require "forger/cli"
+
+Forger::CLI.start(ARGV)

data/forger.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "forger/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "forger"
+  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.homepage      = "https://github.com/tongueroo/forger"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  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_development_dependency "bundler"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "rake"
+end

data/lib/forger.rb

@@ -0,0 +1,29 @@
+$:.unshift(File.expand_path("../", __FILE__))
+require "forger/version"
+require "colorize"
+require "render_me_pretty"
+
+module Forger
+  autoload :Help, "forger/help"
+  autoload :Command, "forger/command"
+  autoload :CLI, "forger/cli"
+  autoload :AwsService, "forger/aws_service"
+  autoload :Profile, "forger/profile"
+  autoload :Base, "forger/base"
+  autoload :Create, "forger/create"
+  autoload :Ami, "forger/ami"
+  autoload :Wait, "forger/wait"
+  autoload :Clean, "forger/clean"
+  autoload :Template, "forger/template"
+  autoload :Script, "forger/script"
+  autoload :Config, "forger/config"
+  autoload :Core, "forger/core"
+  autoload :Dotenv, "forger/dotenv"
+  autoload :Hook, "forger/hook"
+  autoload :Completion, "forger/completion"
+  autoload :Completer, "forger/completer"
+  autoload :Setting, "forger/setting"
+  extend Core
+end
+
+Forger::Dotenv.load!

data/lib/forger/ami.rb

@@ -0,0 +1,10 @@
+module Forger
+  class Ami < Base
+    def run
+      # Delegates to the Create command.
+      # So we just have to set up the option for it.
+      @options[:ami_name] = @name
+      Create.new(@options).run
+    end
+  end
+end

data/lib/forger/aws_service.rb

@@ -0,0 +1,7 @@
+require 'aws-sdk-ec2'
+
+module Forger::AwsService
+  def ec2
+    @ec2 ||= Aws::EC2::Client.new
+  end
+end

data/lib/forger/base.rb

@@ -0,0 +1,42 @@
+module Forger
+  class Base
+    # constants really only used by script classes
+    SCRIPTS_INFO_PATH = "tmp/data/scripts_info.txt"
+    BUILD_ROOT = "tmp"
+
+    def initialize(options={})
+      @options = options.clone
+      @name = randomize(@options[:name])
+      Forger.validate_in_project!
+    end
+
+    # Appends a short random string at the end of the ec2 instance name.
+    # Later we will strip this same random string from the name.
+    # Very makes it convenient.  We can just type:
+    #
+    #   forger create server --randomize
+    #
+    # instead of:
+    #
+    #   forger create server-123 --profile server
+    #
+    def randomize(name)
+      if @options[:randomize]
+        random = (0...3).map { (65 + rand(26)).chr }.join.downcase # Ex: jhx
+        [name, random].join('-')
+      else
+        name
+      end
+    end
+
+    # Strip the random string at end of the ec2 instance name
+    def derandomize(name)
+      if @options[:randomize]
+        name.sub(/-(\w{3})$/,'') # strip the random part at the end
+      else
+        name
+      end
+    end
+
+  end
+end

data/lib/forger/clean.rb

@@ -0,0 +1,13 @@
+module Forger
+  autoload :Cleaner, 'forger/cleaner'
+
+  class Clean < Command
+    desc "ami", "Clean until AMI available."
+    long_desc Help.text("clean:ami")
+    option :keep, type: :numeric, default: 2, desc: "Number of images to keep"
+    option :noop, type: :boolean, desc: "Noop or dry-run mode"
+    def ami(query)
+      Cleaner::Ami.new(options.merge(query: query)).clean
+    end
+  end
+end

data/lib/forger/cleaner.rb

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

data/lib/forger/cleaner/ami.rb

@@ -0,0 +1,45 @@
+module Forger::Cleaner
+  class Ami < Forger::Base
+    include Forger::AwsService
+
+    def clean
+      query = @options[:query]
+      keep = @options[:keep] || 2
+      puts "Cleaning out old AMIs with base name: #{@options[:query]}"
+      return if ENV['TEST']
+
+      images = search_ami(query)
+      images = images.sort_by { |i| i.name }.reverse
+      delete_list = images[keep..-1] || []
+      puts "Deleting #{delete_list.size} images."
+      delete_list.each do |i|
+        delete(i)
+      end
+    end
+
+  private
+    def delete(image)
+      message = "Deleting image: #{image.image_id} #{image.name}"
+      if @options[:noop]
+        puts "NOOP: #{message}"
+      else
+        puts message
+        ec2.deregister_image(image_id: image.image_id)
+      end
+    rescue Aws::EC2::Errors::InvalidAMIIDUnavailable
+      # happens when image was just deleted but its still
+      # showing up as available when calling describe_images
+      puts "WARN: #{e.message}"
+    end
+
+    def search_ami(query, owners=["self"])
+      ec2.describe_images(
+        owners: owners,
+        filters: [
+          {name: "name", values: [query]},
+          {name: "state", values: ["available"]}
+        ]
+      ).images
+    end
+  end
+end

data/lib/forger/cli.rb

@@ -0,0 +1,67 @@
+module Forger
+  class CLI < Command
+    class_option :noop, type: :boolean
+    class_option :profile, desc: "profile name to use"
+
+    desc "clean SUBCOMMAND", "clean subcommands"
+    long_desc Help.text(:clean)
+    subcommand "clean", Clean
+
+    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, supported for amazonlinux2 and ubuntu"
+    end
+
+    desc "create NAME", "create ec2 instance"
+    long_desc Help.text(:create)
+    option :ami_name, desc: "when specified, an ami creation script is appended to the user-data script"
+    option :randomize, type: :boolean, desc: "append random characters to end of name"
+    option :source_ami, desc: "override the source image_id in profile"
+    common_options.call
+    def create(name)
+      Create.new(options.merge(name: name)).run
+    end
+
+    desc "ami NAME", "launches instance and uses it create AMI"
+    long_desc Help.text(:ami)
+    common_options.call
+    def ami(name)
+      Ami.new(options.merge(name: name)).run
+    end
+
+    desc "compile", "compiles app/scripts and app/user-data to tmp folder"
+    long_desc Help.text(:compile)
+    option :layout, default: "default", desc: "layout for user_data helper"
+    def compile
+      Script::Compile.new(options).compile_all
+    end
+
+    desc "upload", "compiles and uploads scripts to s3"
+    long_desc Help.text(:upload)
+    option :compile, type: :boolean, default: true, desc: "compile scripts before uploading"
+    def upload
+      Script::Upload.new(options).upload
+    end
+
+    desc "completion *PARAMS", "Prints words for auto-completion."
+    long_desc Help.text("completion")
+    def completion(*params)
+      Completer.new(CLI, *params).run
+    end
+
+    desc "completion_script", "Generates a script that can be eval to setup auto-completion."
+    long_desc Help.text("completion_script")
+    def completion_script
+      Completer::Script.generate
+    end
+
+    desc "version", "prints version"
+    def version
+      puts VERSION
+    end
+  end
+end

data/lib/forger/command.rb

@@ -0,0 +1,67 @@
+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 Forger
+  class Command < Thor
+    class << self
+      def dispatch(m, args, options, config)
+        # Allow calling for help via:
+        #   forger command help
+        #   forger command -h
+        #   forger command --help
+        #   forger command -D
+        #
+        # as well thor's normal way:
+        #
+        #   forger help command
+        help_flags = Thor::HELP_MAPPINGS + ["help"]
+        if args.length > 1 && !(args & help_flags).empty?
+          args -= help_flags
+          args.insert(-2, "help")
+        end
+
+        #   forger version
+        #   forger --version
+        #   forger -v
+        version_flags = ["--version", "-v"]
+        if args.length == 1 && !(args & version_flags).empty?
+          args = ["version"]
+        end
+
+        super
+      end
+
+      # Override command_help to include the description at the top of the
+      # long_description.
+      def command_help(shell, command_name)
+        meth = normalize_command_name(command_name)
+        command = all_commands[meth]
+        alter_command_description(command)
+        super
+      end
+
+      def alter_command_description(command)
+        return unless command
+        long_desc = if command.long_description
+            "#{command.description}\n\n#{command.long_description}"
+          else
+            command.description
+          end
+        command.long_description = long_desc
+      end
+      private :alter_command_description
+    end
+  end
+end