sonic-screwdriver 2.1.0 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c57f41a4fe34d84ef5b27b1a02119d4f44ebabfc7cb4a4c5b16eee2674d4a17
-  data.tar.gz: 95a874ce5035de37d982a7e305c1da4fe264c12fa6caf4b25e789cf311c8ddf5
+  metadata.gz: 2ac8a33e325657ad0ee4fab9c2d7a4a1d8c3fafbaf0017fed20446983869c39b
+  data.tar.gz: 4b8bcf43b60ae33936f07b4d800173b2c1df27d091f1fac3e8f2f082501a8823
 SHA512:
-  metadata.gz: d5945bde37e07a2bca384f1ed60b35aa03933adf6ce67fae1c3149c25df8debe564fe0b0ee1c266faafba48d7e3f815d8720b0f38eb40329884c7a795b17b099
-  data.tar.gz: 3cacc002fd1f7926ec97a32534c62ed4c7081aee660173b93db3df2711c2dbeb61d33ae140c94eea336cb7f007715e964d418c817a7eff2ffeaffcd36139a05a
+  metadata.gz: 97d9a1992af8d4e2dbede1ae0f8f965b773b94cde16bc06493fc99932cdbc3205c63ebef16c649e95e2f6f9d539775c45ed36db01897f7e33fcc80fe5509f9bb
+  data.tar.gz: dd12a4015571ef144a3a793f9cae38c09ab4f55f8353aea07fbe8c5d598057167b5111988d1a12c595a3d044213bf126deca1fc5c8901fa21b23b3742c28cc94

data/.circleci/config.yml

@@ -7,7 +7,7 @@ jobs:
   build:
     docker:
       # specify the version you desire here
-      - image: circleci/ruby:2.5.1-node-browsers
+      - image: circleci/ruby:2.6.5-node-browsers
 
       # Specify service dependencies here if necessary
       # CircleCI maintains a library of pre-built images
@@ -35,6 +35,8 @@ jobs:
       - run:
           name: install dependencies
           command: |
+            gem install bundler
+            gem update --system
             bundle install --jobs=4 --retry=3 --path vendor/bundle
 
       - save_cache:

data/.gitignore

@@ -14,3 +14,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+Gemfile.lock

data/CHANGELOG.md

@@ -1,7 +1,25 @@
 # Change Log
 
 All notable changes to this project will be documented in this file.
-This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
+This project *loosely* adheres to [Semantic Versioning](http://semver.org/), even before v1.0.
+
+## [2.2.3] - 2021-04-12
+- [#12](https://github.com/boltops-tools/sonic/pull/12) fix cli check
+
+## [2.2.2] - 2021-04-12
+- [#11](https://github.com/boltops-tools/sonic/pull/11) cli check
+
+## [2.2.1] - 2021-04-12
+- [#9](https://github.com/boltops-tools/sonic/pull/9) improve command array handling
+
+## [2.2.0]
+- #7 sonic execute command: `--tags` and `--instance-id` options instead of polymorphic list. Breaking behavior.
+- display output even if tags used
+- configure default log group
+- correct exit status
+
+## [2.1.1]
+- use rainbow gem for terminal colors
 
 ## [2.1.0]
 - change the setting format to ssh.user instead of bastion.user

data/README.md

@@ -4,6 +4,8 @@
 [![Gitter](https://badges.gitter.im/boltopslabs/sonic.svg)](https://gitter.im/boltopslabs/sonic?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 [![Support](https://img.shields.io/badge/get-support-blue.svg)](https://boltops.com?utm_source=badge&utm_medium=badge&utm_campaign=sonic)
 
+[![BoltOps Badge](https://img.boltops.com/boltops/badges/boltops-badge.png)](https://www.boltops.com)
+
 Sonic is a multi-functional tool that helps you manage AWS resources. Sonic contains a group of commands that help debug EC2 instances and ECS containers quickly.
 
 See [sonic-screwdriver.cloud](http://sonic-screwdriver.cloud) for full documentation.
@@ -32,15 +34,7 @@ By the time I get into the container, I need to remind my brain of what the orig
 
 You can install sonic with RubyGems
 
-```sh
-gem install sonic
-```
-
-If you want to quickly install sonic without having to worry about sonic's dependencies you can also install the Bolts Toolbelt which has sonic included.
-
-```sh
-brew cask install boltopslabs/software/bolts
-```
+    gem install sonic
 
 Full installation instructions are at [Install Sonic Screwdriver](http://sonic-screwdriver.cloud/docs/install/).  There are some server side dependencies for some of the sonic commands, so it is important to read through the full installation guide.
 
@@ -48,30 +42,33 @@ Full installation instructions are at [Install Sonic Screwdriver](http://sonic-s
 
 Here is a quick overview of sonic abilities:
 
-```sh
-# ssh into an instance
-sonic ssh i-0f7f833131a51ce35
-sonic ssh hi-web # ec2 tag
-sonic ssh hi-web --cluster staging # ecs service name
-sonic ssh hi-web --cluster staging # ecs service name
-sonic ssh 7fbc8c75-4675-4d39-a5a4-0395ff8cd474 --cluster staging # ECS container id
-sonic ssh 1ed12abd-645c-4a05-9acf-739b9d790170 --cluster staging # ECS task id
+    # ssh into an instance
+    sonic ssh i-0f7f833131a51ce35
+    sonic ssh demo-web # ec2 tag
+    sonic ssh demo-web --cluster staging # ecs service name
+    sonic ssh demo-web --cluster staging # ecs service name
+    sonic ssh 7fbc8c75-4675-4d39-a5a4-0395ff8cd474 --cluster staging # ECS container id
+    sonic ssh 1ed12abd-645c-4a05-9acf-739b9d790170 --cluster staging # ECS task id
+
+    # docker exec to a running ECS docker container
+    sonic ecs exec demo-web
 
-# docker exec to a running ECS docker container
-sonic ecs exec hi-web
+    # docker run with the same environment as the ECS docker running containers
+    sonic ecs sh demo-web
 
-# docker run with the same environment as the ECS docker running containers
-sonic ecs sh hi-web
+    # run command with instance ids
+    sonic execute --instance-ids i-111 uptime
+    sonic execute --instance-ids i-111,i-222 uptime
 
-# run command on 1 instance
-sonic execute i-0f7f833131a51ce35 uptime
+    # run command on all instances tagged with Name demo-web and worker
+    sonic execute --tags Name=demo-web,demo-worker uptime
 
-# run command on all instances tagged with hi-web and worker
-sonic execute hi-web,hi-worker uptime
+    # run command on all instances with multiple tags
+    # Quotes are important due to semi-colon
+    sonic execute --tags "Name=demo-web,demo-worker;Owner=test" uptime
 
-# list ec2 instances
-sonic list hi-web
-```
+    # list ec2 instances
+    sonic list demo-web
 
 ## Contributing
 

data/docs/_docs/install.md

@@ -16,16 +16,6 @@ You can also add sonic to your Gemfile in your project if you are working with a
 gem "sonic-screwdriver"
 ```
 
-### Install with Bolts Toolbelt
-
-If you want to install sonic without having to worry about sonic's ruby dependency you can simply install the Bolts Toolbelt which has sonic included.
-
-```sh
-brew cask install boltopslabs/software/bolts
-```
-
-For more information about the Bolts Toolbelt or to get an installer for another operating system visit: [https://boltops.com/toolbelt](https://boltops.com/toolbelt)
-
 ### Server Side Dependencies
 
 For a small set of the commands there are server side dependencies.

data/docs/_docs/tutorial-execute.md

@@ -6,56 +6,50 @@ title: Sonic Execute
 
 Sonic provides a way to execute commands remotely and securely across a list of AWS servers.  It does this by leveraging [Amazon EC2 Run Command](https://aws.amazon.com/ec2/execute/).  Sonic a simple interface and some conveniences for you.   The command is called `sonic execute`:
 
-```sh
-sonic execute [FILTER] [COMMAND]
-```
+    sonic execute [FILTER] [COMMAND]
 
 ## Examples Summary
 
-```sh
-sonic execute hi-web uptime
-sonic execute hi-web-prod uptime
-sonic execute i-030033c20c54bf149,i-030033c20c54bf150 uname -a
-sonic execute i-030033c20c54bf149 file://hello.sh
-```
+    sonic execute --tags Name=demo-web uptime
+    sonic execute --tags Name=demo-web,demo-worker uptime # multiple tag values
+    sonic execute --instance-ids i-030033c20c54bf149,i-030033c20c54bf150 uname -a
+    sonic execute --instance-ids i-030033c20c54bf149 file://hello.sh
 
 ## Example Detailed
 
 Here's a command example output in detailed:
 
-```sh
-$ sonic execute i-0bf51a000ab4e73a8 uptime
-Sending command to SSM with options:
----
-instance_ids:
-- i-0bf51a000ab4e73a8
-document_name: AWS-RunShellScript
-comment: sonic execute i-0bf51a000ab4e73a8 uptime
-parameters:
-  commands:
-  - uptime
-output_s3_region: us-east-1
-output_s3_bucket_name: [reacted]
-output_s3_key_prefix: ssm/commands/sonic
-
-Command sent to AWS SSM. To check the details of the command:
-  aws ssm list-commands --command-id 0bb18d58-6436-49fd-9bfd-0c4b6c51c7a2
-  aws ssm get-command-invocation --command-id 0bb18d58-6436-49fd-9bfd-0c4b6c51c7a2 --instance-id i-0bf51a000ab4e73a8
-
-Waiting for ssm command to finish.....
-Command finished.
-
-Displaying output for i-0bf51a000ab4e73a8.
-Command status: Success
-Command standard output:
- 01:08:10 up 8 days,  6:41,  0 users,  load average: 0.00, 0.00, 0.00
-
-To see the more output details visit:
-  https://us-west-2.console.aws.amazon.com/systems-manager/run-command/0bb18d58-6436-49fd-9bfd-0c4b6c51c7a2
-
-Pro tip: the console url is already in your copy/paste clipboard.
-$
-```
+    $ sonic execute --instance-ids i-0bf51a000ab4e73a8 uptime
+    Sending command to SSM with options:
+    ---
+    instance_ids:
+    - i-0bf51a000ab4e73a8
+    document_name: AWS-RunShellScript
+    comment: sonic execute --instance-ids i-0bf51a000ab4e73a8 uptime
+    parameters:
+      commands:
+      - uptime
+    output_s3_region: us-east-1
+    output_s3_bucket_name: [reacted]
+    output_s3_key_prefix: ssm/commands/sonic
+
+    Command sent to AWS SSM. To check the details of the command:
+      aws ssm list-commands --command-id 0bb18d58-6436-49fd-9bfd-0c4b6c51c7a2
+      aws ssm get-command-invocation --command-id 0bb18d58-6436-49fd-9bfd-0c4b6c51c7a2 --instance-id i-0bf51a000ab4e73a8
+
+    Waiting for ssm command to finish.....
+    Command finished.
+
+    Displaying output for i-0bf51a000ab4e73a8.
+    Command status: Success
+    Command standard output:
+     01:08:10 up 8 days,  6:41,  0 users,  load average: 0.00, 0.00, 0.00
+
+    To see the more output details visit:
+      https://us-west-2.console.aws.amazon.com/systems-manager/run-command/0bb18d58-6436-49fd-9bfd-0c4b6c51c7a2
+
+    Pro tip: the console url is already in your copy/paste clipboard.
+    $
 
 Notice the conveniences of `sonic execute`, it:
 
@@ -69,28 +63,30 @@ The AWS SSM console looks like this:
 
 <img src="/img/tutorials/ec2-console-run-command.png" class="doc-photo" />
 
-### Polymorphic Filter
+### Filter Options
 
-The `sonic execute` command can understand a variety of different filters.  The filters can be a list of instances ids or one EC2 tag value.  Note, ECS service names are *not* supported for the filter.
+The `sonic execute` command can understand a variety of different filters: `--tags` and `--instance-ids`.  Note, ECS service names are *not* supported for the filter.
 
 Here is an example, where the uptime command will run on both `i-030033c20c54bf149` and `i-030033c20c54bf150` instances.
 
-```sh
-sonic execute i-066b140d9479e9681,i-09482b1a6e330fbf7 uptime
-```
+    sonic execute --instance-ids i-066b140d9479e9681,i-09482b1a6e330fbf7 uptime
+
+Here is an example, where the uptime command will run on instances tagged with `Name=demo-web`
+
+    sonic execute --tags Name=demo-web uptime
 
 ## Windows Support
 
 Windows is also supported. When running a command sonic will first attempt to use the `AWS-RunShellScript` run command, and if it detects that the instance's platform does not support `AWS-RunShellScript`, it will run the command with the `AWS-RunPowerShellScript` run command.  Here's an example:
 
 ```
-$ sonic execute i-0917ad61b10fa1059 pwd
+$ sonic execute --instance-ids i-0917ad61b10fa1059 pwd
 Sending command to SSM with options:
 ---
 instance_ids:
 - i-0917ad61b10fa1059
 document_name: AWS-RunShellScript
-comment: sonic execute i-0917ad61b10fa1059 pwd
+comment: sonic execute --instance-ids i-0917ad61b10fa1059 pwd
 parameters:
   commands:
   - pwd
@@ -129,16 +125,12 @@ $
 
 Sometimes you might want to run more than just a one-liner command. If you need to run a full script, you can provide the file path to the script by designating it with `file://`.  For example, here's a file called `hi.sh`:
 
-```bash
-#!/bin/bash
-echo "hello world"
-```
+    #!/bin/bash
+    echo "hello world"
 
 Here's how you run that file:
 
-```sh
-sonic execute hi-web file://hi.sh
-```
+    sonic execute demo-web file://hi.sh
 
 The file gets read by `sonic execute` and sent to EC2 Run Command to be executed.
 

data/docs/_includes/footer.html

@@ -6,10 +6,12 @@
                     <div class="footer-col col-md-4">
                         <h3>More Tools</h3>
                         <ul class="list-unstyled tools">
-                            <li><a href="http://jack-eb.com">Jack</a></li>
-                            <li><a href="http://lono.cloud">Lono</a></li>
-                            <li><a href="http://ufoships.com">Ufo</a></li>
-                            <li><a href="https://boltops.com/toolbelt">Toolbelt</a></li>
+                            <li><a href="https://terraspace.cloud">Terraspace</a></li>
+                            <li><a href="https://kubes.guru">Kubes</a></li>
+                            <li><a href="https://rubyonjets.com">Jets</a></li>
+                            <li><a href="https://ufoships.com">Ufo</a></li>
+                            <li><a href="https://lono.cloud">Lono</a></li>
+                            <li><a href="https://jack-eb.com">Jack</a></li>
                         </ul>
                     </div>
                     <div class="footer-col col-md-4">

data/docs/_reference/sonic-execute.md

@@ -16,10 +16,10 @@ Runs command across fleet of servers via AWS Run Command.
 
 ## Examples Summary
 
-    $ sonic execute hi-web-prod uptime
-    $ sonic execute hi-web-prod,hi-worker-prod,hi-clock-prod uptime
-    $ sonic execute i-030033c20c54bf149,i-030033c20c54bf150 uname -a
-    $ sonic execute i-030033c20c54bf149 file://hello.sh
+    sonic execute --tags Name=demo-web uptime
+    sonic execute --tags Name=demo-web,demo-worker uptime # multiple values
+    sonic execute --instance-ids i-030033c20c54bf149,i-030033c20c54bf150 uname -a
+    sonic execute --instance-ids i-030033c20c54bf149 file://hello.sh # script from file
 
 You cannot mix instance ids and tag names in the filter.
 
@@ -27,13 +27,13 @@ You cannot mix instance ids and tag names in the filter.
 
 Here's a command example output in detailed:
 
-    $ sonic execute i-0bf51a000ab4e73a8 uptime
+    $ sonic execute --instance-ids i-0bf51a000ab4e73a8 uptime
     Sending command to SSM with options:
     ---
     instance_ids:
     - i-0bf51a000ab4e73a8
     document_name: AWS-RunShellScript
-    comment: sonic execute i-0bf51a000ab4e73a8 uptime
+    comment: sonic execute --instance-ids i-0bf51a000ab4e73a8 uptime
     parameters:
       commands:
       - uptime
@@ -77,6 +77,8 @@ The AWS SSM console looks like this:
 ```
 [--zero-warn], [--no-zero-warn]  # Warns user when no instances found
                                  # Default: true
+[--instance-ids=INSTANCE_IDS]    # Instance ids to execute command on. Format: --instance-ids "i-111,i-222"
+[--tags=TAGS]                    # Tags used to determine what instances to execute command on. Format: --tags "Key1=v1,v2;Key2=v3"
 [--verbose], [--no-verbose]      
 [--noop], [--no-noop]            
 ```

data/docs/bin/web

@@ -1,4 +1,4 @@
 #!/bin/bash -ex
 
 bundle exec jekyll clean
-exec bundle exec jekyll serve
+exec bundle exec jekyll serve --host 0.0.0.0 "$@"

data/docs/quick-start.md

@@ -6,35 +6,31 @@ In a hurry? No sweat! Here's a quick overview of how to use sonic.
 
 ### Install
 
-```sh
-gem install sonic-screwdriver
-```
+    gem install sonic-screwdriver
 
 ### Usage
 
-```sh
-# ssh into an instance
-sonic ssh i-0f7f833131a51ce35
-sonic ssh hi-web # ec2 tag
-sonic ssh hi-web --cluster staging # ecs service name
-sonic ssh 7fbc8c75-4675-4d39-a5a4-0395ff8cd474 --cluster staging # ECS container id
-sonic ssh 1ed12abd-645c-4a05-9acf-739b9d790170 --cluster staging # ECS task id
+    # ssh into an instance
+    sonic ssh i-0f7f833131a51ce35
+    sonic ssh demo-web # ec2 tag
+    sonic ssh demo-web --cluster staging # ecs service name
+    sonic ssh 7fbc8c75-4675-4d39-a5a4-0395ff8cd474 --cluster staging # ECS container id
+    sonic ssh 1ed12abd-645c-4a05-9acf-739b9d790170 --cluster staging # ECS task id
 
-# docker exec to a running ECS docker container
-sonic ecs exec hi-web
+    # docker exec to a running ECS docker container
+    sonic ecs exec demo-web
 
-# docker run with same environment as the ECS docker running containers
-sonic ecs sh hi-web
+    # docker run with same environment as the ECS docker running containers
+    sonic ecs sh demo-web
 
-# run command on 1 instance
-sonic execute i-0f7f833131a51ce35 uptime
+    # run command on 1 instance
+    sonic execute --instance-ids i-0f7f833131a51ce35 uptime
 
-# run command on all instances tagged with hi-web and worker
-sonic execute hi-web,hi-worker uptime
+    # run command on all instances tagged with demo-web and worker
+    sonic execute --tags Name=demo-web,demo-worker uptime
 
-# list ec2 instances
-sonic list hi-web
-```
+    # list ec2 instances
+    sonic list demo-web
 
 Congratulations! You now know the basic sonic screwdriver commands now.
 

data/lib/sonic.rb

@@ -1,6 +1,6 @@
 $:.unshift(File.expand_path("../", __FILE__))
+require "rainbow/ext/string"
 require "sonic/version"
-require "colorize"
 
 module Sonic
   autoload :Core, 'sonic/core'

data/lib/sonic/checks.rb

@@ -3,7 +3,7 @@ module Sonic
     def check_cluster_exists!
       cluster = ecs.describe_clusters(clusters: [@cluster]).clusters.first
       unless cluster
-        UI.error "The #{@cluster.green} cluster does not exist.  Are you sure you specified the right cluster?"
+        UI.error "The #{@cluster.color(:green)} cluster does not exist.  Are you sure you specified the right cluster?"
         exit 1
       end
     end
@@ -20,7 +20,7 @@ module Sonic
 
       service = resp.services.first
       unless service
-        UI.error "The #{@service.green} service does not exist in #{@cluster.green} cluster.  Are you sure you specified the right service and cluster?"
+        UI.error "The #{@service.color(:green)} service does not exist in #{@cluster.color(:green)} cluster.  Are you sure you specified the right service and cluster?"
         exit 1
       end
     end

data/lib/sonic/cli.rb

@@ -27,8 +27,10 @@ module Sonic
     long_desc Help.text("execute")
     option :zero_warn, type: :boolean, default: true, desc: "Warns user when no instances found"
     # filter - Filter ec2 instances by tag name or instance_ids separated by commas
-    def execute(filter, *command)
-      Execute.new(command, options.merge(filter: filter)).execute
+    option :instance_ids, desc: %Q|Instance ids to execute command on. Format: --instance-ids "i-111,i-222"|
+    option :tags, desc: %Q|Tags used to determine what instances to execute command on. Format: --tags "Key1=v1,v2;Key2=v3"|
+    def execute(*command)
+      Execute.new(command, options).execute
     end
 
     desc "list [FILTER]", "Lists ec2 instances."

data/lib/sonic/docker.rb

@@ -30,7 +30,7 @@ module Sonic
 
     # command is an Array
     def execute(*command)
-      UI.say "=> #{command.join(' ')}".colorize(:green)
+      UI.say "=> #{command.join(' ')}".color(:green)
       success = system(*command)
       unless success
         UI.error(command.join(' '))
@@ -59,7 +59,7 @@ module Sonic
 
       ssh = ["ssh", ssh_options, "-At", host, "uptime", "2>&1"]
       command = ssh.join(' ')
-      puts "=> #{command}".colorize(:green)
+      puts "=> #{command}".color(:green)
       output = `#{command}`
       if output.include?("Permission denied")
         puts output

data/lib/sonic/execute.rb

@@ -1,4 +1,3 @@
-require 'colorize'
 require 'yaml'
 require 'active_support/core_ext/hash'
 
@@ -9,7 +8,8 @@ module Sonic
     def initialize(command, options)
       @command = command
       @options = options
-      @filter = @options[:filter].split(',').map{|s| s.strip}
+      @tags = @options[:tags]
+      @instance_ids = @options[:instance_ids]
     end
 
     # aws ssm send-command \
@@ -19,6 +19,7 @@ module Sonic
     #   --parameters '{"commands":["#!/usr/bin/python","print \"Hello world from python\""]}' \
     #   --query "Command.CommandId"
     def execute
+      check_filter_options!
       ssm_options = build_ssm_options
       if @options[:noop]
         UI.noop = true
@@ -34,6 +35,7 @@ module Sonic
         puts
         begin
           resp = send_command(ssm_options)
+
           command_id = resp.command.command_id
           success = true
         rescue Aws::SSM::Errors::InvalidInstanceId => e
@@ -50,9 +52,31 @@ module Sonic
       display_ssm_commands(command_id, ssm_options)
       puts
       return if @options[:noop]
-      wait(command_id)
-      display_ssm_output(command_id, ssm_options)
+      status = wait(command_id)
+      display_ssm_output(command_id)
       display_console_url(command_id)
+
+      if status == "Success"
+        puts "Command successful: #{status}".color(:green)
+        exit_status(0)
+      else
+        puts "Command unsuccessful: #{status}".color(:red)
+        exit_status(1)
+      end
+    end
+
+    def exit_status(code)
+      exit(code) if cli?
+
+      if code == 0
+        true
+      else
+        raise "Error running command"
+      end
+    end
+
+    def cli?
+      $0.include?('sonic')
     end
 
     def wait(command_id)
@@ -69,15 +93,21 @@ module Sonic
       end
       puts "\nCommand finished."
       puts
+      status
     end
 
-    def display_ssm_output(command_id, ssm_options)
-      instance_ids = ssm_options[:instance_ids]
-      return unless instance_ids && instance_ids.size > 0
+    def display_ssm_output(command_id)
+      resp = ssm.list_command_invocations(command_id: command_id)
+      command_invocations = resp.command_invocations
+      command_invocation = command_invocations.first
+      unless command_invocation
+        puts "WARN: No instances found that matches the --tags or --instance-ids option".color(:yellow)
+        return false # instances_found
+      end
+      instance_id = command_invocation.instance_id
 
-      instance_id = instance_ids.first
-      if ssm_options[:instance_ids].size > 1
-        puts "Multiple instance targets. Only displaying output for #{instance_id}."
+      if command_invocations.size > 1
+        puts "Multiple instance targets. Total targets: #{command_invocations.size}. Only displaying output for #{instance_id}."
       else
         puts "Displaying output for #{instance_id}."
       end
@@ -89,6 +119,7 @@ module Sonic
       ssm_output(resp, "output")
       ssm_output(resp, "error")
       puts
+      true # instances_found
     end
 
     def display_console_url(command_id)
@@ -97,16 +128,15 @@ module Sonic
       puts "To see the more output details visit:"
       puts "  #{console_url}"
       puts
-      copy_paste_clipboard(console_url)
-      UI.say "Pro tip: the console url is already in your copy/paste clipboard."
+      copy_paste_clipboard(console_url, "Pro tip: the console url is already in your copy/paste clipboard.")
     end
 
     def colorized_status(status)
       case status
       when "Success"
-        status.colorize(:green)
+        status.color(:green)
       when "Failed"
-        status.colorize(:red)
+        status.color(:red)
       else
         status
       end
@@ -121,7 +151,7 @@ module Sonic
       return if content.empty?
 
       puts "Command standard #{type}:"
-      # "https://s3.amazonaws.com/lr-infrastructure-prod/ssm/commands/sonic/0a4f4bef-8f63-4235-8b30-ae296477261a/i-0b2e6e187a3f9ada9/awsrunPowerShellScript/0.awsrunPowerShellScript/stderr">
+      # "https://s3.amazonaws.com/infra-prod/ssm/commands/sonic/0a4f4bef-8f63-4235-8b30-ae296477261a/i-0b2e6e187a3f9ada9/awsrunPowerShellScript/0.awsrunPowerShellScript/stderr">
       if content.include?("--output truncated--") && !resp[s3_key].empty?
         s3_url = resp[s3_key]
         info = s3_url.sub('https://s3.amazonaws.com/', '').split('/')
@@ -147,7 +177,6 @@ module Sonic
 
       begin
         resp = ssm.send_command(options)
-        # puts "NOOP FOR NOW"
       rescue Aws::SSM::Errors::UnsupportedPlatformType
         retries += 1
         # toggle AWS-RunShellScript / AWS-RunPowerShellScript
@@ -166,12 +195,18 @@ module Sonic
     end
 
     def build_ssm_options
-      criteria = transform_filter(@filter)
+      criteria = transform_filter_option
       command = build_command(@command)
       options = criteria.merge(
         document_name: "AWS-RunShellScript", # default
         comment: "sonic #{ARGV.join(' ')}"[0..99], # comment has a max of 100 chars
-        parameters: { "commands" => command }
+        parameters: { "commands" => command },
+        # Default CloudWatchLog settings. Can be overwritten with settings.yml send_command
+        # IMPORTANT: make sure the EC2 instance the command runs on has access to write to CloudWatch Logs.
+        cloud_watch_output_config: {
+          # cloud_watch_log_group_name: "ssm", # Defaults to /aws/ssm/AWS-RunShellScript (aws/ssm/SystemsManagerDocumentName https://amzn.to/38TKVse)
+          cloud_watch_output_enabled: true,
+        },
       )
       settings_options = settings["send_command"] || {}
       options.merge(settings_options.deep_symbolize_keys)
@@ -181,6 +216,12 @@ module Sonic
       @settings ||= Setting.new.data
     end
 
+    def check_filter_options!
+      return if @tags || @instance_ids
+      puts "ERROR: Please provide --tags or --instance-ids option".color(:red)
+      exit 1
+    end
+
     #
     # Public: Transform the filter to the ssm send_command equivalent options
     #
@@ -188,41 +229,31 @@ module Sonic
     #
     # Examples
     #
-    #   transform_filter(["hi-web-prod", "hi-worker-prod", "i-006a097bb10643e20"])
+    #   transform_filter_option
     #   # => {
     #      instance_ids: ["i-006a097bb10643e20"],
     #      targets: [{key: "Name", values: "hi-web-prod,hi-worker-prod"}]
     #     }
     #
     # Returns the duplicated String.
-    def transform_filter(filter)
-      valid = validate_filter(filter)
-      unless valid
-        UI.error("The filter you provided '#{filter.join(',')}' is not valid.")
-        UI.say("The filter must either be all instance ids or just a list of tag names.")
-        exit 1
-      end
-
-      if filter.detect { |i| instance_id?(i) }
-        instance_ids = filter
-        {instance_ids: instance_ids}
-      else
-        tags = filter
-        targets = [{
-          key: "tag:#{tag_name}",
-          values: tags
-        }]
+    def transform_filter_option
+      if @tags
+        list = @tags.split(';')
+        targets = list.inject([]) do |final,item|
+          tag_name,value_list = item.split('=')
+          values = value_list.split(',').map(&:strip)
+          # structure expected by ssm send_command
+          option = {
+            key: "tag:#{tag_name}",
+            values: values
+          }
+          final << option
+          final
+        end
         {targets: targets}
-      end
-    end
-
-    # Either all instance ids are no instance ids is a valid filter
-    def validate_filter(filter)
-      if filter.detect { |i| instance_id?(i) }
-        instance_ids = filter.select { |i| instance_id?(i) }
-        instance_ids.size == filter.size
-      else
-        true
+      else # @instance_ids
+        instance_ids = @instance_ids.split(',')
+        {instance_ids: instance_ids}
       end
     end
 
@@ -239,7 +270,7 @@ module Sonic
         # The script is being feed inline so just join the command together into one script.
         # Still keep in an array form because that's how ssn.send_command works with AWS-RunShellScript
         # usually reads the command.
-        [command.join(" ")]
+        command.is_a?(Array) ? command : [command]
       end
     end
 
@@ -254,8 +285,7 @@ You can use the following command to check registered instances to SSM.
 #{ssm_describe_command}
       EOS
       UI.warn(message)
-      copy_paste_clipboard(ssm_describe_command)
-      UI.say "Pro tip: ssm describe-instance-information already in your copy/paste clipboard."
+      copy_paste_clipboard(ssm_describe_command, "Pro tip: ssm describe-instance-information already in your copy/paste clipboard.")
     end
 
     def file_path?(command)
@@ -312,9 +342,10 @@ EOL
       end
     end
 
-    def copy_paste_clipboard(command)
+    def copy_paste_clipboard(command, text)
       return unless RUBY_PLATFORM =~ /darwin/
       system("echo '#{command}' | pbcopy")
+      UI.say text
     end
   end
 end

data/lib/sonic/help/execute.md

@@ -3,10 +3,10 @@
 
 ## Examples Summary
 
-    $ sonic execute hi-web-prod uptime
-    $ sonic execute hi-web-prod,hi-worker-prod,hi-clock-prod uptime
-    $ sonic execute i-030033c20c54bf149,i-030033c20c54bf150 uname -a
-    $ sonic execute i-030033c20c54bf149 file://hello.sh
+    sonic execute --tags Name=demo-web uptime
+    sonic execute --tags Name=demo-web,demo-worker uptime # multiple values
+    sonic execute --instance-ids i-030033c20c54bf149,i-030033c20c54bf150 uname -a
+    sonic execute --instance-ids i-030033c20c54bf149 file://hello.sh # script from file
 
 You cannot mix instance ids and tag names in the filter.
 
@@ -14,13 +14,13 @@ You cannot mix instance ids and tag names in the filter.
 
 Here's a command example output in detailed:
 
-    $ sonic execute i-0bf51a000ab4e73a8 uptime
+    $ sonic execute --instance-ids i-0bf51a000ab4e73a8 uptime
     Sending command to SSM with options:
     ---
     instance_ids:
     - i-0bf51a000ab4e73a8
     document_name: AWS-RunShellScript
-    comment: sonic execute i-0bf51a000ab4e73a8 uptime
+    comment: sonic execute --instance-ids i-0bf51a000ab4e73a8 uptime
     parameters:
       commands:
       - uptime

data/lib/sonic/list.rb

@@ -35,7 +35,7 @@ module Sonic
 
       if @options[:header] && !zero_instances
         header = ["Instance Id", "Name", "Public IP", "Private IP", "Type"]
-        UI.say header.join("\t").colorize(:green)
+        UI.say header.join("\t").color(:green)
       end
 
       instances.each do |i|

data/lib/sonic/ssh.rb

@@ -1,5 +1,3 @@
-require 'colorize'
-
 module Sonic
   class Ssh
     autoload :IdentifierDetector, 'sonic/ssh/identifier_detector'
@@ -82,7 +80,7 @@ module Sonic
     def kernel_exec(*args)
       # append the optional command that can be provided to the ssh command
       full_command = args + @options[:command]
-      puts "=> #{full_command.join(' ')}".colorize(:green)
+      puts "=> #{full_command.join(' ')}".color(:green)
       # https://ruby-doc.org/core-2.3.1/Kernel.html#method-i-exec
       # Using 2nd form
       Kernel.exec(*full_command) unless @options[:noop]

data/lib/sonic/ssh/identifier_detector.rb

@@ -73,7 +73,7 @@ class Ssh
 
       task = response.tasks.first
       unless task
-        puts "Unable to find a #{task_arn.green} container instance or task in the #{@cluster.green} cluster."
+        puts "Unable to find a #{task_arn.color(:green)} container instance or task in the #{@cluster.color(:green)} cluster."
         exit 1
       end
 

data/lib/sonic/ui.rb

@@ -19,10 +19,10 @@ module Sonic
         puts msg unless mute
       end
       def error(msg='')
-        say "ERROR: #{msg}".colorize(:red)
+        say "ERROR: #{msg}".color(:red)
       end
       def warn(msg='')
-        say "WARN: #{msg}".colorize(:yellow)
+        say "WARN: #{msg}".color(:yellow)
       end
     end
   end

data/lib/sonic/version.rb

@@ -1,3 +1,3 @@
 module Sonic
-  VERSION = "2.1.0"
+  VERSION = "2.2.3"
 end

data/sonic.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "http://sonic-screwdriver.cloud/"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = File.directory?('.git') ? `git ls-files`.split($/) : Dir.glob("**/*")
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
@@ -23,9 +23,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "aws-sdk-ecs"
   spec.add_dependency "aws-sdk-s3"
   spec.add_dependency "aws-sdk-ssm"
-  spec.add_dependency "colorize"
   spec.add_dependency "hashie"
   spec.add_dependency "memoist"
+  spec.add_dependency "rainbow"
   spec.add_dependency "thor"
   spec.add_dependency "tty-prompt"
 

data/spec/lib/cli_spec.rb

@@ -11,8 +11,13 @@ describe Sonic::CLI do
       expect(out).to include("=> ssh")
     end
 
-    it "execute should print that command has been sent" do
-      out = execute("exe/sonic execute #{@args} 1,2,3 uptime")
+    it "execute should print that command has been sent --instance-ids" do
+      out = execute("exe/sonic execute #{@args} --instance-ids i-1,i-2,i-3 uptime")
+      expect(out).to include("Command sent")
+    end
+
+    it "execute should print that command has been sent --tags" do
+      out = execute("exe/sonic execute #{@args} --tags Name=value uptime")
       expect(out).to include("Command sent")
     end
 

data/spec/lib/sonic/execute_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Sonic::Execute do
   before(:each) do
     @options = {
-      filter: "i-066b140d9479e9681,i-09482b1a6e330fbf7"
+      instance_ids: "i-066b140d9479e9681,i-09482b1a6e330fbf7"
     }
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sonic-screwdriver
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.3
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-01 00:00:00.000000000 Z
+date: 2021-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: memoist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: memoist
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -260,11 +260,9 @@ files:
 - ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
-- ".ruby-version"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md
@@ -421,8 +419,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Multi-functional tool to manage AWS infrastructure

data/.ruby-version

@@ -1 +0,0 @@
-2.5.1

data/Gemfile.lock

@@ -1,163 +0,0 @@
-PATH
-  remote: .
-  specs:
-    sonic-screwdriver (2.0.0)
-      activesupport
-      aws-sdk-ec2
-      aws-sdk-ecs
-      aws-sdk-s3
-      aws-sdk-ssm
-      colorize
-      hashie
-      memoist
-      thor
-      tty-prompt
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.2.0)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    aws-eventstream (1.0.0)
-    aws-partitions (1.89.1)
-    aws-sdk-core (3.21.2)
-      aws-eventstream (~> 1.0)
-      aws-partitions (~> 1.0)
-      aws-sigv4 (~> 1.0)
-      jmespath (~> 1.0)
-    aws-sdk-ec2 (1.34.0)
-      aws-sdk-core (~> 3)
-      aws-sigv4 (~> 1.0)
-    aws-sdk-ecs (1.13.0)
-      aws-sdk-core (~> 3)
-      aws-sigv4 (~> 1.0)
-    aws-sdk-kms (1.5.0)
-      aws-sdk-core (~> 3)
-      aws-sigv4 (~> 1.0)
-    aws-sdk-s3 (1.13.0)
-      aws-sdk-core (~> 3, >= 3.21.2)
-      aws-sdk-kms (~> 1)
-      aws-sigv4 (~> 1.0)
-    aws-sdk-ssm (1.13.0)
-      aws-sdk-core (~> 3)
-      aws-sigv4 (~> 1.0)
-    aws-sigv4 (1.0.2)
-    byebug (10.0.2)
-    cli_markdown (0.1.0)
-    codeclimate-test-reporter (1.0.8)
-      simplecov (<= 0.13)
-    coderay (1.1.2)
-    colorize (0.8.1)
-    concurrent-ruby (1.0.5)
-    diff-lcs (1.3)
-    docile (1.1.5)
-    equatable (0.5.0)
-    ffi (1.9.23)
-    formatador (0.2.5)
-    guard (2.14.2)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      lumberjack (>= 1.0.12, < 2.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.9.12)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-bundler (2.1.0)
-      bundler (~> 1.0)
-      guard (~> 2.2)
-      guard-compat (~> 1.1)
-    guard-compat (1.2.1)
-    guard-rspec (4.7.3)
-      guard (~> 2.1)
-      guard-compat (~> 1.1)
-      rspec (>= 2.99.0, < 4.0)
-    hashie (3.5.7)
-    hitimes (1.2.6)
-    i18n (1.0.1)
-      concurrent-ruby (~> 1.0)
-    jmespath (1.4.0)
-    json (2.1.0)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    lumberjack (1.0.13)
-    memoist (0.16.0)
-    method_source (0.9.0)
-    minitest (5.11.3)
-    necromancer (0.4.0)
-    nenv (0.3.0)
-    notiffany (0.1.1)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    pastel (0.7.2)
-      equatable (~> 0.5.0)
-      tty-color (~> 0.4.0)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (12.3.1)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    ruby_dep (1.5.0)
-    shellany (0.0.1)
-    simplecov (0.13.0)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    thor (0.20.0)
-    thread_safe (0.3.6)
-    timers (4.1.2)
-      hitimes
-    tty-color (0.4.2)
-    tty-cursor (0.5.0)
-    tty-prompt (0.16.1)
-      necromancer (~> 0.4.0)
-      pastel (~> 0.7.0)
-      timers (~> 4.0)
-      tty-cursor (~> 0.5.0)
-      tty-reader (~> 0.3.0)
-    tty-reader (0.3.0)
-      tty-cursor (~> 0.5.0)
-      tty-screen (~> 0.6.4)
-      wisper (~> 2.0.0)
-    tty-screen (0.6.4)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    wisper (2.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  byebug
-  cli_markdown
-  codeclimate-test-reporter
-  guard
-  guard-bundler
-  guard-rspec
-  rake
-  sonic-screwdriver!
-
-BUNDLED WITH
-   1.16.1