forger 1.6.0 → 2.0.0

data/lib/forger/core.rb

@@ -12,6 +12,14 @@ module Forger
       Setting.new.data
     end
 
+    # cloudwatch cli option takes higher precedence than when its set in the
+    # config/settings.yml file.
+    def cloudwatch_enabled?(options)
+      !options[:cloudwatch].nil? ?
+        options[:cloudwatch] : # options can use symbols because this the options hash from Thor
+        settings["cloudwatch"] # settings uses strings as keys
+    end
+
     def root
       path = ENV['FORGER_ROOT'] || '.'
       Pathname.new(path)

data/lib/forger/create.rb

@@ -58,7 +58,9 @@ module Forger
     #       dev_profile1: another-bucket/storage/path
     def sync_scripts_to_s3
       return unless Forger.settings["s3_folder"]
-      Script::Upload.new(@options).run
+      upload = Script::Upload.new(@options)
+      return if upload.empty?
+      upload.run
     end
 
     # params are main derived from profile files

data/lib/forger/create/error_messages.rb

@@ -16,8 +16,8 @@ EOL
     end
 
     # Examples:
-    #   Aws::EC2::Errors::InvalidGroupNotFound => invalid_group_not_found!
-    #   Aws::EC2::Errors::InvalidParameterCombination => invalid_parameter_combination!
+    #   Aws::EC2::Errors::InvalidGroupNotFound => invalid_group_not_found
+    #   Aws::EC2::Errors::InvalidParameterCombination => invalid_parameter_combination
     def map_exception_to_method(exception)
       class_name = File.basename(exception.class.to_s).sub(/.*::/,'')
       class_name.underscore # method_name

data/lib/forger/create/info.rb

@@ -16,6 +16,8 @@ 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])
@@ -23,14 +25,27 @@ class Forger::Create
         retries += 1
         puts "Aws::EC2::Errors::InvalidInstanceIDNotFound error. Retry: #{retries}"
         sleep 2**retries
-        retry if retries <= 3
+        if retries <= 3
+          retry
+        else
+          puts "Unable to find lauched spot instance"
+          return
+        end
       end
+
       spot_id = resp.reservations.first.instances.first.spot_instance_request_id
       return unless spot_id
 
       puts "Spot instance request id: #{spot_id}"
     end
 
+    def monthly_spot_price
+      max_price = @params[:instance_market_options][:spot_options][:max_price].to_f
+      monthly_price = max_price * 24 * 30
+      "%.2f" % monthly_price
+    rescue
+    end
+
     def launch_template
       launch_template = params[:launch_template]
       return unless launch_template
@@ -53,7 +68,7 @@ class Forger::Create
     end
 
     def cloudwatch(instance_id)
-      return unless @options[:cloudwatch]
+      return unless Forger.cloudwatch_enabled?(@options)
 
       region = cloudwatch_log_region
       stream = "#{instance_id}/var/log/cloud-init-output.log"
@@ -68,7 +83,7 @@ class Forger::Create
         puts "  #{cw_terminate_log}"
       end
 
-      puts "Note: It takes a little time for the instance to launch and report logs."
+      puts "Note: It takes at least a few minutes for the instance to launch and report logs."
 
       paste_command = show_cw ? cw_init_log : url
       add_to_clipboard(paste_command)

data/lib/forger/create/waiter.rb

@@ -4,7 +4,7 @@ class Forger::Create
 
     def wait
       @instance_id = @options[:instance_id]
-      handle_wait if @options[:wait]
+      handle_wait if wait?
       handle_ssh if @options[:ssh]
     end
 
@@ -23,7 +23,14 @@ class Forger::Create
       i = resp.reservations.first.instances.first
       puts "Instance #{@instance_id} is ready"
       dns = i.public_dns_name ? i.public_dns_name : 'nil'
-      puts "Instance public_dns_name: #{dns}"
+      puts "Instance public dns name: #{dns}"
+
+      if i.public_dns_name && !@options[:ssh]
+        command = build_ssh_command(i.public_dns_name)
+        puts "Ssh command below. Note the user might be different. You can specify --ssh-user=USER.  You can also ssh automatically into the instance with the --ssh flag."
+        display_ssh(command)
+      end
+
       i
     end
 
@@ -35,11 +42,16 @@ class Forger::Create
       end
 
       command = build_ssh_command(instance.public_dns_name)
-      puts "=> #{command.join(' ')}".colorize(:green)
+      display_ssh(command)
       retry_until_success(command)
       Kernel.exec(*command) unless @options[:noop]
     end
 
+    def wait?
+      return false if @options[:ssh]
+      @options[:wait]
+    end
+
     def build_ssh_command(host)
       user = @options[:ssh_user] || "ec2-user"
       [
@@ -49,13 +61,17 @@ class Forger::Create
       ].compact
     end
 
+    def display_ssh(command)
+      puts "=> #{command.join(' ')}".colorize(:green)
+    end
+
     def retry_until_success(*command)
       retries = 0
       uptime = command + ['uptime', '2>&1']
       uptime = uptime.join(' ')
       out = `#{uptime}`
       while out !~ /load average/ do
-        puts "Can't ssh into the server yet.  Retrying until success." if retries == 0
+        puts "Can't ssh into the server yet.  Retrying until success. (Timeout 10m)" if retries == 0
         print '.'
         retries += 1
         if retries > 600 # Timeout after 10 minutes

data/lib/forger/help/compile.md

@@ -2,4 +2,4 @@ Examples:
 
     $ forger compile
 
-Compiles app/scripts and app/user-data files to the tmp folder. Useful for inspection.
+Compiles app/scripts and app/user_data files to the tmp folder. Useful for inspection.

data/lib/forger/help/create.md

@@ -15,3 +15,9 @@ You can also tell forger to ssh into the instance immediately after it's ready w
     forger create my-instance --ssh # default is to login as ec2-user
     forger create my-instance --ssh --ssh-user ubuntu
     SSH_OPTIONS "-A" forger create my-instance --ssh --ssh-user ubuntu
+
+## CloudWatch support
+
+There is experimental support for CloudWatch logs.  When using the `--cloudwatch` flag, code is added to the very beginning of the user-data script so that logs of the instance are sent to cloudwatch.  Example:
+
+    forger create my-instance --cloudwatch

data/lib/forger/help/new.md

@@ -0,0 +1,33 @@
+## Examples
+
+    forger new ec2 # project name is ec2 here
+    cd ec2
+    forger create box --noop # dry-run
+    forger create box # live-run
+
+Another project name:
+
+    forger new projectname
+
+## S3 Folder Option
+
+    forger new --s3 folder my-s3-bucket/my-folder
+
+## VPC Option
+
+    forger new --vpc-id vpc-123
+
+When the vpc-id option is not provided, forger uses the default vpc.
+
+You can also set the security group and subnet id values explicitly instead:
+
+    forger new --subnet subnet-123
+    forger new --security-group sg-123
+
+## Iam Instance Profile
+
+    forger new --iam MyIamProfile
+
+## Useful Combo Starting Options
+
+    forger new ec2 --security-group sg-123 --iam MyIamProfile --key-name default --s3-folder my-s3-bucket/my-folder

data/lib/forger/help/upload.md

@@ -2,7 +2,7 @@ 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:
+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:

data/lib/forger/hook.rb

@@ -21,7 +21,7 @@ module Forger
     end
 
     def sh(command)
-      puts "=> #{command}".colorize(:cyan)
+      puts "=> #{command}".colorize(:green)
       success = system(command)
       abort("Command failed") unless success
     end

data/lib/forger/network.rb

@@ -0,0 +1,48 @@
+# Provides access to default network settings for a vpc: subnets and security_group
+# If no @vpc_id is provided to the initializer then the default vpc is used.
+module Forger
+  class Network
+    include Forger::AwsService
+    extend Memoist
+
+    def initialize(vpc_id)
+      @vpc_id = vpc_id
+    end
+
+    def vpc_id
+      return @vpc_id if @vpc_id
+
+      resp = ec2.describe_vpcs(filters: [
+        {name: "isDefault", values: ["true"]}
+      ])
+      default_vpc = resp.vpcs.first
+      if default_vpc
+        default_vpc.vpc_id
+      else
+        puts "A default vpc was not found in this AWS account and region.".colorize(:red)
+        puts "Because there is no default vpc, please specify the --vpc-id option.  More info: http://ufoships.com/reference/ufo-init/"
+        exit 1
+      end
+    end
+    memoize :vpc_id
+
+    # all subnets
+    def subnet_ids
+      resp = ec2.describe_subnets(filters: [
+        {name: "vpc-id", values: [vpc_id]}
+      ])
+      resp.subnets.map(&:subnet_id).sort
+    end
+    memoize :subnet_ids
+
+    # default security group
+    def security_group_id
+      resp = ec2.describe_security_groups(filters: [
+        {name: "vpc-id", values: [vpc_id]},
+        {name: "group-name", values: ["default"]}
+      ])
+      resp.security_groups.first.group_id
+    end
+    memoize :security_group_id
+  end
+end

data/lib/forger/new.rb

@@ -0,0 +1,75 @@
+module Forger
+  class New < Sequence
+    argument :project_name
+
+    # Ugly, but when the class_option is only defined in the Thor::Group class
+    # it doesnt show up with cli-template new help :(
+    # If anyone knows how to fix this let me know.
+    # Also options from the cli can be pass through to here
+    def self.cli_options
+      [
+        [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files."],
+        [: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"],
+      ]
+    end
+
+    cli_options.each do |args|
+      class_option *args
+    end
+    
+    def configure_network_settings
+      return if ENV['TEST']
+
+      network = Network.new(@options[:vpc_id]) # used for default settings
+      @subnet = @options[:subnet] || network.subnet_ids.first
+      @security_group = @options[:security_group] || network.security_group_id
+    end
+
+    def create_project
+      copy_project
+      destination_root = "#{Dir.pwd}/#{project_name}"
+      self.destination_root = destination_root
+      FileUtils.cd("#{Dir.pwd}/#{project_name}")
+    end
+
+    def make_executable
+      chmod("exe", 0755 & ~File.umask, verbose: false) if File.exist?("exe")
+    end
+
+    def bundle_install
+      Bundler.with_clean_env do
+        system("BUNDLE_IGNORE_CONFIG=1 bundle install")
+      end
+    end
+
+    def git_init
+      return if !options[:git]
+      return unless git_installed?
+      return if File.exist?(".git") # this is a clone repo
+
+      run("git init")
+      run("git add .")
+      run("git commit -m 'first commit'")
+    end
+
+    def user_message
+      puts <<-EOL
+#{"="*64}
+Congrats 🎉 You have successfully generated a starter forger project.
+
+Test the CLI:
+
+  cd #{project_name}
+  forger create box --noop # dry-run to see the tmp/user-data.txt script
+  forger create box # live-run
+  forger create box --ssh
+EOL
+    end
+  end
+end

data/lib/forger/script.rb

@@ -41,7 +41,7 @@ module Forger
   private
     def load_template(name)
       template = IO.read(File.expand_path("script/templates/#{name}", File.dirname(__FILE__)))
-      text = ERB.new(template, nil, "-").result(binding)
+      ERB.new(template, nil, "-").result(binding) # text
     end
   end
 end

data/lib/forger/script/compress.rb

@@ -12,7 +12,7 @@ class Forger::Script
 
     def create_tarball
       # https://apple.stackexchange.com/questions/14980/why-are-dot-underscore-files-created-and-how-can-i-avoid-them
-      sh "cd #{BUILD_ROOT}/app && dot_clean ." if system("type dot_clean > /dev/null")
+      sh "cd #{BUILD_ROOT}/app && dot_clean ." if system("type dot_clean > /dev/null 2>&1")
 
       # https://serverfault.com/questions/110208/different-md5sums-for-same-tar-contents
       # Using tar czf directly results in a new m5sum each time because the gzip

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

@@ -36,6 +36,26 @@ function extract_forger_scripts() {
     folder="${folder#v}" # remove leading v character
     folder="forger-$folder" # IE: forger-1.0.0
 
+    # install wget if not installed
+    if ! type wget > /dev/null 2>&1 ; then
+      if type yum > /dev/null 2>&1 ; then
+        yum install -y wget
+      elif type apt-get > /dev/null 2>&1 ; then
+        apt-get update
+        apt-get install -y wget
+      fi
+    fi
+
+    # install tar if not installed
+    if ! type tar > /dev/null 2>&1 ; then
+      if type yum > /dev/null 2>&1 ; then
+        yum install -y tar
+      elif type apt-get > /dev/null 2>&1 ; then
+        apt-get update
+        apt-get install -y tar
+      fi
+    fi
+
     wget "$url"
     tar zxf "$filename"
 

data/lib/forger/script/upload.rb

@@ -38,11 +38,25 @@ class Forger::Script
       obj.upload_file(tarball_path)
     rescue Aws::S3::Errors::PermanentRedirect => e
       puts "ERROR: #{e.class} #{e.message}".colorize(:red)
-      puts "The bucket you are trying to upload to is in a different region than the region the instance is being launched in."
+      puts "The bucket you are trying to upload scripts to is in a different region than the region the instance is being launched in."
       puts "You must configured FORGER_S3_ENDPOINT env variable to prevent this error. Example:"
       puts "  FORGER_S3_ENDPOINT=https://s3.us-west-2.amazonaws.com"
       puts "Check your ~/.aws/config for the region being used for the ec2 instance."
       exit 1
+    rescue Aws::S3::Errors::AccessDenied, Aws::S3::Errors::AllAccessDisabled
+      e = $!
+      puts "ERROR: #{e.class} #{e.message}".colorize(:red)
+      puts "You do not have permission to upload scripts to this bucket: #{bucket_name}.  Are you sure the right bucket is configured?"
+      if ENV['AWS_PROFILE']
+        puts "Also maybe check your AWS_PROFILE env. Current AWS_PROFILE=#{ENV['AWS_PROFILE']}"
+      end
+      exit 1
+    end
+
+    def empty?
+      Dir.glob("#{Forger.root}/app/scripts/**/*").select do |path|
+        File.file?(path)
+      end.empty?
     end
 
     def tarball_path

data/lib/forger/scripts/auto_terminate/functions.sh

@@ -19,7 +19,8 @@ function terminate_instance() {
   INSTANCE_ID=$(wget -q -O - http://169.254.169.254/latest/meta-data/instance-id)
   SPOT_INSTANCE_REQUEST_ID=$(aws ec2 describe-instances --instance-ids "$INSTANCE_ID" | jq -r '.Reservations[].Instances[].SpotInstanceRequestId')
 
-  if [ -n "$SPOT_INSTANCE_REQUEST_ID" ]; then
+  # jq returns null
+  if [ "$SPOT_INSTANCE_REQUEST_ID" != "null" ]; then
     cancel_spot_request
   fi
   aws ec2 terminate-instances --instance-ids "$INSTANCE_ID"

data/lib/forger/scripts/auto_terminate/functions/amzn2.sh

@@ -0,0 +1,10 @@
+#!/bin/bash -eux
+function schedule_termination() {
+  chmod +x /etc/rc.d/rc.local
+  echo "/opt/forger/auto_terminate.sh after_ami >> /var/log/auto-terminate.log 2>&1" >> /etc/rc.d/rc.local
+}
+
+function unschedule_termination() {
+  grep -v auto_terminate.sh /etc/rc.d/rc.local > /etc/rc.d/rc.local.tmp
+  mv /etc/rc.d/rc.local.tmp /etc/rc.d/rc.local
+}