forger 1.5.0

data/lib/forger/script/compress.rb

@@ -0,0 +1,62 @@
+require 'fileutils'
+
+class Forger::Script
+  class Compress < Forger::Base
+    def compress
+      reset
+      puts "Tarballing #{BUILD_ROOT}/app/scripts folder to scripts.tgz".colorize(:green)
+      tarball_path = create_tarball
+      save_scripts_info(tarball_path)
+      puts "Tarball created at #{tarball_path}"
+    end
+
+    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")
+
+      # 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
+      # timestamp is included.  So using:  tar -c ... | gzip -n
+      sh "cd #{BUILD_ROOT}/app && tar -c scripts | gzip -n > scripts.tgz" # temporary app/scripts.tgz file
+
+      rename_with_md5!
+    end
+
+    def clean
+      FileUtils.rm_f("#{BUILD_ROOT}/scripts/scripts-#{md5sum}.tgz")
+    end
+
+    # Apppend a md5 to file after it's been created and moves it to
+    # output/scripts/scripts-[MD5].tgz
+    def rename_with_md5!
+      md5_path = "#{BUILD_ROOT}/scripts/scripts-#{md5sum}.tgz"
+      FileUtils.mkdir_p(File.dirname(md5_path))
+      FileUtils.mv("#{BUILD_ROOT}/app/scripts.tgz", md5_path)
+      md5_path
+    end
+
+    def save_scripts_info(scripts_name)
+      FileUtils.mkdir_p(File.dirname(SCRIPTS_INFO_PATH))
+      IO.write(SCRIPTS_INFO_PATH, scripts_name)
+    end
+
+    # cache this because the file will get removed
+    def md5sum
+      @md5sum ||= Digest::MD5.file("#{BUILD_ROOT}/app/scripts.tgz").to_s[0..7]
+    end
+
+    def sh(command)
+      puts "=> #{command}"
+      system command
+    end
+
+    # Only avaialble after script has been built.
+    def scripts_name
+      IO.read(SCRIPTS_INFO_PATH).strip
+    end
+
+    def reset
+      FileUtils.rm_f(SCRIPTS_INFO_PATH)
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+#!/bin/bash -eux
+
+# Create AMI Bundle
+AMI_NAME="<%= @ami_name %>"
+INSTANCE_ID=$(wget -q -O - http://169.254.169.254/latest/meta-data/instance-id)
+REGION=$(aws configure get region)
+# Note this will cause the instance to reboot.  Not using the --no-reboot flag
+# to ensure consistent AMI creation.
+SOURCE_AMI_ID=$(wget -q -O - http://169.254.169.254/latest/meta-data/ami-id)
+echo "$SOURCE_AMI_ID" > /var/log/source-ami-id.txt
+mkdir -p /opt/forger/data
+aws ec2 create-image --name "$AMI_NAME" --instance-id "$INSTANCE_ID" --region "$REGION" > /opt/forger/data/ami-id.txt

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

@@ -0,0 +1,11 @@
+#!/bin/bash -eux
+
+/opt/forger/auto_terminate/setup.sh
+
+<% if @options[:auto_terminate] -%>
+  <% if @options[:ami_name] %>
+/opt/forger/auto_terminate.sh later
+  <% else %>
+/opt/forger/auto_terminate.sh now # terminate immediately
+  <% end -%>
+<% end -%>

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

@@ -0,0 +1,5 @@
+#!/bin/bash -eux
+
+/opt/forger/auto_terminate/setup.sh
+
+/opt/forger/auto_terminate.sh after_timeout

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

@@ -0,0 +1,3 @@
+#!/bin/bash -eux
+
+/opt/forger/cloudwatch.sh ec2

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

@@ -0,0 +1,48 @@
+#!/bin/bash -eux
+
+# Downloads and extract the scripts.
+# The extracted folder from github looks like this:
+#   branch-name.tar.gz => forger-branch-name
+#   master.tar.gz => forger-master
+#   v1.0.0.tar.gz => forger-1.0.0
+function extract_forger_scripts() {
+  local temp_folder
+  local url
+  local filename
+
+  rm -rf /opt/forger   # clean start
+
+  temp_folder="/opt/forger-temp"
+  rm -rf "$temp_folder"
+  mkdir -p "$temp_folder"
+
+  (
+    cd "$temp_folder"
+
+  <%
+    # Examples:
+    #   AWS_EC2_CODE=v1.0.0
+    #   AWS_EC2_CODE=master
+    #   AWS_EC2_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 ||= "v#{Forger::VERSION}"
+  %>
+    url="https://github.com/tongueroo/forger/archive/<%= code_version %>.tar.gz"
+    filename=$(basename "$url")
+    folder="${filename%.tar.gz}" # remove extension
+    folder="${folder#v}" # remove leading v character
+    folder="forger-$folder" # IE: forger-1.0.0
+
+    wget "$url"
+    tar zxf "$filename"
+
+    mv "$temp_folder/$folder/lib/forger/scripts" /opt/forger
+    rm -rf "$temp_folder"
+    chmod a+x -R /opt/forger
+  )
+}
+
+extract_forger_scripts

data/lib/forger/script/upload.rb

@@ -0,0 +1,99 @@
+require 'filesize'
+require 'aws-sdk-s3'
+require 'fileutils'
+
+# Class for forger upload command
+class Forger::Script
+  class Upload < Forger::Base
+    def initialize(options={})
+      @options = options
+      @compile = @options[:compile] ? @options[:compile] : true
+    end
+
+    def run
+      compiler.compile_scripts if @compile
+      compressor.compress
+      upload(tarball_path)
+      compressor.clean
+      compiler.clean if @compile and Forger.settings["compile_clean"]
+    end
+
+    def upload(tarball_path)
+      puts "Uploading scripts.tgz (#{filesize}) to #{s3_dest}".colorize(:green)
+      obj = s3_resource.bucket(bucket_name).object(key)
+      start_time = Time.now
+      if @options[:noop]
+        puts "NOOP: Not uploading file to s3"
+      else
+        obj.upload_file(tarball_path)
+      end
+      time_took = pretty_time(Time.now-start_time).colorize(:green)
+      puts "Time to upload code to s3: #{time_took}"
+    end
+
+    def tarball_path
+      IO.read(SCRIPTS_INFO_PATH).strip
+    end
+
+    def filesize
+      Filesize.from(File.size(tarball_path).to_s + " B").pretty
+    end
+
+    def s3_dest
+      "s3://#{bucket_name}/#{key}"
+    end
+
+    def key
+      # Example key: ec2/development/scripts/scripts-md5
+      "#{dest_folder}/#{File.basename(tarball_path)}"
+    end
+
+    # Example:
+    #   s3_folder: s3://infra-bucket/ec2
+    #   bucket_name: infra-bucket
+    def bucket_name
+      s3_folder.sub('s3://','').split('/').first
+    end
+
+    # Removes s3://bucket-name and adds Forger.env. Example:
+    #   s3_folder: s3://infra-bucket/ec2
+    #   bucket_name: ec2/development/scripts
+    def dest_folder
+      folder = s3_folder.sub('s3://','').split('/')[1..-1].join('/')
+      "#{folder}/#{Forger.env}/scripts"
+    end
+
+    # s3_folder example:
+    def s3_folder
+      Forger.settings["s3_folder"]
+    end
+
+    def s3_resource
+      @s3_resource ||= Aws::S3::Resource.new
+    end
+
+    # http://stackoverflow.com/questions/4175733/convert-duration-to-hoursminutesseconds-or-similar-in-rails-3-or-ruby
+    def pretty_time(total_seconds)
+      minutes = (total_seconds / 60) % 60
+      seconds = total_seconds % 60
+      if total_seconds < 60
+        "#{seconds.to_i}s"
+      else
+        "#{minutes.to_i}m #{seconds.to_i}s"
+      end
+    end
+
+    def sh(command)
+      puts "=> #{command}"
+      system command
+    end
+
+    def compiler
+      @compiler ||= Compile.new(@options)
+    end
+
+    def compressor
+      @compressor ||= Compress.new(@options)
+    end
+  end
+end

data/lib/forger/scripts/auto_terminate.sh

@@ -0,0 +1,14 @@
+#!/bin/bash -exu
+
+if [ $# -eq 0 ]; then
+  command=$(basename "$0")
+  echo "Usage: $command WHEN"
+  echo "Examples:"
+  echo "  $command now"
+  echo "  $command later"
+  exit 1
+fi
+WHEN=$1 # now or later
+
+source /opt/forger/auto_terminate/functions.sh
+terminate "$WHEN"

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

@@ -0,0 +1,18 @@
+#!/bin/bash -exu
+
+# This is another copy the /opt/forger/auto_terminate.sh script because the
+# /opt/forger/auto_terminate.sh also gets removed when it gets called.  Specifically,
+# it gets gets removed when "terminate after_ami" is called.
+
+# There's this extra script that terminates after a timeout because sometimes:
+#   1. the script stalls: IE: aws ec2 wait image-available and a custom wait_ami
+#      does this.
+#   2. the user_data script breaks and stops before finishing, never reaching
+#      the terminate_later or terminate_now functions.
+#
+
+source /opt/forger/auto_terminate/functions.sh
+# remove itself since at jobs survive reboots and if the ami gets created
+# successfully we do not want this to be captured as part of the ami
+rm -f /opt/forger/auto_terminate/after_timeout.sh
+terminate now # hard code to now since only gets called via an at job

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

@@ -0,0 +1,130 @@
+#!/bin/bash -eux
+
+# Key is that instance will not be terminated if source image is the same as the
+# original image id.
+function terminate_instance() {
+  local SOURCE_AMI_ID
+  local AMI_ID
+
+  SOURCE_AMI_ID=$(curl -s http://169.254.169.254/latest/meta-data/ami-id)
+  AMI_ID=$(cat /opt/forger/data/ami-id.txt | jq -r '.ImageId')
+  if [ "$SOURCE_AMI_ID" = "$AMI_ID" ]; then
+    echo "The source ami and ami_id are the same: $AMI_ID"
+    echo "Will not terminate the instance for this case."
+    echo "This case can happen when an /etc/rc.local script to auto-terminate the "
+    echo "instance was capture from a previous AMI build."
+    return
+  fi
+
+  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
+    cancel_spot_request
+  fi
+  aws ec2 terminate-instances --instance-ids "$INSTANCE_ID"
+}
+
+# on-demand instance example:
+# $ aws ec2 describe-instances --instance-ids i-09482b1a6e330fbf7 | jq '.Reservations[].Instances[].SpotInstanceRequestId'
+# null
+# spot instance example:
+# $ aws ec2 describe-instances --instance-ids i-08318bb7f33c216bd | jq '.Reservations[].Instances[].SpotInstanceRequestId'
+# "sir-dzci5wsh"
+function cancel_spot_request() {
+  aws ec2 cancel-spot-instance-requests --spot-instance-request-ids "$SPOT_INSTANCE_REQUEST_ID"
+}
+
+# When image doesnt exist at all, an empty string is returned.
+function ami_state() {
+  local ami_id
+  ami_id=$1
+  aws ec2 describe-images --image-ids "$ami_id" --owners self | jq -r '.Images[].State'
+}
+
+function wait_for_ami() {
+  local name
+  name=$1
+
+  local x
+  local state
+  x=0
+
+  state=$(ami_state "$name")
+  while [ "$x" -lt 10 ] && [ "$state" != "available" ]; do
+    x=$((x+1))
+
+    state=$(ami_state "$name")
+    echo "state $state"
+    echo "sleeping for 60 seconds... times out at 10 minutes total"
+
+    type sleep
+    sleep 60
+  done
+
+  echo "final state $state"
+}
+
+function terminate() {
+  local when
+  when=$1
+
+  export PATH=/usr/local/bin:$PATH # for jq
+
+  if [ "$when" == "later" ]; then
+    terminate_later
+  elif [ "$when" == "after_ami" ]; then
+    terminate_after_ami
+  elif [ "$when" == "after_timeout" ]; then
+    terminate_after_timeout
+  else
+    terminate_now
+  fi
+}
+
+function terminate_later() {
+  schedule_termination
+}
+
+# This gets set up at the very beginning of the user_data script.  This ensures
+# that after a 45 minute timeout the instance will get cleaned up and terminated.
+function terminate_after_timeout() {
+  rm -f /opt/forger/data/ami-id.txt # rm file possible stale file from previous ami
+
+  # Remove all old at jobs.
+  # Assume all at job are previous after_timeout.sh job from previous AMI.
+  # Note: Each new at job increments the id by 1.  So each AMI will have a different
+  # at job number.
+  for i in $(atq | awk '{print $1}') ; do
+    at -r $i
+  done
+  echo "/opt/forger/auto_terminate/after_timeout.sh now" | at now + 45 minutes
+}
+
+function terminate_after_ami() {
+  local AMI_ID
+
+  unschedule_termination
+  AMI_ID=$(cat /opt/forger/data/ami-id.txt | jq -r '.ImageId')
+  if [ -n "$AMI_ID" ]; then
+    # wait for the ami to be successfully created before terminating the instance
+    # https://docs.aws.amazon.com/cli/latest/reference/ec2/wait/image-available.html
+    # It will poll every 15 seconds until a successful state has been reached. This will exit with a return code of 255 after 40 failed checks.
+    # so it'll wait for 10 mins max
+    # aws ec2 wait image-available --image-ids "$AMI_ID" --owners self
+
+    # For some reason aws ec2 wait image-available didnt work for amazonlinux2
+    # so using a custom version
+    wait_for_ami "$AMI_ID"
+  fi
+
+  terminate_instance
+}
+
+function terminate_now() {
+  terminate_instance
+}
+
+source "/opt/forger/shared/functions.sh"
+os=$(os_name)
+source "/opt/forger/auto_terminate/functions/${os}.sh"

data/lib/forger/scripts/auto_terminate/functions/amazonlinux2.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
+}

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

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

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

@@ -0,0 +1,31 @@
+#!/bin/bash -eux
+function install_jq() {
+  if ! type jq > /dev/null ; then
+    wget "https://github.com/stedolan/jq/releases/download/jq-1.5/jq-linux64"
+    mv jq-linux64 /usr/local/bin/jq
+    chmod a+x /usr/local/bin/jq
+  fi
+}
+
+function configure_aws_cli() {
+  local home_dir
+  home_dir=${1:-/root} # default to /root
+  # Configure aws cli in case it is not yet configured
+  mkdir -p "$home_dir/.aws"
+  if [ ! -f "$home_dir/.aws/config" ]; then
+    EC2_AVAIL_ZONE=$(curl -s http://169.254.169.254/latest/meta-data/placement/availability-zone)
+    EC2_REGION=${EC2_AVAIL_ZONE::-1}
+    cat >"$home_dir/.aws/config" <<CONFIGURE_AWS_CLI
+[default]
+region = $EC2_REGION
+output = json
+CONFIGURE_AWS_CLI
+  fi
+}
+
+function setup() {
+  install_jq
+  configure_aws_cli /root
+}
+
+setup