broadside 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f38120e5ed461522f423547c8f4cb6cb1d80dc2
-  data.tar.gz: 46b2213e403886e691880e640752fd2791bc0b69
+  metadata.gz: 899d3a593ec0af2a6d0bf8ac1d57c70effc37ca5
+  data.tar.gz: 51a9d9276948eaf1beef32e2392bb66b0d4bd372
 SHA512:
-  metadata.gz: 452b96e5e2567b1e954897c3652742199b33402e718c9d0cb63131b1756691ed7f4c9895a06695dce6ee75046042290f7b6c7f015d6d9f057fda561b879e5467
-  data.tar.gz: 783ae62663751c666413f2a2a72d2ba6d745e419254c0c8fccd2769cb415686cc4378b00b6da3298eaf11549004c2fdb63445e9496d84027c76c5a0d03d0b112
+  metadata.gz: 6c828f7cf4ae5c293265af3e8a40955695fd3cd6b346a5628eb716a253fb55216dfb57ca55c34fccc3c98d7b965d44810ade651ed513486b9b8b217cefcaadf7
+  data.tar.gz: fcd3efac4301a37d48dab29b91df591a349b2cdd953dbb015d69008c7bd4bd3cbaa7d660448c63f49c8a55b6558c0814c3161deec48bcdafda5fb598999f8ae6

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 3.3.0
+-- Add `execute` command to execute arbitrary bash inside a running container
+-- Add `--all` flag to `execute` to run a command on all containers
+-- Always turn on TTY interaction when running remote commands.
+-- Fix bug with command being an array instead of string
+
 # 3.2.0
 -- Add ability to execute a bash command on a container
 -- Output actual bash command being run when log level is debug.

data/README.md

@@ -15,7 +15,7 @@ Broadside does _not_ attempt to handle operational tasks like infrastructure set
 - **Inject** environment variables into ECS containers from local configuration files
 - **Launch a bash shell** on container in the cluster
 - **SSH** directly onto a host running a container
-- **Execute** an arbitrary shell command on a container
+- **Execute** an arbitrary shell command on a container (or all containers)
 - **Tail logs** of a running container
 - **Scale** an existing deployment on the fly
 
@@ -31,17 +31,17 @@ Broadside.configure do |config|
   config.targets = {
     production_web: {
       scale: 7,
-      command: ['bundle', 'exec', 'unicorn', '-c', 'config/unicorn.conf.rb'],
+      command: %w(bundle exec unicorn -c config/unicorn.conf.rb),
       env_file: '.env.production'
       predeploy_commands: [
-        ['bundle', 'exec', 'rake', 'db:migrate'],
-        ['bundle', 'exec', 'rake', 'data:migrate']
+        %w(bundle exec rake db:migrate),
+        %w(bundle exec rake data:migrate)
       ]
     },
     # If you have multiple images or clusters, you can configure them per target
     staging_web: {
       scale: 1,
-      command: ['bundle', 'exec', 'puma'],
+      command: %w(bundle exec puma),
       env_file: '.env.staging',
       tag: 'latest',                                # Set a default tag for this target
       cluster: 'staging-cluster',                   # Overrides config.aws.ecs_default_cluster
@@ -49,7 +49,7 @@ Broadside.configure do |config|
     },
     json_stream: {
       scale: 1,
-      command: ['java', '-cp', '*:.', 'path.to.MyClass'],
+      command: %w(java -cp *:. path.to.MyClass),
       # This target has a task_definition and service config which you use to bootstrap a new AWS Service
       service_config: { deployment_configuration: { minimum_healthy_percent: 0.5 } },
       task_definition_config: { container_definitions: [ { cpu: 1, memory: 2000, } ] }

data/lib/broadside/command.rb

@@ -1,3 +1,4 @@
+require 'open3'
 require 'pp'
 require 'shellwords'
 require 'tty-table'
@@ -108,13 +109,24 @@ module Broadside
       end
 
       def bash(options)
-        command = options[:command] || BASH
         target = Broadside.config.get_target_by_name!(options[:target])
+        cmd = "docker exec -i -t `#{docker_ps_cmd(target.family)}` #{BASH}"
         ip = get_running_instance_ip!(target, *options[:instance])
+        info "Executing #{BASH} on running container at #{ip}..."
+
+        system_exec(Broadside.config.ssh_cmd(ip, tty: true) + " '#{cmd}'")
+      end
+
+      def execute(options)
+        command = options[:command]
+        target = Broadside.config.get_target_by_name!(options[:target])
         cmd = "docker exec -i -t `#{docker_ps_cmd(target.family)}` #{command}"
-        info "Executing #{command} on running container at #{ip}..."
+        ips = options[:all] ? running_instances(target) : [get_running_instance_ip!(target, *options[:instance])]
 
-        system_exec(Broadside.config.ssh_cmd(ip, tty: command == BASH) + " '#{cmd}'")
+        ips.each do |ip|
+          info "Executing '#{command}' on running container at #{ip}..."
+          Open3.popen3(Broadside.config.ssh_cmd(ip, tty: true) + " '#{cmd}'") { |_, stdout, _, _| puts stdout.read }
+        end
       end
 
       private
@@ -125,16 +137,20 @@ module Broadside
       end
 
       def get_running_instance_ip!(target, instance_index = 0)
-        EcsManager.check_service_and_task_definition_state!(target)
-        running_instances = EcsManager.get_running_instance_ips!(target.cluster, target.family)
+        instances = running_instances(target)
 
         begin
-          running_instances.fetch(instance_index)
+          instances.fetch(instance_index)
         rescue IndexError
-          raise Error, "There are only #{running_instances.size} instances; index #{instance_index} does not exist"
+          raise Error, "There are only #{instances.size} instances; index #{instance_index} does not exist"
         end
       end
 
+      def running_instances(target)
+        EcsManager.check_service_and_task_definition_state!(target)
+        EcsManager.get_running_instance_ips!(target.cluster, target.family)
+      end
+
       def docker_ps_cmd(family)
         "docker ps -n 1 --quiet --filter name=#{Shellwords.shellescape(family)}"
       end

data/lib/broadside/gli/commands.rb

@@ -91,19 +91,32 @@ command :ssh do |ssh|
   end
 end
 
-desc 'Establish a shell or run a bash command inside a running container.'
+desc 'Establish a shell inside a running container.'
 command :bash do |bash|
   add_command_flags(bash)
 
-  bash.desc 'bash command to run (wrap argument in quotes)'
-  bash.arg_name 'BASH_COMMAND'
-  bash.flag [:c, :command], type: Array
-
   bash.action do |_, options, _|
     Broadside::Command.bash(options)
   end
 end
 
+desc 'Execute a bash command inside a running container.'
+command :execute do |execute|
+  add_command_flags(execute)
+
+  execute.desc 'bash command to run (wrap argument in quotes)'
+  execute.arg_name 'BASH_COMMAND'
+  execute.flag [:c, :command], type: String, required: true
+
+  execute.desc 'run on all containers in series'
+  execute.arg_name 'ALL_CONTAINERS'
+  execute.switch :all, negatable: false
+
+  execute.action do |_, options, _|
+    Broadside::Command.execute(options)
+  end
+end
+
 desc 'Deploy your application.'
 command :deploy do |d|
   d.desc 'Deploys WITHOUT running predeploy commands'

data/lib/broadside/version.rb

@@ -1,3 +1,3 @@
 module Broadside
-  VERSION = '3.2.0'.freeze
+  VERSION = '3.3.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: broadside
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Matthew Leung
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-14 00:00:00.000000000 Z
+date: 2017-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport