moose-inventory 1.0.9 → 2.1

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

@@ -1,50 +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::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
-    @app = Moose::Inventory::Cli::Application
+    setup_cli_harness(command_class: Moose::Inventory::Cli::Group, command_ivar: :@group)
   end
 
   before(:each) do
-    @db.reset
+    reset_cli_harness
   end
 
   #==================
   describe 'addvar' do
     #-----------------
     it 'should be responsive' do
-      result = @group.instance_methods(false).include?(:addvar)
+      result = @group.method_defined?(:addvar, false)
       expect(result).to eq(true)
     end
 
     #-----------------
     it '<missing args> ... should abort with an error' do
       actual = runner  do
-        @app.start(%w(group addvar)) # <- no group given
+        @app.start(%w[group addvar]) # <- no group given
       end
       # @console.out(actual, 'y')
 
@@ -60,16 +41,16 @@ RSpec.describe Moose::Inventory::Cli::Group do
       group_var = 'foo=bar'
 
       actual = runner do
-        @app.start(%W(group addvar #{group_name} #{group_var}))
+        @app.start(%W[group addvar #{group_name} #{group_var}])
       end
 
       # Check output
       desired = { aborted: true }
       desired[:STDOUT] =
-        "Add variables '#{group_var}' to group '#{group_name}':\n"\
-        "  - retrieve group '#{group_name}'...\n"
+        "Add variables '#{group_var}' to group '#{group_name}':\n  " \
+        "- retrieve group '#{group_name}'...\n"
       desired[:STDERR] =
-        "An error occurred during a transaction, any changes have been rolled back.\n"\
+        "An error occurred during a transaction, any changes have been rolled back.\n" \
         "ERROR: The group '#{group_name}' does not exist.\n"
       expected(actual, desired)
     end
@@ -81,32 +62,30 @@ RSpec.describe Moose::Inventory::Cli::Group do
 
       group_name = 'test_group'
       @db.models[:group].create(name: group_name)
-
-      var = { name: 'var1', value: 'testval' }
-      cases = %w(
+      cases = %w[
         testvar
         testvar=
         =testval
         testvar=testval=
         =testvar=testval
         testvar=testval=extra
-      )
+      ]
 
       cases.each do |args|
         actual = runner do
-          @app.start(%W(group addvar #{group_name} #{args}))
+          @app.start(%W[group addvar #{group_name} #{args}])
         end
         # @console.out(actual,'p')
 
         desired = { aborted: true }
         desired[:STDOUT] =
-          "Add variables '#{args}' to group '#{group_name}':\n"\
-          "  - retrieve group '#{group_name}'...\n"\
-          "    - OK\n"\
-          "  - add variable '#{args}'...\n"
+          "Add variables '#{args}' to group '#{group_name}':\n  " \
+          "- retrieve group '#{group_name}'...\n    " \
+          "- OK\n  " \
+          "- add variable '#{args}'...\n"
 
         desired[:STDERR] =
-          "An error occurred during a transaction, any changes have been rolled back.\n"\
+          "An error occurred during a transaction, any changes have been rolled back.\n" \
           "ERROR: Incorrect format in '{#{args}}'. Expected 'key=value'.\n"
 
         expected(actual, desired)
@@ -124,18 +103,18 @@ RSpec.describe Moose::Inventory::Cli::Group do
       @db.models[:group].create(name: group_name)
 
       actual = runner do
-        @app.start(%W(group addvar #{group_name} #{var[:name]}=#{var[:value]}))
+        @app.start(%W[group addvar #{group_name} #{var[:name]}=#{var[:value]}])
       end
       # @console.out(actual,'p')
 
       desired = { aborted: false }
       desired[:STDOUT] =
-        "Add variables '#{var[:name]}=#{var[:value]}' to group '#{group_name}':\n"\
-        "  - retrieve group '#{group_name}'...\n"\
-        "    - OK\n"\
-        "  - add variable '#{var[:name]}=#{var[:value]}'...\n"\
-        "    - OK\n"\
-        "  - all OK\n"\
+        "Add variables '#{var[:name]}=#{var[:value]}' to group '#{group_name}':\n  " \
+        "- retrieve group '#{group_name}'...\n    " \
+        "- OK\n  " \
+        "- add variable '#{var[:name]}=#{var[:value]}'...\n    " \
+        "- OK\n  " \
+        "- all OK\n" \
         "Succeeded.\n"
       expected(actual, desired)
 
@@ -155,43 +134,60 @@ RSpec.describe Moose::Inventory::Cli::Group do
       group_name = 'test1'
       varsarray  = [
         { name: 'var1', value: 'val1' },
-        { name: 'var2', value: 'val2' },
+        { name: 'var2', value: 'val2' }
       ]
 
-      vars = []
-      varsarray.each do |var|
-        vars << "#{var[:name]}=#{var[:value]}"
+      vars = varsarray.map do |var|
+        "#{var[:name]}=#{var[:value]}"
       end
 
       @db.models[:group].create(name: group_name)
 
       actual = runner do
-        @app.start(%W(group addvar #{group_name}) + vars)
+        @app.start(%W[group addvar #{group_name}] + vars)
       end
 
       # @console.out(actual,'y')
 
       desired = { aborted: false }
       desired[:STDOUT] =
-        "Add variables '#{vars.join(',')}' to group '#{group_name}':\n"\
-        "  - retrieve group '#{group_name}'...\n"\
-        "    - OK\n"
+        "Add variables '#{vars.join(',')}' to group '#{group_name}':\n  " \
+        "- retrieve group '#{group_name}'...\n    " \
+        "- OK\n"
       vars.each do |var|
         desired[:STDOUT] =  desired[:STDOUT] +
-                            "  - add variable '#{var}'...\n"\
-                            "    - OK\n"
+                            "  - add variable '#{var}'...\n    " \
+                            "- OK\n"
       end
       desired[:STDOUT] = desired[:STDOUT] +
-                         "  - all OK\n"\
+                         "  - all OK\n" \
                          "Succeeded.\n"
       expected(actual, desired)
 
       # We should have the correct hostvar associations
       group = @db.models[:group].find(name: group_name)
-      groupvars = group.groupvars_dataset
+      group.groupvars_dataset
       expect(vars.count).to eq(vars.length)
     end
 
+    #------------------------
+    it 'GROUP key=value --dry-run should not create or update variables' do
+      group_name = 'test1'
+      @db.models[:group].create(name: group_name)
+      runner { @app.start(%W[group addvar #{group_name} var1=old]) }
+
+      actual = runner do
+        @app.start(%W[group addvar #{group_name} var1=new var2=val2 --dry-run])
+      end
+
+      expect(actual[:unexpected]).to eq(false)
+      expect(actual[:aborted]).to eq(false)
+      expect(actual[:STDOUT]).to include('Dry run complete. No changes applied.')
+      group = @db.models[:group].find(name: group_name)
+      expect(group.groupvars_dataset[name: 'var1'][:value]).to eq('old')
+      expect(group.groupvars_dataset[name: 'var2']).to be_nil
+    end
+
     #------------------------
     it 'GROUP key=value ... should update an already existing association' do
       # 1. Should add the var to the db
@@ -201,23 +197,23 @@ RSpec.describe Moose::Inventory::Cli::Group do
       var = { name: 'var1', value: 'testval' }
 
       @db.models[:group].create(name: group_name)
-      runner { @app.start(%W(group addvar #{group_name} #{var[:name]}=#{var[:value]})) }
+      runner { @app.start(%W[group addvar #{group_name} #{var[:name]}=#{var[:value]}]) }
 
       var[:value] = 'newtestval'
       actual = runner do
-        @app.start(%W(group addvar #{group_name} #{var[:name]}=#{var[:value]}))
+        @app.start(%W[group addvar #{group_name} #{var[:name]}=#{var[:value]}])
       end
       # @console.out(actual,'y')
 
       desired = { aborted: false }
       desired[:STDOUT] =
-        "Add variables '#{var[:name]}=#{var[:value]}' to group '#{group_name}':\n"\
-        "  - retrieve group '#{group_name}'...\n"\
-        "    - OK\n"\
-        "  - add variable '#{var[:name]}=#{var[:value]}'...\n"\
-        "    - already exists, applying as an update...\n"\
-        "    - OK\n"\
-        "  - all OK\n"\
+        "Add variables '#{var[:name]}=#{var[:value]}' to group '#{group_name}':\n  " \
+        "- retrieve group '#{group_name}'...\n    " \
+        "- OK\n  " \
+        "- add variable '#{var[:name]}=#{var[:value]}'...\n    " \
+        "- already exists, applying as an update...\n    " \
+        "- OK\n  " \
+        "- all OK\n" \
         "Succeeded.\n"
       expected(actual, desired)
 
@@ -233,3 +229,4 @@ RSpec.describe Moose::Inventory::Cli::Group do
     end
   end
 end
+# rubocop:enable Metrics/BlockLength

data/spec/lib/moose_inventory/cli/group_get_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::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
-    @app = Moose::Inventory::Cli::Application
+    setup_cli_harness(command_class: Moose::Inventory::Cli::Group, command_ivar: :@group)
   end
 
   before(:each) do
-    @db.reset
+    reset_cli_harness
   end
 
   #=======================
   describe 'get' do
     #---------------------
     it 'should be responsive' do
-      result = @group.instance_methods(false).include?(:get)
+      result = @group.method_defined?(:get, false)
       expect(result).to eq(true)
     end
 
     #---------------------
     it '<missing args> ... should abort with an error' do
-      actual = runner { @app.start(%w(group get)) }
+      actual = runner { @app.start(%w[group get]) }
 
       # @console.out(actual,'y')
 
@@ -56,7 +37,7 @@ RSpec.describe Moose::Inventory::Cli::Group do
     #---------------------
     it "GROUP ... should return an empty set when GROUP doesn't exist" do
       group_name = 'does-not-exist'
-      actual = runner { @app.start(%W(group get #{group_name})) }
+      actual = runner { @app.start(%W[group get #{group_name}]) }
 
       # @console.out(actual, 'y')
 
@@ -69,13 +50,15 @@ RSpec.describe Moose::Inventory::Cli::Group do
     #---------------------
     it 'GROUP ... should get a group from the db' do
       name = 'test_group'
-      runner { @app.start(%W(group add #{name})) }
+      runner { @app.start(%W[group add #{name}]) }
 
-      actual = runner { @app.start(%W(group get #{name})) }
+      actual = runner { @app.start(%W[group get #{name}]) }
 
       mock = {}
       mock[name.to_sym] = {}
-      # mock[name.to_sym][:hosts] = [] # TODO: Should this be present or not?
+      # Contract: `group get` omits empty relationship collections in the default
+      # human/data output. `group list --ansible` keeps `hosts: []` because
+      # Ansible inventory consumers expect the key to exist.
 
       desired = { aborted: false, STDOUT: '', STDERR: '' }
       desired[:STDOUT] = mock.to_yaml
@@ -87,10 +70,10 @@ RSpec.describe Moose::Inventory::Cli::Group do
     it 'GROUP ... should display groupvars, if any are set' do
       name = 'test_group'
       var = 'foo=bar'
-      tmp = runner { @app.start(%W(group add #{name})) }
-      tmp = runner { @app.start(%W(group addvar #{name} #{var})) }
+      runner { @app.start(%W[group add #{name}]) }
+      runner { @app.start(%W[group addvar #{name} #{var}]) }
 
-      actual = runner { @app.start(%W(group get #{name})) }
+      actual = runner { @app.start(%W[group get #{name}]) }
       # @console.out(actual, 'y')
 
       mock = {}
@@ -104,3 +87,4 @@ RSpec.describe Moose::Inventory::Cli::Group do
     end
   end
 end
+# rubocop:enable Metrics/BlockLength

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