sonic-screwdriver 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bceac30eb060267cadfbf45908bb3577a9182b7cc41f26163c8b2dea2ad9cd8
-  data.tar.gz: 411d3d01a83f3f412e4e41d6aed8e5ff4f75fc8d7514ea47f2d38ea73f902295
+  metadata.gz: bc8cb5fef87d05bf06b47548ad6d943fa90682269ac5493881bee38eb47e2e45
+  data.tar.gz: 7f19894b800b5b042cb86e984d25fa793fe7601f2f35578b76fd8c088edb1790
 SHA512:
-  metadata.gz: a7ee03c40b123fb2af14f470bb465e02bd8c1c9687f3912056c50d4f92ff8df677e1e7c6970e712d3667e7a2e95ee07a70a73b6fd32975950e78def1a9dd708b
-  data.tar.gz: 87d14c75178e7935d34cc473122aa18ecb52bcc75f3116b591835456eb042c9a0e878829d1cdf332b325bd195813508cf63481afc4f837b17454de7184f09209
+  metadata.gz: 85d9a8a7cd31dc070265d3769f9ca654f34654e89d29d56b90a1772530781ff74d092210ed2479f780c1c8bc456e65ee822b0f1bc9a91d361a6950b6e42966f5
+  data.tar.gz: 8641e4970facbbb88546f9e542f2cc4fd07f4f3008c7c6287284e1e79977323c7865c14df74f5e667c758fbdec81c682743a37560bacb86907e3e2458bf714a6

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,70 @@
+# 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.5.1-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: |
+            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

data/.ruby-version

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

data/CHANGELOG.md

@@ -3,6 +3,17 @@
 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.
 
+## [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
 - update gemspec homepage
@@ -29,8 +40,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/Gemfile.lock

@@ -1,41 +1,61 @@
 PATH
   remote: .
   specs:
-    sonic-screwdriver (1.3.2)
+    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:
-    aws-partitions (1.59.0)
-    aws-sdk-core (3.15.0)
+    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.26.0)
+    aws-sdk-ec2 (1.34.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
-    aws-sdk-ecs (1.8.0)
+    aws-sdk-ecs (1.13.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
-    aws-sdk-ssm (1.7.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.21)
+    ffi (1.9.23)
     formatador (0.2.5)
     guard (2.14.2)
       formatador (>= 0.2.4)
@@ -57,14 +77,18 @@ GEM
       rspec (>= 2.99.0, < 4.0)
     hashie (3.5.7)
     hitimes (1.2.6)
-    jmespath (1.3.1)
+    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.12)
+    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)
@@ -76,8 +100,8 @@ GEM
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rake (12.3.0)
-    rb-fsevent (0.10.2)
+    rake (12.3.1)
+    rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
     rspec (3.7.0)
@@ -101,21 +125,24 @@ GEM
       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.15.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.2.0)
-    tty-reader (0.2.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
@@ -123,6 +150,8 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
+  byebug
+  cli_markdown
   codeclimate-test-reporter
   guard
   guard-bundler

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

@@ -51,26 +51,26 @@ 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
+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
 
 # docker exec to a running ECS docker container
-sonic ecs-exec hi-web-stag
+sonic ecs exec hi-web
 
 # docker run with the same environment as the ECS docker running containers
-sonic ecs-run hi-web-stag
+sonic ecs sh hi-web
 
 # run command on 1 instance
 sonic execute i-0f7f833131a51ce35 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 tagged with hi-web and worker
+sonic execute hi-web,hi-worker uptime
 
 # list ec2 instances
-sonic list hi-web-stag
+sonic list hi-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.
 $