forger 2.0.5 → 3.0.0

data/forger.gemspec

@@ -6,9 +6,9 @@ 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.summary       = "Tool to create AWS ec2 instances"
+  spec.author        = "Tung Nguyen"
+  spec.email         = "tongueroo@gmail.com"
+  spec.summary       = "Create EC2 Instances with preconfigured settings"
   spec.homepage      = "https://github.com/tongueroo/forger"
   spec.license       = "MIT"
 
@@ -19,8 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport"
+  spec.add_dependency "aws-sdk-cloudformation"
   spec.add_dependency "aws-sdk-ec2"
   spec.add_dependency "aws-sdk-s3"
+  spec.add_dependency "cfn-status"
   spec.add_dependency "dotenv"
   spec.add_dependency "filesize"
   spec.add_dependency "hashie"
@@ -28,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rainbow"
   spec.add_dependency "render_me_pretty"
   spec.add_dependency "thor"
+  spec.add_dependency "zeitwerk"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"

data/lib/forger.rb

@@ -4,31 +4,12 @@ require "rainbow/ext/string"
 require "render_me_pretty"
 require "memoist"
 
+require "forger/autoloader"
+Forger::Autoloader.setup
+
 module Forger
-  autoload :Ami, "forger/ami"
-  autoload :AwsService, "forger/aws_service"
-  autoload :Base, "forger/base"
-  autoload :Clean, "forger/clean"
-  autoload :CLI, "forger/cli"
-  autoload :Command, "forger/command"
-  autoload :Completer, "forger/completer"
-  autoload :Completion, "forger/completion"
-  autoload :Config, "forger/config"
-  autoload :Core, "forger/core"
-  autoload :Create, "forger/create"
-  autoload :Destroy, "forger/destroy"
-  autoload :Dotenv, "forger/dotenv"
-  autoload :Help, "forger/help"
-  autoload :Hook, "forger/hook"
-  autoload :Network, "forger/network"
-  autoload :New, "forger/new"
-  autoload :Profile, "forger/profile"
-  autoload :Script, "forger/script"
-  autoload :Sequence, "forger/sequence"
-  autoload :Setting, "forger/setting"
-  autoload :Template, "forger/template"
-  autoload :Wait, "forger/wait"
   extend Core
 end
 
 Forger::Dotenv.load!
+Forger.set_aws_profile!

data/lib/forger/autoloader.rb

@@ -0,0 +1,21 @@
+require "zeitwerk"
+
+module Forger
+  class Autoloader
+    class Inflector < Zeitwerk::Inflector
+      def camelize(basename, _abspath)
+        map = { cli: "CLI", version: "VERSION" }
+        map[basename.to_sym] || super
+      end
+    end
+
+    class << self
+      def setup
+        loader = Zeitwerk::Loader.new
+        loader.inflector = Inflector.new
+        loader.push_dir(File.dirname(__dir__)) # lib
+        loader.setup
+      end
+    end
+  end
+end

data/lib/forger/aws_services.rb

@@ -0,0 +1,22 @@
+require 'aws-sdk-cloudformation'
+require 'aws-sdk-ec2'
+require 'aws-sdk-s3'
+
+module Forger::AwsServices
+  extend Memoist
+
+  def cfn
+    Aws::CloudFormation::Client.new
+  end
+  memoize :cfn
+
+  def ec2
+    Aws::EC2::Client.new
+  end
+  memoize :ec2
+
+  def s3
+    Aws::S3::Client.new
+  end
+  memoize :s3
+end

data/lib/forger/clean.rb

@@ -1,6 +1,4 @@
 module Forger
-  autoload :Cleaner, 'forger/cleaner'
-
   class Clean < Command
     desc "ami", "Clean until AMI available."
     long_desc Help.text("clean:ami")

data/lib/forger/cleaner.rb

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

data/lib/forger/cleaner/ami.rb

@@ -1,6 +1,6 @@
 module Forger::Cleaner
   class Ami < Forger::Base
-    include Forger::AwsService
+    include Forger::AwsServices
 
     def clean
       query = @options[:query]

data/lib/forger/cli.rb

@@ -14,6 +14,12 @@ module Forger
     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, desc: "enable cloudwatch logging, supported for amazonlinux2 and ubuntu"
+      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"
+      option :wait, type: :boolean, default: true, desc: "Wait until the instance is ready and report dns name"
+      option :ssh, type: :boolean, desc: "Ssh into instance immediately after it's ready"
+      option :ssh_user, default: "ec2-user", desc: "User to use to with the ssh option to log into instance"
     end
 
     long_desc Help.text(:new)
@@ -24,12 +30,6 @@ module Forger
 
     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"
-    option :wait, type: :boolean, default: true, desc: "Wait until the instance is ready and report dns name"
-    option :ssh, type: :boolean, desc: "Ssh into instance immediately after it's ready"
-    option :ssh_user, default: "ec2-user", desc: "User to use to with the ssh option to log into instance"
     common_options.call
     def create(name)
       Create.new(options.merge(name: name)).run
@@ -78,5 +78,9 @@ module Forger
     def version
       puts VERSION
     end
+
+    desc "s3 SUBCOMMAND", "s3 subcommands"
+    long_desc Help.text(:s3)
+    subcommand "s3", S3
   end
 end

data/lib/forger/completer.rb

@@ -70,8 +70,6 @@ Auto-completion accounts for each of these type of commands.
 =end
 module Forger
   class Completer
-    autoload :Script, 'forger/completer/script'
-
     def initialize(command_class, *params)
       @params = params
       @current_command = @params[0]

data/lib/forger/core.rb

@@ -3,10 +3,7 @@ require 'yaml'
 
 module Forger
   module Core
-    @@config = nil
-    def config
-      @@config ||= Config.new.data
-    end
+    extend Memoist
 
     def settings
       Setting.new.data
@@ -44,18 +41,37 @@ module Forger
       Base::BUILD_ROOT
     end
 
+    # Overrides AWS_PROFILE based on the Forger.env if set in config/settings.yml
+    # 2-way binding.
+    def set_aws_profile!
+      return if ENV['TEST']
+      return unless File.exist?("#{Forger.root}/config/settings.yml") # for rake docs
+      return unless settings # Only load if within Ufo project and there's a settings.yml
+      data = settings[Forger.env] || {}
+      if data["aws_profile"]
+        puts "Using AWS_PROFILE=#{data["aws_profile"]} from FORGER_ENV=#{Forger.env} in config/settings.yml"
+        ENV['AWS_PROFILE'] = data["aws_profile"]
+      end
+    end
+
+    # Do not use the Setting#data to load the profile because it can cause an
+    # infinite loop then if we decide to use Forger.env from within settings class.
+    def settings
+      path = "#{Forger.root}/config/settings.yml"
+      return {} unless File.exist?(path)
+      YAML.load_file(path)
+    end
+    memoize :settings
+
     private
     # Do not use the Setting class to load the profile because it can cause an
     # infinite loop then if we decide to use Forger.env from within settings class.
     def env_from_profile(aws_profile)
-      settings_path = "#{Forger.root}/config/settings.yml"
-      return unless File.exist?(settings_path)
-
-      data = YAML.load_file(settings_path)
-      env = data.find do |_env, setting|
-        setting ||= {}
-        profiles = setting['aws_profiles']
-        profiles && profiles.include?(aws_profile)
+      return unless settings
+      env = settings.find do |_env, settings|
+        settings ||= {}
+        profiles = settings['aws_profile']
+        profiles && profiles == aws_profile
       end
       env.first if env
     end

data/lib/forger/create.rb

@@ -3,12 +3,7 @@ require 'active_support/core_ext/hash'
 
 module Forger
   class Create < Base
-    autoload :Params, "forger/create/params"
-    autoload :ErrorMessages, "forger/create/error_messages"
-    autoload :Waiter, "forger/create/waiter"
-    autoload :Info, "forger/create/info"
-
-    include AwsService
+    include AwsServices
     include ErrorMessages
 
     def run
@@ -28,7 +23,7 @@ module Forger
 
       instance_id = resp.instances.first.instance_id
       info.spot(instance_id)
-      puts "EC2 instance #{@name} created: #{instance_id} 🎉"
+      puts "EC2 instance with profile #{@name.color(:green)} created: #{instance_id} 🎉"
       puts "Visit https://console.aws.amazon.com/ec2/home to check on the status"
       info.cloudwatch(instance_id)
 
@@ -41,23 +36,7 @@ module Forger
       handle_ec2_service_error!(e)
     end
 
-    # Configured by config/settings.yml.
-    # Example: config/settings.yml:
-    #
-    # Format 1: Simple String
-    #
-    #   development:
-    #     s3_folder: mybucket/path/to/folder
-    #
-    # Format 2: Hash
-    #
-    #   development:
-    #     s3_folder:
-    #       default: mybucket/path/to/folder
-    #       dev_profile1: mybucket/path/to/folder
-    #       dev_profile1: another-bucket/storage/path
     def sync_scripts_to_s3
-      return unless Forger.settings["s3_folder"]
       upload = Script::Upload.new(@options)
       return if upload.empty?
       upload.run

data/lib/forger/create/info.rb

@@ -1,6 +1,6 @@
 class Forger::Create
   class Info
-    include Forger::AwsService
+    include Forger::AwsServices
 
     attr_reader :params
     def initialize(options, params)
@@ -16,8 +16,6 @@ class Forger::Create
     end
 
     def spot(instance_id)
-      puts "Max monthly price: $#{monthly_spot_price}/mo" if monthly_spot_price
-
       retries = 0
       begin
         resp = ec2.describe_instances(instance_ids: [instance_id])
@@ -33,7 +31,15 @@ class Forger::Create
         end
       end
 
-      spot_id = resp.reservations.first.instances.first.spot_instance_request_id
+      reservation = resp.reservations.first
+      # Super edge case when reserverations not immediately found yet
+      until reservation
+        reservation = resp.reservations.first
+        seconds = 0.5
+        puts "Reserveration not found. Sleeping for #{seconds} and will try again."
+        sleep seconds
+      end
+      spot_id = reservation.instances.first.spot_instance_request_id
       return unless spot_id
 
       puts "Spot instance request id: #{spot_id}"

data/lib/forger/create/waiter.rb

@@ -1,6 +1,6 @@
 class Forger::Create
   class Waiter < Forger::Base
-    include Forger::AwsService
+    include Forger::AwsServices
 
     def wait
       @instance_id = @options[:instance_id]

data/lib/forger/destroy.rb

@@ -1,6 +1,6 @@
 module Forger
   class Destroy < Base
-    include AwsService
+    include AwsServices
 
     def run(instance_id)
       puts "Destroying #{instance_id}"

data/lib/forger/help/upload.md

@@ -2,16 +2,4 @@ Examples:
 
     $ forger upload
 
-Compiles the app/scripts and app/user_data files to the tmp folder. Then uploads the files to an s3 bucket that is configured in config/settings.yml.  Example s3_folder setting:
-
-```yaml
-development:
-  # Format 1: Simple String
-  s3_folder: my-bucket/folder # enables auto sync to s3
-
-  # Format 2: Hash
-  # s3_folder:
-  #   default: mybucket/path/to/folder
-  #   dev_profile1: mybucket/path/to/folder
-  #   dev_profile1: another-bucket/storage/path
-```
+Compiles the `app/scripts` and `app/user_data` files to the tmp folder. Then uploads the files to the forger managed s3 bucket.

data/lib/forger/network.rb

@@ -2,7 +2,7 @@
 # If no @vpc_id is provided to the initializer then the default vpc is used.
 module Forger
   class Network
-    include Forger::AwsService
+    include Forger::AwsServices
     extend Memoist
 
     def initialize(vpc_id)
@@ -20,7 +20,7 @@ module Forger
         default_vpc.vpc_id
       else
         puts "A default vpc was not found in this AWS account and region.".color(:red)
-        puts "Because there is no default vpc, please specify the --vpc-id option.  More info: http://ufoships.com/reference/ufo-init/"
+        puts "Because there is no default vpc, please specify the --vpc-id option."
         exit 1
       end
     end

data/lib/forger/new.rb

@@ -12,17 +12,16 @@ module Forger
         [:git, type: :boolean, default: true, desc: "Git initialize the project"],
         [:iam, desc: "iam_instance_profile to use in the profiles/default.yml"],
         [:key_name, desc: "key name to use with launched instance in profiles/default.yml"],
-        [:s3_folder, desc: "s3_folder setting for config/settings.yml."],
-        [:security_group, desc: "Security group to use. For config/development.yml network settings."],
-        [:subnet, desc: "Subnet to use. For config/development.yml network settings."],
-        [:vpc_id, desc: "Vpc id. For config/development.yml network settings. Will use default sg and subnet"],
+        [:security_group, desc: "Security group to use. For config/variables/development.rb network settings."],
+        [:subnet, desc: "Subnet to use. For config/variables/development.rb network settings."],
+        [:vpc_id, desc: "Vpc id. For config/variables/development.rb network settings. Will use default sg and subnet"],
       ]
     end
 
     cli_options.each do |args|
-      class_option *args
+      class_option(*args)
     end
-    
+
     def configure_network_settings
       return if ENV['TEST']
 

data/lib/forger/profile.rb

@@ -23,10 +23,23 @@ module Forger
     def load_profile(file)
       return {} unless File.exist?(file)
 
+      base_file, base_data = profile_file(:base), {}
+      if File.exist?(base_file)
+        puts "Detected profiles/base.yml"
+        base_data = yaml_load(base_file)
+      end
+
       puts "Using profile: #{file}".color(:green)
+      data = yaml_load(file)
+      data = base_data.merge(data)
+      data.has_key?("run_instances") ? data["run_instances"] : data
+    end
+
+    def yaml_load(file)
       text = RenderMePretty.result(file, context: context)
       begin
-        data = YAML.load(text)
+        data = YAML.load(text) # data
+        data ? data : {} # in case the file is empty
       rescue Psych::SyntaxError => e
         tmp_file = file.sub("profiles", Forger.build_root)
         FileUtils.mkdir_p(File.dirname(tmp_file))
@@ -36,10 +49,9 @@ module Forger
         puts "ERROR: #{e.message}"
         exit 1
       end
-      data ? data : {} # in case the file is empty
-      data.has_key?("run_instances") ? data["run_instances"] : data
     end
 
+
     # Determines a valid profile_name. Falls back to default
     def profile_name
       # allow user to specify the path also

data/lib/forger/s3.rb

@@ -0,0 +1,23 @@
+module Forger
+  class S3 < Command
+    desc "deploy", "deploys forger managed s3 bucket"
+    long_desc Help.text("s3/deploy")
+    def deploy
+      Bucket.new(options).deploy
+    end
+
+    desc "show", "shows forger managed s3 bucket"
+    long_desc Help.text("s3/show")
+    option :sure, type: :boolean, desc: "Bypass are you sure prompt"
+    def show
+      Bucket.new(options).show
+    end
+
+    desc "delete", "deletes forger managed s3 bucket"
+    long_desc Help.text("s3/delete")
+    option :sure, type: :boolean, desc: "Bypass are you sure prompt"
+    def delete
+      Bucket.new(options).delete
+    end
+  end
+end