sonic-screwdriver 0.0.1 → 1.0.0

data/lib/sonic/ssh/identifier_detector.rb

@@ -0,0 +1,145 @@
+module Sonic
+class Ssh
+  autoload :Ec2Tag, 'sonic/ssh/ec2_tag'
+  class IdentifierDetector
+
+    include Ec2Tag
+    include AwsServices
+
+    def initialize(cluster, service, identifier, options)
+      @cluster = cluster
+      @service = service
+      @identifier = identifier
+      @options = options
+    end
+
+    # Returns exactly 1 instance_id or exits the program.
+    # The bang check_* methods can exit early.
+    def detect!
+      instance_id = case detected_type
+        when :ecs_container_instance_or_task_arn
+          check_cluster_exists! unless @options[:noop]
+
+          find_container_instance(@identifier) ||
+          find_task(@identifier)
+        when :ecs_service
+          check_cluster_exists! unless @options[:noop]
+          check_service_exists!
+          check_tasks_running!
+
+          find_container_instance(task.container_instance_arn)
+        when :ec2_tag
+          find_ec2_instance
+        when :ec2_instance
+          @identifier
+        end
+    end
+
+    # Any of these methods either returns exactly 1 instance_id or exit the program.
+    #
+    # Returns detected_type
+    def detected_type
+      # Note order here matters because some checks are slower in performance
+      @detected_type ||= if instance_id? # fast
+        :ec2_instance
+      elsif container_instance_or_task_arn? # fast
+        :ecs_container_instance_or_task_arn
+      elsif ec2_tag_exists? # slow
+        :ec2_tag
+      else
+        :ecs_service # will be slower with the logic from the calling method
+      end
+    end
+
+    # takes argument
+    def find_container_instance(container_instance_arn)
+      response = ecs.describe_container_instances(
+                    cluster: @cluster,
+                    container_instances: [container_instance_arn])
+
+      container_instance = response.container_instances.first
+      return false unless container_instance
+
+      ec2_instance_id = container_instance.ec2_instance_id
+    end
+
+    def find_task(task_arn)
+      response = ecs.describe_tasks(cluster: @cluster, tasks: [task_arn])
+
+      task = response.tasks.first
+      unless task
+        puts "Unable to find a #{task_arn.green} container instance or task in the #{@cluster.green} cluster."
+        exit 1
+      end
+
+      find_container_instance(task.container_instance_arn)
+    end
+
+    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?"
+        exit 1
+      end
+    end
+
+    def check_service_exists!
+      begin
+        resp = ecs.describe_services(services: [@service], cluster: @cluster)
+      rescue Aws::ECS::Errors::ClusterNotFoundException
+        UI.error("Unable to find ECS cluster '#{@cluster}'. Are you sure the cluster exists?")
+        UI.say("You can specify the cluster with --cluster or you can specify it as a setting in settings.yml.")
+        UI.say("More info about settings available at: http://sonic-screwdriver.cloud/docs/settings")
+        exit 1
+      end
+
+      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?"
+        exit 1
+      end
+    end
+
+    def check_tasks_running!
+      if task_arns.empty?
+        puts "Unable to find a running task that belongs to the #{@service} service on the #{@cluster} cluster."
+        puts "There must be a running task in order for sonic to look up an container instance."
+        exit 1
+      end
+    end
+
+    def task_arns
+      @task_arns ||= ecs.list_tasks(cluster: @cluster, service_name: @service).task_arns
+    end
+
+    # Only need one container instance to ssh into so we'll just use the first.
+    # Useful to have this in a method for subclasses like Sonic::Exec.
+    def task
+      @task ||= ecs.describe_tasks(cluster: @cluster, tasks: [task_arns.first]).tasks.first
+    end
+
+
+    # Examples:
+    #
+    # Container instance ids:
+    # b748e59a-b679-42a7-b713-afb12294935b
+    # 9f1dadc7-4f67-41da-abec-ec08810bfbc9
+    #
+    # Task ids:
+    # 222c9e66-780b-4755-8c16-8670988e8011
+    # 6358f9c2-b231-4f5b-a59b-15bf19d52a15
+    #
+    # Container instance and task ids have the same format
+    def container_instance_or_task_arn?
+      @identifier =~ /.{8}-.{4}-.{4}-.{4}-.{12}/
+    end
+
+    # Examples:
+    # i-006a097bb10643e20
+    def instance_id?
+      @identifier =~ /i-.{17}/
+    end
+
+  end
+end
+end

data/lib/sonic/ui.rb

@@ -0,0 +1,26 @@
+module Sonic
+  class UI
+    class << self
+      @@mute = false
+      def mute
+        @@mute
+      end
+      def mute=(v)
+        @@mute=v
+      end
+
+      @@noop = false
+      def noop=(v)
+        @@noop=v
+      end
+
+      def say(msg='')
+        msg = "NOOP: #{msg}" if @@noop
+        puts msg unless mute
+      end
+      def error(msg='')
+        say "ERROR: #{msg}".colorize(:red)
+      end
+    end
+  end
+end

data/lib/sonic/version.rb

@@ -1,3 +1,3 @@
 module Sonic
-  VERSION = "0.0.1"
-end
+  VERSION = "1.0.0"
+end

data/qa.md

@@ -0,0 +1,21 @@
+# QA Notes
+
+sonic ssh [INSTANCE_ID]
+* when instance is ready
+* when instance is terminated
+* when instance is pending
+* when instance does not exist
+
+sonic ssh [ECS_CONTAINER_ID]
+* when container instance found
+* when container instance is terminated
+* when container instance does not exist
+
+sonic ssh [ECS_SERVICE]
+* when service found and instance found
+* when service found but instance not found
+* when service not found
+
+sonic ssh [ECS_TASK_ID]
+* when task found and instance found
+* when task not found

data/sonic.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "sonic-screwdriver"
   spec.version       = Sonic::VERSION
   spec.authors       = ["Tung Nguyen"]
-  spec.email         = ["tongueroo@gmail.com"]
+  spec.email         = ["tung@boltops.com"]
   spec.description   = %q{Multi-functional tool to manage AWS infrastructure}
   spec.summary       = %q{Multi-functional tool to manage AWS infrastructure}
   spec.homepage      = ""
@@ -21,6 +21,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "thor"
   spec.add_dependency "hashie"
   spec.add_dependency "colorize"
+  spec.add_dependency "aws-sdk"
+  spec.add_dependency "tty-prompt"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/spec/fixtures/project/command.txt

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+puts "hi"

data/spec/lib/cli_spec.rb

@@ -2,18 +2,28 @@ require 'spec_helper'
 
 # to run specs with what's remembered from vcr
 #   $ rake
-# 
+#
 # to run specs with new fresh data from aws api calls
 #   $ rake clean:vcr ; time rake
 describe Sonic::CLI do
   before(:all) do
-    @args = "--from Tung"
+    @args = "--project-root spec/fixtures/project --noop"
   end
 
   describe "sonic" do
-    it "should hello world" do
-      out = execute("bin/sonic hello world #{@args}")
-      expect(out).to include("from: Tung\nHello world")
+    it "ssh should print out ssh command to be ran" do
+      out = execute("bin/sonic ssh my-service #{@args} --cluster default")
+      expect(out).to include("=> ssh")
+    end
+
+    it "execute should print that command has been sent" do
+      out = execute("bin/sonic execute #{@args} --filter 1,2,3 uptime")
+      expect(out).to include("Command sent")
+    end
+
+    it "list should list running instances" do
+      out = execute("bin/sonic list #{@args} --filter 1,2,3 --header")
+      expect(out).to include("Instance Id")
     end
   end
-end
+end

data/spec/lib/sonic/execute_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Sonic::Execute do
+  before(:each) do
+    @options = {
+      project_root: "spec/fixtures/project",
+      filter: "hi-web-stag,hi-clock-stag"
+    }
+  end
+
+  describe "Sonic#execute" do
+    it "should build up options for ssm send command with inline command" do
+      execute = Sonic::Execute.new(["uname", "-a"], @options)
+      options = execute.build_ssm_options
+      expect(options[:instance_ids]).to eq nil
+      expect(options[:targets]).to eq [{:key=>"tag:Name", :values=>%w[hi-web-stag hi-clock-stag]}]
+      expect(options[:document_name]).to eq "AWS-RunShellScript"
+      expect(options[:comment]).to include "sonic "
+      expect(options[:parameters]["commands"]).to eq ["uname -a"]
+    end
+
+    it "should build up options for ssm send command with file" do
+      execute = Sonic::Execute.new(["file://command.txt"], @options)
+      options = execute.build_ssm_options
+      expect(options[:instance_ids]).to eq nil
+      expect(options[:targets]).to eq [{:key=>"tag:Name", :values=>%w[hi-web-stag hi-clock-stag]}]
+      expect(options[:document_name]).to eq "AWS-RunShellScript"
+      expect(options[:comment]).to include "sonic "
+      expect(options[:parameters]["commands"]).to eq([
+        '#!/usr/bin/env ruby',
+        'puts "hi"'
+      ])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,9 @@
 ENV['TEST'] = '1'
+# Ensures aws api never called. Fixture home folder does not contain ~/.aws/credentails
+ENV['HOME'] = "spec/fixtures/home"
 
-require 'simplecov'
-SimpleCov.start
+# Ensures aws api never called. Fixture home folder does not contain ~/.aws/credentails
+ENV['HOME'] = "spec/fixtures/home"
 
 require "pp"
 
@@ -19,4 +21,4 @@ end
 
 RSpec.configure do |c|
   c.include Helpers
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sonic-screwdriver
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-13 00:00:00.000000000 Z
+date: 2017-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -124,7 +152,7 @@ dependencies:
         version: '0'
 description: Multi-functional tool to manage AWS infrastructure
 email:
-- tongueroo@gmail.com
+- tung@boltops.com
 executables:
 - sonic
 extensions: []
@@ -132,6 +160,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -139,13 +168,110 @@ files:
 - README.md
 - Rakefile
 - bin/sonic
+- docs/.gitignore
+- docs/CNAME
+- docs/Gemfile
+- docs/LICENSE
+- docs/README.md
+- docs/_config.yml
+- docs/_docs/commands.md
+- docs/_docs/how-it-works.md
+- docs/_docs/install.md
+- docs/_docs/next-steps.md
+- docs/_docs/settings.md
+- docs/_docs/sonic-ecs-exec.md
+- docs/_docs/sonic-ecs-run.md
+- docs/_docs/sonic-execute.md
+- docs/_docs/sonic-help.md
+- docs/_docs/sonic-list.md
+- docs/_docs/sonic-ssh.md
+- docs/_docs/tutorial-ecs-exec.md
+- docs/_docs/tutorial-ecs-run.md
+- docs/_docs/tutorial-execute.md
+- docs/_docs/tutorial-ssh.md
+- docs/_docs/tutorial.md
+- docs/_docs/why.md
+- docs/_includes/about.html
+- docs/_includes/commands.html
+- docs/_includes/contact.html
+- docs/_includes/contact_disqus.html
+- docs/_includes/contact_static.html
+- docs/_includes/content.html
+- docs/_includes/css/bootstrap.min.css
+- docs/_includes/css/main.css
+- docs/_includes/css/quotes.css
+- docs/_includes/css/sonic.css
+- docs/_includes/css/syntax.css
+- docs/_includes/css/table.css
+- docs/_includes/css/timeline.css
+- docs/_includes/edit-on-github.html
+- docs/_includes/example.html
+- docs/_includes/footer.html
+- docs/_includes/head.html
+- docs/_includes/header.html
+- docs/_includes/js.html
+- docs/_includes/js_disqus.html
+- docs/_includes/modals.html
+- docs/_includes/nav.html
+- docs/_includes/quotes.html
+- docs/_includes/subnav.html
+- docs/_includes/ufo-ship-options.md
+- docs/_includes/uses.html
+- docs/_layouts/default.html
+- docs/_layouts/style.css
+- docs/articles.md
+- docs/css/font-awesome/css/font-awesome.css
+- docs/css/font-awesome/css/font-awesome.min.css
+- docs/css/font-awesome/fonts/FontAwesome.otf
+- docs/css/font-awesome/fonts/fontawesome-webfont.eot
+- docs/css/font-awesome/fonts/fontawesome-webfont.svg
+- docs/css/font-awesome/fonts/fontawesome-webfont.ttf
+- docs/css/font-awesome/fonts/fontawesome-webfont.woff
+- docs/docs.md
+- docs/img/logos/boltops-logo-full.png
+- docs/img/logos/boltops-logo.png
+- docs/img/sonic-screwdriver.jpg
+- docs/img/tutorials/ec2-console-public-ip.png
+- docs/img/ufo.jpg
+- docs/index.html
+- docs/js/bootstrap.js
+- docs/js/bootstrap.min.js
+- docs/js/cbpAnimatedHeader.js
+- docs/js/cbpAnimatedHeader.min.js
+- docs/js/classie.js
+- docs/js/contact_me.js
+- docs/js/contact_me_static.js
+- docs/js/freelancer.js
+- docs/js/jqBootstrapValidation.js
+- docs/js/jquery-1.11.0.js
+- docs/js/jquery.easing.min.js
+- docs/js/nav.js
+- docs/quick-start.md
+- docs/style.css
+- lib/bash_scripts/docker-exec.sh
+- lib/bash_scripts/docker-run.sh
 - lib/sonic.rb
+- lib/sonic/aws_services.rb
 - lib/sonic/cli.rb
 - lib/sonic/cli/help.rb
 - lib/sonic/command.rb
+- lib/sonic/default/settings.yml
+- lib/sonic/docker.rb
+- lib/sonic/execute.rb
+- lib/sonic/list.rb
+- lib/sonic/settings.rb
+- lib/sonic/ssh.rb
+- lib/sonic/ssh/ec2_tag.rb
+- lib/sonic/ssh/identifier_detector.rb
+- lib/sonic/ui.rb
 - lib/sonic/version.rb
+- qa.md
 - sonic.gemspec
+- spec/fixtures/home/.gitkeep
+- spec/fixtures/project/.gitkeep
+- spec/fixtures/project/command.txt
 - spec/lib/cli_spec.rb
+- spec/lib/sonic/execute_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -172,5 +298,9 @@ signing_key:
 specification_version: 4
 summary: Multi-functional tool to manage AWS infrastructure
 test_files:
+- spec/fixtures/home/.gitkeep
+- spec/fixtures/project/.gitkeep
+- spec/fixtures/project/command.txt
 - spec/lib/cli_spec.rb
+- spec/lib/sonic/execute_spec.rb
 - spec/spec_helper.rb