moose-inventory 2.0 → 2.1

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

@@ -1,49 +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?
-
-    @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 'addgroup' do
     #------------------------
     it 'Host.addgroup() should be responsive' do
-      result = @host.instance_methods(false).include?(:addgroup)
+      result = @host.method_defined?(:addgroup, false)
       expect(result).to eq(true)
     end
 
     #------------------------
     it 'host addgroup <missing args> ... should abort with an error' do
       actual = runner do
-        @app.start(%w(host addgroup)) # <- no group given
+        @app.start(%w[host addgroup]) # <- no group given
       end
 
       # Check output
@@ -55,16 +37,16 @@ RSpec.describe Moose::Inventory::Cli::Host do
     #------------------------
     it 'host addgroup HOST GROUP ... should abort if the host does not exist' do
       actual = runner do
-        @app.start(%w(host addgroup not-a-host example))
+        @app.start(%w[host addgroup not-a-host example])
       end
 
       # Check output
       desired = { aborted: true }
       desired[:STDOUT] =
-        "Associate host 'not-a-host' with groups 'example':\n"\
-        "  - Retrieve host 'not-a-host'...\n"
+        "Associate host 'not-a-host' with groups 'example':\n  " \
+        "- Retrieve host 'not-a-host'...\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 host 'not-a-host' was not found in the database.\n"
       expected(actual, desired)
     end
@@ -77,26 +59,23 @@ RSpec.describe Moose::Inventory::Cli::Host do
       name = 'test1'
       group_name = 'testgroup1'
 
-      runner { @app.start(%W(host add #{name})) }
+      runner { @app.start(%W[host add #{name}]) }
       @db.models[:group].create(name: group_name)
 
-      actual = runner { @app.start(%W(host addgroup #{name} #{group_name})) }
+      actual = runner { @app.start(%W[host addgroup #{name} #{group_name}]) }
 
-      # rubocop:disable Metrics/LineLength
       desired = { aborted: false }
       desired[:STDOUT] =
-        "Associate host '#{name}' with groups '#{group_name}':\n"\
-        "  - Retrieve host '#{name}'...\n"\
-        "    - OK\n"\
-        "  - Add association {host:#{name} <-> group:#{group_name}}...\n"\
-        "    - OK\n"\
-        "  - Remove automatic association {host:#{name} <-> group:ungrouped}...\n"\
-        "    - OK\n"\
-        "  - All OK\n"\
+        "Associate host '#{name}' with groups '#{group_name}':\n  " \
+        "- Retrieve host '#{name}'...\n    " \
+        "- OK\n  " \
+        "- Add association {host:#{name} <-> group:#{group_name}}...\n    " \
+        "- OK\n  " \
+        "- Remove automatic association {host:#{name} <-> group:ungrouped}...\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: name)
       groups = host.groups_dataset
@@ -105,14 +84,51 @@ RSpec.describe Moose::Inventory::Cli::Host do
       expect(groups[name: 'ungrouped']).to be_nil # redundant, but for clarity!
     end
 
+    #------------------------
+    it 'host addgroup HOST GROUP --dry-run should not create the group or change membership' do
+      name = 'test1'
+      group_name = 'drygroup'
+      runner { @app.start(%W[host add #{name}]) }
+
+      actual = runner { @app.start(%W[host addgroup #{name} #{group_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[:group].find(name: group_name)).to be_nil
+      host = @db.models[:host].find(name: name)
+      expect(host.groups_dataset[name: 'ungrouped']).not_to be_nil
+    end
+
+    #------------------------
+    it 'host addgroup HOST GROUP --dry-run --plan-format json should emit a pure relation plan' do
+      name = 'test1'
+      group_name = 'drygroup'
+      runner { @app.start(%W[host add #{name}]) }
+
+      actual = runner { @app.start(%W[host addgroup #{name} #{group_name} --dry-run --plan-format json]) }
+
+      expect(actual[:unexpected]).to eq(false)
+      expect(actual[:aborted]).to eq(false)
+      expect(actual[:STDOUT]).not_to include('Associate host')
+      plan = JSON.parse(actual[:STDOUT])
+      expect(plan['command']).to eq('host addgroup')
+      expect(plan['events'].map do |event|
+        event['type']
+      end).to include('adding_host_group_association', 'dry_run_summary')
+      expect(@db.models[:group].find(name: group_name)).to be_nil
+      host = @db.models[:host].find(name: name)
+      expect(host.groups_dataset[name: 'ungrouped']).not_to be_nil
+    end
+
     #------------------------
     it 'HOST \'ungrouped\' ... should abort with an error' do
       name = 'test1'
       group_name = 'ungrouped'
 
-      runner { @app.start(%W(host add #{name})) }
+      runner { @app.start(%W[host add #{name}]) }
 
-      actual = runner { @app.start(%W(host addgroup #{name} #{group_name})) }
+      actual = runner { @app.start(%W[host addgroup #{name} #{group_name}]) }
 
       desired = { aborted: true }
       desired[:STDERR] =
@@ -125,25 +141,25 @@ RSpec.describe Moose::Inventory::Cli::Host do
       name = 'test1'
       group_name = 'testgroup1'
 
-      runner { @app.start(%W(host add #{name})) }
+      runner { @app.start(%W[host add #{name}]) }
 
       # DON'T CREATE THE GROUP! That's the point of the test. ;o)
 
-      actual = runner { @app.start(%W(host addgroup #{name} #{group_name})) }
+      actual = runner { @app.start(%W[host addgroup #{name} #{group_name}]) }
 
       # Check output
       desired = { aborted: false }
       desired[:STDOUT] =
-        "Associate host '#{name}' with groups '#{group_name}':\n"\
-        "  - Retrieve host '#{name}'...\n"\
-        "    - OK\n"\
-        "  - Add association {host:#{name} <-> group:#{group_name}}...\n"\
-        "    - Group does not exist, creating now...\n"\
-        "      - OK\n"\
-        "    - OK\n"\
-        "  - Remove automatic association {host:#{name} <-> group:ungrouped}...\n"\
-        "    - OK\n"\
-        "  - All OK\n"\
+        "Associate host '#{name}' with groups '#{group_name}':\n  " \
+        "- Retrieve host '#{name}'...\n    " \
+        "- OK\n  " \
+        "- Add association {host:#{name} <-> group:#{group_name}}...\n    " \
+        "- Group does not exist, creating now...\n      " \
+        "- OK\n    " \
+        "- OK\n  " \
+        "- Remove automatic association {host:#{name} <-> group:ungrouped}...\n    " \
+        "- OK\n  " \
+        "- All OK\n" \
         "Succeeded\n"
       desired[:STDERR] =
         "WARNING: Group '#{group_name}' does not exist and will be created."
@@ -158,33 +174,33 @@ RSpec.describe Moose::Inventory::Cli::Host do
     end
 
     #------------------------
-    it 'HOST GROUP ... should skip associations that already '\
-      ' exist, but raise a warning.' do
+    it 'HOST GROUP ... should skip associations that already  ' \
+       'exist, but raise a warning.' do
       name = 'test1'
       group_name = 'testgroup1'
 
-      runner { @app.start(%W(host add #{name})) }
+      runner { @app.start(%W[host add #{name}]) }
 
       # DON'T CREATE THE GROUP! That's the point of the test. ;o)
 
       # Run once to make the association
-      runner { @app.start(%W(host addgroup #{name} #{group_name})) }
+      runner { @app.start(%W[host addgroup #{name} #{group_name}]) }
 
       # Run again, to prove expected result
-      actual = runner { @app.start(%W(host addgroup #{name} #{group_name})) }
+      actual = runner { @app.start(%W[host addgroup #{name} #{group_name}]) }
 
       # Check output
       # Note: This time, we don't expect to see any messages about
       # dissociation from 'ungrouped'
       desired = { aborted: false }
       desired[:STDOUT] =
-        "Associate host '#{name}' with groups '#{group_name}':\n"\
-        "  - Retrieve host \'#{name}\'...\n"\
-        "    - OK\n"\
-        "  - Add association {host:#{name} <-> group:#{group_name}}...\n"\
-        "    - Already exists, skipping.\n"\
-        "    - OK\n"\
-        "  - All OK\n"\
+        "Associate host '#{name}' with groups '#{group_name}':\n  " \
+        "- Retrieve host '#{name}'...\n    " \
+        "- OK\n  " \
+        "- Add association {host:#{name} <-> group:#{group_name}}...\n    " \
+        "- Already exists, skipping.\n    " \
+        "- OK\n  " \
+        "- All OK\n" \
         "Succeeded\n"
       desired[:STDERR] = "WARNING: Association {host:#{name} <-> group:#{group_name}} already exists, skipping."
       expected(actual, desired)
@@ -198,35 +214,35 @@ RSpec.describe Moose::Inventory::Cli::Host do
     end
 
     #------------------------
-    it 'host addgroup GROUP1 GROUP1 ... should add the host to'\
-      ' multiple groups at once' do
+    it 'host addgroup GROUP1 GROUP1 ... should add the host to ' \
+       'multiple groups at once' do
       name = 'test1'
-      group_names = %w(group1 group2 group3)
+      group_names = %w[group1 group2 group3]
 
-      runner { @app.start(%W(host add #{name})) }
+      runner { @app.start(%W[host add #{name}]) }
 
-      actual = runner { @app.start(%W(host addgroup #{name}) + group_names) }
+      actual = runner { @app.start(%W[host addgroup #{name}] + group_names) }
 
       # Check output
       desired = { aborted: false, STDERR: '' }
       desired[:STDOUT] =
-        "Associate host '#{name}' with groups '#{group_names.join(',')}':\n"\
-        "  - Retrieve host '#{name}'...\n"\
-        "    - OK\n"
+        "Associate host '#{name}' with groups '#{group_names.join(',')}':\n  " \
+        "- Retrieve host '#{name}'...\n    " \
+        "- OK\n"
       group_names.each do |group|
         desired[:STDOUT] = desired[:STDOUT] +
-                           "  - Add association {host:#{name} <-> group:#{group}}...\n"\
-                           "    - Group does not exist, creating now...\n"\
-                           "      - OK\n"\
-                           "    - OK\n"
+                           "  - Add association {host:#{name} <-> group:#{group}}...\n    " \
+                           "- Group does not exist, creating now...\n      " \
+                           "- OK\n    " \
+                           "- OK\n"
 
         desired[:STDERR] = desired[:STDERR] +
                            "WARNING: Group '#{group}' does not exist and will be created."
       end
       desired[:STDOUT] = desired[:STDOUT] +
-                         "  - Remove automatic association {host:#{name} <-> group:ungrouped}...\n"\
-                         "    - OK\n"\
-                         "  - All OK\n"\
+                         "  - Remove automatic association {host:#{name} <-> group:ungrouped}...\n    " \
+                         "- OK\n  " \
+                         "- All OK\n" \
                          "Succeeded\n"
       expected(actual, desired)
 
@@ -244,3 +260,4 @@ RSpec.describe Moose::Inventory::Cli::Host do
     end
   end
 end
+# rubocop:enable Metrics/BlockLength

data/spec/lib/moose_inventory/cli/host_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::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 'addvar' do
     #-----------------
     it 'should be responsive' do
-      result = @host.instance_methods(false).include?(:addvar)
+      result = @host.method_defined?(:addvar, false)
       expect(result).to eq(true)
     end
 
     #-----------------
     it 'host addvar <missing args> ... should abort with an error' do
       actual = runner do
-        @app.start(%w(host addvar)) # <- no group given
+        @app.start(%w[host addvar]) # <- no group given
       end
 
       # Check output
@@ -59,16 +40,16 @@ RSpec.describe Moose::Inventory::Cli::Host do
       host_var = 'foo=bar'
 
       actual = runner do
-        @app.start(%W(host addvar #{host_name} #{host_var}))
+        @app.start(%W[host addvar #{host_name} #{host_var}])
       end
 
       # Check output
       desired = { aborted: true }
       desired[:STDOUT] =
-        "Add variables '#{host_var}' to host '#{host_name}':\n"\
-        "  - retrieve host '#{host_name}'...\n"
+        "Add variables '#{host_var}' to host '#{host_name}':\n  " \
+        "- retrieve host '#{host_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 host '#{host_name}' does not exist.\n"
       expected(actual, desired)
     end
@@ -80,32 +61,30 @@ RSpec.describe Moose::Inventory::Cli::Host do
 
       host_name = 'test1'
       @db.models[:host].create(name: host_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(host addvar #{host_name} #{args}))
+          @app.start(%W[host addvar #{host_name} #{args}])
         end
         # @console.out(actual,'p')
 
         desired = { aborted: true }
         desired[:STDOUT] =
-          "Add variables '#{args}' to host '#{host_name}':\n"\
-          "  - retrieve host '#{host_name}'...\n"\
-          "    - OK\n"\
-          "  - add variable '#{args}'...\n"
+          "Add variables '#{args}' to host '#{host_name}':\n  " \
+          "- retrieve host '#{host_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)
@@ -123,18 +102,18 @@ RSpec.describe Moose::Inventory::Cli::Host do
       @db.models[:host].create(name: host_name)
 
       actual = runner do
-        @app.start(%W(host addvar #{host_name} #{var[:name]}=#{var[:value]}))
+        @app.start(%W[host addvar #{host_name} #{var[:name]}=#{var[:value]}])
       end
       # @console.out(actual,'p')
 
       desired = { aborted: false }
       desired[:STDOUT] =
-        "Add variables '#{var[:name]}=#{var[:value]}' to host '#{host_name}':\n"\
-        "  - retrieve host '#{host_name}'...\n"\
-        "    - OK\n"\
-        "  - add variable '#{var[:name]}=#{var[:value]}'...\n"\
-        "    - OK\n"\
-        "  - all OK\n"\
+        "Add variables '#{var[:name]}=#{var[:value]}' to host '#{host_name}':\n  " \
+        "- retrieve host '#{host_name}'...\n    " \
+        "- OK\n  " \
+        "- add variable '#{var[:name]}=#{var[:value]}'...\n    " \
+        "- OK\n  " \
+        "- all OK\n" \
         "Succeeded.\n"
       expected(actual, desired)
 
@@ -157,18 +136,18 @@ RSpec.describe Moose::Inventory::Cli::Host do
       @db.models[:host].create(name: host_name)
 
       actual = runner do
-        @app.start(%W(host addvar #{host_name} #{var[:name]}=#{var[:value]}))
+        @app.start(%W[host addvar #{host_name} #{var[:name]}=#{var[:value]}])
       end
       # @console.out(actual,'p')
 
       desired = { aborted: false }
       desired[:STDOUT] =
-        "Add variables '#{var[:name]}=#{var[:value]}' to host '#{host_name}':\n"\
-        "  - retrieve host '#{host_name}'...\n"\
-        "    - OK\n"\
-        "  - add variable '#{var[:name]}=#{var[:value]}'...\n"\
-        "    - OK\n"\
-        "  - all OK\n"\
+        "Add variables '#{var[:name]}=#{var[:value]}' to host '#{host_name}':\n  " \
+        "- retrieve host '#{host_name}'...\n    " \
+        "- OK\n  " \
+        "- add variable '#{var[:name]}=#{var[:value]}'...\n    " \
+        "- OK\n  " \
+        "- all OK\n" \
         "Succeeded.\n"
       expected(actual, desired)
 
@@ -188,33 +167,32 @@ RSpec.describe Moose::Inventory::Cli::Host do
       host_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[:host].create(name: host_name)
 
       actual = runner do
-        @app.start(%W(host addvar #{host_name}) + vars)
+        @app.start(%W[host addvar #{host_name}] + vars)
       end
       # @console.out(actual,'p')
 
       desired = { aborted: false }
       desired[:STDOUT] =
-        "Add variables '#{vars.join(',')}' to host '#{host_name}':\n"\
-        "  - retrieve host '#{host_name}'...\n"\
-        "    - OK\n"
+        "Add variables '#{vars.join(',')}' to host '#{host_name}':\n  " \
+        "- retrieve host '#{host_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)
 
@@ -224,6 +202,45 @@ RSpec.describe Moose::Inventory::Cli::Host do
       expect(hostvars.count).to eq(vars.length)
     end
 
+    #------------------------
+    it 'host addvar HOST key=value --dry-run should not create or update variables' do
+      host_name = 'test1'
+      @db.models[:host].create(name: host_name)
+      runner { @app.start(%W[host addvar #{host_name} var1=old]) }
+
+      actual = runner do
+        @app.start(%W[host addvar #{host_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.')
+      host = @db.models[:host].find(name: host_name)
+      expect(host.hostvars_dataset[name: 'var1'][:value]).to eq('old')
+      expect(host.hostvars_dataset[name: 'var2']).to be_nil
+    end
+
+    #------------------------
+    it 'host addvar HOST key=value --dry-run --plan-format json should emit a plan without writing' do
+      host_name = 'test1'
+      @db.models[:host].create(name: host_name)
+      runner { @app.start(%W[host addvar #{host_name} var1=old]) }
+
+      actual = runner do
+        @app.start(%W[host addvar #{host_name} var1=new var2=val2 --dry-run --plan-format json])
+      end
+
+      expect(actual[:unexpected]).to eq(false)
+      expect(actual[:aborted]).to eq(false)
+      expect(actual[:STDOUT]).not_to include('Add variables')
+      plan = JSON.parse(actual[:STDOUT])
+      expect(plan['command']).to eq('host addvar')
+      expect(plan['events'].map { |event| event['type'] }).to include('adding_variable', 'dry_run_summary')
+      host = @db.models[:host].find(name: host_name)
+      expect(host.hostvars_dataset[name: 'var1'][:value]).to eq('old')
+      expect(host.hostvars_dataset[name: 'var2']).to be_nil
+    end
+
     #------------------------
     it 'host addvar HOST key=value ... should update an already existing association' do
       # 1. Should add the var to the db
@@ -233,23 +250,23 @@ RSpec.describe Moose::Inventory::Cli::Host do
       var = { name: 'var1', value: 'testval' }
 
       @db.models[:host].create(name: host_name)
-      runner { @app.start(%W(host addvar #{host_name} #{var[:name]}=#{var[:value]})) }
+      runner { @app.start(%W[host addvar #{host_name} #{var[:name]}=#{var[:value]}]) }
 
       var[:value] = 'newtestval'
       actual = runner do
-        @app.start(%W(host addvar #{host_name} #{var[:name]}=#{var[:value]}))
+        @app.start(%W[host addvar #{host_name} #{var[:name]}=#{var[:value]}])
       end
       # @console.out(actual,'p')
 
       desired = { aborted: false }
       desired[:STDOUT] =
-        "Add variables '#{var[:name]}=#{var[:value]}' to host '#{host_name}':\n"\
-        "  - retrieve host '#{host_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 host '#{host_name}':\n  " \
+        "- retrieve host '#{host_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)
 
@@ -265,3 +282,4 @@ RSpec.describe Moose::Inventory::Cli::Host do
     end
   end
 end
+# rubocop:enable Metrics/BlockLength