moose-inventory 2.0 → 2.1

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

@@ -1,49 +1,30 @@
+# 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::Host 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
-
-    @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
-    @app = Moose::Inventory::Cli::Application
+    setup_cli_harness(command_class: Moose::Inventory::Cli::Host, command_ivar: :@host)
   end
 
   before(:each) do
-    @db.reset
+    reset_cli_harness
   end
 
   # ============================
   describe 'add' do
     # --------------------
     it 'Host.add() method should be responsive' do
-      result = @host.instance_methods(false).include?(:add)
+      result = @host.method_defined?(:add, false)
       expect(result).to eq(true)
     end
 
     # --------------------
     it '<no arguments> ... should bail with an error' do
-      actual = runner { @app.start(%w(host add)) }
+      actual = runner { @app.start(%w[host add]) }
 
       desired = { aborted: true }
       desired[:STDERR] = "ERROR: Wrong number of arguments, 0 for 1 or more.\n"
@@ -54,18 +35,18 @@ RSpec.describe Moose::Inventory::Cli::Host do
     it 'HOST ... should add a host to the db' do
       name = 'test-host-add'
 
-      actual = runner { @app.start(%W(host add #{name})) }
+      actual = runner { @app.start(%W[host add #{name}]) }
       # @console.out(actual,'y')
 
       # Check output
       desired = {}
       desired[:STDOUT] =
-        "Add host '#{name}':\n"\
-        "  - Creating host '#{name}'...\n"\
-        "    - OK\n"\
-        "  - Adding automatic association {host:#{name} <-> group:ungrouped}...\n"\
-        "    - OK\n"\
-        "  - All OK\n"\
+        "Add host '#{name}':\n  " \
+        "- Creating host '#{name}'...\n    " \
+        "- OK\n  " \
+        "- Adding automatic association {host:#{name} <-> group:ungrouped}...\n    " \
+        "- OK\n  " \
+        "- All OK\n" \
         "Succeeded\n"
 
       expected(actual, desired)
@@ -79,20 +60,94 @@ RSpec.describe Moose::Inventory::Cli::Host do
       expect(groups[name: 'ungrouped']).not_to be_nil
     end
 
+    # --------------------
+    it 'HOST --dry-run should show planned host creation without writing to the db' do
+      name = 'dry-run-host'
+
+      actual = runner { @app.start(%W[host add #{name} --dry-run]) }
+
+      desired = {}
+      desired[:STDOUT] =
+        "Add host '#{name}':\n  " \
+        "- Creating host '#{name}'...\n    " \
+        "- OK\n  " \
+        "- Adding automatic association {host:#{name} <-> group:ungrouped}...\n    " \
+        "- OK\n  " \
+        "- All OK\n" \
+        "Dry run complete. No changes applied.\n" \
+        "Succeeded\n"
+
+      expected(actual, desired)
+      expect(@db.models[:host].find(name: name)).to be_nil
+    end
+
+    # --------------------
+    it 'HOST --groups GROUP --dry-run should not create the missing group or host' do
+      name = 'dry-run-host'
+      group_name = 'dry-run-group'
+
+      actual = runner { @app.start(%W[host add #{name} --groups #{group_name} --dry-run]) }
+
+      desired = {}
+      desired[:STDOUT] =
+        "Add host '#{name}':\n  " \
+        "- Creating host '#{name}'...\n    " \
+        "- OK\n  " \
+        "- Adding association {host:#{name} <-> group:#{group_name}}...\n    " \
+        "- OK\n  " \
+        "- All OK\n" \
+        "Dry run complete. No changes applied.\n" \
+        "Succeeded\n"
+      desired[:STDERR] =
+        "WARNING: The group '#{group_name}' doesn't exist, but will be created.\n"
+
+      expected(actual, desired)
+      expect(@db.models[:host].find(name: name)).to be_nil
+      expect(@db.models[:group].find(name: group_name)).to be_nil
+    end
+    # --------------------
+    it 'HOST --dry-run --plan-format json should emit a machine-readable plan only' do
+      name = 'plan-host'
+
+      actual = runner { @app.start(%W[host add #{name} --dry-run --plan-format json]) }
+
+      expect(actual[:unexpected]).to eq(false)
+      expect(actual[:aborted]).to eq(false)
+      expect(actual[:STDERR]).to eq('')
+      expect(actual[:STDOUT]).not_to include('Succeeded')
+      plan = JSON.parse(actual[:STDOUT])
+      expect(plan['command']).to eq('host add')
+      expect(plan['dry_run']).to eq(true)
+      expect(plan['changes_applied']).to eq(false)
+      expect(plan['events'].map { |event| event['type'] }).to include('creating_host', 'dry_run_summary')
+      expect(@db.models[:host].find(name: name)).to be_nil
+    end
+
+    # --------------------
+    it 'HOST --plan-format json without --dry-run should abort before writing' do
+      name = 'plan-host-without-dry-run'
+
+      actual = runner { @app.start(%W[host add #{name} --plan-format json]) }
+
+      expect(actual[:aborted]).to eq(true)
+      expect(actual[:STDERR]).to eq("ERROR: --plan-format requires --dry-run.\n")
+      expect(@db.models[:host].find(name: name)).to be_nil
+    end
+
     # --------------------
     it 'HOST ... should skip HOST creation if HOST already exists' do
       name = 'test-host-add'
-      runner { @app.start(%W(host add #{name})) }
+      runner { @app.start(%W[host add #{name}]) }
 
-      actual = runner { @app.start(%W(host add #{name})) }
+      actual = runner { @app.start(%W[host add #{name}]) }
 
       # Check output
       desired = {}
       desired[:STDOUT] =
-        "Add host '#{name}':\n"\
-        "  - Creating host '#{name}'...\n"\
-        "    - OK\n"\
-        "  - All OK\n"\
+        "Add host '#{name}':\n  " \
+        "- Creating host '#{name}'...\n    " \
+        "- OK\n  " \
+        "- All OK\n" \
         "Succeeded\n"
 
       desired[:STDERR] =
@@ -103,22 +158,22 @@ RSpec.describe Moose::Inventory::Cli::Host do
 
     # --------------------
     it 'HOST1 HOST2 HOST3 ... should add multiple hosts' do
-      names = %w(test1 test2 test3)
+      names = %w[test1 test2 test3]
 
-      actual = runner { @app.start(%w(host add) + names) }
+      actual = runner { @app.start(%w[host add] + names) }
 
       # Check output
       desired = { STDOUT: '' }
       names.each do |name|
         desired[:STDOUT] = desired[:STDOUT] +
-                           "Add host '#{name}':\n"\
-                           "  - Creating host '#{name}'...\n"\
-                           "    - OK\n"\
-                           "  - Adding automatic association {host:#{name} <-> group:ungrouped}...\n"\
-                           "    - OK\n"\
-                           "  - All OK\n"
+                           "Add host '#{name}':\n  " \
+                           "- Creating host '#{name}'...\n    " \
+                           "- OK\n  " \
+                           "- Adding automatic association {host:#{name} <-> group:ungrouped}...\n    " \
+                           "- OK\n  " \
+                           "- All OK\n"
       end
-      desired[:STDOUT] = desired[:STDOUT] + "Succeeded\n"
+      desired[:STDOUT] = "#{desired[:STDOUT]}Succeeded\n"
 
       expected(actual, desired)
 
@@ -134,25 +189,25 @@ RSpec.describe Moose::Inventory::Cli::Host do
     end
 
     # --------------------
-    it 'HOST1 --groups GROUP ... should add the '\
-      'host and associate it with an existing group' do
+    it 'HOST1 --groups GROUP ... should add the ' \
+       'host and associate it with an existing group' do
       group_name = 'testgroup'
       @db.models[:group].create(name: group_name)
 
       name = 'testhost'
       actual = runner do
-        @app.start(%W(host add #{name} --groups #{group_name}))
+        @app.start(%W[host add #{name} --groups #{group_name}])
       end
 
       # Check output
       desired = {}
       desired[:STDOUT] =
-        "Add host '#{name}':\n"\
-        "  - Creating host '#{name}'...\n"\
-        "    - OK\n"\
-        "  - Adding association {host:#{name} <-> group:#{group_name}}...\n"\
-        "    - OK\n"\
-        "  - All OK\n"\
+        "Add host '#{name}':\n  " \
+        "- Creating host '#{name}'...\n    " \
+        "- OK\n  " \
+        "- Adding association {host:#{name} <-> group:#{group_name}}...\n    " \
+        "- OK\n  " \
+        "- All OK\n" \
         "Succeeded\n"
 
       expected(actual, desired)
@@ -166,26 +221,26 @@ RSpec.describe Moose::Inventory::Cli::Host do
     end
 
     # --------------------
-    it 'HOST1 --groups GROUP ... should add the host and associate '\
-      ' it with a non-existent group, creating the group' do
+    it 'HOST1 --groups GROUP ... should add the host and associate  ' \
+       'it with a non-existent group, creating the group' do
       group_name = 'testgroup'
 
       # DON'T MANUALLY CREATE THE GROUP! That's the point of the test.
 
       name = 'testhost'
       actual = runner do
-        @app.start(%W(host add #{name} --groups #{group_name}))
+        @app.start(%W[host add #{name} --groups #{group_name}])
       end
 
       # Check output
       desired = {}
       desired[:STDOUT] =
-        "Add host '#{name}':\n"\
-        "  - Creating host '#{name}'...\n"\
-        "    - OK\n"\
-        "  - Adding association {host:#{name} <-> group:#{group_name}}...\n"\
-        "    - OK\n"\
-        "  - All OK\n"\
+        "Add host '#{name}':\n  " \
+        "- Creating host '#{name}'...\n    " \
+        "- OK\n  " \
+        "- Adding association {host:#{name} <-> group:#{group_name}}...\n    " \
+        "- OK\n  " \
+        "- All OK\n" \
         "Succeeded\n"
       desired[:STDERR] =
         "WARNING: The group '#{group_name}' doesn't exist, but will be created.\n"
@@ -206,20 +261,20 @@ RSpec.describe Moose::Inventory::Cli::Host do
       initial_group = 'initialgroup'
       new_group = 'newgroup'
 
-      runner { @app.start(%W(host add #{name} --groups #{initial_group})) }
-      actual = runner { @app.start(%W(host add #{name} --groups #{new_group})) }
+      runner { @app.start(%W[host add #{name} --groups #{initial_group}]) }
+      actual = runner { @app.start(%W[host add #{name} --groups #{new_group}]) }
 
       desired = {}
       desired[:STDOUT] =
-        "Add host '#{name}':\n"\
-        "  - Creating host '#{name}'...\n"\
-        "    - OK\n"\
-        "  - Adding association {host:#{name} <-> group:#{new_group}}...\n"\
-        "    - OK\n"\
-        "  - All OK\n"\
+        "Add host '#{name}':\n  " \
+        "- Creating host '#{name}'...\n    " \
+        "- OK\n  " \
+        "- Adding association {host:#{name} <-> group:#{new_group}}...\n    " \
+        "- OK\n  " \
+        "- All OK\n" \
         "Succeeded\n"
       desired[:STDERR] =
-        "WARNING: The host '#{name}' already exists, skipping creation.\n"\
+        "WARNING: The host '#{name}' already exists, skipping creation.\n" \
         "WARNING: The group '#{new_group}' doesn't exist, but will be created.\n"
 
       expected(actual, desired)
@@ -236,20 +291,20 @@ RSpec.describe Moose::Inventory::Cli::Host do
       name = 'testhost'
       group_name = 'testgroup'
 
-      runner { @app.start(%W(host add #{name} --groups #{group_name})) }
-      actual = runner { @app.start(%W(host add #{name} --groups #{group_name})) }
+      runner { @app.start(%W[host add #{name} --groups #{group_name}]) }
+      actual = runner { @app.start(%W[host add #{name} --groups #{group_name}]) }
 
       desired = {}
       desired[:STDOUT] =
-        "Add host '#{name}':\n"\
-        "  - Creating host '#{name}'...\n"\
-        "    - OK\n"\
-        "  - Adding association {host:#{name} <-> group:#{group_name}}...\n"\
-        "    - OK\n"\
-        "  - All OK\n"\
+        "Add host '#{name}':\n  " \
+        "- Creating host '#{name}'...\n    " \
+        "- OK\n  " \
+        "- Adding association {host:#{name} <-> group:#{group_name}}...\n    " \
+        "- OK\n  " \
+        "- All OK\n" \
         "Succeeded\n"
       desired[:STDERR] =
-        "WARNING: The host '#{name}' already exists, skipping creation.\n"\
+        "WARNING: The host '#{name}' already exists, skipping creation.\n" \
         "WARNING: Association {host:#{name} <-> group:#{group_name}} already exists, skipping creation.\n"
 
       expected(actual, desired)
@@ -264,7 +319,7 @@ RSpec.describe Moose::Inventory::Cli::Host do
     it 'HOST1 --groups ungrouped ... should abort with an error' do
       name = 'testhost'
       actual = runner do
-        @app.start(%W(host add #{name} --groups ungrouped))
+        @app.start(%W[host add #{name} --groups ungrouped])
       end
 
       # Check output
@@ -279,13 +334,13 @@ RSpec.describe Moose::Inventory::Cli::Host do
     end
 
     # --------------------
-    it 'HOST --groups GROUP1,GROUP2 ... should add the host and '\
-      'associate it with multiple groups' do
-      group_names = %w(group1 group2 group3)
+    it 'HOST --groups GROUP1,GROUP2 ... should add the host and ' \
+       'associate it with multiple groups' do
+      group_names = %w[group1 group2 group3]
 
       name = 'testhost'
       actual = runner do
-        @app.start(%W(host add #{name} --groups #{group_names.join(',')}))
+        @app.start(%W[host add #{name} --groups #{group_names.join(',')}])
       end
 
       # @console.out(actual,'y')
@@ -293,19 +348,19 @@ RSpec.describe Moose::Inventory::Cli::Host do
       # Check output
       desired = { STDOUT: '', STDERR: '' }
       desired[:STDOUT] =
-        "Add host '#{name}':\n"\
-        "  - Creating host '#{name}'...\n"\
-        "    - OK\n"\
+        "Add host '#{name}':\n  " \
+        "- Creating host '#{name}'...\n    " \
+        "- OK\n" \
 
       group_names.each do |group|
-        desired[:STDOUT] =  desired[:STDOUT] +
-                            "  - Adding association {host:#{name} <-> group:#{group}}...\n"\
-                            "    - OK\n"
-        desired[:STDERR] =  desired[:STDERR] +
-                            "WARNING: The group '#{group}' doesn't exist, but will be created.\n"
+        desired[:STDOUT] = desired[:STDOUT] +
+                           "  - Adding association {host:#{name} <-> group:#{group}}...\n    " \
+                           "- OK\n"
+        desired[:STDERR] = desired[:STDERR] +
+                           "WARNING: The group '#{group}' doesn't exist, but will be created.\n"
       end
       desired[:STDOUT] = desired[:STDOUT] +
-                         "  - All OK\n"\
+                         "  - All OK\n" \
                          "Succeeded\n"
 
       expected(actual, desired)
@@ -320,13 +375,13 @@ RSpec.describe Moose::Inventory::Cli::Host do
       end
     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
@@ -337,38 +392,36 @@ RSpec.describe Moose::Inventory::Cli::Host do
       expected(actual, desired)
     end
 
-    it 'HOST1 HOST2 --groups GROUP1,GROUP2 ... should add multiple '\
-      'hosts, associating each with multiple groups' do
-      #
-      group_names = %w(group1 group2 group3)
+    it 'HOST1 HOST2 --groups GROUP1,GROUP2 ... should add multiple ' \
+       'hosts, associating each with multiple groups' do
+      group_names = %w[group1 group2 group3]
       # Note, relies on auto-generation of groups
 
-      names = %w(host1 host2 host3)
+      names = %w[host1 host2 host3]
       actual = runner do
-        @app.start(%w(host add) + names + %W(--groups #{group_names.join(',')}))
+        @app.start(%w[host add] + names + %W[--groups #{group_names.join(',')}])
       end
 
       # Check output
       desired = { aborted: false, STDERR: '', STDOUT: '' }
       names.each do |name|
         desired[:STDOUT] = desired[:STDOUT] +
-                           "Add host '#{name}':\n"\
-                           "  - Creating host '#{name}'...\n"\
-                           "    - OK\n"
+                           "Add host '#{name}':\n  " \
+                           "- Creating host '#{name}'...\n    " \
+                           "- OK\n"
         group_names.each do |group|
           desired[:STDOUT] = desired[:STDOUT] +
-                             "  - Adding association {host:#{name} <-> group:#{group}}...\n"\
-                             "    - OK\n"
+                             "  - Adding association {host:#{name} <-> group:#{group}}...\n    " \
+                             "- OK\n"
         end
-        desired[:STDOUT] = desired[:STDOUT] +
-                           "  - All OK\n"
+        desired[:STDOUT] = "#{desired[:STDOUT]}  - All OK\n"
       end
 
       group_names.each do |group|
         desired[:STDERR] = desired[:STDERR] +
                            "WARNING: The group '#{group}' doesn't exist, but will be created.\n"
       end
-      desired[:STDOUT] = desired[:STDOUT] + "Succeeded\n"
+      desired[:STDOUT] = "#{desired[:STDOUT]}Succeeded\n"
 
       # @console.out(desired,'y')
 
@@ -388,3 +441,4 @@ RSpec.describe Moose::Inventory::Cli::Host do
     end
   end
 end
+# rubocop:enable Metrics/BlockLength