sonic-screwdriver 1.4.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bceac30eb060267cadfbf45908bb3577a9182b7cc41f26163c8b2dea2ad9cd8
-  data.tar.gz: 411d3d01a83f3f412e4e41d6aed8e5ff4f75fc8d7514ea47f2d38ea73f902295
+  metadata.gz: ca0ee2f6b882f119c6e607c3de2c38391c8c17236f9ef892211cb55e887c7c95
+  data.tar.gz: a4592ac7afc7d3c875be3f02b26f5a884d2bd09423f518cf53fc5b027c963436
 SHA512:
-  metadata.gz: a7ee03c40b123fb2af14f470bb465e02bd8c1c9687f3912056c50d4f92ff8df677e1e7c6970e712d3667e7a2e95ee07a70a73b6fd32975950e78def1a9dd708b
-  data.tar.gz: 87d14c75178e7935d34cc473122aa18ecb52bcc75f3116b591835456eb042c9a0e878829d1cdf332b325bd195813508cf63481afc4f837b17454de7184f09209
+  metadata.gz: e4c02076435af8641128a6487769362b4a3cb4f428a88fe07f14cb0455f8a5ab3bf80ea1950748b9ea0690307e7c38f4f779165e01a3e5279801ad798e4b279f
+  data.tar.gz: f0a7a5cea95e05190b5cf2fe767cc212d49e4063b9cfd4e04c18fb95ed20f2ae4b59b7bfe5a245b1616750aba6eb562ab53cddc196034af98977f8c25af56845

data/.circleci/bin/commit_docs.sh

@@ -0,0 +1,26 @@
+#!/bin/bash -eux
+
+# Even though specs also generate docs, lets run again to ensure clean slate
+bundle exec rake docs
+
+out=$(git status docs)
+if [[ "$out" = *"nothing to commit"* ]]; then
+  exit
+fi
+
+COMMIT_MESSAGE="docs updated by circleci"
+
+# If the last commit already updated the docs, then exit.
+# Preventable measure to avoid infinite loop.
+if git log -1 --pretty=oneline | grep "$COMMIT_MESSAGE" ; then
+  exit
+fi
+
+# If reach here, we have some changes on docs that we should commit.
+# Even though s
+git add docs
+git commit -m "$COMMIT_MESSAGE"
+
+# https://makandracards.com/makandra/12107-git-show-current-branch-name-only
+current_branch=$(git rev-parse --abbrev-ref HEAD)
+git push origin "$current_branch"

data/.circleci/config.yml

@@ -0,0 +1,72 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/ruby:2.6.5-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - run:
+          name: submodule sync
+          command: |
+            git submodule sync
+            git submodule update --init
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            gem install bundler
+            gem update --system
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile" }}
+
+      # specs need git configured ad commit_docs.sh required it also
+      - run:
+          name: configure git
+          command: |
+            git config --global user.email "tongueroo@gmail.com"
+            git config --global user.name "Tung Nguyen"
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            bundle exec rspec
+
+      - run:
+          name: commit cli reference docs
+          command: |
+            chmod a+x -R .circleci/bin
+            .circleci/bin/commit_docs.sh
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

@@ -3,10 +3,10 @@
 .bundle
 .config
 .yardoc
-InstalledFiles
 _yardoc
 coverage
 doc/
+InstalledFiles
 lib/bundler/man
 pkg
 rdoc
@@ -14,3 +14,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+Gemfile.lock

data/CHANGELOG.md

@@ -1,7 +1,33 @@
 # 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.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
+
+## [2.0.0]
+- Merge pull request #5 from boltopslabs/cli-template-upgrade
+- improve css for docs site
+- add CLI reference docs
+- use JumpProxy option for bastion
+- change the way settings work, usage of SONIC_PROFILE and AWS_PROFILE and separate files
+- Big restructuring of sonic commands:
+- sonic ecs exec
+- sonic ecs run
+- sonic execute # much improved and added conveniences
 
 ## [1.4.0]
 - only use required aws-sdk modules
@@ -29,8 +55,8 @@ This project *tries* to adhere to [Semantic Versioning](http://semver.org/), eve
 - standardize filter to be first argument
 
 ## [1.0.0]
-- sonic ecs-exec
-- sonic ecs-run
+- sonic ecs exec
+- sonic ecs sh
 - sonic execute
 - sonic list
 - sonic ssh

data/Gemfile

@@ -1,6 +1,6 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in sonic.gemspec
+# Specify your gem dependencies in sonic.gemspec
 gemspec
 
-gem "codeclimate-test-reporter", group: :test, require: nil
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Guardfile

@@ -1,12 +1,19 @@
-guard 'rspec' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})      { "spec/sonic_spec.rb" }
-  watch(%r{^lib/sonic/(.+)\.rb$})  { "spec/sonic_spec.rb" }
-  watch('spec/spec_helper.rb')   { "spec/sonic_spec.rb" }
-  watch(%r{^lib/sonic/(.+)\.rb$})   { |m| "spec/lib/#{m[1]}_spec.rb" }
+guard "bundler", cmd: "bundle" do
+  watch("Gemfile")
+  watch(/^.+\.gemspec/)
 end
 
-guard 'bundler' do
-  watch('Gemfile')
-  watch(/^.+\.gemspec/)
-end
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Tung Nguyen
+Copyright (c) 2018 Tung Nguyen
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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-stag # ec2 tag
-sonic ssh hi-web-stag --cluster stag # ecs service name
-sonic ssh hi-web-stag --cluster stag  # ecs service name
-sonic ssh 7fbc8c75-4675-4d39-a5a4-0395ff8cd474 --cluster stag  # ECS container id
-sonic ssh 1ed12abd-645c-4a05-9acf-739b9d790170 --cluster stag  # 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-stag
+    # 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-run hi-web-stag
+    # 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-stag and worker
-sonic execute hi-web-stag,hi-worker-stag 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-stag
-```
+    # list ec2 instances
+    sonic list demo-web
 
 ## Contributing
 

data/Rakefile

@@ -1,6 +1,13 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-task :default => :spec
+task default: :spec
 
-RSpec::Core::RakeTask.new
+RSpec::Core::RakeTask.new
+
+require_relative "lib/sonic"
+require "cli_markdown"
+desc "Generates cli reference docs as markdown"
+task :docs do
+  CliMarkdown::Creator.create_all(cli_class: Sonic::CLI, cli_name: "sonic")
+end

data/docs/_config.yml

@@ -61,6 +61,9 @@ collections:
   docs:
     name: "Documentation"
     output: true
+  reference:
+    name: "Reference"
+    output: true
 
 defaults:
   - values:

data/docs/_docs/help.md

@@ -12,7 +12,7 @@ You can append `help`, `-h` or `--help` to the end of any command to get more he
 
 ```sh
 sonic ssh help
-sonic ecs-exec --help
+sonic ecs exec --help
 sonic execute -h
 ```
 

data/docs/_docs/install-bastion.md

@@ -7,21 +7,13 @@ It is common to secure your network setup by restricting access to your servers
 You can configure the [settings.yml]({% link _docs/settings.md %}) file to use a bastion host. Here's an example:
 
 ```yaml
-bastion: # cluster_host mapping
-  default: ec2-user@bastion.mydomain.com
-  prod: ec2-user@bastion.mydomain.com
-  stag: ubuntu@bastion-stag.mydomain.com
+bastion:
+  host: ec2-user@34.211.223.3
+  host_key_check: false
+  user: ec2-user # user for 2nd level servers
 ```
 
-The configuration specifies a bastion for the specific clusters. If the cluster is not in the configuration it defaults to the default bastion host setting.
-
-```sh
-sonic ssh --cluster prod [IDENTIFER] # ec2-user@bastion.mydomain.com used as the bastion host
-sonic ssh --cluster stag [IDENTIFER] # ubuntu@bastion-stag.mydomain.com used as the bastion host
-sonic ssh --cluster whatever [IDENTIFER] # ec2-user@bastion.mydomain.com used as the bastion host
-```
-
-The settting directs the `sonic ssh` to jump through the bastion host. This works completely transparently. The sonic commands are exactly the same as if there is no bastion host. Examples:
+The settting directs the `sonic ssh` to jump through the bastion host. This works transparently. The sonic commands are exactly the same as if there is no bastion host. Examples:
 
 ```
 sonic ssh i-0f7f833131a51ce35
@@ -32,8 +24,6 @@ You should notice that the built up command now includes the bastion jump host.
 ```
 $ sonic ssh i-0f7f833131a51ce35 uptime
 => ssh -At ec2-user@34.211.223.3 ssh ec2-user@10.10.110.135 uptime
-Warning: Permanently added '34.211.223.3' (ECDSA) to the list of known hosts.
-Warning: Permanently added '10.10.110.135' (ECDSA) to the list of known hosts.
  18:35:18 up  1:14,  0 users,  load average: 0.24, 0.07, 0.02
 Connection to 34.211.223.3 closed.
 $

data/docs/_docs/install.md

@@ -16,28 +16,18 @@ 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.
 
-#### sonic ecs-* dependencies
+#### sonic ecs dependencies
 
-For the `sonic ecs-*` commands to work `jq` is required on the server side. This is covered in the [How It Works]({% link _docs/how-it-works.md %}) section.
+For the `sonic ecs` commands to work `jq` is required on the server side. This is covered in the [How It Works]({% link _docs/how-it-works.md %}) section.
 
 One way to install `jq` quickly is by using the `sonic execute` command.  For example:
 
 ```sh
-sonic execute hi-web-stag yum install -y jq
+sonic execute hi-web yum install -y jq
 ```
 
 It is recommended that you install `jq` with the UserData script or bake it into the AMI though.

data/docs/_docs/next-steps.md

@@ -14,6 +14,6 @@ From here, there are a few resources that can help you continue along:
 Everyone can contribute to make sonic better, including the documentation. These docs are of the same sonic repo in the [docs folder](https://github.com/boltopslabs/sonic/tree/master/docs). Please fork the project and open a pull request!  We love your pull requests. Contributions are encouraged and welcomed!
 
 <a id="prev" class="btn btn-basic" href="{% link _docs/how-it-works.md %}">Back</a>
-<!-- <a id="next" class="btn btn-primary" href="{% link articles.md %}">Next Step</a> -->
+<a id="next" class="btn btn-primary" href="{% link reference.md %}">Next Step</a>
 <p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
 

data/docs/_docs/settings.md

@@ -2,92 +2,78 @@
 title: Settings
 ---
 
-You can adjust the behavior of sonic and set some handy default values with `settings.yml` files.  There can exist multiple settings files which all get loaded and merged. The options from the files follow the following precedence rules:
+You can adjust the behavior of sonic and set some handy default values with settings files.  The settings files used are determined by the value of environment variable `SONIC_PROFILE` or `AWS_PROFILE`. The value determines the settings profile to use.  There can exist multiple settings files which all get loaded and merged. The options from the files follow the following precedence rules:
 
-1. current folder - The current folder's `.sonic/settings.yml` values take the highest precedence. The current folder is typically the project folder.
-2. user - The user's `~/.sonic/settings.yml` values take the second highest precedence.
+1. current folder - The current folder's `.sonic/[AWS_PROFILE].yml` values take the highest precedence. The current folder is typically the project folder.
+2. user - The user's `~/.sonic/[AWS_PROFILE].yml` values take the second highest precedence.
 3. default - The [default settings](https://github.com/boltopslabs/sonic/blob/master/lib/sonic/default/settings.yml) bundled with the tool takes the lowest precedence.
 
-Here is an `settings.yml` example:
+A concrete example helps explain it. Let's say `AWS_PROFILE=prod-profile` with the following files:
 
-```yaml
-bastion: # cluster_host mapping
-  default: # default is nil - which means a bastion host wont be used
-  # Examples:
-  # prod: bastion.mydomain.com
-  # stag: ubuntu@bastion-stag.mydomain.com
-host_key_check: false
-service_cluster:
-  default: # defaults to nil
-  hi-web-prod: prod
-  hi-clock-prod: prod
-  hi-worker-prod: prod
-  hi-web-stag: stag
-  hi-clock-stag: stag
-  hi-worker-stag: stag
-user: ec2-user
-```
+* in current folder: `.sonic/prod-profile.yml`
+* in user home folder: `~/.sonic/prod-profile.yml`
 
-The following table covers the different setting options:
-
-Setting  | Description | Default
-------------- | ------------- | -------------
-bastion  | Bastion mapping allows you to set a bastion host on a per ECS cluster basis.  The bastion host is used as the jump host. Examples: bastion.mydomain.com, myuser@bastion.myuser.com or 123.123.123.123. | (no value)
-host_key_check  | Controls whether or not use the strict host checking ssh option.  Since EC2 server host changes often the default value is false. | false
-service_cluster  | Service to cluster mapping.  This is a Hash structure that maps the service name to cluster names. | (no value)
-user  | User to ssh into the server with. This can be overriden at the CLI with the user@host notation but can be set in the settings.yml file also. | ec2-user
+Then the `.sonic/prod-profile.yml` gets merged into `~/.sonic/prod-profile.yml` and that in turn gets merged into sonic's [default settings](https://github.com/boltopslabs/sonic/blob/master/lib/sonic/default/settings.yml).
 
-The default settings are located tool source code at [lib/sonic/default/settings.yml](https://github.com/boltopslabs/sonic/blob/master/lib/sonic/default/settings.yml).
+You can also use the `SONIC_PROFILE=prod-profile` environment variable instead of the `AWS_PROFILE` environment variable. The `SONIC_PROFILE` wins over the `AWS_PROFILE` value.
 
-### Bastion cluster to host mapping
+## Full Example
 
-Provided this example:
+Here is an `prod-profile.yml` example:
 
 ```yaml
 bastion: # cluster_host mapping
-  default: ec2-user@bastion.mydomain.com
-  prod: ec2-user@bastion.mydomain.com
-  stag: ubuntu@bastion-stag.mydomain.com
+  host: # default is nil - which means a bastion host wont be used
+  host_key_check: false
+
+ssh:
+  user: ec2-user
+
+# used with `sonic ecs ssh` command
+ecs_service_cluster_map:
+  default: default # default cluster
+  hi-web: production
+  hi-clock: production
+  hi-worker: production
 ```
 
-This results in
+The following table covers the different setting options:
 
-```sh
-sonic ssh --cluster prod [IDENTIFER] # ec2-user@bastion.mydomain.com used as the bastion host
-sonic ssh --cluster stag [IDENTIFER] # ubuntu@bastion-stag.mydomain.com used as the bastion host
-sonic ssh --cluster whatever [IDENTIFER] # ec2-user@bastion.mydomain.com used as the bastion host
-```
+Setting  | Description | Default
+------------- | ------------- | -------------
+bastion.host  | Bastion mapping allows you to set a bastion host on a per ECS cluster basis.  The bastion host is used as the jump host. Examples: bastion.mydomain.com, myuser@bastion.myuser.com or 123.123.123.123. | (no value)
+bastion.host_key_check  | Controls whether or not use the strict host checking ssh option.  Since EC2 server host changes often the default value is false. | false
+ecs_service_cluster_map  | Service to cluster mapping.  This is a Hash structure that maps the service name to cluster names. | (no value)
+ssh.user  | User to ssh into the server with. This can be overriden at the CLI with the user@host notation but can be set in the settings.yml file also. | ec2-user
+
+The default settings are located tool source code at [lib/sonic/default/settings.yml](https://github.com/boltopslabs/sonic/blob/master/lib/sonic/default/settings.yml).
 
 ### Service to Cluster Mapping
 
-One of the useful options is the `service_cluster`.  This option maps service names to cluster names.  This saves you from  typing the `--cluster` option over and over.  Here is an example `~/.sonic/settings.yml`:
+A useful option is the `ecs_service_cluster_map`.  This option maps ecs service names to cluster names.  This saves you from  typing the `--cluster` option repeatedly.  Here is an example `~/.sonic/settings.yml`:
 
 ```yaml
-user: ec2-user
-service_cluster:
+ecs_service_cluster_map:
   default: my-default-cluster
-  hi-web-prod: prod
-  hi-clock-prod: prod
-  hi-worker-prod: prod
-  hi-web-stag: stag
-  hi-clock-stag: stag
-  hi-worker-stag: stag
+  hi-web: production
+  hi-clock: production
+  hi-worker: production
 ```
 
 This results in shorter commands:
 
 ```
-sonic ssh hi-web-prod
-sonic ssh hi-clock-prod
-sonic ssh hi-worker-stag
+sonic ecs ssh hi-web
+sonic ecs ssh hi-clock
+sonic ecs ssh hi-worker
 ```
 
 Instead of what you normally would have to type:
 
 ```
-sonic ssh hi-web-prod --cluster prod
-sonic ssh hi-clock-prod --cluster prod
-sonic ssh hi-worker-stag --cluster stag
+sonic ecs ssh hi-web --cluster production
+sonic ecs ssh hi-clock --cluster production
+sonic ecs ssh hi-worker --cluster production
 ```