elastic_beans 0.13.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 505869ec19aba8fb70e2c8484f6a3cafae59aaab
-  data.tar.gz: 58200cac978bb7c3f477b89bc283387bddd8cfe6
+  metadata.gz: 85d2e1b5cb7fb1449bf1c31ef6486324f54e554f
+  data.tar.gz: 9efe208d0b3ffcde0e6b57c376af44cca66da2c3
 SHA512:
-  metadata.gz: fa9c6f4d1796607931b642d13972e40ddc946bb8545b903f4590046c9851f3b32d5accbd1d784c22478a911c3758fac5ce84e197d6ee285e1ff5f1b37b17e57c
-  data.tar.gz: 89dd1e139cf8b22e12d0f779fb113a5f0baadd2c4a885bc47b6fb1c07a7573024985d62a76749d9aa9757a0f2f3cb76eda9d38747f43af74e54477d7db9eaa04
+  metadata.gz: f69ee93f26ee6f40a15841600d2bcd30ad5c3afe4d5b51469b163d7ce093f95379fa377eeedcd0f2fad729ae584c740bc9777c64131c9e21f184038590f37160
+  data.tar.gz: d41f1f33cc3dd28ff8f51748e09a82960343c1c4a22178dbf31ded0fc3e4bbf76cca23bb21cb1e09c4773d8fff9c1cfea5cf7a8ef195ee9814a1ef8450c19bdd

data/README.md

@@ -261,11 +261,6 @@ Make sure that its redrive policy allows such inspection before considering a me
 Your application must use the [active-elastic-job gem](https://github.com/tawan/active-elastic-job) for background job processing.
 Elastic Beans will set the `PROCESS_ACTIVE_ELASTIC_JOBS` environment variable appropriately in your environments.
 
-### Known issues and limitations of the pre-release
-
-Elastic Beans is in pre-release and still has some rough edges that need to be worked out.
-See [the wiki page](https://github.com/onemedical/elastic_beans/wiki/Known-Issues).
-
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/elastic_beans/cli.rb

@@ -23,7 +23,8 @@ class ElasticBeans::CLI < Thor
   option :public_key, aliases: %w(-p), desc: "For end-to-end encryption. The public key of the SSL certificate the ELB will verify to communicate with your Rails app"
   option :ssl_certificate_arn, aliases: %w(-s), desc: "The ARN of the SSL server certificate stored in IAM to attach to the ELB"
   option :solution_stack, desc: "Solution stack name to deploy the application on. Defaults to the latest Ruby Puma solution stack."
-  def configure
+  option :queue, default: "default", aliases: %w(-q), desc: "The name of the queue a new worker environment should listen to, e.g. `default`"
+  def configure(environment_type = nil)
     @verbose = options[:verbose]
     ElasticBeans::Command::Configure.new(
       internal: options[:internal],
@@ -38,6 +39,8 @@ class ElasticBeans::CLI < Thor
       elastic_beanstalk: elastic_beanstalk_client,
       iam: iam_client,
       ui: ui,
+      environment_type: environment_type,
+      queue: options[:queue]
     ).run
   rescue StandardError => e
     error(e)

data/lib/elastic_beans/command/configure.rb

@@ -9,11 +9,13 @@ module ElasticBeans
       DESC = "Configure the given Elastic Beanstalk application"
       LONG_DESC = <<-LONG_DESC
 Configure the given Elastic Beanstalk application.
+Specify an environment to configure a single environment within your EB application
 Creates and updates configuration templates for each possible environment type.
 Updates running environments with the new configuration.
 
 Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.
       LONG_DESC
+      VALID_ARGUMENTS = %w(webserver worker exec scheduler)
 
       def initialize(
         internal:,
@@ -27,7 +29,9 @@ Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID an
         network:,
         elastic_beanstalk:,
         iam:,
-        ui:
+        ui:,
+        environment_type: nil,
+        queue:
       )
         @internal = internal
         @keypair = keypair
@@ -41,16 +45,15 @@ Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID an
         @elastic_beanstalk = elastic_beanstalk
         @iam = iam
         @ui = ui
+        @environment_type = environment_type
+        @queue = queue
+        # Required attributes not passed from CLI
+        @environments = application.environments
+        @threads = []
       end
 
       def run
-        environments = application.environments
-        unready_environments = environments.select { |environment| environment.status != "Ready" }
-        if unready_environments.any?
-          raise EnvironmentsNotReady.new(environments: unready_environments)
-        end
-
-        threads = []
+        check_environment_status
 
         Signal.trap("INT") do
           puts "\nInterrupting beans"
@@ -63,24 +66,112 @@ Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID an
           raise SignalException.new("TERM")
         end
 
-        config_templates = 4 + application.worker_queues.size
-        progressbar = ProgressBar.create(title: "Configuring", total: config_templates, output: ui.stdout)
+        configure_progressbar
         progressbar.log("Updating configuration templates in #{application.name}...")
-        progressbar.log("Updating base configuration template...")
-        base_config = ElasticBeans::ConfigurationTemplate::Base.new(
-          application: application,
-          elastic_beanstalk: elastic_beanstalk,
-        )
-        base_config.upsert(
-          network: network,
-          keypair: keypair,
-          solution_stack: solution_stack,
-          option_settings: option_settings,
-          options_to_remove: options_to_remove,
-          iam: iam,
-        )
-        progressbar.increment
 
+        if environment_type
+          raise InvalidCommandArgumentError if !VALID_ARGUMENTS.include?(environment_type)
+          self.send("configure_#{environment_type}".to_sym)
+        else
+          # Shared configuration with common values for all environments
+          progressbar.log("Updating base configuration template...")
+          base_config = ElasticBeans::ConfigurationTemplate::Base.new(
+            application: application,
+            elastic_beanstalk: elastic_beanstalk,
+          )
+          base_config.upsert(
+            network: network,
+            keypair: keypair,
+            solution_stack: solution_stack,
+            option_settings: option_settings,
+            options_to_remove: options_to_remove,
+            iam: iam,
+          )
+          progressbar.increment
+
+          configure_webserver
+          configure_exec
+          configure_scheduler
+          configure_worker
+        end
+
+        threads.each(&:join)
+        progressbar.finish
+      end
+
+      private
+
+      attr_reader(
+        :application,
+        :internal,
+        :keypair,
+        :network,
+        :public_key,
+        :ssl_certificate_arn,
+        :solution_stack,
+        :elastic_beanstalk,
+        :iam,
+        :ui,
+        :environment_type,
+        :queue,
+        :progressbar,
+        :environments,
+        :threads
+      )
+
+      # Coerces +@option_setting_strings+ into object format.
+      def option_settings
+        @option_settings ||= @option_setting_strings.map { |option_setting_string|
+          setting, value = option_setting_string.split('=', 2)
+          if !setting || setting.empty? || !value || value.empty?
+            raise InvalidOptionSettingFormatError
+          end
+          namespace, option_name = setting.split('/', 2)
+          if !namespace || namespace.empty? || !option_name || option_name.empty?
+            raise InvalidOptionSettingFormatError
+          end
+          {namespace: namespace, option_name: option_name, value: value}
+        }
+      end
+
+      # Coerces +@option_strings_to_remove+ into object format.
+      def options_to_remove
+        @options_to_remove ||= @option_strings_to_remove.map { |option_setting_string|
+          namespace, option_name = option_setting_string.split('/', 2)
+          if !namespace || namespace.empty? || !option_name || option_name.empty? || option_name.include?('=')
+            raise InvalidOptionSettingFormatError
+          end
+          {namespace: namespace, option_name: option_name}
+        }
+      end
+
+      def check_environment_status
+        target_environments = if environment_type && environment_type != 'worker'
+          environments.select { |environment| environment.name.include?(environment_type) }
+        elsif environment_type == 'worker'
+          environments.select { |environment| environment.name.include?(environment_type) && environment.name.include?(queue) }
+        else
+          environments
+        end
+
+        unready_environments = target_environments.select { |environment| environment.status != "Ready" }
+        if unready_environments.any?
+          raise EnvironmentsNotReady.new(environments: unready_environments)
+        end
+      end
+
+      def configure_progressbar
+        config_templates = if !environment_type
+          # (Base + exec + scheduler + webserver) + total number of worker queues
+          4 + application.worker_queues.size
+        else
+          1
+        end
+
+        @progressbar = ProgressBar.create(title: "Configuring", total: config_templates, output: ui.stdout)
+      end
+
+      def configure_webserver
         progressbar.log("Updating webserver configuration template...")
         webserver_config = ElasticBeans::ConfigurationTemplate::Webserver.new(
           application: application,
@@ -105,7 +196,9 @@ Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID an
           end
         end
         progressbar.increment
+      end
 
+      def configure_exec
         progressbar.log("Updating exec configuration template...")
         exec_config = ElasticBeans::ConfigurationTemplate::Exec.new(
           application: application,
@@ -127,7 +220,9 @@ Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID an
           end
         end
         progressbar.increment
+      end
 
+      def configure_scheduler
         progressbar.log("Updating scheduler configuration template...")
         scheduler_config = ElasticBeans::ConfigurationTemplate::Scheduler.new(
           application: application,
@@ -149,8 +244,12 @@ Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID an
           end
         end
         progressbar.increment
+      end
 
-        application.worker_queues.each do |queue|
+      def configure_worker
+        target_queues = environment_type ? application.worker_queues.select { |q| q == queue } : application.worker_queues
+
+        target_queues.each do |queue|
           progressbar.log("Updating worker-#{queue} configuration template...")
           worker_config = ElasticBeans::ConfigurationTemplate::Worker.new(
             queue: queue,
@@ -173,50 +272,6 @@ Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID an
             end
           end
         end
-        threads.each(&:join)
-        progressbar.increment
-        progressbar.finish
-      end
-
-      private
-
-      attr_reader(
-        :application,
-        :internal,
-        :keypair,
-        :network,
-        :public_key,
-        :ssl_certificate_arn,
-        :solution_stack,
-        :elastic_beanstalk,
-        :iam,
-        :ui,
-      )
-
-      # Coerces +@option_setting_strings+ into object format.
-      def option_settings
-        @option_settings ||= @option_setting_strings.map { |option_setting_string|
-          setting, value = option_setting_string.split('=', 2)
-          if !setting || setting.empty? || !value || value.empty?
-            raise InvalidOptionSettingFormatError
-          end
-          namespace, option_name = setting.split('/', 2)
-          if !namespace || namespace.empty? || !option_name || option_name.empty?
-            raise InvalidOptionSettingFormatError
-          end
-          {namespace: namespace, option_name: option_name, value: value}
-        }
-      end
-
-      # Coerces +@option_strings_to_remove+ into object format.
-      def options_to_remove
-        @options_to_remove ||= @option_strings_to_remove.map { |option_setting_string|
-          namespace, option_name = option_setting_string.split('/', 2)
-          if !namespace || namespace.empty? || !option_name || option_name.empty? || option_name.include?('=')
-            raise InvalidOptionSettingFormatError
-          end
-          {namespace: namespace, option_name: option_name}
-        }
       end
 
       # :nodoc: all
@@ -248,6 +303,22 @@ Option settings to remove should in the format 'NAMESPACE/OPTION_NAME', e.g. 'aw
 If you'd like to *set* option settings, use --option-settings 'NAMESPACE/OPTION_NAME=VALUE'.
 Please re-run `#{command_as_string "configure"}` with updated syntax.
 
+#{command_help "configure"}
+          MESSAGE
+        end
+      end
+
+      # :nodoc: all
+      # @!visibility private
+      class InvalidCommandArgumentError < ElasticBeans::Error
+        def message
+          require "elastic_beans/cli"
+          require "elastic_beans/cli/string_shell"
+          <<-MESSAGE
+Unknown environment '#{@environment_type}'
+Command 'configure' can be run without passing an argument or by using one of the following: #{VALID_ARGUMENTS}
+Please re-run `#{command_as_string "configure"}` with updated syntax.
+
 #{command_help "configure"}
           MESSAGE
         end

data/lib/elastic_beans/exec/elastic_beans_exec.conf

@@ -9,7 +9,30 @@ script
     source $EB_SUPPORT_DIR/envvars
 
     # execute using Elastic Beanstalk's built-in Ruby with aws-sdk pre-installed
+    ruby_version="`ls /opt/elasticbeanstalk/lib/ruby/lib/ruby/ | grep '^[0-9]\.[0-9]'`"
     export PATH="/opt/elasticbeanstalk/lib/ruby/bin:$PATH"
-    export GEM_PATH="/opt/elasticbeanstalk/lib/ruby/lib/ruby/2.2.0"
+    export GEM_PATH="/opt/elasticbeanstalk/lib/ruby/lib/ruby/$ruby_version"
     exec ruby /opt/elastic_beans/exec/init.rb start
 end script
+
+pre-start script
+    EB_SUPPORT_DIR="`/opt/elasticbeanstalk/bin/get-config container -k support_dir`"
+    source $EB_SUPPORT_DIR/envvars
+
+    # execute using Elastic Beanstalk's built-in Ruby with aws-sdk pre-installed
+    ruby_version="`ls /opt/elasticbeanstalk/lib/ruby/lib/ruby/ | grep '^[0-9]\.[0-9]'`"
+    export PATH="/opt/elasticbeanstalk/lib/ruby/bin:$PATH"
+    export GEM_PATH="/opt/elasticbeanstalk/lib/ruby/lib/ruby/$ruby_version"
+    exec ruby /opt/elastic_beans/exec/init.rb pre_start
+end script
+
+post-stop script
+    EB_SUPPORT_DIR="`/opt/elasticbeanstalk/bin/get-config container -k support_dir`"
+    source $EB_SUPPORT_DIR/envvars
+
+    # execute using Elastic Beanstalk's built-in Ruby with aws-sdk pre-installed
+    ruby_version="`ls /opt/elasticbeanstalk/lib/ruby/lib/ruby/ | grep '^[0-9]\.[0-9]'`"
+    export PATH="/opt/elasticbeanstalk/lib/ruby/bin:$PATH"
+    export GEM_PATH="/opt/elasticbeanstalk/lib/ruby/lib/ruby/$ruby_version"
+    exec ruby /opt/elastic_beans/exec/init.rb post_stop
+end script

data/lib/elastic_beans/exec/init.rb

@@ -1,11 +1,13 @@
 require "aws-sdk"
 require "fileutils"
 require "net/http"
+require "timeout"
 require "uri"
 
 # :nodoc: all
 # @!visibility private
 class Init
+  APP_DIR_TIMEOUT = 1800
   LOGDIR = "/var/log/elastic_beans/exec"
   PIDFILE = "/var/run/elastic_beans_exec.pid"
   AZ_PATTERN = /\A(?<region>.+-\d+)\w+\z/
@@ -15,35 +17,54 @@ class Init
   def self.run(command)
     init = new
     unless init.respond_to?(command)
-      abort "Usage: #{$0} {start}"
+      abort "Usage: #{$0} {start|pre_start|post_stop}"
     end
     init.send(command)
   end
 
   def start
-    queue_url = ENV['ELASTIC_BEANS_EXEC_QUEUE_URL']
-    if queue_url.nil?
-      raise "ELASTIC_BEANS_EXEC_QUEUE_URL not set; please re-run `beans configure`."
-    end
-    s3_client = ::Aws::S3::Client.new(region: region)
-    sqs_client = ::Aws::SQS::Client.new(region: region)
-    require File.expand_path("../sqs_consumer", __FILE__)
-    consumer = SQSConsumer.new(
+    wait_until_app_dir_exists
+    consumer.run
+  end
+
+  def post_stop
+    consumer.cleanup
+  end
+
+  def pre_start
+    consumer.cleanup
+  end
+
+  private
+
+  def app_dir
+    `/opt/elasticbeanstalk/bin/get-config container -k app_deploy_dir`
+  end
+
+  def consumer
+    args = {
       instance_id: instance_id,
       logdir: LOGDIR,
       queue_url: queue_url,
       s3: s3_client,
       sqs: sqs_client,
-    )
-    consumer.run
+    }
+    require File.expand_path("../sqs_consumer", __FILE__)
+    consumer = SQSConsumer.new(**args)
   end
 
-  private
-
   def instance_id
     @instance_id ||= Net::HTTP.get(INSTANCE_ID_URI)
   end
 
+  def queue_url
+    queue_url = ENV['ELASTIC_BEANS_EXEC_QUEUE_URL']
+    if queue_url.nil?
+      raise "ELASTIC_BEANS_EXEC_QUEUE_URL not set; please re-run `beans configure`."
+    end
+    queue_url
+  end
+
   def region
     return @region if @region
     az = Net::HTTP.get(AZ_URI)
@@ -53,6 +74,25 @@ class Init
     end
     @region = az_match[:region]
   end
+
+  def s3_client
+    @s3_client ||= ::Aws::S3::Client.new(region: region)
+  end
+
+  def sqs_client
+    @sqs_client ||= ::Aws::SQS::Client.new(region: region)
+  end
+
+  def wait_until_app_dir_exists
+    ::Timeout.timeout(APP_DIR_TIMEOUT) do
+      loop do
+        sleep 1
+        break if Dir.glob("#{app_dir}/*").any?
+      end
+    end
+  rescue ::Timeout::Error
+    raise "App dir #{app_dir} has no contents; waited #{APP_DIR_TIMEOUT} seconds"
+  end
 end
 
 Init.run(ARGV[0])

data/lib/elastic_beans/exec/sqs_consumer.rb

@@ -15,6 +15,7 @@ class SQSConsumer
     @instance_id = instance_id
     @logdir = logdir
     @command_logfile = File.join(logdir, "command.log")
+    @command_metafile = File.join(logdir, "command.json")
     @consumer_logfile = File.join(logdir, "sqs_consumer.log")
     @queue_url = queue_url
     @s3 = s3
@@ -93,18 +94,27 @@ class SQSConsumer
     end
   end
 
+  def cleanup
+    command = interrupted_command
+    if command
+      log("Cleaning up metadata for command ID=#{command['id']} `#{command['command']}' on host #{`hostname`.chomp}...")
+      remove_metadata(command: command)
+    else
+      log("No cleanup necessary on host #{`hostname`.chomp}")
+    end
+  end
+
   private
 
-  attr_reader :consumer_logfile, :command_logfile, :command_script, :instance_id, :logdir, :queue_url, :s3, :sqs
+  attr_reader :consumer_logfile, :command_logfile, :command_metafile, :command_script, :instance_id, :logdir, :queue_url, :s3, :sqs
   # Transient attributes
   attr_reader :command_pid
 
-  def stop(signal = nil)
-    log("Terminating message receiving process")
-    signal ||= "TERM"
-    Process.kill(signal, command_pid) if command_pid
+  def stop(signal = 15)
+    log("Terminating message receiving process with signal '#{signal}'")
+    force = (signal == 9)
+    kill_command(interrupted_command, force: force) if command_pid
     exit
-  rescue Errno::ESRCH
   end
 
   def command_from_message(message)
@@ -114,6 +124,14 @@ class SQSConsumer
     raise e
   end
 
+  def interrupted_command
+    return unless File.exists?(command_metafile)
+    JSON.parse(File.read(command_metafile))
+  rescue StandardError => e
+    log("[interrupted_command] #{e.class.name}: #{e.message}\n#{e.backtrace.join("\n")}")
+    raise e
+  end
+
   def log(message)
     File.open(consumer_logfile, "a") do |file|
       file.puts("[#{Time.now.iso8601}] [elastic_beans/exec] #{message}")
@@ -150,7 +168,7 @@ class SQSConsumer
   rescue ::Aws::S3::Errors::NotFound
     false
   rescue StandardError => e
-    log("[metadata_exists] #{e.class.name}: #{e.message}\n#{e.backtrace.join("\n")}")
+    log("[killing_command?] #{e.class.name}: #{e.message}\n#{e.backtrace.join("\n")}")
   end
 
   def kill_command(command, force: false)
@@ -160,17 +178,17 @@ class SQSConsumer
       signal = "TERM"
     end
 
-    log_command(
-      "Sending signal '#{signal}' to" \
-        " command ID=#{command['id']} `#{command['command']}' on host #{`hostname`.chomp} pid #{command_pid}" \
-        " because it was killed"
-    )
+    if command
+      log_command("Command ID=#{command['id']} `#{command['command']}' killed on host #{`hostname`.chomp}: pid #{command_pid} exit #{signal}")
+    end
     Process.kill(signal, command_pid)
 
     unless force
       # give the command a little bit to die
       sleep(TERM_TIMEOUT)
     end
+  rescue Errno::ESRCH => e
+    log("[kill_command] #{e.class.name}: #{e.message}\n#{e.backtrace.join("\n")}")
   end
 
   def while_killed(command)
@@ -204,6 +222,7 @@ class SQSConsumer
   end
 
   def update_metadata(command:, start_time:)
+    File.write(command_metafile, command.to_json)
     metadata = command['metadata']
     if metadata && metadata['bucket'] && metadata['key']
       s3.put_object(
@@ -231,6 +250,7 @@ class SQSConsumer
         key: "#{metadata['key']}.killed",
       )
     end
+    FileUtils.rm_f(command_metafile)
   rescue StandardError => e
     log("[remove_metadata] #{e.class.name}: #{e.message}\n#{e.backtrace.join("\n")}")
   end

data/lib/elastic_beans/version.rb

@@ -1,3 +1,3 @@
 module ElasticBeans
-  VERSION = "0.13.0"
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic_beans
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Adam Stegman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-28 00:00:00.000000000 Z
+date: 2017-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -256,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Elastic Beanstalk environment orchestration for a Rails app