ec2ctl 0.7.9 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9d5765abec98bc65ea4dd0c1276041db0c2766c
-  data.tar.gz: 3ed14b3b91fa16fc850c5f1a567b9f3970df6e86
+  metadata.gz: 2db3d33906e470bb3a0e6b4a96e840feae7e0dfd
+  data.tar.gz: aac465cbdf09c95ce707088fd6dd705584088290
 SHA512:
-  metadata.gz: bc349a68f3004dafea7daf1951f790b8da4ee30a8dd3434ec3429fb5b86a061eb52a42317e44f1081192d4d0e09a87b0ede2377d462e3e7ff82ae22af24f9967
-  data.tar.gz: da45141f0d9338d1386c4d988741622df08ec521958b4f4146efa9e3bd50bd1d75c4f25c58fa9b9caaf33bcebf3c78067811f63de7bcfbf0af3d63a535ede5f6
+  metadata.gz: 14cadc9ca8e185e0b97547b05a155b0fb44ee2be7952430ae27199a292f3dc2594027e24c5fbdc71e3afcf46be780ccba3c2533da63febb972c2de37abcc8aa7
+  data.tar.gz: 19ab369c479627d591d68b44e943bcd6d3ce66ae66ec5fde155c634ec49f7afb0a411f1efe162a9b1d95487beaed8c4f26dccb50c900bace55b9bf8b940f8774

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at yamaguchi@cloudpack.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yoriki Yamaguchi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.

data/README.md

@@ -1,6 +1,6 @@
 # EC2Ctl
 
-**!!! Version 0.7 or later is not compatible with 0.6 !!!**
+A small command line tool for managing EC2/ELB.
 
 ## Installation
 
@@ -20,7 +20,37 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### `ec2 list`
+
+List EC2 instances.
+
+### `ec2 execute`
+
+Execute commands in the EC2 instances.
+
+### `elb list`     
+
+List load balancers.
+
+### `elb status`   
+
+Show the load balancer's status.
+
+### `elb attach`   
+
+Attach the instances to the load balancer.
+
+### `elb detach`   
+
+Detach the instances from the load balancer.
+
+### `elb execute`  
+
+Execute commands on instance(s) registered to a load balancer.
+
+### `elb graceful`
+
+Sequencially deregister instance(s) from load balancer, execute commands, register it back to load balancer and wait until it's in `InService` state.
 
 ## Development
 

data/Rakefile

@@ -1,6 +1 @@
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/ec2ctl.gemspec

@@ -4,26 +4,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ec2ctl/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ec2ctl"
-  spec.version       = EC2Ctl::VERSION
-  spec.authors       = ["y13i"]
-  spec.email         = ["email@y13i.com"]
-
-  spec.summary       = %q{A minimum tool for EC2 instances.}
-  spec.description   = %q{A minimum tool for EC2 instances.}
-  spec.homepage      = "https://github.com/y13i/ec2ctl"
+  spec.name        = "ec2ctl"
+  spec.version     = EC2Ctl::VERSION
+  spec.authors     = ["Yoriki Yamaguchi"]
+  spec.email       = ["email@y13i.com"]
+  spec.summary     = %(A small command line tool for managing EC2/ELB.)
+  spec.description = %(A small command line tool for managing EC2/ELB.)
+  spec.homepage    = "https://github.com/y13i/ec2ctl"
+  spec.license     = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "commander"
-  spec.add_dependency "aws-sdk", ">= 2.0"
-  spec.add_dependency "terminal-table"
+  spec.required_ruby_version = ">= 2.1.0"
+
+  spec.add_dependency "aws-sdk",        "~> 2.3"
+  spec.add_dependency "commander",      "~> 4.4"
+  spec.add_dependency "coderay",        "~> 1.1"
+  spec.add_dependency "terminal-table", "~> 1.6"
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "pry",     "~> 0.10"
 end

data/lib/ec2ctl/cli.rb

@@ -1,108 +1,238 @@
 require "commander"
-require "json"
-require "yaml"
-require "terminal-table"
+require "ec2ctl/logger"
 
 module EC2Ctl
   class CLI
     include Commander::Methods
 
+    OptionError = Class.new RuntimeError
+
     def run
-      program :name,        "EC2Ctl"
-      program :version,     EC2Ctl::VERSION
-      program :description, "A minimum tool for EC2 instances."
+      program :name,        self.class.to_s
+      program :version,     VERSION
+      program :description, "A small command line tool for managing EC2/ELB."
+
+      global_option("-V", "--verbose",                                 "Debug output.")       {@verbose = true}
+      global_option("-P", "--pretty",                                  "Pretty JSON output.") {@pretty  = true}
+      global_option("-o", "--output #{EC2Ctl::Logger::VALID_FORMATS}", "Log output format.")  {|v| @output_format     = v.intern}
+      global_option("-p", "--profile PROFILE_NAME",                    "AWS profile name.")   {|v| ENV["AWS_PROFILE"] = v}
+      global_option("-r", "--region REGION_NAME",                      "AWS region name.")    {|v| ENV["AWS_REGION"]  = v}
+
+      default_command :"ec2 list"
+
+      command :"ec2 list" do |c|
+        c.syntax      = "ec2ctl ec2 list"
+        c.description = "List EC2 instances."
+
+        ec2_options c
+
+        c.action do |args, options|
+          options.default attributes: %w(instance_id tag:Name instance_type public_dns_name state.name)
+
+          invoke options do
+            @client.ec2_list
+          end
+        end
+      end
+
+      command :"ec2 execute" do |c|
+        c.syntax      = "ec2ctl ec2 execute"
+        c.description = "Execute commands in the EC2 instances."
+
+        ec2_options c
+
+        c.option "-c", "--commands 'STRING1','STRING2',...", Array, "The commands to execute."
+
+        c.action do |args, options|
+          invoke options do
+            mandatory options, :commands
+            @client.ec2_execute
+          end
+        end
+      end
 
-      global_option "-p", "--profile PROFILE", "Load AWS credentials from shared credentials file by specified name."
-      global_option "-r", "--region REGION",   "Specify AWS region."
+      command :"elb list" do |c|
+        c.syntax      = "ec2ctl elb list"
+        c.description = "List load balancers."
 
-      default_command :list
+        c.action do |args, options|
+          invoke options do
+            @client.elb_list
+          end
+        end
+      end
 
-      command :list do |c|
-        c.syntax      = "list [options]"
-        c.description = "List EC2 instances"
+      command :"elb status" do |c|
+        c.syntax      = "ec2ctl elb status"
+        c.description = "Show the load balancer's status."
 
-        c.option "-a", "--attributes STRING", String, "Attribute of EC2 instances separated by commas."
-        c.option "-s", "--search STRING",     String, "Search instance with given KEY=VALUE attributes."
-        c.option "-o", "--order STRING",      String, "Order list by specified attribute."
-        c.option "-f", "--format STRING",     String, "Output format (table/json/yaml)."
+        c.option "-b", "--load-balancer-name VALUE", String, "The name of the load balancer."
 
         c.action do |args, options|
-          options.default(
-            attributes: "instance_id,tag:Name,instance_type,private_ip_address,public_ip_address,state.name",
-            format:     "table",
-            order:      "tag:Name",
-          )
-
-          set_client(options)
-
-          search = if options.search
-            options.search.split(",").map {|s| s.split("=")}.inject Hash.new do |acc, pair|
-              acc.merge pair.first => pair.last
-            end
-          else
-            {}
+          invoke options do
+            mandatory options, :load_balancer_name
+            @client.elb_status
           end
+        end
+      end
+
+      command :"elb attach" do |c|
+        c.syntax      = "ec2ctl elb attach"
+        c.description = "Attach the instances to the load balancer."
+
+        c.option "-b", "--load-balancer-name VALUE",     String, "The name of the load balancer."
+        c.option "-i", "--instance-ids STRING1,STRING2", Array,   "(Optional) The IDs of the instances to attach."
 
-          attributes     = (options.attributes.split(",") + search.keys).uniq
-          instance_infos = client.instance_infos(attributes, search).sort_by {|i| i[options.order]}
-
-          if instance_infos.empty?
-            say "Instance not found."
-          else
-            case options.format
-            when /table/i
-              say tableize(attributes, instance_infos)
-            when /markdown/i
-              say tableize(attributes, instance_infos, :markdown)
-            when /backlog/i
-              say tableize(attributes, instance_infos, :backlog)
-            when /json/i
-              say JSON.pretty_generate(instance_infos)
-            when /yaml/i
-              say instance_infos.to_yaml
-            end
+        c.action do |args, options|
+          invoke options do
+            mandatory options, :load_balancer_name, :instance_ids
+            @client.elb_attach
           end
         end
       end
 
-      alias_command :ls, :list
+      command :"elb detach" do |c|
+        c.syntax      = "ec2ctl elb detach"
+        c.description = "Detach the instances from the load balancer."
+
+        c.option "-b", "--load-balancer-name VALUE",     String, "The name of the load balancer."
+        c.option "-i", "--instance-ids STRING1,STRING2", Array,   "(Optional) The IDs of the instances to detach."
+
+        c.action do |args, options|
+          invoke options do
+            mandatory options, :load_balancer_name, :instance_ids
+            @client.elb_detach
+          end
+        end
+      end
+
+      command :"elb execute" do |c|
+        c.syntax      = "ec2ctl elb execute"
+        c.description = "Execute commands on instance(s) registered to a load balancer."
+
+        elb_execute_options c
+
+        c.action do |args, options|
+          invoke options do
+            mandatory options, :load_balancer_name, :commands
+            @client.elb_execute
+          end
+        end
+      end
+
+      command :"elb graceful" do |c|
+        c.syntax      = "ec2ctl elb graceful"
+        c.description = "Sequencially deregister instance(s) from load balancer, execute commands, register it back to load balancer and wait until it's in `InService` state."
+
+        elb_execute_options c
+
+        c.action do |args, options|
+          invoke options do
+            mandatory options, :load_balancer_name, :commands
+            @client.elb_graceful
+          end
+        end
+      end
 
       run!
     end
 
     private
 
-    def tableize(attributes, instance_infos, mode = nil)
-      table = Terminal::Table.new(
-        headings: attributes,
-        rows:     instance_infos.map {|i| attributes.map {|a| i[a]}}
+    def init_client(options)
+      global_options = %i(
+        verbose
+        pretty
+        output
+        profile
+        region
+        trace
+        version
+        help
+      )
+
+      @client = EC2Ctl::Client.new options.__hash__.reject {|k, v| global_options.include? k}.merge(logger: logger)
+    end
+
+    def logger
+      @logger ||= EC2Ctl::Logger.new(
+        output_format: (@output_format || :json),
+        pretty:        @pretty,
+        verbose:       @verbose,
       )
+    end
+
+    def invoke(options, &block)
+      begin
+        debug_init options
+        init_client options
+        block.call
+      rescue => ex
+        logger.error(
+          error: {
+            class:   ex.class,
+            message: ex.message
+          }
+        )
+
+        raise
+      end
+    end
 
-      case mode
-      when :markdown
-        lines = table.to_s.lines[1..-2]
-        lines[1].gsub!("+", "|")
-        lines.join
-      when :backlog
-        lines = table.to_s.lines[1..-2]
-        lines[0].sub!("\n", "h\n")
-        lines[1] = nil
-        lines.compact.join
-      else
-        table
+    # e.g.
+    #
+    # mandatory options, :load_balancer_name, :commands
+    #
+    def mandatory(options, *option_names)
+      option_names.each do |option_name|
+        fail OptionError, "Option `#{option_name}` is mandatory." if options.__send__(option_name).nil?
       end
     end
 
-    def client
-      @client
+    # only for debug output
+    def aws_env
+      {
+        AWS_ACCESS_KEY_ID:     ("#{ENV["AWS_ACCESS_KEY_ID"][0, 5]}..." if ENV["AWS_ACCESS_KEY_ID"]),
+        AWS_SECRET_ACCESS_KEY: ("#{ENV["AWS_SECRET_ACCESS_KEY"][0, 5]}..." if ENV["AWS_SECRET_ACCESS_KEY"]),
+        AWS_PROFILE:           ENV["AWS_PROFILE"],
+        AWS_REGION:            ENV["AWS_REGION"],
+      }
     end
 
-    def set_client(options)
-      o           = {}
-      o[:profile] = options.profile if options.profile
-      o[:region]  = options.region  if options.region
+    def debug_init(options)
+      logger.debug options: options.__hash__
+      logger.debug aws_env: aws_env
+    end
+
+    def elb_execute_options(_command)
+      _command.option "-b", "--load-balancer-name STRING",               String,  "The name of the load balancer."
+      _command.option "-c", "--commands 'STRING1','STRING2',...",        Array,   "The commands to execute."
+      _command.option "-P", "--platform-type Linux|Windows",             String,  "(Optional) Platform type: `Linux` or `Windows`. Default is `Linux`."
+      _command.option       "--skip-ping-check",                                  "(Optional) Skip SSM ping check."
+      _command.option       "--skip-command-waits",                               "(Optional) Skip waiting command success."
+      _command.option       "--wait-interval INTEGER",                   Integer, "(Optional) Waiting interval."
+      _command.option       "--working-directory STRING",                String,  "(Optional) The path to the working directory on your instance."
+      _command.option       "--execution-timeout INTEGER",               Integer, "(Optional) The time in seconds for a command to be completed before it is considered to have failed. Default is 3600 (1 hour). Maximum is 28800 (8 hours)."
+      _command.option       "--timeout-seconds INTEGER",                 Integer, "(Optional) If this time is reached and the command has not already started executing, it will not execute."
+      _command.option       "--comment STRING",                          String,  "(Optional) User-specified information about the command, such as a brief description of what the command should do."
+      _command.option       "--output-s3-bucket-name STRING",            String,  "(Optional) The name of the S3 bucket where command execution responses should be stored."
+      _command.option       "--output-s3-key-prefix STRING",             String,  "(Optional) The directory structure within the S3 bucket where the responses should be stored."
+      _command.option       "--service-role-arn STRING",                 String,  "(Optional) The IAM role that SSM uses to send notifications."
+      _command.option       "--notification-arn STRING",                 String,  "(Optional) An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic."
+      _command.option       "--notification-events STRING1,STRING2,...", Array,   "(Optional) The different events for which you can receive notifications."
+      _command.option       "--notification-type STRING",                String,  "(Optional) Command: Receive notification when the status of a command changes."
+      _command.option       "--rolling-group-size INTEGER",              Integer, "(Optional) The count of instances to register/deregister/execute simultaneously."
+      _command.option       "--skip-draining-waits",                              "(Optional) Skip waiting connection draining after deregistering instances from load balancer."
+      _command.option       "--skip-inservice-waits",                             "(Optional) Skip waiting `InService` state after registering instances to load balancer."
+      _command.option       "--inservice-wait-timeout INTEGER",          Integer, "(Optional) The time in seconds for instances to be `InService` state after registering to load balancer."
+      _command.option "-i", "--instance-ids STRING1,STRING2",            Array,   "(Optional) The IDs of the instances. If specified, the commands will be executed only on these instances."
+    end
 
-      @client = EC2Ctl::Client.new(o)
+    def ec2_options(_command)
+      _command.option "-a", "--attributes KEY1,KEY2...",            Array, "(Optional) The instance attribute keys to display."
+      _command.option "-f", "--filters KEY1=VALUE1,KEY2=VALUE2...", Array, "(Optional) The key-value pairs to filter instances."
+      _command.option "-s", "--search KEY1=VALUE1,KEY2=VALUE2...",  Array, "(Optional) The key-value pairs to search instances by Regexp."
+      _command.option "-i", "--instance-ids STRING1,STRING2",       Array, "(Optional) The IDs of the instances."
     end
   end
 end