moose-inventory 1.0.9 → 2.1

data/spec/lib/moose_inventory/cli/factory_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'cli/factory'
+require 'operations/query_inventory'
+
+RSpec.describe Moose::Inventory::Cli::Factory do
+  let(:context) { instance_double('InventoryContext') }
+  subject(:factory) { described_class.new(context: context) }
+
+  it 'builds operations with the shared context' do
+    operation_class = class_double('OperationClass')
+    operation = instance_double('Operation')
+
+    expect(operation_class).to receive(:new).with(context: context, emitter: :emit).and_return(operation)
+
+    expect(factory.operation(operation_class, emitter: :emit)).to eq(operation)
+  end
+
+  it 'memoizes the query inventory wrapper for the shared context' do
+    first = factory.query_inventory
+    second = factory.query_inventory
+
+    expect(first).to be_a(Moose::Inventory::Operations::QueryInventory)
+    expect(second).to equal(first)
+  end
+end

data/spec/lib/moose_inventory/cli/formatter_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-# TODO: the usual respond_to? method doesn't seem to work on Thor objects.
 # Why not? For now, we'll check against instance_methods.
 
 RSpec.describe Moose::Inventory::Cli::Formatter do
@@ -33,7 +34,7 @@ RSpec.describe Moose::Inventory::Cli::Formatter do
       actual = runner { @formatter.out(test, 'json') }
 
       desired = { aborted: false, STDOUT: '', STDERR: '' }
-      desired[:STDOUT] = test.to_json + "\n"
+      desired[:STDOUT] = "#{test.to_json}\n"
 
       expected(actual, desired)
     end
@@ -44,7 +45,7 @@ RSpec.describe Moose::Inventory::Cli::Formatter do
       actual = runner { @formatter.out(test, 'prettyjson') }
 
       desired = { aborted: false, STDOUT: '', STDERR: '' }
-      desired[:STDOUT] = JSON.pretty_generate(test) + "\n"
+      desired[:STDOUT] = "#{JSON.pretty_generate(test)}\n"
 
       expected(actual, desired)
     end
@@ -59,5 +60,96 @@ RSpec.describe Moose::Inventory::Cli::Formatter do
 
       expected(actual, desired)
     end
+
+    it 'info() prints the provided message instead of a literal placeholder' do
+      actual = runner { @formatter.info(2, 'hello world') }
+
+      desired = { aborted: false, STDOUT: '', STDERR: '' }
+      desired[:STDOUT] = '  INFO: hello world'
+
+      expected(actual, desired)
+    end
+  end
+
+  describe 'stream helpers' do
+    it 'puts() writes indented text to stdout by default' do
+      actual = runner { @formatter.puts(2, 'hello world') }
+
+      desired = { aborted: false, STDOUT: "  hello world\n", STDERR: '' }
+
+      expected(actual, desired)
+    end
+
+    it 'puts() writes indented text to stderr when requested' do
+      actual = runner { @formatter.puts(2, 'hello world', 'STDERR') }
+
+      desired = { aborted: false, STDOUT: '', STDERR: "  hello world\n" }
+
+      expected(actual, desired)
+    end
+
+    it 'puts() aborts on an unknown output stream' do
+      actual = runner { @formatter.puts(2, 'hello world', 'BOGUS') }
+
+      desired = { aborted: true, STDOUT: '', STDERR: "Output stream 'BOGUS' is not known.\n" }
+
+      expected(actual, desired)
+    end
+
+    it 'print() writes indented text to stdout by default' do
+      actual = runner { @formatter.print(2, 'hello world') }
+
+      desired = { aborted: false, STDOUT: '  hello world', STDERR: '' }
+
+      expected(actual, desired)
+    end
+
+    it 'print() writes indented text to stderr when requested' do
+      actual = runner { @formatter.print(2, 'hello world', 'STDERR') }
+
+      desired = { aborted: false, STDOUT: '', STDERR: '  hello world' }
+
+      expected(actual, desired)
+    end
+
+    it 'print() aborts on an unknown output stream' do
+      actual = runner { @formatter.print(2, 'hello world', 'BOGUS') }
+
+      desired = { aborted: true, STDOUT: '', STDERR: "Output stream 'BOGUS' is not known.\n" }
+
+      expected(actual, desired)
+    end
+
+    it 'info() writes to stderr when requested' do
+      actual = runner { @formatter.info(2, 'hello world', 'STDERR') }
+
+      desired = { aborted: false, STDOUT: '', STDERR: '  INFO: hello world' }
+
+      expected(actual, desired)
+    end
+
+    it 'info() aborts on an unknown output stream' do
+      actual = runner { @formatter.info(2, 'hello world', 'BOGUS') }
+
+      desired = { aborted: true, STDOUT: '', STDERR: "Output stream 'BOGUS' is not known.\n" }
+
+      expected(actual, desired)
+    end
+
+    it 'warn() writes to stderr with the warning prefix' do
+      actual = runner { @formatter.warn('hello world') }
+
+      desired = { aborted: false, STDOUT: '', STDERR: 'WARNING: hello world' }
+
+      expected(actual, desired)
+    end
+
+    it 'error() writes to stderr with the error prefix' do
+      actual = runner { @formatter.error('hello world') }
+
+      desired = { aborted: false, STDOUT: '', STDERR: 'ERROR: hello world' }
+
+      expected(actual, desired)
+    end
   end
 end

data/spec/lib/moose_inventory/cli/group_add_spec.rb

@@ -1,52 +1,35 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/BlockLength
 require 'spec_helper'
 
-# TODO: the usual respond_to? method doesn't seem to work on Thor objects.
 # Why not? For now, we'll check against instance_methods.
 
 RSpec.describe Moose::Inventory::Cli::Group do
   before(:all) do
-    # Set up the configuration object
-    @mockarg_parts = {
-      config:  File.join(spec_root, 'config/config.yml'),
-      format:  'yaml',
-      env:     'test',
-    }
-
-    @mockargs = []
-    @mockarg_parts.each do |key, val|
-      @mockargs << "--#{key}"
-      @mockargs << val
-    end
-    @mockargs << '--trace' # extra info for debugging
-
-    @console = Moose::Inventory::Cli::Formatter
-
-    @config = Moose::Inventory::Config
-    @config.init(@mockargs)
-
-    @db = Moose::Inventory::DB
-    @db.init if @db.db.nil?
-
-    @host = Moose::Inventory::Cli::Host
-    @group = Moose::Inventory::Cli::Group
-    @app = Moose::Inventory::Cli::Application
+    setup_cli_harness(
+      command_class: Moose::Inventory::Cli::Group,
+      command_ivar: :@group,
+      extra_commands: { :@host => Moose::Inventory::Cli::Host },
+      extra_args: ['--trace']
+    )
   end
 
   before(:each) do
-    @db.reset
+    reset_cli_harness
   end
 
   # ============================
   describe 'add' do
     # --------------------
     it 'Group.add() method should be responsive' do
-      result = @group.instance_methods(false).include?(:add)
+      result = @group.method_defined?(:add, false)
       expect(result).to eq(true)
     end
 
     # --------------------
     it '<no arguments> ... should bail with an error' do
-      actual = runner { @app.start(%w(group add)) }
+      actual = runner { @app.start(%w[group add]) }
 
       desired = { aborted: true }
       desired[:STDERR] = "ERROR: Wrong number of arguments, 0 for 1 or more.\n"
@@ -55,7 +38,7 @@ RSpec.describe Moose::Inventory::Cli::Group do
 
     # --------------------
     it 'ungrouped ... should abort with an error' do
-      actual = runner { @app.start(%w(group add ungrouped)) }
+      actual = runner { @app.start(%w[group add ungrouped]) }
 
       # Check output
       desired = { aborted: true }
@@ -67,17 +50,17 @@ RSpec.describe Moose::Inventory::Cli::Group do
     # --------------------
     it 'GROUP ... should add a group to the db' do
       name = 'test'
-      actual = runner { @app.start(%W(group add #{name})) }
+      actual = runner { @app.start(%W[group add #{name}]) }
 
       # @console.out(actual)
 
       # Check output
       desired = {}
       desired[:STDOUT] =
-        "Add group '#{name}':\n"\
-        "  - create group...\n"\
-        "    - OK\n"\
-        "  - all OK\n"\
+        "Add group '#{name}':\n  " \
+        "- create group...\n    " \
+        "- OK\n  " \
+        "- all OK\n" \
         "Succeeded\n"
 
       expected(actual, desired)
@@ -87,23 +70,68 @@ RSpec.describe Moose::Inventory::Cli::Group do
       expect(group[:name]).to eq(name)
     end
 
+    # --------------------
+    it 'GROUP --dry-run should show planned group creation without writing to the db' do
+      name = 'dry-run-group'
+
+      actual = runner { @app.start(%W[group add #{name} --dry-run]) }
+
+      desired = {}
+      desired[:STDOUT] =
+        "Add group '#{name}':\n  " \
+        "- create group...\n    " \
+        "- OK\n  " \
+        "- all OK\n" \
+        "Dry run complete. No changes applied.\n" \
+        "Succeeded\n"
+
+      expected(actual, desired)
+      expect(@db.models[:group].find(name: name)).to be_nil
+    end
+
+    # --------------------
+    it 'GROUP --hosts HOST --dry-run should not create the group or missing host' do
+      group_name = 'dry-run-group'
+      host_name = 'dry-run-host'
+
+      actual = runner { @app.start(%W[group add #{group_name} --hosts #{host_name} --dry-run]) }
+
+      desired = {}
+      desired[:STDOUT] =
+        "Add group '#{group_name}':\n  " \
+        "- create group...\n    " \
+        "- OK\n  " \
+        "- add association {group:#{group_name} <-> host:#{host_name}}...\n    " \
+        "- host doesn't exist, creating now...\n      " \
+        "- OK\n    " \
+        "- OK\n  " \
+        "- all OK\n" \
+        "Dry run complete. No changes applied.\n" \
+        "Succeeded, with warnings.\n"
+      desired[:STDERR] =
+        "WARNING: Host '#{host_name}' doesn't exist, but will be created.\n"
+
+      expected(actual, desired)
+      expect(@db.models[:group].find(name: group_name)).to be_nil
+      expect(@db.models[:host].find(name: host_name)).to be_nil
+    end
     # --------------------
     it 'GROUP ... should skip GROUP creation if it already exists' do
       name = 'test-group'
       @db.models[:group].create(name: name)
 
-      actual = runner { @app.start(%W(group add #{name})) }
+      actual = runner { @app.start(%W[group add #{name}]) }
 
       # @console.out(actual)
 
       # Check output
       desired = {}
       desired[:STDOUT] =
-        "Add group '#{name}':\n"\
-        "  - create group...\n"\
-        "    - already exists, skipping.\n"\
-        "    - OK\n"\
-        "  - all OK\n"\
+        "Add group '#{name}':\n  " \
+        "- create group...\n    " \
+        "- already exists, skipping.\n    " \
+        "- OK\n  " \
+        "- all OK\n" \
         "Succeeded, with warnings.\n"
       desired[:STDERR] =
         "WARNING: Group '#{name}' already exists, skipping creation.\n"
@@ -115,9 +143,9 @@ RSpec.describe Moose::Inventory::Cli::Group do
 
     # --------------------
     it 'GROUP1 GROUP2 GROUP3 ... should add multiple groups' do
-      names = %w(test1 test2 test3)
+      names = %w[test1 test2 test3]
 
-      actual = runner { @app.start(%w(group add) + names) }
+      actual = runner { @app.start(%w[group add] + names) }
 
       # @console.out(actual)
 
@@ -125,12 +153,12 @@ RSpec.describe Moose::Inventory::Cli::Group do
       desired = { STDOUT: '' }
       names.each do |name|
         desired[:STDOUT] = desired[:STDOUT] +
-                           "Add group '#{name}':\n"\
-                           "  - create group...\n"\
-                           "    - OK\n"\
-                           "  - all OK\n"\
+                           "Add group '#{name}':\n  " \
+                           "- create group...\n    " \
+                           "- OK\n  " \
+                           "- all OK\n" \
       end
-      desired[:STDOUT] = desired[:STDOUT] + "Succeeded\n"
+      desired[:STDOUT] = "#{desired[:STDOUT]}Succeeded\n"
 
       expected(actual, desired)
 
@@ -142,15 +170,14 @@ RSpec.describe Moose::Inventory::Cli::Group do
     end
 
     # --------------------
-    it 'GROUP1 --hosts HOST1 ... should add the '\
-      'group and associate it with existing hosts' do
-
+    it 'GROUP1 --hosts HOST1 ... should add the ' \
+       'group and associate it with existing hosts' do
       host_name = 'test-host'
       @db.models[:host].create(name: host_name)
 
       group_name = 'test-group'
       actual = runner do
-        @app.start(%W(group add #{group_name} --hosts #{host_name}))
+        @app.start(%W[group add #{group_name} --hosts #{host_name}])
       end
 
       # @console.out(actual)
@@ -158,12 +185,12 @@ RSpec.describe Moose::Inventory::Cli::Group do
       # Check output
       desired = {}
       desired[:STDOUT] =
-        "Add group '#{group_name}':\n"\
-        "  - create group...\n"\
-        "    - OK\n"\
-        "  - add association {group:#{group_name} <-> host:#{host_name}}...\n"\
-        "    - OK\n"\
-        "  - all OK\n"\
+        "Add group '#{group_name}':\n  " \
+        "- create group...\n    " \
+        "- OK\n  " \
+        "- add association {group:#{group_name} <-> host:#{host_name}}...\n    " \
+        "- OK\n  " \
+        "- all OK\n" \
         "Succeeded\n"
 
       expected(actual, desired)
@@ -184,7 +211,7 @@ RSpec.describe Moose::Inventory::Cli::Group do
 
       group_name = 'test-group'
       actual = runner do
-        @app.start(%W(group add #{group_name} --hosts #{host_name}))
+        @app.start(%W[group add #{group_name} --hosts #{host_name}])
       end
 
       # @console.out(actual)
@@ -192,14 +219,14 @@ RSpec.describe Moose::Inventory::Cli::Group do
       # Check output
       desired = {}
       desired[:STDOUT] =
-        "Add group '#{group_name}':\n"\
-        "  - create group...\n"\
-        "    - OK\n"\
-        "  - add association {group:#{group_name} <-> host:#{host_name}}...\n"\
-        "    - host doesn't exist, creating now...\n"\
-        "      - OK\n"\
-        "    - OK\n"\
-        "  - all OK\n"\
+        "Add group '#{group_name}':\n  " \
+        "- create group...\n    " \
+        "- OK\n  " \
+        "- add association {group:#{group_name} <-> host:#{host_name}}...\n    " \
+        "- host doesn't exist, creating now...\n      " \
+        "- OK\n    " \
+        "- OK\n  " \
+        "- all OK\n" \
         "Succeeded, with warnings.\n"
       desired[:STDERR] =
         "WARNING: Host '#{host_name}' doesn't exist, but will be created.\n"
@@ -220,11 +247,11 @@ RSpec.describe Moose::Inventory::Cli::Group do
       group_name = 'test-group'
 
       # Create group and association
-      runner { @app.start(%W(group add #{group_name} --hosts #{host_name})) }
+      runner { @app.start(%W[group add #{group_name} --hosts #{host_name}]) }
 
       # Do it again, to prove that we skip
       actual = runner do
-        @app.start(%W(group add #{group_name} --hosts #{host_name}))
+        @app.start(%W[group add #{group_name} --hosts #{host_name}])
       end
 
       # @console.out(actual, 'y')
@@ -232,17 +259,17 @@ RSpec.describe Moose::Inventory::Cli::Group do
       # Check output
       desired = {}
       desired[:STDOUT] =
-        "Add group '#{group_name}':\n"\
-        "  - create group...\n"\
-        "    - already exists, skipping.\n"\
-        "    - OK\n"\
-        "  - add association {group:#{group_name} <-> host:#{host_name}}...\n"\
-        "    - already exists, skipping.\n"\
-        "    - OK\n"\
-        "  - all OK\n"\
+        "Add group '#{group_name}':\n  " \
+        "- create group...\n    " \
+        "- already exists, skipping.\n    " \
+        "- OK\n  " \
+        "- add association {group:#{group_name} <-> host:#{host_name}}...\n    " \
+        "- already exists, skipping.\n    " \
+        "- OK\n  " \
+        "- all OK\n" \
         "Succeeded, with warnings.\n"
       desired[:STDERR] =
-        "WARNING: Group '#{group_name}' already exists, skipping creation.\n"\
+        "WARNING: Group '#{group_name}' already exists, skipping creation.\n" \
         "WARNING: Association {group:#{group_name} <-> host:#{host_name}} already exists, skipping creation.\n"
 
       expected(actual, desired)
@@ -256,26 +283,25 @@ RSpec.describe Moose::Inventory::Cli::Group do
     end
 
     # --------------------
-    it 'GROUP --hosts HOST1,HOST2 ... should add the group and '\
-      'associate it with multiple hosts' do
-
+    it 'GROUP --hosts HOST1,HOST2 ... should add the group and ' \
+       'associate it with multiple hosts' do
       # The group should be added
       # Each host should be associated with the group
       # Each host should be removed from the automatic 'ungrouped' group
 
       group_name = 'test-group'
-      host_names = %w(host1 host2 host3)
+      host_names = %w[host1 host2 host3]
 
       # Add just the first host. This ensure that we cover paths for both
       # and existing host (with an 'ungrouped' association) and for none
       # existing groups.
-      tmp = runner { @app.start(%W(host add #{host_names[0]})) }
+      runner { @app.start(%W[host add #{host_names[0]}]) }
 
       # @console.out(tmp,  'y')
 
       # Now run the actual group addition
       actual = runner do
-        @app.start(%W(group add #{group_name} --hosts #{host_names.join(',')}))
+        @app.start(%W[group add #{group_name} --hosts #{host_names.join(',')}])
       end
 
       # @console.out(actual,'y')
@@ -283,25 +309,25 @@ RSpec.describe Moose::Inventory::Cli::Group do
       # Check output
       desired = { aborted: false, STDERR: '', STDOUT: '' }
       desired[:STDOUT] =
-        "Add group '#{group_name}':\n"\
-        "  - create group...\n"\
-        "    - OK\n"\
-        "  - add association {group:#{group_name} <-> host:#{host_names[0]}}...\n"\
-        "    - OK\n"\
-        "  - remove automatic association {group:ungrouped <-> host:#{host_names[0]}}...\n"\
-        "    - OK\n"
+        "Add group '#{group_name}':\n  " \
+        "- create group...\n    " \
+        "- OK\n  " \
+        "- add association {group:#{group_name} <-> host:#{host_names[0]}}...\n    " \
+        "- OK\n  " \
+        "- remove automatic association {group:ungrouped <-> host:#{host_names[0]}}...\n    " \
+        "- OK\n"
 
       host_names.slice(1, host_names.length - 1).each do |host_name|
         desired[:STDOUT] = desired[:STDOUT] +
-                           "  - add association {group:#{group_name} <-> host:#{host_name}}...\n"\
-                           "    - host doesn't exist, creating now...\n"\
-                           "      - OK\n"\
-                           "    - OK\n"
+                           "  - add association {group:#{group_name} <-> host:#{host_name}}...\n    " \
+                           "- host doesn't exist, creating now...\n      " \
+                           "- OK\n    " \
+                           "- OK\n"
         desired[:STDERR] = desired[:STDERR] +
                            "WARNING: Host '#{host_name}' doesn't exist, but will be created.\n"
       end
       desired[:STDOUT] = desired[:STDOUT] +
-                         "  - all OK\n"\
+                         "  - all OK\n" \
                          "Succeeded, with warnings.\n"
 
       expected(actual, desired)
@@ -318,13 +344,13 @@ RSpec.describe Moose::Inventory::Cli::Group do
     end
 
     # --------------------
-    it 'HOST --groups GROUP1,ungrouped ... should bail '\
-      'with an error' do
+    it 'HOST --groups GROUP1,ungrouped ... should bail ' \
+       'with an error' do
       name = 'testhost'
-      group_names = %w(group1 ungrouped)
+      group_names = %w[group1 ungrouped]
 
       actual = runner do
-        @app.start(%W(host add #{name} --groups #{group_names.join(',')}))
+        @app.start(%W[host add #{name} --groups #{group_names.join(',')}])
       end
 
       # Check output
@@ -336,15 +362,14 @@ RSpec.describe Moose::Inventory::Cli::Group do
     end
 
     # --------------------
-    it 'HOST1 HOST2 --groups GROUP1,GROUP2 ... should add multiple '\
-      'groups, associating each with multiple hosts' do
-      #
-      host_names = %w(host1 host2 host3)
+    it 'HOST1 HOST2 --groups GROUP1,GROUP2 ... should add multiple ' \
+       'groups, associating each with multiple hosts' do
+      host_names = %w[host1 host2 host3]
       # Note, relies on auto-generation of hosts
 
-      group_names = %w(group1 group2 group3)
+      group_names = %w[group1 group2 group3]
       actual = runner do
-        @app.start(%w(group add) + group_names + %W(--hosts #{host_names.join(',')}))
+        @app.start(%w[group add] + group_names + %W[--hosts #{host_names.join(',')}])
       end
 
       # @console.out(actual,'y')
@@ -354,27 +379,25 @@ RSpec.describe Moose::Inventory::Cli::Group do
       first_pass = true
       group_names.each do |group|
         desired[:STDOUT] = desired[:STDOUT] +
-                           "Add group '#{group}':\n"\
-                           "  - create group...\n"\
-                           "    - OK\n"
+                           "Add group '#{group}':\n  " \
+                           "- create group...\n    " \
+                           "- OK\n"
 
         host_names.each do |host|
           desired[:STDOUT] = desired[:STDOUT] +
                              "  - add association {group:#{group} <-> host:#{host}}...\n"
           if first_pass
             desired[:STDOUT] = desired[:STDOUT] +
-                               "    - host doesn't exist, creating now...\n"\
-                               "      - OK\n"
+                               "    - host doesn't exist, creating now...\n      " \
+                               "- OK\n"
           end
-          desired[:STDOUT] = desired[:STDOUT] +
-                             "    - OK\n"
+          desired[:STDOUT] = "#{desired[:STDOUT]}    - OK\n"
         end
-        desired[:STDOUT] = desired[:STDOUT] +
-                           "  - all OK\n"
+        desired[:STDOUT] = "#{desired[:STDOUT]}  - all OK\n"
         first_pass = false
       end
 
-      desired[:STDOUT] = desired[:STDOUT] + "Succeeded, with warnings.\n"
+      desired[:STDOUT] = "#{desired[:STDOUT]}Succeeded, with warnings.\n"
       host_names.each do |host|
         desired[:STDERR] = desired[:STDERR] +
                            "WARNING: Host '#{host}' doesn't exist, but will be created.\n"
@@ -395,3 +418,4 @@ RSpec.describe Moose::Inventory::Cli::Group do
     end
   end
 end
+# rubocop:enable Metrics/BlockLength