moose-inventory 1.0.9 → 2.1

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

@@ -1,15 +1,17 @@
+# 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',
+      config: File.join(spec_root, 'config/config.yml'),
+      format: 'yaml',
+      env: 'test'
     }
 
     @mockargs = []
@@ -39,14 +41,14 @@ RSpec.describe Moose::Inventory::Cli::Group do
   describe 'addchild' do
     #------------------------
     it 'Group.addchild() should be responsive' do
-      result = @group.instance_methods(false).include?(:addchild)
+      result = @group.method_defined?(:addchild, false)
       expect(result).to eq(true)
     end
 
     #------------------------
     it '<missing args> ... should abort with an error' do
       actual = runner  do
-        @app.start(%w(group addchild))
+        @app.start(%w[group addchild])
       end
 
       # @console.out(actual, 'y')
@@ -63,7 +65,7 @@ RSpec.describe Moose::Inventory::Cli::Group do
       child_name = 'fake'
 
       actual = runner do
-        @app.start(%W(group addchild #{parent_name} #{child_name}))
+        @app.start(%W[group addchild #{parent_name} #{child_name}])
       end
 
       # @console.out(actual, 'y')
@@ -79,7 +81,7 @@ RSpec.describe Moose::Inventory::Cli::Group do
       child_name = 'ungrouped'
 
       actual = runner do
-        @app.start(%W(group addchild #{parent_name} #{child_name}))
+        @app.start(%W[group addchild #{parent_name} #{child_name}])
       end
 
       # @console.out(actual, 'y')
@@ -92,25 +94,28 @@ RSpec.describe Moose::Inventory::Cli::Group do
 
     #------------------------
     it 'GROUP CHILDGROUP  ... should abort if GROUP does not exist' do
-      # TODO: Why don't we just create GROUP?  Likewise for all similar functions?
-
+      # Contract: addchild attaches children to an existing parent. Missing child
+      # groups may be created, but the parent must already exist so typos do not
+      # silently create a new tree root.
       pname = 'parent_group'
       cname = 'child group'
 
       actual = runner do
-        @app.start(%W(group addchild #{pname} #{cname}))
+        @app.start(%W[group addchild #{pname} #{cname}])
       end
 
       # @console.out(actual, 'y')
       # Check output
       desired = { aborted: true }
       desired[:STDOUT] =
-        "Associate parent group '#{pname}' with child group(s) '#{cname}':\n"\
-        "  - retrieve group '#{pname}'...\n"
+        "Associate parent group '#{pname}' with child group(s) '#{cname}':\n  " \
+        "- retrieve group '#{pname}'...\n"
       desired[:STDERR] =
-        "ERROR: The group '#{pname}' does not exist.\n"\
+        "ERROR: The group '#{pname}' does not exist.\n" \
         "An error occurred during a transaction, any changes have been rolled back.\n"
       expected(actual, desired)
+      expect(@db.models[:group].find(name: pname)).to be_nil
+      expect(@db.models[:group].find(name: cname)).to be_nil
     end
 
     #------------------------
@@ -118,20 +123,20 @@ RSpec.describe Moose::Inventory::Cli::Group do
       pname = 'parent_group'
       cname = 'child_group'
 
-      runner { @app.start(%W(group add #{pname} #{cname})) }
+      runner { @app.start(%W[group add #{pname} #{cname}]) }
 
-      actual = runner { @app.start(%W(group addchild #{pname} #{cname})) }
+      actual = runner { @app.start(%W[group addchild #{pname} #{cname}]) }
 
       # @console.out(actual, 'y')
 
       desired = { aborted: false }
       desired[:STDOUT] =
-        "Associate parent group '#{pname}' with child group(s) '#{cname}':\n"\
-        "  - retrieve group '#{pname}'...\n"\
-        "    - OK\n"\
-        "  - add association {group:#{pname} <-> group:#{cname}}...\n"\
-        "    - OK\n"\
-        "  - all OK\n"\
+        "Associate parent group '#{pname}' with child group(s) '#{cname}':\n  " \
+        "- retrieve group '#{pname}'...\n    " \
+        "- OK\n  " \
+        "- add association {group:#{pname} <-> group:#{cname}}...\n    " \
+        "- OK\n  " \
+        "- all OK\n" \
         "Succeeded.\n"
       expected(actual, desired)
 
@@ -143,28 +148,76 @@ RSpec.describe Moose::Inventory::Cli::Group do
     end
 
     #------------------------
-    it 'GROUP CHILDGROUP... should associate GROUP with a CHILDGROUP '\
-      'creating it if necessary' do
-      #
+    it 'GROUP CHILDGROUP --dry-run should not create the child or association' do
+      pname = 'parent_group'
+      cname = 'dry_child'
+
+      runner { @app.start(%W[group add #{pname}]) }
+
+      actual = runner { @app.start(%W[group addchild #{pname} #{cname} --dry-run]) }
+
+      expect(actual[:unexpected]).to eq(false)
+      expect(actual[:aborted]).to eq(false)
+      expect(actual[:STDOUT]).to include('Dry run complete. No changes applied.')
+      expect(@db.models[:group].find(name: cname)).to be_nil
+      pgroup = @db.models[:group].find(name: pname)
+      expect(pgroup.children_dataset[name: cname]).to be_nil
+    end
+
+    #------------------------
+
+    it 'GROUP CHILDGROUP... should warn and skip when the association already exists' do
+      pname = 'parent_group'
+      cname = 'child_group'
+
+      runner { @app.start(%W[group add #{pname} #{cname}]) }
+      runner { @app.start(%W[group addchild #{pname} #{cname}]) }
+
+      actual = runner { @app.start(%W[group addchild #{pname} #{cname}]) }
+
+      desired = { aborted: false }
+      desired[:STDOUT] = <<~OUTPUT
+        Associate parent group '#{pname}' with child group(s) '#{cname}':
+          - retrieve group '#{pname}'...
+            - OK
+          - add association {group:#{pname} <-> group:#{cname}}...
+            - already exists, skipping.
+            - OK
+          - all OK
+        Succeeded, with warnings.
+      OUTPUT
+      desired[:STDERR] = <<~ERROR
+        WARNING: Association {group:#{pname} <-> group:#{cname}} already exists, skipping.
+      ERROR
+      expected(actual, desired)
+
+      pgroup = @db.models[:group].find(name: pname)
+      cgroups = pgroup.children_dataset
+      expect(cgroups.count).to eq(1)
+      expect(cgroups[name: cname]).not_to be_nil
+    end
+
+    it 'GROUP CHILDGROUP... should associate GROUP with a CHILDGROUP ' \
+       'creating it if necessary' do
       pname = 'parent_group'
       cname = 'child_group'
 
-      runner { @app.start(%W(group add #{pname})) } # <- don't pre-create the child
+      runner { @app.start(%W[group add #{pname}]) } # <- don't pre-create the child
 
-      actual = runner { @app.start(%W(group addchild #{pname} #{cname})) }
+      actual = runner { @app.start(%W[group addchild #{pname} #{cname}]) }
 
       # @console.out(actual, 'y')
 
       desired = { aborted: false }
       desired[:STDOUT] =
-        "Associate parent group '#{pname}' with child group(s) '#{cname}':\n"\
-        "  - retrieve group '#{pname}'...\n"\
-        "    - OK\n"\
-        "  - add association {group:#{pname} <-> group:#{cname}}...\n"\
-        "    - child group does not exist, creating now...\n"\
-        "      - OK\n"\
-        "    - OK\n"\
-        "  - all OK\n"\
+        "Associate parent group '#{pname}' with child group(s) '#{cname}':\n  " \
+        "- retrieve group '#{pname}'...\n    " \
+        "- OK\n  " \
+        "- add association {group:#{pname} <-> group:#{cname}}...\n    " \
+        "- child group does not exist, creating now...\n      " \
+        "- OK\n    " \
+        "- OK\n  " \
+        "- all OK\n" \
         "Succeeded, with warnings.\n"
       desired[:STDERR] = "WARNING: Group '#{cname}' does not exist and will be created.\n"
       expected(actual, desired)
@@ -177,3 +230,4 @@ RSpec.describe Moose::Inventory::Cli::Group do
     end
   end
 end
+# rubocop:enable Metrics/BlockLength

data/spec/lib/moose_inventory/cli/group_addhost_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
-
-    @console = Moose::Inventory::Cli::Formatter
-
-    @config = Moose::Inventory::Config
-    @config.init(@mockargs)
-
-    @db = Moose::Inventory::DB
-    @db.init if @db.db.nil?
-
-    @group = Moose::Inventory::Cli::Group
-    @host  = Moose::Inventory::Cli::Host
-    @app   = Moose::Inventory::Cli::Application
+    setup_cli_harness(
+      command_class: Moose::Inventory::Cli::Group,
+      command_ivar: :@group,
+      extra_commands: { :@host => Moose::Inventory::Cli::Host }
+    )
   end
 
   before(:each) do
-    @db.reset
+    reset_cli_harness
   end
 
   #=======================
   describe 'addhost' do
     #------------------------
     it 'Group.addhost() should be responsive' do
-      result = @group.instance_methods(false).include?(:addhost)
+      result = @group.method_defined?(:addhost, false)
       expect(result).to eq(true)
     end
 
     #------------------------
     it 'addhost <missing args> ... should abort with an error' do
       actual = runner do
-        @app.start(%w(group addhost)) # <- no group given
+        @app.start(%w[group addhost]) # <- no group given
       end
 
       # @console.out(actual, 'y')
@@ -63,17 +46,17 @@ RSpec.describe Moose::Inventory::Cli::Group do
       group_name = 'not-a-group'
 
       actual = runner do
-        @app.start(%W(group addhost #{group_name} #{host_name}))
+        @app.start(%W[group addhost #{group_name} #{host_name}])
       end
 
       # @console.out(actual, 'y')
       # Check output
       desired = { aborted: true }
       desired[:STDOUT] =
-        "Associate group '#{group_name}' with host(s) '#{host_name}':\n"\
-        "  - retrieve group '#{group_name}'...\n"
+        "Associate group '#{group_name}' with host(s) '#{host_name}':\n  " \
+        "- retrieve group '#{group_name}'...\n"
       desired[:STDERR] =
-        "ERROR: The group '#{group_name}' does not exist.\n"\
+        "ERROR: The group '#{group_name}' does not exist.\n" \
         "An error occurred during a transaction, any changes have been rolled back.\n"
       expected(actual, desired)
     end
@@ -86,26 +69,23 @@ RSpec.describe Moose::Inventory::Cli::Group do
       host_name = 'test1'
       group_name = 'testgroup1'
 
-      runner { @app.start(%W(host add #{host_name})) }
+      runner { @app.start(%W[host add #{host_name}]) }
       @db.models[:group].create(name: group_name)
 
-      actual = runner { @app.start(%W(group addhost #{group_name} #{host_name})) }
+      actual = runner { @app.start(%W[group addhost #{group_name} #{host_name}]) }
 
-      # rubocop:disable Metrics/LineLength
       desired = { aborted: false }
       desired[:STDOUT] =
-        "Associate group '#{group_name}' with host(s) '#{host_name}':\n"\
-        "  - retrieve group '#{group_name}'...\n"\
-        "    - OK\n"\
-        "  - add association {group:#{group_name} <-> host:#{host_name}}...\n"\
-        "    - OK\n"\
-        "  - remove automatic association {group:ungrouped <-> host:#{host_name}}...\n"\
-        "    - OK\n"\
-        "  - all OK\n"\
+        "Associate group '#{group_name}' with host(s) '#{host_name}':\n  " \
+        "- retrieve group '#{group_name}'...\n    " \
+        "- OK\n  " \
+        "- add association {group:#{group_name} <-> host:#{host_name}}...\n    " \
+        "- OK\n  " \
+        "- remove automatic association {group:ungrouped <-> host:#{host_name}}...\n    " \
+        "- OK\n  " \
+        "- all OK\n" \
         "Succeeded.\n"
       expected(actual, desired)
-      # rubocop:enable Metrics/LineLength
-
       # We should have the correct group associations
       host = @db.models[:host].find(name: host_name)
       groups = host.groups_dataset
@@ -114,14 +94,30 @@ RSpec.describe Moose::Inventory::Cli::Group do
       expect(groups[name: 'ungrouped']).to be_nil # redundant, but for clarity!
     end
 
+    #------------------------
+    it 'group addhost GROUP HOST --dry-run should not create the host or association' do
+      host_name = 'dry-host'
+      group_name = 'testgroup1'
+      runner { @app.start(%W[group add #{group_name}]) }
+
+      actual = runner { @app.start(%W[group addhost #{group_name} #{host_name} --dry-run]) }
+
+      expect(actual[:unexpected]).to eq(false)
+      expect(actual[:aborted]).to eq(false)
+      expect(actual[:STDOUT]).to include('Dry run complete. No changes applied.')
+      expect(@db.models[:host].find(name: host_name)).to be_nil
+      group = @db.models[:group].find(name: group_name)
+      expect(group.hosts_dataset[name: host_name]).to be_nil
+    end
+
     #------------------------
     it '\'ungrouped\' HOST... should abort with an error' do
       host_name = 'test1'
       group_name = 'ungrouped'
 
-      runner { @app.start(%W(host add #{host_name})) }
+      runner { @app.start(%W[host add #{host_name}]) }
 
-      actual = runner { @app.start(%W(group addhost #{group_name} #{host_name})) }
+      actual = runner { @app.start(%W[group addhost #{group_name} #{host_name}]) }
 
       desired = { aborted: true }
       desired[:STDERR] =
@@ -134,23 +130,23 @@ RSpec.describe Moose::Inventory::Cli::Group do
       host_name = 'test1'
       group_name = 'testgroup1'
 
-      runner { @app.start(%W(group add #{group_name})) }
+      runner { @app.start(%W[group add #{group_name}]) }
 
       # DON'T CREATE THE HOST! That's the point of the test. ;o)
 
-      actual = runner { @app.start(%W(group addhost #{group_name} #{host_name})) }
+      actual = runner { @app.start(%W[group addhost #{group_name} #{host_name}]) }
 
       # Check output
       desired = {}
       desired[:STDOUT] =
-        "Associate group '#{group_name}' with host(s) '#{host_name}':\n"\
-        "  - retrieve group '#{group_name}'...\n"\
-        "    - OK\n"\
-        "  - add association {group:#{group_name} <-> host:#{host_name}}...\n"\
-        "    - host does not exist, creating now...\n"\
-        "      - OK\n"\
-        "    - OK\n"\
-        "  - all OK\n"\
+        "Associate group '#{group_name}' with host(s) '#{host_name}':\n  " \
+        "- retrieve group '#{group_name}'...\n    " \
+        "- OK\n  " \
+        "- add association {group:#{group_name} <-> host:#{host_name}}...\n    " \
+        "- host does not exist, creating now...\n      " \
+        "- OK\n    " \
+        "- OK\n  " \
+        "- all OK\n" \
         "Succeeded, with warnings.\n"
       desired[:STDERR] =
         "WARNING: Host '#{host_name}' does not exist and will be created.\n"
@@ -164,32 +160,32 @@ RSpec.describe Moose::Inventory::Cli::Group do
     end
 
     #------------------------
-    it 'GROUP HOST... should skip associations that already '\
-       ' exist, but raise a warning.' do
+    it 'GROUP HOST... should skip associations that already  ' \
+       'exist, but raise a warning.' do
       host_name = 'test1'
       group_name = 'testgroup1'
 
-      runner { @app.start(%W(group add #{group_name})) }
-      runner { @app.start(%W(host add #{host_name})) }
+      runner { @app.start(%W[group add #{group_name}]) }
+      runner { @app.start(%W[host add #{host_name}]) }
 
       # Run once to make the initial association
-      runner { @app.start(%W(group addhost #{group_name} #{host_name})) }
+      runner { @app.start(%W[group addhost #{group_name} #{host_name}]) }
 
       # Run again, to prove expected result
-      actual = runner { @app.start(%W(group addhost #{group_name} #{host_name})) }
+      actual = runner { @app.start(%W[group addhost #{group_name} #{host_name}]) }
 
       # @console.out(actual,'y')
 
       # Check output
       desired = {}
       desired[:STDOUT] =
-        "Associate group '#{group_name}' with host(s) '#{host_name}':\n"\
-        "  - retrieve group \'#{group_name}\'...\n"\
-        "    - OK\n"\
-        "  - add association {group:#{group_name} <-> host:#{host_name}}...\n"\
-        "    - already exists, skipping.\n"\
-        "    - OK\n"\
-        "  - all OK\n"\
+        "Associate group '#{group_name}' with host(s) '#{host_name}':\n  " \
+        "- retrieve group '#{group_name}'...\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: Association {group:#{group_name} <-> host:#{host_name}} already exists, skipping.\n"
@@ -203,38 +199,38 @@ RSpec.describe Moose::Inventory::Cli::Group do
     end
 
     #------------------------
-    it 'GROUP HOST1 HOST2 ... should associate the group with '\
-      ' multiple hosts at once' do
+    it 'GROUP HOST1 HOST2 ... should associate the group with  ' \
+       'multiple hosts at once' do
       group_name = 'test1'
-      host_names = %w(host1 host2 host3)
+      host_names = %w[host1 host2 host3]
 
-      runner { @app.start(%W(group add #{group_name})) }
+      runner { @app.start(%W[group add #{group_name}]) }
       host_names.each do |host|
-        runner { @app.start(%W(host add #{host})) }
+        runner { @app.start(%W[host add #{host}]) }
       end
 
-      actual = runner { @app.start(%W(group addhost #{group_name}) + host_names) }
+      actual = runner { @app.start(%W[group addhost #{group_name}] + host_names) }
 
       # @console.out(actual, 'y')
 
       # Check output
       desired = { aborted: false, STDERR: '' }
       desired[:STDOUT] =
-        "Associate group '#{group_name}' with host(s) '#{host_names.join(',')}':\n"\
-        "  - retrieve group '#{group_name}'...\n"\
-        "    - OK\n"
+        "Associate group '#{group_name}' with host(s) '#{host_names.join(',')}':\n  " \
+        "- retrieve group '#{group_name}'...\n    " \
+        "- OK\n"
       host_names.each do |host|
         desired[:STDOUT] = desired[:STDOUT] +
-                           "  - add association {group:#{group_name} <-> host:#{host}}...\n"\
-                           "    - OK\n"\
-                           "  - remove automatic association {group:ungrouped <-> host:#{host}}...\n"\
-                           "    - OK\n"\
+                           "  - add association {group:#{group_name} <-> host:#{host}}...\n    " \
+                           "- OK\n  " \
+                           "- remove automatic association {group:ungrouped <-> host:#{host}}...\n    " \
+                           "- OK\n" \
 
         # desired[:STDERR] = desired[:STDERR] +
         #  "WARNING: Host '#{host}' does not exist and will be created.\n"
       end
       desired[:STDOUT] = desired[:STDOUT] +
-                         "  - all OK\n"\
+                         "  - all OK\n" \
                          "Succeeded.\n"
       expected(actual, desired)
 
@@ -246,3 +242,4 @@ RSpec.describe Moose::Inventory::Cli::Group do
     end
   end
 end
+# rubocop:enable Metrics/BlockLength