moose-inventory 2.0 → 2.1

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

@@ -1,48 +1,29 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/BlockLength
 require 'spec_helper'
 
 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
-
-    @config = Moose::Inventory::Config
-    @config.init(@mockargs)
-
-    @db = Moose::Inventory::DB
-    @db.init if @db.db.nil?
-
-    @console = Moose::Inventory::Cli::Formatter
-    @group = Moose::Inventory::Cli::Group
-    @cli = Moose::Inventory::Cli
-    @app = Moose::Inventory::Cli::Application
+    setup_cli_harness(command_class: Moose::Inventory::Cli::Group, command_ivar: :@group, include_cli: true)
   end
 
   before(:each) do
-    @db.reset
+    reset_cli_harness
   end
 
   #====================
   describe 'list' do
     #---------------------
     it 'should be responsive' do
-      result = @group.instance_methods(false).include?(:list)
+      result = @group.method_defined?(:list, false)
       expect(result).to eq(true)
     end
 
     #---------------------
     it 'should return an empty set when no results' do
       # no items in the db
-      actual = runner { @app.start(%w(group list)) }
+      actual = runner { @app.start(%w[group list]) }
 
       desired = { aborted: false, STDOUT: '', STDERR: '' }
       desired[:STDOUT] = {}.to_yaml
@@ -53,19 +34,18 @@ RSpec.describe Moose::Inventory::Cli::Group do
     #---------------------
     it 'should get a list of group from the db' do
       var = 'foo=bar'
-      host_name = 'test_host'
 
       mock = {}
-      groups = %w(group1 group2 group3)
+      groups = %w[group1 group2 group3]
       groups.each do |name|
-        runner { @app.start(%W(group add #{name})) }
-        runner { @app.start(%W(group addvar #{name} #{var})) }
+        runner { @app.start(%W[group add #{name}]) }
+        runner { @app.start(%W[group addvar #{name} #{var}]) }
         mock[name.to_sym] = {}
         mock[name.to_sym][:groupvars] = { foo: 'bar' }
       end
 
       # items should now be in the db
-      actual = runner { @app.start(%w(group list)) }
+      actual = runner { @app.start(%w[group list]) }
 
       desired = { aborted: false, STDOUT: '', STDERR: '' }
       desired[:STDOUT] = mock.to_yaml
@@ -75,12 +55,10 @@ RSpec.describe Moose::Inventory::Cli::Group do
 
     #---------------------
     it 'should be an alias of --list (i.e. Ansible parameter)' do
-      host_name = 'test_host'
-
       mock = {}
-      groups = %w(group1 group2 group3)
+      groups = %w[group1 group2 group3]
       groups.each do |name|
-        runner { @app.start(%W(group add #{name})) }
+        runner { @app.start(%W[group add #{name}]) }
         mock[name.to_sym] = { hosts: [] }
       end
 
@@ -92,10 +70,10 @@ RSpec.describe Moose::Inventory::Cli::Group do
       # @console.out(actual, 'y')
 
       desired = { aborted: false, STDOUT: '', STDERR: '' }
-      desired[:STDOUT] = mock.to_json + "\n"
+      desired[:STDOUT] = "#{mock.to_json}\n"
 
       expected(actual, desired)
     end
-    end
   end
-
+end
+# rubocop:enable Metrics/BlockLength

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

@@ -1,50 +1,28 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/BlockLength
 require 'spec_helper'
 
 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
-
-    @config = Moose::Inventory::Config
-    @config.init(@mockargs)
-
-    @db = Moose::Inventory::DB
-    @db.init if @db.db.nil?
-
-    @console = Moose::Inventory::Cli::Formatter
-    @group = Moose::Inventory::Cli::Group
-    @cli = Moose::Inventory::Cli
-    @app = Moose::Inventory::Cli::Application
+    setup_cli_harness(command_class: Moose::Inventory::Cli::Group, command_ivar: :@group, include_cli: true)
   end
 
   before(:each) do
-    # We make some @cli calls, which changes config,
-    # so we must reset config on each pass
-    @config.init(@mockargs)
-    @db.reset
+    reset_cli_harness(reset_config: true)
   end
 
   #==================
   describe 'listvar' do
     #-----------------
     it 'should be responsive' do
-      result = @group.instance_methods(false).include?(:listvars)
+      result = @group.method_defined?(:listvars, false)
       expect(result).to eq(true)
     end
 
     #-----------------
     it '<missing args> ... should abort with an error' do
-      actual = runner  { @app.start(%w(group listvars)) }
+      actual = runner  { @app.start(%w[group listvars]) }
 
       # Check output
       desired = { aborted: true }
@@ -55,7 +33,7 @@ RSpec.describe Moose::Inventory::Cli::Group do
     #-----------------
     it '--ansible <missing args> ... should abort with an error' do
       args = @mockargs.clone
-      args.concat(%w(--ansible group listvars)).flatten
+      args.push('--ansible', 'group', 'listvars').flatten
 
       actual = runner { @cli.start(args) }
 
@@ -68,13 +46,13 @@ RSpec.describe Moose::Inventory::Cli::Group do
     #------------------------
     it 'GROUP ... should return a list of group variables grouped by group' do
       group_name = 'test_group'
-      group_vars = %w(foo=bar cow=chicken)
+      group_vars = %w[foo=bar cow=chicken]
 
-      tmp = runner {  @app.start(%W(group add #{group_name})) }
-      tmp = runner {  @app.start(%W(group addvar #{group_name} #{group_vars[0]} #{group_vars[1]})) }
+      runner {  @app.start(%W[group add #{group_name}]) }
+      runner {  @app.start(%W[group addvar #{group_name} #{group_vars[0]} #{group_vars[1]}]) }
 
       actual = runner do
-        @app.start(%W(group listvars #{group_name}))
+        @app.start(%W[group listvars #{group_name}])
       end
 
       # @console.out(actual, 'y')
@@ -93,15 +71,15 @@ RSpec.describe Moose::Inventory::Cli::Group do
     end
 
     #------------------------
-    it '--ansible GROUP ... should return a list of group variables, in a  style akin to Ansible\'s \'--host HOSTNAME\'' do
+    it 'returns group variables in an Ansible-style hostvars payload' do
       group_name = 'test_group'
-      group_vars = %w(foo=bar cow=chicken)
+      group_vars = %w[foo=bar cow=chicken]
 
-      tmp = runner {  @app.start(%W(group add #{group_name})) }
-      tmp = runner {  @app.start(%W(group addvar #{group_name} #{group_vars[0]} #{group_vars[1]})) }
+      runner {  @app.start(%W[group add #{group_name}]) }
+      runner {  @app.start(%W[group addvar #{group_name} #{group_vars[0]} #{group_vars[1]}]) }
 
       actual = runner do
-        @cli.start(%W(--config #{@mockarg_parts[:config]} --ansible group listvars #{group_name}))
+        @cli.start(%W[--config #{@mockarg_parts[:config]} --ansible group listvars #{group_name}])
       end
 
       # @console.out(actual, 'y')
@@ -114,8 +92,23 @@ RSpec.describe Moose::Inventory::Cli::Group do
       end
 
       desired = {}
-      desired[:STDOUT] = mock.to_json + "\n"
+      desired[:STDOUT] = "#{mock.to_json}\n"
+      expected(actual, desired)
+    end
+
+    #------------------------
+    it 'warns when an Ansible-mode group does not exist' do
+      group_name = 'missing_group'
+
+      actual = runner do
+        @cli.start(%W[--config #{@mockarg_parts[:config]} --ansible group listvars #{group_name}])
+      end
+
+      desired = {}
+      desired[:STDOUT] = "{}\n"
+      desired[:STDERR] = "WARNING: The Group #{group_name} does not exist."
       expected(actual, desired)
     end
   end
 end
+# rubocop:enable Metrics/BlockLength

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

@@ -1,51 +1,34 @@
+# 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
-
-    @config = Moose::Inventory::Config
-    @config.init(@mockargs)
-
-    @console = Moose::Inventory::Cli::Formatter
-
-    @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 'rm' do
     #---------------
     it 'Group.rm() should be responsive' do
-      result = @group.instance_methods(false).include?(:rm)
+      result = @group.method_defined?(:rm, false)
       expect(result).to eq(true)
     end
 
     #---------------
     it '<missing argument> ... should abort with an error' do
-      actual = runner { @app.start(%w(host rm)) }
+      actual = runner { @app.start(%w[host rm]) }
 
       # Check output
       desired = { aborted: true, STDERR: '', STDOUT: '' }
@@ -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 rm ungrouped)) }
+      actual = runner { @app.start(%w[group rm ungrouped]) }
 
       # Check output
       desired = { aborted: true }
@@ -73,16 +56,16 @@ RSpec.describe Moose::Inventory::Cli::Group do
 
       # no items in the db
       group_name = 'fake'
-      actual = runner { @app.start(%W(group rm #{group_name})) }
+      actual = runner { @app.start(%W[group rm #{group_name} --yes]) }
 
       # @console.out(actual,'y')
       desired = {}
       desired[:STDOUT] =
-        "Remove group '#{group_name}':\n"\
-        "  - Retrieve group '#{group_name}'...\n"\
-        "    - No such group, skipping.\n"\
-        "    - OK\n"\
-        "  - All OK\n"\
+        "Remove group '#{group_name}':\n  " \
+        "- Retrieve group '#{group_name}'...\n    " \
+        "- No such group, skipping.\n    " \
+        "- OK\n  " \
+        "- All OK\n" \
         "Succeeded, with warnings.\n"
       desired[:STDERR] =
         "WARNING: Group '#{group_name}' does not exist, skipping.\n"
@@ -95,17 +78,17 @@ RSpec.describe Moose::Inventory::Cli::Group do
       group_name = 'test1'
       @db.models[:group].create(name: group_name)
 
-      actual = runner { @app.start(%W(group rm #{group_name})) }
+      actual = runner { @app.start(%W[group rm #{group_name} --yes]) }
 
       # Check output
       desired = {}
       desired[:STDOUT] =
-        "Remove group '#{group_name}':\n"\
-        "  - Retrieve group '#{group_name}'...\n"\
-        "    - OK\n"\
-        "  - Destroy group '#{group_name}'...\n"\
-        "    - OK\n"\
-        "  - All OK\n"\
+        "Remove group '#{group_name}':\n  " \
+        "- Retrieve group '#{group_name}'...\n    " \
+        "- OK\n  " \
+        "- Destroy group '#{group_name}'...\n    " \
+        "- OK\n  " \
+        "- All OK\n" \
         "Succeeded.\n"
       expected(actual, desired)
 
@@ -114,12 +97,68 @@ RSpec.describe Moose::Inventory::Cli::Group do
       expect(group).to be_nil
     end
 
+    #---------------
+    it 'GROUP without --yes or --dry-run should abort before deleting' do
+      group_name = 'group1'
+      @db.models[:group].create(name: group_name)
+
+      actual = runner { @app.start(%W[group rm #{group_name}]) }
+
+      desired = {
+        aborted: true,
+        STDOUT: '',
+        STDERR: "ERROR: group rm #{group_name} is destructive. Re-run with --yes to confirm, " \
+                "or use --dry-run to preview.\n"
+      }
+      expected(actual, desired)
+      expect(@db.models[:group].find(name: group_name)).not_to be_nil
+    end
+
+    #---------------
+    it 'GROUP --dry-run should show planned removal without deleting the group' do
+      group_name = 'test1'
+      @db.models[:group].create(name: group_name)
+
+      actual = runner { @app.start(%W[group rm #{group_name} --dry-run]) }
+
+      desired = {}
+      desired[:STDOUT] =
+        "Remove group '#{group_name}':\n  " \
+        "- Retrieve group '#{group_name}'...\n    " \
+        "- OK\n  " \
+        "- Destroy group '#{group_name}'...\n    " \
+        "- OK\n  " \
+        "- All OK\n" \
+        "Dry run complete. No changes applied.\n" \
+        "Succeeded.\n"
+
+      expected(actual, desired)
+      expect(@db.models[:group].find(name: group_name)).not_to be_nil
+    end
+
+    #---------------
+    it 'GROUP --recursive --dry-run should show recursive cleanup without deleting groups' do
+      runner { @app.start(%w[group add parent]) }
+      runner { @app.start(%w[group add child --hosts child-host]) }
+      runner { @app.start(%w[group addchild parent child]) }
+
+      actual = runner { @app.start(%w[group rm --recursive parent --dry-run]) }
+
+      expect(actual[:unexpected]).to eq(false)
+      expect(actual[:aborted]).to eq(false)
+      expect(actual[:STDOUT]).to include("- Recursively delete orphaned group 'child'...\n")
+      expect(actual[:STDOUT]).to include('Dry run complete. No changes applied.')
+      expect(@db.models[:group].find(name: 'parent')).not_to be_nil
+      expect(@db.models[:group].find(name: 'child')).not_to be_nil
+      host = @db.models[:host].find(name: 'child-host')
+      expect(host.groups_dataset[name: 'ungrouped']).to be_nil
+    end
     #---------------
     it "GROUP ... should handle the automatic 'ungrouped' group for associated hosts" do
       host_name = 'test-host1'
       group_name = 'test-group1'
 
-      tmp = runner { @app.start(%W(group add #{group_name} --hosts #{host_name})) }
+      tmp = runner { @app.start(%W[group add #{group_name} --hosts #{host_name}]) }
       expect(tmp[:unexpected]).to eq(false)
       expect(tmp[:aborted]).to eq(false)
       host = @db.models[:host].find(name: host_name)
@@ -128,21 +167,21 @@ RSpec.describe Moose::Inventory::Cli::Group do
       expect(groups_ds[name: 'ungrouped']).to be_nil # Shouldn't be ungrouped
 
       # Now do the rm
-      actual = runner { @app.start(%W(group rm #{group_name})) }
+      actual = runner { @app.start(%W[group rm #{group_name} --yes]) }
 
       # @console.out(actual)
 
       # Check output
       desired = {}
       desired[:STDOUT] =
-        "Remove group '#{group_name}':\n"\
-        "  - Retrieve group '#{group_name}'...\n"\
-        "    - OK\n"\
-        "  - Adding automatic association {group:ungrouped <-> host:#{host_name}}...\n"\
-        "    - OK\n"\
-        "  - Destroy group '#{group_name}'...\n"\
-        "    - OK\n"\
-        "  - All OK\n"\
+        "Remove group '#{group_name}':\n  " \
+        "- Retrieve group '#{group_name}'...\n    " \
+        "- OK\n  " \
+        "- Adding automatic association {group:ungrouped <-> host:#{host_name}}...\n    " \
+        "- OK\n  " \
+        "- Destroy group '#{group_name}'...\n    " \
+        "- OK\n  " \
+        "- All OK\n" \
         "Succeeded.\n"
       expected(actual, desired)
 
@@ -159,26 +198,26 @@ RSpec.describe Moose::Inventory::Cli::Group do
 
     #---------------
     it 'GROUP1 GROUP2 ... should remove multiple groups' do
-      names = %w(group1 group2 group3)
+      names = %w[group1 group2 group3]
       names.each do |name|
         @db.models[:group].create(name: name)
       end
 
-      actual = runner { @app.start(%w(group rm) + names) }
+      actual = runner { @app.start(%w[group rm --yes] + names) }
 
       # Check output
       desired = { STDOUT: '' }
       names.each do |name|
         # Check output
         desired[:STDOUT] = desired[:STDOUT] +
-                           "Remove group '#{name}':\n"\
-                           "  - Retrieve group '#{name}'...\n"\
-                           "    - OK\n"\
-                           "  - Destroy group '#{name}'...\n"\
-                           "    - OK\n"\
-                           "  - All OK\n"
+                           "Remove group '#{name}':\n  " \
+                           "- Retrieve group '#{name}'...\n    " \
+                           "- OK\n  " \
+                           "- Destroy group '#{name}'...\n    " \
+                           "- OK\n  " \
+                           "- All OK\n"
       end
-      desired[:STDOUT] = desired[:STDOUT] + "Succeeded.\n"
+      desired[:STDOUT] = "#{desired[:STDOUT]}Succeeded.\n"
       expected(actual, desired)
 
       # Check db
@@ -189,24 +228,24 @@ RSpec.describe Moose::Inventory::Cli::Group do
     #---------------
     it 'GROUP ... should remove GROUP, where GROUP has an associated parent.' do
       @db.models[:group].create(name: 'parent')
-      runner { @app.start(%w(group addchild parent child)) }
+      runner { @app.start(%w[group addchild parent child]) }
 
-      actual = runner { @app.start(%w(group rm child)) }
+      actual = runner { @app.start(%w[group rm child --yes]) }
 
       # Check output
       desired = { STDOUT: '' }
       # Check output
       desired[:STDOUT] = desired[:STDOUT] +
-                         "Remove group 'child':\n"\
-                         "  - Retrieve group 'child'...\n"\
-                         "    - OK\n"\
-                         "  - Remove association {group:child <-> group:parent}...\n"\
-                         "    - OK\n"\
-                         "  - Destroy group 'child'...\n"\
-                         "    - OK\n"\
-                         "  - All OK\n"
-
-      desired[:STDOUT] = desired[:STDOUT] + "Succeeded.\n"
+                         "Remove group 'child':\n  " \
+                         "- Retrieve group 'child'...\n    " \
+                         "- OK\n  " \
+                         "- Remove association {group:child <-> group:parent}...\n    " \
+                         "- OK\n  " \
+                         "- Destroy group 'child'...\n    " \
+                         "- OK\n  " \
+                         "- All OK\n"
+
+      desired[:STDOUT] = "#{desired[:STDOUT]}Succeeded.\n"
       expected(actual, desired)
 
       # Check db
@@ -217,24 +256,24 @@ RSpec.describe Moose::Inventory::Cli::Group do
     #---------------
     it 'GROUP ... should remove GROUP, where GROUP has an associated child.' do
       @db.models[:group].create(name: 'parent')
-      runner { @app.start(%w(group addchild parent child)) }
+      runner { @app.start(%w[group addchild parent child]) }
 
-      actual = runner { @app.start(%w(group rm parent)) }
+      actual = runner { @app.start(%w[group rm parent --yes]) }
 
       # Check output
       desired = { STDOUT: '' }
       # Check output
       desired[:STDOUT] = desired[:STDOUT] +
-                         "Remove group 'parent':\n"\
-                         "  - Retrieve group 'parent'...\n"\
-                         "    - OK\n"\
-                         "  - Remove association {group:parent <-> group:child}...\n"\
-                         "    - OK\n"\
-                         "  - Destroy group 'parent'...\n"\
-                         "    - OK\n"\
-                         "  - All OK\n"
-
-      desired[:STDOUT] = desired[:STDOUT] + "Succeeded.\n"
+                         "Remove group 'parent':\n  " \
+                         "- Retrieve group 'parent'...\n    " \
+                         "- OK\n  " \
+                         "- Remove association {group:parent <-> group:child}...\n    " \
+                         "- OK\n  " \
+                         "- Destroy group 'parent'...\n    " \
+                         "- OK\n  " \
+                         "- All OK\n"
+
+      desired[:STDOUT] = "#{desired[:STDOUT]}Succeeded.\n"
       expected(actual, desired)
 
       # Check db
@@ -244,20 +283,20 @@ RSpec.describe Moose::Inventory::Cli::Group do
 
     #---------------
     it 'GROUP --recursive ... should remove orphaned child groups recursively' do
-      runner { @app.start(%w(group add parent)) }
-      runner { @app.start(%w(group add child --hosts child-host)) }
-      runner { @app.start(%w(group add grandchild)) }
-      runner { @app.start(%w(group addchild parent child)) }
-      runner { @app.start(%w(group addchild child grandchild)) }
+      runner { @app.start(%w[group add parent]) }
+      runner { @app.start(%w[group add child --hosts child-host]) }
+      runner { @app.start(%w[group add grandchild]) }
+      runner { @app.start(%w[group addchild parent child]) }
+      runner { @app.start(%w[group addchild child grandchild]) }
 
-      actual = runner { @app.start(%w(group rm --recursive parent)) }
+      actual = runner { @app.start(%w[group rm --recursive parent --yes]) }
 
       expect(actual[:unexpected]).to eq(false)
       expect(actual[:aborted]).to eq(false)
       expect(actual[:STDOUT]).to include("- Recursively delete orphaned group 'child'...\n")
       expect(actual[:STDOUT]).to include("- Recursively delete orphaned group 'grandchild'...\n")
 
-      %w(parent child grandchild).each do |name|
+      %w[parent child grandchild].each do |name|
         expect(@db.models[:group].find(name: name)).to be_nil
       end
 
@@ -267,11 +306,11 @@ RSpec.describe Moose::Inventory::Cli::Group do
 
     #---------------
     it 'GROUP --recursive ... should not remove child groups with another parent' do
-      runner { @app.start(%w(group add parent other-parent)) }
-      runner { @app.start(%w(group addchild parent child)) }
-      runner { @app.start(%w(group addchild other-parent child)) }
+      runner { @app.start(%w[group add parent other-parent]) }
+      runner { @app.start(%w[group addchild parent child]) }
+      runner { @app.start(%w[group addchild other-parent child]) }
 
-      actual = runner { @app.start(%w(group rm --recursive parent)) }
+      actual = runner { @app.start(%w[group rm --recursive parent --yes]) }
 
       expect(actual[:unexpected]).to eq(false)
       expect(actual[:aborted]).to eq(false)
@@ -283,3 +322,4 @@ RSpec.describe Moose::Inventory::Cli::Group do
     end
   end
 end
+# rubocop:enable Metrics/BlockLength