elastic_beans 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07dcf92670f011c2715d0ffd754bc856803f1434
-  data.tar.gz: 8b483d5a53cb03898d44f8de16fcf4c5e180aa25
+  metadata.gz: '058ffb4aa22e205e19470449420643bc3e55298f'
+  data.tar.gz: 5dcd342a6962c0ee82dd672c2ee07a32fc7b1562
 SHA512:
-  metadata.gz: c2758059cb4a7351e4c6ebb1492d5211c2098b351d4e7fbd584f96e0ce266d085bb4d7633cf4aa8a8f34695585adf4581b34150ab4350d3eef958927f9cb99c1
-  data.tar.gz: 2c2e12f9ee533a77d60b82b888b80bc708615ad12ae3f60b13c96b66b5ce89daecf5767c05770a65a9c3416a8e1b0b157a83cdc0f6487d77339653ec52d2035f
+  metadata.gz: 40f88906d991227878c85386c3fd79fba38e14bbddddfbb26c9101e3c4b1e01d7996f9dafef8cb1b0e3035f59548a664f41c4de94f46d0010a7bd9b653c517d8
+  data.tar.gz: 3aeebfe162e590b106c6e253af178aef7c447ef4d005179ed197e34c4357a5a350bcc864a1e8eed51ef9c1d9e425a6617fe6a06df4a540e2b7aea8470f79829c

data/Gemfile

@@ -6,4 +6,6 @@ gemspec
 group :test do
   gem "net-ssh-gateway"
   gem "rails", "~> 5.0"
+  gem "rspec_junit_formatter"
+  gem "timecop"
 end

data/README.md

@@ -26,7 +26,7 @@ As the SDK documentation suggests, using environment variables is recommended.
     beans configure -n myapp-networking -a myapp \
       -b SECRET_KEY_BASE -d DATABASE_URL -k KEYPAIR \
       -p INTERNAL_PUBLIC_KEY -s SSL_CERTIFICATE_ARN \
-      [-i IMAGE_ID] [-t INSTANCE_TYPE] [-l LOGGING_HTTP_ENDPOINT]
+      [-i IMAGE_ID] [-t INSTANCE_TYPE]
 
     # Create a webserver environment with a pretty DNS name at myapp.TLD (managed by Route53)
     beans create -a myapp [-d myapp.TLD] [--tags=Environment:production Team:Unicorn] webserver
@@ -50,14 +50,14 @@ As the SDK documentation suggests, using environment variables is recommended.
     # Then deploy that version to each running environment.
     beans deploy -a myapp
 
-    # Run one-off tasks and upload logs to the LOGGING_HTTP_ENDPOINT from `configure`
+    # Run one-off tasks
     beans exec -a myapp rake db:migrate
 
     # Update all existing environments and configuration
     beans configure -n myapp-networking -a myapp \
       [-b SECRET_KEY_BASE] [-d DATABASE_URL] [-k KEYPAIR] \
       [-p INTERNAL_PUBLIC_KEY] [-s SSL_CERTIFICATE_ARN] \
-      [-i IMAGE_ID] [-t INSTANCE_TYPE] [-l LOGGING_HTTP_ENDPOINT]
+      [-i IMAGE_ID] [-t INSTANCE_TYPE]
 
 ### API
 
@@ -88,8 +88,8 @@ In `config/initializers/elastic_beans.rb`, add the middleware into your stack, b
           cloudformation: Aws::CloudFormation::Client.new,
           elastic_beanstalk: Aws::ElasticBeanstalk::Client.new,
           s3: Aws::S3::Client.new,
+          sqs: Aws::SQS::Client.new,
         ),
-        sqs: Aws::SQS::Client.new,
         logger: Rails.logger,
       )
     else
@@ -100,8 +100,8 @@ In `config/initializers/elastic_beans.rb`, add the middleware into your stack, b
           cloudformation: Aws::CloudFormation::Client.new,
           elastic_beanstalk: Aws::ElasticBeanstalk::Client.new,
           s3: Aws::S3::Client.new,
+          sqs: Aws::SQS::Client.new,
         ),
-        sqs: Aws::SQS::Client.new,
         logger: Rails.logger,
       )
     end
@@ -141,7 +141,6 @@ Before loading your application, the configuration is fetched and loaded.
 Elastic Beans supports the execution of one-off and periodic commands in an isolated environment.
 This way they can be computationally expensive without affecting application performance.
 Additionally, they are not limited to the visibility timeout of an application background job queue.
-Logs are persisted to an HTTPS endpoint upon command completion.
 
 ### Persistent configuration
 
@@ -209,9 +208,13 @@ Its details will be discovered from the following outputs:
 * `ExecQueueUrl`
 * `Worker[Name]QueueUrl`
 
-Where a separate worker environment will be configured for each queue `[Name]` that appears.
+A separate worker environment will be configured for each queue `[Name]` that appears.
 A default worker queue, i.e. `WorkerDefaultQueueUrl`, must exist.
 
+The `ExecQueueUrl` is used by `beans exec` to enqueue one-off commands.
+It is also by `beans ps` to inspect scheduled commands that have not yet run.
+Make sure that its redrive policy allows such inspection before considering a message failed.
+
 ### Code
 
 Your application must use the [active-elastic-job gem](https://github.com/tawan/active-elastic-job) for background job processing.
@@ -288,7 +291,9 @@ Or install it yourself as:
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run all the tests, including feature tests. This will take about 1.5–2 hours. To run only the unit tests, run `rake spec:unit`.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/Rakefile

@@ -1,6 +1,14 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ENV['RSPEC_OPTS']
+end
 
 task :default => :spec
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.rspec_opts = "--tag ~feature #{ENV['RSPEC_OPTS']}"
+  end
+end

data/circle.yml

@@ -1,4 +1,8 @@
 ---
+machine:
+  environment:
+    RSPEC_OPTS: "-r rspec_junit_formatter --format progress --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/junit.xml"
+
 dependencies:
   override:
     - |

data/elastic_beans.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "ruby-progressbar", "~> 1.2"
   spec.add_dependency "rubyzip", "~> 1.2"
   spec.add_dependency "thor", "~> 0.19.0"
+  spec.add_dependency "tty-table", "~> 0.7.0"
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/elastic_beans.rb

@@ -6,5 +6,6 @@ require "elastic_beans/application_version"
 require "elastic_beans/configuration_template"
 require "elastic_beans/env_vars"
 require "elastic_beans/environment"
+require "elastic_beans/exec"
 require "elastic_beans/network"
 require "elastic_beans/version"

data/lib/elastic_beans/application.rb

@@ -1,4 +1,5 @@
 require "json"
+require "timeout"
 require "aws-sdk"
 require "elastic_beans/aws/cloudformation_stack"
 require "elastic_beans/error"
@@ -10,10 +11,11 @@ module ElasticBeans
   class Application
     attr_reader :name
 
-    def initialize(name:, cloudformation:, elastic_beanstalk:, s3:)
+    def initialize(name:, cloudformation:, elastic_beanstalk:, s3:, sqs: nil)
       @name = name
       @elastic_beanstalk = elastic_beanstalk
       @s3 = s3
+      @sqs = sqs
       @stack = ElasticBeans::Aws::CloudformationStack.new(name, cloudformation: cloudformation)
     end
 
@@ -96,25 +98,76 @@ module ElasticBeans
       @bucket_name = bucket.name
     end
 
-    # Enqueues a one-off command to be run on the application's +exec+ environment.
+    # Enqueues a one-off Exec::Command to be run on the application's +exec+ environment.
     # Does not wait for action to be taken, but returns immediately after enqueuing the command.
     #
-    # Raises an error if the exec environment cannot be found.
-    def enqueue_command(command, sqs:)
+    # Raises an error if the exec environment or queue cannot be found.
+    def enqueue_command(command)
       if environments.none? { |environment| environment.is_a?(Environment::Exec) }
         raise MissingExecEnvironmentError
       end
 
+      if command.to_s == command
+        command = Exec::Command.new(command_string: command)
+      end
+      command.metadata[:bucket] = bucket_name
+      command.metadata[:key] = "#{command_key_prefix}#{command.id}.json"
+
       sqs.send_message(
         queue_url: exec_queue_url,
-        message_body: exec_message(command),
+        message_body: command.to_json,
       )
     end
 
+    # Fetches commands enqueued in the +exec_queue_url+.
+    # Polls the queue for 5 seconds.
+    #
+    # If a large number of commands is enqueued they may not all be found.
+    #
+    # Raises an error if the exec queue cannot be found.
+    def enqueued_commands
+      messages = []
+      Timeout.timeout(5) do
+        loop do
+          messages += sqs.receive_message(
+            queue_url: exec_queue_url,
+            max_number_of_messages: 10,
+            visibility_timeout: 5,
+            wait_time_seconds: 5,
+          ).messages
+        end
+      end
+    rescue Timeout::Error
+      messages.map { |msg| Exec::Command.from_json(msg.body) }
+    end
+
     def exec_queue_url
       stack.stack_output("ExecQueueUrl")
     end
 
+    # Fetches commands running in the Environment::Exec environment.
+    # Commands are deserialized from metadata files in a well-known location in S3.
+    # The instances update the metadata when executing a command, and remove the metadata when they are done.
+    #
+    # Raises an error if the exec environment cannot be found.
+    def running_commands
+      # Ignoring truncation for simplicity; >100 commands will just have to suffer.
+      objects = s3.list_objects_v2(
+        bucket: bucket_name,
+        prefix: command_key_prefix,
+        max_keys: 100,
+      ).contents
+      objects.each_with_object([]) { |object, commands|
+        begin
+          response = s3.get_object(bucket: bucket_name, key: object.key)
+          commands << ElasticBeans::Exec::Command.from_json(response.body.read)
+        # skip finished or invalid commands
+        rescue ::Aws::S3::Errors::NoSuchKey
+        rescue JSON::ParserError
+        end
+      }
+    end
+
     # Returns an ElasticBeans::ApplicationVersion for each version of the Elastic Beanstalk application.
     def versions
       response = elastic_beanstalk.describe_application_versions(application_name: name)
@@ -146,10 +199,8 @@ module ElasticBeans
 
     attr_reader :elastic_beanstalk, :s3, :stack
 
-    def exec_message(command)
-      {
-        command: command,
-      }.to_json
+    def command_key_prefix
+      @command_key_prefix ||= "#{name}/exec/command/"
     end
 
     def exists?
@@ -159,6 +210,10 @@ module ElasticBeans
       retry
     end
 
+    def sqs
+      @sqs || raise("ElasticBeans::Application: Missing SQS client")
+    end
+
     # :nodoc: all
     # @!visibility private
     class MissingApplicationError < ElasticBeans::Error

data/lib/elastic_beans/application_version.rb

@@ -129,6 +129,10 @@ module ElasticBeans
           ".elastic_beans/exec/init.rb",
           File.expand_path('../exec/init.rb', __FILE__),
         )
+        zip_file.add(
+          ".elastic_beans/exec/logrotate",
+          File.expand_path('../exec/logrotate', __FILE__),
+        )
         zip_file.add(
           ".elastic_beans/exec/run_command.sh",
           File.expand_path('../exec/run_command.sh', __FILE__),

data/lib/elastic_beans/cli.rb

@@ -20,7 +20,6 @@ class ElasticBeans::CLI < Thor
   option :image_id, aliases: %w(-i), desc: "A custom AMI to use instead of the default Ruby Elastic Beanstalk AMI"
   option :instance_type, aliases: %w(-t), desc: "A default instance type to use for all environments instead of c4.large"
   option :keypair, aliases: %w(-k), desc: "Required on first run. The EC2 keypair to use for Elastic Beanstalk instances"
-  option :logging_endpoint, aliases: %w(-l), desc: "An HTTP endpoint that can receive logs from one-off commands"
   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 :secret_key_base, aliases: %w(-b), desc: "The SECRET_KEY_BASE for the Rails application"
   option :ssl_certificate_arn, aliases: %w(-s), desc: "The ARN of the SSL server certificate stored in IAM to attach to the ELB"
@@ -31,7 +30,6 @@ class ElasticBeans::CLI < Thor
       image_id: options[:image_id],
       instance_type: options[:instance_type],
       keypair: options[:keypair],
-      logging_endpoint: options[:logging_endpoint],
       public_key: options[:public_key],
       secret_key_base: options[:secret_key_base],
       ssl_certificate_arn: options[:ssl_certificate_arn],
@@ -94,13 +92,27 @@ class ElasticBeans::CLI < Thor
       application: application(
         name: options[:application],
       ),
-      sqs: sqs_client,
       ui: ui,
     ).run(*command_parts)
   rescue StandardError => e
     error(e)
   end
 
+  desc ElasticBeans::Command::Ps::USAGE, ElasticBeans::Command::Ps::DESC
+  long_desc ElasticBeans::Command::Ps::LONG_DESC
+  option :application, aliases: %w(-a), required: true, desc: APPLICATION_DESC
+  def ps
+    @verbose = options[:verbose]
+    ElasticBeans::Command::Ps.new(
+      application: application(
+        name: options[:application],
+      ),
+      ui: ui,
+    ).run
+  rescue StandardError => e
+    error(e)
+  end
+
   desc ElasticBeans::Command::Scale::USAGE, ElasticBeans::Command::Scale::DESC
   long_desc ElasticBeans::Command::Scale::LONG_DESC
   option :application, aliases: %w(-a), required: true, desc: APPLICATION_DESC
@@ -187,13 +199,15 @@ class ElasticBeans::CLI < Thor
     name:,
     cloudformation: cloudformation_client,
     elastic_beanstalk: elastic_beanstalk_client,
-    s3: s3_client
+    s3: s3_client,
+    sqs: sqs_client
   )
     @application ||= ElasticBeans::Application.new(
       name: name,
       cloudformation: cloudformation,
       elastic_beanstalk: elastic_beanstalk,
       s3: s3,
+      sqs: sqs,
     )
   end
 

data/lib/elastic_beans/command.rb

@@ -2,6 +2,7 @@ require "elastic_beans/command/configure"
 require "elastic_beans/command/create"
 require "elastic_beans/command/deploy"
 require "elastic_beans/command/exec"
+require "elastic_beans/command/ps"
 require "elastic_beans/command/scale"
 require "elastic_beans/command/get_env"
 require "elastic_beans/command/set_env"

data/lib/elastic_beans/command/configure.rb

@@ -20,7 +20,6 @@ Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID an
         image_id:,
         instance_type:,
         keypair:,
-        logging_endpoint:,
         public_key:,
         secret_key_base:,
         ssl_certificate_arn:,
@@ -34,7 +33,6 @@ Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID an
         @image_id = image_id
         @instance_type = instance_type
         @keypair = keypair
-        @logging_endpoint = logging_endpoint
         @public_key = public_key
         @secret_key_base = secret_key_base
         @ssl_certificate_arn = ssl_certificate_arn
@@ -111,7 +109,6 @@ Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID an
           instance_type: instance_type,
           keypair: keypair,
           iam: iam,
-          logging_endpoint: logging_endpoint,
         )
         exec_environment = exec_config.environment
         if exec_environment
@@ -182,7 +179,6 @@ Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID an
         :image_id,
         :instance_type,
         :keypair,
-        :logging_endpoint,
         :network,
         :public_key,
         :secret_key_base,

data/lib/elastic_beans/command/exec.rb

@@ -10,28 +10,28 @@ module ElasticBeans
 Run an arbitrary command in the context of your application.
 The command is run in an "exec" environment, separate from your webserver or worker environments.
 You must create the exec environment prior to this command being run: `beans create exec -a APPLICATION`.
-Upload output from the command to an HTTP endpoint.
+Output from the command is appended to /var/log/elastic_beans/exec/command.log.
 
 Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.
       LONG_DESC
 
-      def initialize(application:, sqs:, ui:)
+      def initialize(application:, ui:)
         @application = application
-        @sqs = sqs
         @ui = ui
       end
 
       def run(*command_parts)
         ui.info("Running `#{command_parts.join(" ")}' on #{application.name}...")
-        application.enqueue_command(command(command_parts), sqs: sqs)
+        application.enqueue_command(command(command_parts))
       end
 
       private
 
-      attr_reader :application, :sqs, :ui
+      attr_reader :application, :ui
 
       def command(command_parts)
-        command_parts.map { |word| Shellwords.escape(word) }.join(" ")
+        command_string = command_parts.map { |word| Shellwords.escape(word) }.join(" ")
+        ::ElasticBeans::Exec::Command.new(command_string: command_string)
       end
     end
   end

data/lib/elastic_beans/command/ps.rb

@@ -0,0 +1,64 @@
+module ElasticBeans
+  module Command
+    # :nodoc: all
+    class Ps
+      USAGE = "ps"
+      DESC = "List scheduled and running one-off commands run using `beans exec`"
+      LONG_DESC = <<-LONG_DESC
+List scheduled and running one-off commands run using `beans exec`.
+See `beans help exec` for more information about running one-off commands.
+
+Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.
+      LONG_DESC
+
+      COLUMNS = {
+        "INSTANCE" => ->(command) { command.instance_id || SCHEDULED_INSTANCE },
+        "RUN TIME" => ->(command) {
+          if command.start_time
+            seconds = Time.now - command.start_time
+            hours, seconds = seconds / 3600, seconds % 3600
+            minutes, seconds = seconds / 60, seconds % 60
+            sprintf("%02d:%02d:%02d", hours, minutes, seconds)
+          else
+            SCHEDULED_RUN_TIME
+          end
+        },
+        "COMMAND" => ->(command) { command.command_string },
+      }
+      SCHEDULED_INSTANCE = "scheduled"
+      SCHEDULED_RUN_TIME = "00:00:00"
+
+      def initialize(application:, ui:)
+        @application = application
+        @ui = ui
+      end
+
+      def run
+        enqueued_commands = []
+        running_commands = []
+        ui.debug { "Fetching enqueued and running commands from #{application.name}..." }
+        threads = [
+          Thread.new do
+            enqueued_commands = application.enqueued_commands
+          end,
+          Thread.new do
+            running_commands = application.running_commands
+          end,
+        ]
+        threads.each(&:join)
+
+        running_commands.sort_by!(&:start_time)
+        commands = running_commands + enqueued_commands
+        if commands.any?
+          ui.table(level: :info, columns: COLUMNS, rows: running_commands + enqueued_commands)
+        else
+          ui.info("No commands enqueued or running")
+        end
+      end
+
+      private
+
+      attr_reader :application, :ui
+    end
+  end
+end

data/lib/elastic_beans/configuration_template/exec.rb

@@ -1,10 +1,9 @@
-require "uri"
 require "elastic_beans/error"
 
 module ElasticBeans
   class ConfigurationTemplate
     # The "exec" configuration template stored in the Elastic Beanstalk application.
-    # Settings for the exec environment are stored here, such as the exec queue URL and the logging endpoint.
+    # Settings for the exec environment are stored here, such as the exec queue URL.
     class Exec < ElasticBeans::ConfigurationTemplate::Base
       def initialize(**args)
         super(name: "exec", **args)
@@ -13,42 +12,13 @@ module ElasticBeans
       protected
 
       # Constructs the configuration for the exec environment.
-      # +logging_endpoint+, if provided, must be a valid HTTPS URL.
-      def build_option_settings(logging_endpoint: nil, **_)
-        if logging_endpoint
-          begin
-            if URI(logging_endpoint).scheme != "https"
-              raise InvalidLoggingEndpointError.new(logging_endpoint: logging_endpoint)
-            end
-          rescue URI::InvalidURIError
-            raise InvalidLoggingEndpointError.new(logging_endpoint: logging_endpoint)
-          end
-
-          logging_endpoint_setting = template_option_setting(namespace: "aws:elasticbeanstalk:application:environment", option_name: "ELASTIC_BEANS_EXEC_LOGGING_ENDPOINT", override: logging_endpoint)
-        end
-
-        settings = [
+      def build_option_settings(**_)
+        super + [
           template_option_setting(namespace: "aws:elasticbeanstalk:application", option_name: "Application Healthcheck URL", default: "HTTP:80/"),
           template_option_setting(namespace: "aws:elasticbeanstalk:application:environment", option_name: "DISABLE_SQS_CONSUMER", override: "false"),
           template_option_setting(namespace: "aws:elasticbeanstalk:application:environment", option_name: "ELASTIC_BEANS_EXEC_QUEUE_URL", override: application.exec_queue_url),
           template_option_setting(namespace: "aws:elasticbeanstalk:application:environment", option_name: "RAILS_SKIP_MIGRATIONS", default: "true"),
         ]
-        if logging_endpoint
-          settings << logging_endpoint_setting
-        end
-        super + settings
-      end
-
-      # :nodoc: all
-      # @!visibility private
-      class InvalidLoggingEndpointError < ElasticBeans::Error
-        def initialize(logging_endpoint:)
-          @logging_endpoint = logging_endpoint
-        end
-
-        def message
-          "Logging endpoint `#{@logging_endpoint}' must be a valid HTTPS URL."
-        end
       end
     end
   end

data/lib/elastic_beans/exec.rb

@@ -0,0 +1,6 @@
+module ElasticBeans
+  module Exec
+  end
+end
+
+require "elastic_beans/exec/command"

data/lib/elastic_beans/exec/command.rb

@@ -0,0 +1,58 @@
+require "json"
+require "time"
+require "securerandom"
+
+module ElasticBeans
+  module Exec
+    # A command enqueued or running on an exec instance in this Application, from +beans exec+.
+    class Command
+      # A unique ID to identify this command later on.
+      attr_reader :id
+
+      # The command string that is executed; the string passed to +beans exec+
+      attr_reader :command_string
+
+      # The instance ID this command is being executed on.
+      attr_reader :instance_id
+
+      # The time this command started execution.
+      attr_reader :start_time
+
+      # Command metadata, such as where to store execution data in S3.
+      attr_reader :metadata
+
+      def initialize(command_string:, id: nil, instance_id: nil, start_time: nil, metadata: nil)
+        @id = id || SecureRandom.uuid
+        @command_string = command_string
+        @instance_id = instance_id
+        @start_time = start_time
+        @metadata = metadata || {}
+      end
+
+      def ==(other)
+        id == other.id
+      end
+
+      def to_json
+        attributes = {}
+        attributes[:id] = id
+        attributes[:command] = command_string
+        attributes[:instance_id] = instance_id if instance_id
+        attributes[:start_time] = start_time.iso8601 if start_time
+        attributes[:metadata] = metadata
+        attributes.to_json
+      end
+
+      def self.from_json(json)
+        attributes = JSON.parse(json)
+        new(
+          id: attributes["id"],
+          command_string: attributes["command"],
+          instance_id: attributes["instance_id"],
+          start_time: attributes["start_time"] ? Time.iso8601(attributes["start_time"]) : nil,
+          metadata: attributes["metadata"],
+        )
+      end
+    end
+  end
+end

data/lib/elastic_beans/exec/ebextension.yml

@@ -3,8 +3,12 @@ container_commands:
     command: "mkdir -vp /opt/elastic_beans && cp -vR /var/app/ondeck/.elastic_beans/exec /opt/elastic_beans/"
   01_permissions:
     command: "chmod 755 /opt/elastic_beans/exec/run_command.sh"
+  09_logrotate:
+    command: "cp -v /opt/elastic_beans/exec/logrotate /etc/logrotate.d/elastic_beans_exec"
+    test: "/opt/elasticbeanstalk/bin/get-config meta -k sqsdconfig --output YAML | grep -q '^environment_name: .*-exec$'"
   09_upstart:
     command: "cp -v /opt/elastic_beans/exec/elastic_beans_exec.conf /etc/init/"
+    test: "/opt/elasticbeanstalk/bin/get-config meta -k sqsdconfig --output YAML | grep -q '^environment_name: .*-exec$'"
   10_start_elastic_beans_exec:
     command: stop elastic_beans_exec; start elastic_beans_exec
     test: "/opt/elasticbeanstalk/bin/get-config meta -k sqsdconfig --output YAML | grep -q '^environment_name: .*-exec$'"

data/lib/elastic_beans/exec/init.rb

@@ -6,10 +6,11 @@ require "uri"
 # :nodoc: all
 # @!visibility private
 class Init
-  LOGFILE = "/var/log/elastic_beans_exec.log"
+  LOGDIR = "/var/log/elastic_beans/exec"
   PIDFILE = "/var/run/elastic_beans_exec.pid"
   AZ_PATTERN = /\A(?<region>.+-\d+)\w+\z/
   AZ_URI = URI("http://169.254.169.254/latest/meta-data/placement/availability-zone")
+  INSTANCE_ID_URI = URI("http://169.254.169.254/latest/meta-data/instance-id")
 
   def self.run(command)
     init = new
@@ -20,17 +21,18 @@ class Init
   end
 
   def start
-    logging_endpoint = ENV['ELASTIC_BEANS_EXEC_LOGGING_ENDPOINT']
     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(
-      logfile: LOGFILE,
-      logging_endpoint: logging_endpoint,
+      instance_id: instance_id,
+      logdir: LOGDIR,
       queue_url: queue_url,
+      s3: s3_client,
       sqs: sqs_client,
     )
     consumer.run
@@ -38,6 +40,10 @@ class Init
 
   private
 
+  def instance_id
+    @instance_id ||= Net::HTTP.get(INSTANCE_ID_URI)
+  end
+
   def region
     return @region if @region
     az = Net::HTTP.get(AZ_URI)

data/lib/elastic_beans/exec/logrotate

@@ -0,0 +1,8 @@
+/var/log/elastic_beans/exec/*.log {
+    daily
+    rotate 10
+    missingok
+    notifempty
+    compress
+    copytruncate
+}

data/lib/elastic_beans/exec/sqs_consumer.rb

@@ -1,77 +1,137 @@
+require "fileutils"
 require "json"
 require "net/http"
-require "uri"
+require "time"
 
 # :nodoc: all
 # @!visibility private
 class SQSConsumer
-  def initialize(logfile:, queue_url:, sqs:, logging_endpoint: nil)
-    @logfile = logfile
+  def initialize(instance_id:, logdir:, queue_url:, s3:, sqs:)
+    @instance_id = instance_id
+    @logdir = logdir
+    @command_logfile = File.join(logdir, "command.log")
+    @consumer_logfile = File.join(logdir, "sqs_consumer.log")
     @queue_url = queue_url
+    @s3 = s3
     @sqs = sqs
-    @logging_uri = URI(logging_endpoint) if logging_endpoint
     @command_script = File.expand_path('../run_command.sh', __FILE__)
   end
 
   def run
     trap("TERM", &method(:stop))
+    FileUtils.mkdir_p(logdir)
+    log("Starting message receive loop")
     loop do
-      sleep 1
-      response = sqs.receive_message(
-        queue_url: queue_url,
-        max_number_of_messages: 1,
-      )
-      message = response.messages[0]
-      if message
-        command = JSON.parse(message.body)
+      begin
+        sleep 1
+        if (message = receive_message)
+          command = command_from_message(message)
+          log_command("Executing command ID=#{command['id']} `#{command['command']}' on host #{`hostname`.chomp} pid #{command_pid}...")
+          start_time = Time.now
+          @command_pid = Process.spawn(
+            "#{command_script} #{command['command']}",
+            out: [command_logfile, "a"],
+            err: [command_logfile, "a"],
+          )
+          delete_message(message)
+          update_metadata(command: command, start_time: start_time)
+          _, status = Process.wait2(command_pid)
+          log_command("Command ID=#{command['id']} `#{command['command']}' exited on host #{`hostname`.chomp}: #{status}")
 
-        @command_pid = Process.spawn("#{command_script} #{command['command']}", out: logfile, err: logfile)
-        sqs.delete_message(
-          queue_url: queue_url,
-          receipt_handle: message.receipt_handle,
-        )
-        upload_log("Executing command `#{command['command']}' on host #{`hostname`.chomp} pid #{command_pid}...")
-        _, status = Process.wait2(command_pid)
-        File.open(logfile, "a") do |file|
-          file.puts "Command `#{command['command']}' exited on host #{`hostname`.chomp}: #{status}"
+          @command_pid = nil
+          remove_metadata(command: command)
         end
-
-        @command_pid = nil
-        upload_logfile
+      rescue StandardError => e
+        log("[loop] #{e.class.name}: #{e.message}\n#{e.backtrace.join("\n")}")
+        next
       end
     end
   end
 
   private
 
-  attr_reader :command_pid, :command_script, :logfile, :logging_uri, :queue_url, :sqs
+  attr_reader :consumer_logfile, :command_logfile, :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
     exit
   rescue Errno::ESRCH
   end
 
-  def upload_log(logs)
-    if logging_uri
-      Net::HTTP.start(logging_uri.host, logging_uri.port, use_ssl: true) do |http|
-        request = Net::HTTP::Post.new(logging_uri)
-        request.body = logs
-        request.content_type = "text/plain"
-        http.request(request)
-      end
+  def command_from_message(message)
+    JSON.parse(message.body)
+  rescue JSON::ParserError => e
+    log("[command_from_message] #{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}")
     end
+  rescue StandardError => e
+    $stdout.puts message
+    $stderr.puts "#{e.class.name}: #{e.message}"
+    $stderr.puts e.backtrace.join("\n")
   end
 
-  def upload_logfile
-    if logging_uri
-      Net::HTTP.start(logging_uri.host, logging_uri.port, use_ssl: true) do |http|
-        request = Net::HTTP::Post.new(logging_uri, "Transfer-Encoding" => "chunked")
-        request.body_stream = File.open(logfile, "rb")
-        request.content_type = "text/plain"
-        http.request(request)
-      end
+  def log_command(message)
+    File.open(command_logfile, "a") do |file|
+      file.puts("[#{Time.now.iso8601}] [elastic_beans/exec] #{message}")
     end
+  rescue StandardError => e
+    $stdout.puts message
+    $stderr.puts "#{e.class.name}: #{e.message}"
+    $stderr.puts e.backtrace.join("\n")
+  end
+
+  def receive_message
+    sqs.receive_message(
+      queue_url: queue_url,
+      max_number_of_messages: 1,
+    ).messages[0]
+  rescue StandardError => e
+    log("[receive_message] #{e.class.name}: #{e.message}\n#{e.backtrace.join("\n")}")
   end
+
+  def delete_message(message)
+    sqs.delete_message(
+      queue_url: queue_url,
+      receipt_handle: message.receipt_handle,
+    )
+  rescue StandardError => e
+    log("[delete_message] #{e.class.name}: #{e.message}\n#{e.backtrace.join("\n")}")
+  end
+
+  def update_metadata(command:, start_time:)
+    metadata = command['metadata']
+    if metadata && metadata['bucket'] && metadata['key']
+      s3.put_object(
+        bucket: metadata['bucket'],
+        key: metadata['key'],
+        body: {
+          instance_id: instance_id,
+          start_time: start_time.iso8601,
+        }.merge(command).to_json,
+      )
+    end
+  rescue StandardError => e
+    log("[update_metadata] #{e.class.name}: #{e.message}\n#{e.backtrace.join("\n")}")
+  end
+
+  def remove_metadata(command:)
+    metadata = command['metadata']
+    if metadata && metadata['bucket'] && metadata['key']
+      s3.delete_object(
+        bucket: metadata['bucket'],
+        key: metadata['key'],
+      )
     end
+  rescue StandardError => e
+    log("[remove_metadata] #{e.class.name}: #{e.message}\n#{e.backtrace.join("\n")}")
+  end
+end

data/lib/elastic_beans/rack/exec.rb

@@ -17,7 +17,6 @@ module ElasticBeans
       def initialize(app, args={})
         @app = app
         @application = args.fetch(:application)
-        @sqs = args.fetch(:sqs)
         @logger = args[:logger] || Logger.new("/dev/null")
       end
 
@@ -27,7 +26,7 @@ module ElasticBeans
           command = command_from_request(request)
           logger.info("[elastic_beans] Executing command: `#{command}'")
           begin
-            application.enqueue_command(command, sqs: sqs)
+            application.enqueue_command(command)
           rescue => e
             logger.info("[elastic_beans] Enqueue failed: #{e.class.name}: #{e.message}\n#{e.backtrace.join("; ")}")
             return FAILURE
@@ -42,7 +41,7 @@ module ElasticBeans
 
       private
 
-      attr_reader :app, :application, :logger, :sqs
+      attr_reader :app, :application, :logger
 
       def aws_sqsd?(request)
         current_user_agent = request.headers['User-Agent'.freeze]
@@ -52,7 +51,8 @@ module ElasticBeans
       end
 
       def command_from_request(request)
-        URI.unescape(request.path.sub(%r{\A/exec/}, ''))
+        command_string = URI.unescape(request.path.sub(%r{\A/exec/}, ''))
+        ::ElasticBeans::Exec::Command.new(command_string: command_string)
       end
 
       def cron_request?(request)

data/lib/elastic_beans/ui.rb

@@ -1,3 +1,5 @@
+require 'tty-table'
+
 module ElasticBeans
   # :nodoc: all
   # @!visibility private
@@ -24,6 +26,34 @@ module ElasticBeans
       stdout.puts message
     end
 
+    def table(level:, columns:, rows:)
+      raise "ElasticBeans::UI#table: No such level '#{level}'" unless %w(debug error info).include?(level.to_s)
+      raise "ElasticBeans::UI#table: Missing 'columns' argument" if columns.empty?
+
+      msg = Proc.new do
+        # Produce an array for each row, containing strings for each column
+        if rows.any?
+          table_rows = rows.map { |item|
+            columns.map { |_, item_proc|
+              item_proc.call(item)
+            }
+          }
+        else
+          table_rows = [columns.map { "" }]
+        end
+        TTY::Table.new(
+          header: columns.keys,
+          rows: table_rows,
+        ).render(:basic)
+      end
+
+      if level.to_s == "debug"
+        debug(&msg)
+      else
+        send(level, msg.call)
+      end
+    end
+
     private
 
     def verbose?

data/lib/elastic_beans/version.rb

@@ -1,3 +1,3 @@
 module ElasticBeans
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic_beans
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Adam Stegman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-30 00:00:00.000000000 Z
+date: 2017-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -168,6 +182,7 @@ files:
 - lib/elastic_beans/command/deploy.rb
 - lib/elastic_beans/command/exec.rb
 - lib/elastic_beans/command/get_env.rb
+- lib/elastic_beans/command/ps.rb
 - lib/elastic_beans/command/scale.rb
 - lib/elastic_beans/command/set_env.rb
 - lib/elastic_beans/command/talk.rb
@@ -189,9 +204,12 @@ files:
 - lib/elastic_beans/environment/worker.rb
 - lib/elastic_beans/error.rb
 - lib/elastic_beans/error/environments_not_ready.rb
+- lib/elastic_beans/exec.rb
+- lib/elastic_beans/exec/command.rb
 - lib/elastic_beans/exec/ebextension.yml
 - lib/elastic_beans/exec/elastic_beans_exec.conf
 - lib/elastic_beans/exec/init.rb
+- lib/elastic_beans/exec/logrotate
 - lib/elastic_beans/exec/run_command.sh
 - lib/elastic_beans/exec/sqs_consumer.rb
 - lib/elastic_beans/network.rb
@@ -218,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Elastic Beanstalk environment orchestration for a Rails app