moose-inventory 2.0 → 2.1

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

@@ -1,51 +1,31 @@
+# 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
-
-    @config = Moose::Inventory::Config
-    @config.init(@mockargs)
-    @console = Moose::Inventory::Cli::Formatter
-
-    @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 'get' do
     #---------------------
     it 'Host.get() should be responsive' do
-      result = @host.instance_methods(false).include?(:get)
+      result = @host.method_defined?(:get, false)
       expect(result).to eq(true)
     end
 
     #---------------------
     it 'host get <missing args> ... should abort with an error' do
       # no items in the db
-      name = 'not-in-db'
-      actual = runner { @app.start(%w(host get)) }
+      actual = runner { @app.start(%w[host get]) }
 
       desired = { aborted: true }
       desired[:STDERR] = "ERROR: Wrong number of arguments, 0 for 1 or more\n"
@@ -57,7 +37,7 @@ RSpec.describe Moose::Inventory::Cli::Host do
     it 'host get HOST ... should return an empty set when HOST doesn\'t exist' do
       # no items in the db
       name = 'not-in-db'
-      actual = runner { @app.start(%W(host get #{name})) }
+      actual = runner { @app.start(%W[host get #{name}]) }
 
       desired = {}
       desired[:STDOUT] = {}.to_yaml
@@ -68,9 +48,9 @@ RSpec.describe Moose::Inventory::Cli::Host do
     #---------------------
     it 'host get HOST ... should get a host from the db' 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 get #{name})) }
+      actual = runner { @app.start(%W[host get #{name}]) }
 
       mock = {}
       mock[name.to_sym] = {}
@@ -86,10 +66,10 @@ RSpec.describe Moose::Inventory::Cli::Host do
     it 'host get HOST ... should display hostvars, if any are set' do
       name = 'test-host-add'
       var = 'foo=bar'
-      runner { @app.start(%W(host add #{name})) }
-      runner { @app.start(%W(host addvar #{name} #{var})) }
+      runner { @app.start(%W[host add #{name}]) }
+      runner { @app.start(%W[host addvar #{name} #{var}]) }
 
-      actual = runner { @app.start(%W(host get #{name})) }
+      actual = runner { @app.start(%W[host get #{name}]) }
 
       mock = {}
       mock[name.to_sym] = {}
@@ -103,3 +83,4 @@ RSpec.describe Moose::Inventory::Cli::Host do
     end
   end
 end
+# rubocop:enable Metrics/BlockLength

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

@@ -1,51 +1,31 @@
+# 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
-
-    @config = Moose::Inventory::Config
-    @config.init(@mockargs)
-
-    @db = Moose::Inventory::DB
-    @db.init if @db.db.nil?
-
-    @console = Moose::Inventory::Cli::Formatter
-    @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 'list' do
     #---------------------
     it 'should be responsive' do
-      result = @host.instance_methods(false).include?(:list)
+      result = @host.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
-      name = 'not-in-db'
-      actual = runner { @app.start(%w(host list)) }
+      actual = runner { @app.start(%w[host list]) }
 
       desired = { aborted: false, STDOUT: '', STDERR: '' }
       desired[:STDOUT] = {}.to_yaml
@@ -55,25 +35,53 @@ RSpec.describe Moose::Inventory::Cli::Host do
 
     #---------------------
     it 'should get a list of hosts from the db' do
-      var = 'foo=bar'
-
       mock = {}
-      hosts = %w(host1 host2 host3)
+      hosts = %w[host1 host2 host3]
       hosts.each do |name|
-        runner { @app.start(%W(host add #{name})) }
-        runner { @app.start(%W(host addvar #{name} foo=bar)) }
+        runner { @app.start(%W[host add #{name}]) }
+        runner { @app.start(%W[host addvar #{name} foo=bar]) }
         mock[name.to_sym] = {}
         mock[name.to_sym][:groups] = ['ungrouped']
         mock[name.to_sym][:hostvars] = { foo: 'bar' }
       end
 
       # items should now be in the db
-      actual = runner { @app.start(%w(host list)) }
+      actual = runner { @app.start(%w[host list]) }
 
       desired = { aborted: false, STDOUT: '', STDERR: '' }
       desired[:STDOUT] = mock.to_yaml
 
       expected(actual, desired)
     end
+
+    it 'filters hosts by group, tag, and variable' do
+      runner { @app.start(%w[group add web]) }
+      runner { @app.start(%w[host add web01 --groups web]) }
+      runner { @app.start(%w[host add db01]) }
+      runner { @app.start(%w[host addtag web01 prod]) }
+      runner { @app.start(%w[host addvar web01 os=fedora]) }
+      runner { @app.start(%w[host addtag db01 prod]) }
+      runner { @app.start(%w[host addvar db01 os=debian]) }
+
+      actual = runner { @app.start(%w[host list --group web --tag prod --var os=fedora]) }
+
+      desired = { aborted: false, STDERR: '' }
+      desired[:STDOUT] = {
+        web01: {
+          groups: ['web'],
+          tags: ['prod'],
+          hostvars: { os: 'fedora' }
+        }
+      }.to_yaml
+      expected(actual, desired)
+    end
+
+    it 'aborts on invalid variable filters' do
+      actual = runner { @app.start(%w[host list --var broken]) }
+
+      expect(actual[:aborted]).to eq(true)
+      expect(actual[:STDERR]).to include("ERROR: Invalid variable filter 'broken'. Expected key=value.")
+    end
   end
 end
+# rubocop:enable Metrics/BlockLength

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

@@ -1,53 +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
-
-    @config = Moose::Inventory::Config
-    @config.init(@mockargs)
-
-    @db = Moose::Inventory::DB
-    @db.init if @db.db.nil?
-
-    @console = Moose::Inventory::Cli::Formatter
-    @host = Moose::Inventory::Cli::Host
-    @cli = Moose::Inventory::Cli
-    @app = Moose::Inventory::Cli::Application
+    setup_cli_harness(command_class: Moose::Inventory::Cli::Host, command_ivar: :@host, 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 = @host.instance_methods(false).include?(:listvars)
+      result = @host.method_defined?(:listvars, false)
       expect(result).to eq(true)
     end
 
     #-----------------
     it '<missing args> ... should abort with an error' do
-      actual = runner  { @app.start(%w(host listvars)) }
+      actual = runner  { @app.start(%w[host listvars]) }
 
       # Check output
       desired = { aborted: true }
@@ -58,7 +35,7 @@ RSpec.describe Moose::Inventory::Cli::Host do
     #-----------------
     it '--ansible <missing args> ... should abort with an error' do
       args = @mockargs.clone
-      args.concat(%w(--ansible host listvars)).flatten
+      args.push('--ansible', 'host', 'listvars').flatten
 
       actual = runner { @cli.start(args) }
 
@@ -71,13 +48,13 @@ RSpec.describe Moose::Inventory::Cli::Host do
     #------------------------
     it 'HOST ... should return a list of host variables grouped by host' do
       host_name = 'test_host'
-      host_vars = %w(foo=bar cow=chicken)
+      host_vars = %w[foo=bar cow=chicken]
 
-      tmp = runner {  @app.start(%W(host add #{host_name})) }
-      tmp = runner {  @app.start(%W(host addvar #{host_name} #{host_vars[0]} #{host_vars[1]})) }
+      runner {  @app.start(%W[host add #{host_name}]) }
+      runner {  @app.start(%W[host addvar #{host_name} #{host_vars[0]} #{host_vars[1]}]) }
 
       actual = runner do
-        @app.start(%W(host listvars #{host_name}))
+        @app.start(%W[host listvars #{host_name}])
       end
 
       # @console.out(actual, 'y')
@@ -98,65 +75,80 @@ RSpec.describe Moose::Inventory::Cli::Host do
     #------------------------
     it '--ansible HOST ... should return a list of host variables per Ansible specs' do
       host_name = 'test_host'
-      host_vars = %w(foo=bar cow=chicken)
+      host_vars = %w[foo=bar cow=chicken]
 
-      tmp = runner {  @app.start(%W(host add #{host_name})) }
-      tmp = runner {  @app.start(%W(host addvar #{host_name} #{host_vars[0]} #{host_vars[1]})) }
+      runner {  @app.start(%W[host add #{host_name}]) }
+      runner {  @app.start(%W[host addvar #{host_name} #{host_vars[0]} #{host_vars[1]}]) }
 
       actual = runner do
-        @cli.start(%W(--config #{@mockarg_parts[:config]} --ansible host listvars #{host_name}))
+        @cli.start(%W[--config #{@mockarg_parts[:config]} --ansible host listvars #{host_name}])
       end
 
       # @console.out(actual, 'y')
 
       # Check output
       meta = {}
-      meta['hostvars'.to_sym] = {}
-      meta['hostvars'.to_sym][host_name.to_sym] = {}
+      meta[:hostvars] = {}
+      meta[:hostvars][host_name.to_sym] = {}
 
       mock = {}
       host_vars.each do |hv|
         hv_array = hv.split('=')
         mock[hv_array[0].to_sym] = hv_array[1]
-        meta['hostvars'.to_sym][host_name.to_sym][hv_array[0].to_sym] = hv_array[1]
+        meta[:hostvars][host_name.to_sym][hv_array[0].to_sym] = hv_array[1]
+      end
+      mock[:_meta] = meta
+
+      desired = {}
+      desired[:STDOUT] = "#{mock.to_json}\n"
+      expected(actual, desired)
+    end
+
+    #------------------------
+    it '--ansible HOST ... should warn when the host does not exist' do
+      host_name = 'missing_host'
+
+      actual = runner do
+        @cli.start(%W[--config #{@mockarg_parts[:config]} --ansible host listvars #{host_name}])
       end
-      mock['_meta'.to_sym] = meta
 
       desired = {}
-      desired[:STDOUT] = mock.to_json + "\n"
+      desired[:STDOUT] = "{\"_meta\":{\"hostvars\":{}}}\n"
+      desired[:STDERR] = "WARNING: The host #{host_name} does not exist.\n"
       expected(actual, desired)
     end
 
     #------------------------
     it '--ansible HOST ... should be an alias for Ansible\'s --host HOST' do
       host_name = 'test_host'
-      host_vars = %w(foo=bar cow=chicken)
+      host_vars = %w[foo=bar cow=chicken]
 
-      tmp = runner {  @app.start(%W(host add #{host_name})) }
-      tmp = runner {  @app.start(%W(host addvar #{host_name} #{host_vars[0]} #{host_vars[1]})) }
+      runner {  @app.start(%W[host add #{host_name}]) }
+      runner {  @app.start(%W[host addvar #{host_name} #{host_vars[0]} #{host_vars[1]}]) }
 
       actual = runner do
-        @cli.start(%W(--config #{@mockarg_parts[:config]} --host #{host_name}))
+        @cli.start(%W[--config #{@mockarg_parts[:config]} --host #{host_name}])
       end
 
       # @console.out(actual, 'y')
 
       # Check output
       meta = {}
-      meta['hostvars'.to_sym] = {}
-      meta['hostvars'.to_sym][host_name.to_sym] = {}
+      meta[:hostvars] = {}
+      meta[:hostvars][host_name.to_sym] = {}
 
       mock = {}
       host_vars.each do |hv|
         hv_array = hv.split('=')
         mock[hv_array[0].to_sym] = hv_array[1]
-        meta['hostvars'.to_sym][host_name.to_sym][hv_array[0].to_sym] = hv_array[1]
+        meta[:hostvars][host_name.to_sym][hv_array[0].to_sym] = hv_array[1]
       end
-      mock['_meta'.to_sym] = meta
+      mock[:_meta] = meta
 
       desired = {}
-      desired[:STDOUT] = mock.to_json + "\n"
+      desired[:STDOUT] = "#{mock.to_json}\n"
       expected(actual, desired)
     end
   end
 end
+# rubocop:enable Metrics/BlockLength

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

@@ -1,48 +1,29 @@
+# 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::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
-
-    @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 'rm' do
     #---------------
     it 'Host.rm() should be responsive' do
-      result = @host.instance_methods(false).include?(:rm)
+      result = @host.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: '' }
@@ -59,15 +40,15 @@ RSpec.describe Moose::Inventory::Cli::Host do
 
       # no items in the db
       name = 'fake'
-      actual = runner { @app.start(%W(host rm #{name})) }
+      actual = runner { @app.start(%W[host rm #{name} --yes]) }
 
       desired = {}
       desired[:STDOUT] =
-        "Remove host '#{name}':\n"\
-        "  - Retrieve host '#{name}'...\n"\
-        "    - No such host, skipping.\n"\
-        "    - OK\n"\
-        "  - All OK\n"\
+        "Remove host '#{name}':\n  " \
+        "- Retrieve host '#{name}'...\n    " \
+        "- No such host, skipping.\n    " \
+        "- OK\n  " \
+        "- All OK\n" \
         "Succeeded, with warnings.\n"
       desired[:STDERR] =
         "WARNING: Host '#{name}' does not exist, skipping.\n"
@@ -75,22 +56,39 @@ RSpec.describe Moose::Inventory::Cli::Host do
       expected(actual, desired)
     end
 
+    #---------------
+    it 'HOST without --yes or --dry-run should abort before deleting' do
+      name = 'test1'
+      @db.models[:host].create(name: name)
+
+      actual = runner { @app.start(%W[host rm #{name}]) }
+
+      desired = {
+        aborted: true,
+        STDOUT: '',
+        STDERR: "ERROR: host rm #{name} is destructive. Re-run with --yes to confirm, " \
+                "or use --dry-run to preview.\n"
+      }
+      expected(actual, desired)
+      expect(@db.models[:host].find(name: name)).not_to be_nil
+    end
+
     #---------------
     it 'HOST ... should remove a host' do
       name = 'test1'
       @db.models[:host].create(name: name)
 
-      actual = runner { @app.start(%W(host rm #{name})) }
+      actual = runner { @app.start(%W[host rm #{name} --yes]) }
 
       # Check output
       desired = {}
       desired[:STDOUT] =
-        "Remove host '#{name}':\n"\
-        "  - Retrieve host '#{name}'...\n"\
-        "    - OK\n"\
-        "  - Destroy host '#{name}'...\n"\
-        "    - OK\n"\
-        "  - All OK\n"\
+        "Remove host '#{name}':\n  " \
+        "- Retrieve host '#{name}'...\n    " \
+        "- OK\n  " \
+        "- Destroy host '#{name}'...\n    " \
+        "- OK\n  " \
+        "- All OK\n" \
         "Succeeded.\n"
 
       expected(actual, desired)
@@ -100,28 +98,48 @@ RSpec.describe Moose::Inventory::Cli::Host do
       expect(host).to be_nil
     end
 
+    #---------------
+    it 'HOST --dry-run should show planned removal without deleting the host' do
+      name = 'test1'
+      @db.models[:host].create(name: name)
+
+      actual = runner { @app.start(%W[host rm #{name} --dry-run]) }
+
+      desired = {}
+      desired[:STDOUT] =
+        "Remove host '#{name}':\n  " \
+        "- Retrieve host '#{name}'...\n    " \
+        "- OK\n  " \
+        "- Destroy host '#{name}'...\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)).not_to be_nil
+    end
     #---------------
     it 'HOST1 HOST2 ... should remove multiple hosts' do
-      names = %w(host1 host2 host3)
+      names = %w[host1 host2 host3]
       names.each do |name|
         @db.models[:host].create(name: name)
       end
 
-      actual = runner { @app.start(%w(host rm) + names) }
+      actual = runner { @app.start(%w[host rm --yes] + names) }
 
       # Check output
       desired = { aborted: false, STDERR: '', STDOUT: '' }
       names.each do |name|
         desired[:STDOUT] = desired[:STDOUT] +
-                           "Remove host '#{name}':\n"\
-                           "  - Retrieve host '#{name}'...\n"\
-                           "    - OK\n"\
-                           "  - Destroy host '#{name}'...\n"\
-                           "    - OK\n"\
-                           "  - All OK\n"
+                           "Remove host '#{name}':\n  " \
+                           "- Retrieve host '#{name}'...\n    " \
+                           "- OK\n  " \
+                           "- Destroy host '#{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