opsworks-cli 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1f9314cdf3a4f3ca9c386e2dc2f0e537cfa498f9
-  data.tar.gz: cfb55e0c88b9efb9188c0fece32de6edbf83494e
+SHA256:
+  metadata.gz: 7245edfcd7b7b42bb13b880e8e6e420eed060679712b2f1e6e4d54052387fa99
+  data.tar.gz: 3c8699d3f0b438b1f5a55779dd0f233cd596be5980a35cee36aeeba6ec708bd0
 SHA512:
-  metadata.gz: c63763cc141a5bc68fc7a32632cf6b73da5ba4e316dfbc2b96c51b7b29aded201b45eb857b5cc79fc42bacbb31a9b630081ad93c8755577329297963d47f4ab9
-  data.tar.gz: 221fe534dcb3affcc3de82ec1038fe5524c48af2a9a5ea79f69a446e9ec6b418b893cf80538de625f3dc7d91cb29f71fd5f277d1656081e018eb398ba39746ab
+  metadata.gz: aa0ae55d4ea9198bd44e329e933de21b2a3bf62758537c7816b70730f66a14ac770bdf8f31206c010326599c1998268869328b9382273afa9b19d1ca078e9003
+  data.tar.gz: a5fa63b9259cb2c9aa8f91dd44d2c0a5379f42d4b1d7794f8f93244c48428715cd69e4f456783b3656011ee1599ddae6e82f857134c0c3e58767568547ad9902

data/lib/opsworks.rb

@@ -0,0 +1,14 @@
+require 'thor'
+require 'jsonpath'
+require 'aws-sdk'
+require 'active_support/core_ext/hash/slice'
+
+require 'opsworks/errors'
+require 'opsworks/resource'
+require 'opsworks/app'
+require 'opsworks/instance'
+require 'opsworks/permission'
+require 'opsworks/layer'
+require 'opsworks/resource'
+require 'opsworks/deployment'
+require 'opsworks/stack'

data/lib/opsworks/app.rb

@@ -1,6 +1,3 @@
-require 'opsworks/resource'
-require 'opsworks/deployment'
-
 module OpsWorks
   class App < Resource
     attr_accessor :id, :name, :revision

data/lib/opsworks/cli.rb

@@ -1,3 +1,4 @@
+require 'opsworks'
 require 'opsworks/cli/version'
 require 'opsworks/cli/agent'
 

data/lib/opsworks/cli/agent.rb

@@ -9,6 +9,7 @@ require_relative 'subcommands/apps'
 require_relative 'subcommands/iam'
 require_relative 'subcommands/config'
 require_relative 'subcommands/deployments'
+require_relative 'subcommands/instances'
 
 module OpsWorks
   module CLI
@@ -24,6 +25,7 @@ module OpsWorks
       include Subcommands::IAM
       include Subcommands::Config
       include Subcommands::Deployments
+      include Subcommands::Instances
 
       desc 'version', 'Print OpsWorks CLI version'
       def version

data/lib/opsworks/cli/helpers/options.rb

@@ -1,5 +1,3 @@
-require 'opsworks/stack'
-
 module OpsWorks
   module CLI
     module Helpers

data/lib/opsworks/cli/helpers/typecasts.rb

@@ -1,5 +1,3 @@
-require 'opsworks/stack'
-
 module OpsWorks
   module CLI
     module Helpers

data/lib/opsworks/cli/subcommands/apps.rb

@@ -1,5 +1,3 @@
-require 'opsworks/deployment'
-
 module OpsWorks
   module CLI
     module Subcommands

data/lib/opsworks/cli/subcommands/chef.rb

@@ -1,5 +1,3 @@
-require 'opsworks/stack'
-
 module OpsWorks
   module CLI
     module Subcommands

data/lib/opsworks/cli/subcommands/config.rb

@@ -1,5 +1,3 @@
-require 'opsworks/stack'
-
 module OpsWorks
   module CLI
     module Subcommands

data/lib/opsworks/cli/subcommands/deployments.rb

@@ -16,6 +16,11 @@ module OpsWorks
               end
 
               will_retry = last_deployment.map do |stack, deployment|
+                if deployment.nil?
+                  say "Skipping stack #{stack.name}: no deployment"
+                  next
+                end
+
                 if deployment.status == 'successful'
                   say "Skipping stack #{stack.name}: last deployment is " \
                       "#{deployment.status}"
@@ -53,7 +58,7 @@ module OpsWorks
                 opts[:app_id] = dep.app_id if dep.app_id
                 opts[:custom_json] = dep.custom_json if dep.custom_json
 
-                new_deployment = stack.send(:create_deployment, opts)
+                new_deployment = stack.create_deployment(opts)
 
                 [stack, new_deployment]
               end

data/lib/opsworks/cli/subcommands/iam.rb

@@ -1,5 +1,3 @@
-require 'opsworks/permission'
-
 module OpsWorks
   module CLI
     module Subcommands

data/lib/opsworks/cli/subcommands/instances.rb

@@ -0,0 +1,65 @@
+module OpsWorks
+  module CLI
+    module Subcommands
+      module Instances
+        def self.included(thor)
+          thor.class_eval do
+            desc 'instances:status [--stack STACK]',
+                 'Display instance status for a stack'
+            option :stack, type: :array
+            define_method 'instances:status' do
+              stacks = parse_stacks(options)
+              stacks.each do |stack|
+                stack.instances.each do |instance|
+                  say [
+                    stack.name,
+                    instance.hostname,
+                    instance.status
+                  ].join("\t")
+                end
+              end
+            end
+
+            desc 'instances:wait [--timeout TIMEOUT] [--stack STACK]',
+                 'Wait for all instances to settle'
+            option :timeout, type: :numeric, default: 300
+            option :stack, type: :array
+            define_method 'instances:wait' do
+              deadline = Time.now + options[:timeout]
+              stacks = parse_stacks(options)
+
+              loop do
+                stacks = stacks.reject(&:settled?)
+                break if stacks.empty?
+
+                if Time.now > deadline
+                  raise "Stacks did not settle: #{stacks.map(&:name).join(' ')}"
+                end
+
+                sleep 5
+              end
+            end
+
+            desc 'instances:setup [--stack STACK]',
+                 'Retry setup on any instances where it failed'
+            option :stack, type: :array
+            define_method 'instances:setup' do
+              stacks = parse_stacks(options)
+              stacks.each do |stack|
+                stack.instances.each do |instance|
+                  next unless instance.setup_failed?
+                  say "Running setup on #{stack.name} #{instance.hostname}"
+
+                  stack.create_deployment(
+                    command: { name: 'setup' },
+                    instance_ids: [instance.id]
+                  )
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opsworks/cli/subcommands/recipes.rb

@@ -1,5 +1,3 @@
-require 'opsworks/deployment'
-
 module OpsWorks
   module CLI
     module Subcommands

data/lib/opsworks/cli/version.rb

@@ -1,5 +1,5 @@
 module OpsWorks
   module CLI
-    VERSION = '0.5.0'.freeze
+    VERSION = '0.6.0'.freeze
   end
 end

data/lib/opsworks/deployment.rb

@@ -1,5 +1,3 @@
-require 'opsworks/resource'
-
 module OpsWorks
   class Deployment < Resource
     attr_accessor :id, :command, :status, :created_at, :custom_json, :app_id

data/lib/opsworks/errors.rb

@@ -0,0 +1,14 @@
+module OpsWorks
+  module Errors
+    class StackInFatalState < StandardError
+      attr_reader :stack, :instances
+
+      def initialize(stack, instances)
+        @stack = stack
+        @instances = instances
+        names = instances.map(&:hostname).join(' ')
+        super("Instances entered a fatal state on #{stack.name}: #{names}")
+      end
+    end
+  end
+end

data/lib/opsworks/instance.rb

@@ -1,9 +1,15 @@
-require 'opsworks/resource'
-
 module OpsWorks
   class Instance < Resource
     attr_accessor :id, :hostname, :ec2_instance_id, :instance_type, :status
 
+    FATAL_STATUSES = %w(
+      connection_lost setup_failed start_failed stop_failed
+    ).freeze
+
+    SETTLED_STATUSES = (
+      FATAL_STATUSES + %w(online stopped terminated)
+    ).freeze
+
     def self.from_collection_response(client, response)
       response.data[:instances].map do |hash|
         new(
@@ -20,5 +26,17 @@ module OpsWorks
     def online?
       status == 'online'
     end
+
+    def setup_failed?
+      status == 'setup_failed'
+    end
+
+    def fatal?
+      FATAL_STATUSES.include?(status)
+    end
+
+    def settled?
+      SETTLED_STATUSES.include?(status)
+    end
   end
 end

data/lib/opsworks/layer.rb

@@ -1,6 +1,3 @@
-require 'opsworks/resource'
-require 'thor'
-
 module OpsWorks
   class Layer < Resource
     attr_accessor :id, :name, :shortname, :custom_recipes

data/lib/opsworks/permission.rb

@@ -1,5 +1,3 @@
-require 'opsworks/resource'
-
 module OpsWorks
   class Permission < Resource
     attr_accessor :id, :stack_id, :iam_user_arn, :ssh, :sudo

data/lib/opsworks/stack.rb

@@ -1,13 +1,3 @@
-require 'jsonpath'
-require 'aws-sdk'
-require 'active_support/core_ext/hash/slice'
-
-require 'opsworks/resource'
-require 'opsworks/app'
-require 'opsworks/instance'
-require 'opsworks/permission'
-require 'opsworks/layer'
-
 module OpsWorks
   class Stack < Resource
     attr_accessor :id, :name, :custom_json
@@ -142,6 +132,16 @@ module OpsWorks
       create_deployment(**deploy_args)
     end
 
+    def create_deployment(options = {})
+      response = client.create_deployment(
+        options.merge(stack_id: id)
+      )
+    rescue Aws::OpsWorks::Errors::ValidationException => e
+      raise unless e.message == DEPLOY_NO_INSTANCES_ERROR
+    else
+      Deployment.from_response(client, response)
+    end
+
     def active?
       instances.any?(&:online?)
     end
@@ -164,6 +164,13 @@ module OpsWorks
       client.create_app(options)
     end
 
+    def settled?
+      instances = initialize_instances
+      fatal = instances.select(&:fatal?)
+      raise Errors::StackInFatalState.new(self, fatal) if fatal.any?
+      instances.all?(&:settled?)
+    end
+
     private
 
     # rubocop:disable Eval
@@ -215,15 +222,5 @@ module OpsWorks
       response = client.describe_deployments(stack_id: id)
       Deployment.from_collection_response(client, response)
     end
-
-    def create_deployment(options = {})
-      response = client.create_deployment(
-        options.merge(stack_id: id)
-      )
-    rescue Aws::OpsWorks::Errors::ValidationException => e
-      raise unless e.message == DEPLOY_NO_INSTANCES_ERROR
-    else
-      Deployment.from_response(client, response)
-    end
   end
 end

data/opsworks-cli.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'fabrication', '~> 2.16.0'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'timecop', '~> 0.9'
 end

data/spec/fabricators/opsworks/instance_fabricator.rb

@@ -0,0 +1,6 @@
+Fabricator(:instance, from: OpsWorks::Instance) do
+  initialize_with { @_klass.new(opsworks_stub) }
+  id { SecureRandom.uuid }
+  hostname { Fabricate.sequence { |i| "test-instance#{i}" } }
+  status { 'online' }
+end

data/spec/opsworks/cli/subcommands/instances_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+describe OpsWorks::CLI::Agent do
+  let(:stacks) do
+    Array.new(3) { |i| Fabricate(:stack, name: "stack-#{i}") }
+  end
+  before { allow(OpsWorks::Stack).to receive(:all) { stacks } }
+
+  describe 'instances:status' do
+    it 'returns the status of instances on all stacks' do
+      statuses = %w(starting online setup_failed)
+
+      stacks.zip(statuses).each do |stack, status|
+        i = Fabricate(:instance, hostname: "instance-#{status}", status: status)
+        expect(stack).to receive(:instances).and_return([i])
+      end
+
+      messages = [
+        "stack-0\tinstance-starting\tstarting",
+        "stack-1\tinstance-online\tonline",
+        "stack-2\tinstance-setup_failed\tsetup_failed"
+      ]
+
+      messages.each do |m|
+        expect(subject).to receive(:say).with(m).once.ordered
+      end
+
+      subject.send('instances:status')
+    end
+
+    it 'returns the status of instances on the selected stacks' do
+      i = Fabricate(:instance, hostname: 'instance', status: 'online')
+      expect(stacks[1]).to receive(:instances).and_return([i])
+      [0, 2].each { |n| expect(stacks[n]).not_to receive(:instances) }
+
+      expect(subject).to receive(:say).with("stack-1\tinstance\tonline")
+      subject.options = { stack: [stacks[1].name] }
+
+      subject.send('instances:status')
+    end
+  end
+
+  describe 'instances:wait' do
+    before do
+      subject.options = { timeout: 100 }
+    end
+
+    it 'waits until all stacks settle' do
+      stacks.each { |s| expect(s).to receive(:settled?).and_return(false) }
+      expect(subject).to receive(:sleep) do
+        stacks.each { |s| expect(s).to receive(:settled?).and_return(true) }
+      end
+
+      subject.send('instances:wait')
+    end
+
+    it 'waits until selected stacks settle' do
+      expect(stacks[0]).to receive(:settled?).and_return(false)
+      expect(subject).to receive(:sleep) do
+        expect(stacks[0]).to receive(:settled?).and_return(true)
+      end
+
+      expect(stacks[1]).not_to receive(:settled?)
+      expect(stacks[2]).not_to receive(:settled?)
+
+      subject.options[:stack] = [stacks[0].name]
+
+      subject.send('instances:wait')
+    end
+
+    it 'fails if the stacks never settle' do
+      t = 0
+      allow(subject).to receive(:sleep) do |i|
+        t += i
+        Timecop.freeze(t)
+      end
+
+      stacks.each { |s| allow(s).to receive(:settled?).and_return(false) }
+      allow(stacks[0]).to receive(:settled?).and_return(true)
+
+      expect { Timecop.freeze(t) { subject.send('instances:wait') } }
+        .to raise_error(/did not settle: stack-1 stack-2$/i)
+    end
+  end
+
+  describe 'instances:setup' do
+    let(:i0) { Fabricate(:instance, hostname: 'i0', status: 'setup_failed') }
+    let(:i1) { Fabricate(:instance, hostname: 'i1', status: 'online') }
+    let(:i2) { Fabricate(:instance, hostname: 'i2', status: 'setup_failed') }
+
+    before do
+      allow(stacks[0]).to receive(:instances).and_return([i0])
+      allow(stacks[1]).to receive(:instances).and_return([i1])
+      allow(stacks[2]).to receive(:instances).and_return([i2])
+    end
+
+    it 're-runs setup on setup_failed instances across all stacks' do
+      expect(stacks[0]).to receive(:create_deployment)
+        .with(command: { name: 'setup' }, instance_ids: [i0.id])
+
+      expect(stacks[1]).not_to receive(:create_deployment)
+
+      expect(stacks[2]).to receive(:create_deployment)
+        .with(command: { name: 'setup' }, instance_ids: [i2.id])
+
+      expect(subject).to receive(:say)
+        .with('Running setup on stack-0 i0')
+        .once.ordered
+
+      expect(subject).to receive(:say)
+        .with('Running setup on stack-2 i2')
+        .once.ordered
+
+      subject.send('instances:setup')
+    end
+
+    it 're-runs setup on setup_failed instances across selected stacks' do
+      expect(stacks[0]).not_to receive(:create_deployment)
+      expect(stacks[1]).not_to receive(:create_deployment)
+      expect(stacks[2]).to receive(:create_deployment)
+        .with(command: { name: 'setup' }, instance_ids: [i2.id])
+
+      expect(subject).to receive(:say)
+        .with('Running setup on stack-2 i2')
+        .once.ordered
+
+      subject.options = { stack: [stacks[2].name] }
+
+      subject.send('instances:setup')
+    end
+  end
+end

data/spec/opsworks/instance_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe OpsWorks::Instance do
+  context 'status' do
+    STATUSES = [
+      ['booting', false, false],
+      ['connection_lost', true, true],
+      ['online', true, false],
+      ['pending', false, false],
+      ['rebooting', false, false],
+      ['requested', false, false],
+      ['running_setup', false, false],
+      ['setup_failed', true, true],
+      ['shutting_down', false, false],
+      ['start_failed', true, true],
+      ['stop_failed', true, true],
+      ['stopped', true, false],
+      ['stopping', false, false],
+      ['terminated', true, false],
+      ['terminating', false, false]
+    ].freeze
+
+    STATUSES.each do |status, settled_expected, fatal_expected|
+      context status do
+        it "#settled? is #{settled_expected}" do
+          i = described_class.new(nil, status: status)
+          expect(i.settled?).to be(settled_expected)
+        end
+
+        it "#fatal? is #{fatal_expected}" do
+          i = described_class.new(nil, status: status)
+          expect(i.fatal?).to be(fatal_expected)
+        end
+      end
+    end
+
+    it 'has only a few defined non-fatal settled states' do
+      # We use this to make sure that our test cases above are coherent.
+      expect(STATUSES.select { |_, s, f| s && !f }.map(&:first))
+        .to match_array(%w(online stopped terminated))
+    end
+  end
+end

data/spec/opsworks/stack_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe OpsWorks::Stack do
+  describe '#settled?' do
+    it 'makes a new API call' do
+      client = Aws::OpsWorks::Client.new(
+        stub_responses: {
+          describe_instances: [
+            { instances: [{ instance_id: 'a', status: 'starting' }] },
+            { instances: [{ instance_id: 'a', status: 'online' }] },
+            { instances: [{ instance_id: 'b', status: 'stopping' }] }
+          ]
+        }
+      )
+
+      subject = described_class.new(client, id: '123')
+
+      expect(client).to receive(:describe_instances)
+        .with(stack_id: '123')
+        .exactly(3).times
+        .and_call_original
+
+      expect(subject).not_to be_settled
+      expect(subject).to be_settled
+      expect(subject).not_to be_settled
+    end
+
+    it 'returns true if all instances have settled' do
+      client = Aws::OpsWorks::Client.new(
+        stub_responses: {
+          describe_instances: {
+            instances: [
+              { instance_id: 'a', status: 'online' },
+              { instance_id: 'b', status: 'stopped' }
+            ]
+          }
+        }
+      )
+
+      expect(described_class.new(client, id: '123')).to be_settled
+    end
+
+    it 'returns false if any instances has not settled' do
+      client = Aws::OpsWorks::Client.new(
+        stub_responses: {
+          describe_instances: {
+            instances: [
+              { instance_id: 'a', status: 'online' },
+              { instance_id: 'b', status: 'stopping' }
+            ]
+          }
+        }
+      )
+
+      expect(described_class.new(client, id: '123')).not_to be_settled
+    end
+
+    it 'fails if any instance will not settle' do
+      client = Aws::OpsWorks::Client.new(
+        stub_responses: {
+          describe_instances: {
+            instances: [
+              { instance_id: 'a', status: 'online' },
+              { instance_id: 'b', status: 'setup_failed', hostname: 'bar' }
+            ]
+          }
+        }
+      )
+
+      e = OpsWorks::Errors::StackInFatalState
+
+      expect { described_class.new(client, id: '123', name: 'foo').settled? }
+        .to raise_error(e, /fatal.*foo.*bar/i)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ require 'opsworks/cli'
 
 require 'securerandom'
 require 'fabrication'
+require 'timecop'
 
 def opsworks_stub
   Aws::OpsWorks::Client.new(stub_responses: true)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opsworks-cli
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Frank Macreery
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2018-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: OpsWorks CLI
 email:
 - frank@macreery.com
@@ -166,6 +180,7 @@ files:
 - README.md
 - Rakefile
 - bin/opsworks
+- lib/opsworks.rb
 - lib/opsworks/app.rb
 - lib/opsworks/cli.rb
 - lib/opsworks/cli/agent.rb
@@ -176,9 +191,11 @@ files:
 - lib/opsworks/cli/subcommands/config.rb
 - lib/opsworks/cli/subcommands/deployments.rb
 - lib/opsworks/cli/subcommands/iam.rb
+- lib/opsworks/cli/subcommands/instances.rb
 - lib/opsworks/cli/subcommands/recipes.rb
 - lib/opsworks/cli/version.rb
 - lib/opsworks/deployment.rb
+- lib/opsworks/errors.rb
 - lib/opsworks/instance.rb
 - lib/opsworks/layer.rb
 - lib/opsworks/permission.rb
@@ -187,6 +204,7 @@ files:
 - opsworks-cli.gemspec
 - spec/fabricators/opsworks/app_fabricator.rb
 - spec/fabricators/opsworks/deployment_fabricator.rb
+- spec/fabricators/opsworks/instance_fabricator.rb
 - spec/fabricators/opsworks/permission_fabricator.rb
 - spec/fabricators/opsworks/stack_fabricator.rb
 - spec/opsworks/cli/agent_spec.rb
@@ -194,7 +212,10 @@ files:
 - spec/opsworks/cli/subcommands/chef_spec.rb
 - spec/opsworks/cli/subcommands/config_spec.rb
 - spec/opsworks/cli/subcommands/iam_spec.rb
+- spec/opsworks/cli/subcommands/instances_spec.rb
 - spec/opsworks/cli/subcommands/recipes_spec.rb
+- spec/opsworks/instance_spec.rb
+- spec/opsworks/stack_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/aptible/opsworks-cli
 licenses:
@@ -216,13 +237,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Alternative CLI for Amazon OpsWorks
 test_files:
 - spec/fabricators/opsworks/app_fabricator.rb
 - spec/fabricators/opsworks/deployment_fabricator.rb
+- spec/fabricators/opsworks/instance_fabricator.rb
 - spec/fabricators/opsworks/permission_fabricator.rb
 - spec/fabricators/opsworks/stack_fabricator.rb
 - spec/opsworks/cli/agent_spec.rb
@@ -230,5 +252,8 @@ test_files:
 - spec/opsworks/cli/subcommands/chef_spec.rb
 - spec/opsworks/cli/subcommands/config_spec.rb
 - spec/opsworks/cli/subcommands/iam_spec.rb
+- spec/opsworks/cli/subcommands/instances_spec.rb
 - spec/opsworks/cli/subcommands/recipes_spec.rb
+- spec/opsworks/instance_spec.rb
+- spec/opsworks/stack_spec.rb
 - spec/spec_helper.rb