Merge pull request #8980 from mhashizume/PUP-11684/main/unchanged_default

(PUP-11684) Default to exclude unchanged resources

Author: joshcooper

lib/puppet/defaults.rb

@@ -1452,7 +1452,7 @@ def self.initialize_default_settings!(settings)
         To turn off reports entirely, set this to `none`",
     },
     :exclude_unchanged_resources => {
-      :default => false,
+      :default => true,
       :type => :boolean,
       :desc => 'When set to true, resources that have had no changes after catalog application
         will not have corresponding unchanged resource status updates listed in the report.'

spec/unit/transaction/report_spec.rb

@@ -138,14 +138,46 @@
   end
 
   describe "when exclude_unchanged_resources is true" do
+    let(:test_dir) { tmpdir('unchanged_resources') }
+    let(:test_dir2) { tmpdir('unchanged_resources') }
+    let(:test_file) { tmpfile('some_path')}
+    it 'should still list "changed" resource statuses but remove "unchanged"' do
+      transaction = apply_compiled_manifest(<<-END)
+        notify { "hi": } ~>
+        exec { "/bin/this_command_does_not_exist":
+          command => "#{make_absolute('/bin/this_command_does_not_exist')}",
+          refreshonly => true,
+        }
+        file { '#{test_dir}':
+          ensure => directory
+        }
+        file { 'failing_file':
+          path => '#{test_dir2}',
+          ensure => file
+        }
+        file { 'skipped_file':
+          path => '#{test_file}',
+          require => File[failing_file]
+        }
+      END
+      rs = transaction.report.to_data_hash['resource_statuses']
+      expect(rs["Notify[hi]"]['out_of_sync']).to be true
+      expect(rs["Exec[/bin/this_command_does_not_exist]"]['failed_to_restart']).to be true
+      expect(rs["File[failing_file]"]['failed']).to be true
+      expect(rs["File[skipped_file]"]['skipped']).to be true
+      expect(rs).to_not have_key(["File[#{test_dir}]"])
+    end
+  end
+
+  describe"when exclude_unchanged_resources is false" do
     before do
-      Puppet[:exclude_unchanged_resources] = true
+      Puppet[:exclude_unchanged_resources] = false
     end
 
     let(:test_dir) { tmpdir('unchanged_resources') }
     let(:test_dir2) { tmpdir('unchanged_resources') }
     let(:test_file) { tmpfile('some_path')}
-    it 'should still list "changed" resource statuses but remove "unchanged"' do
+    it 'should list all resource statuses' do
       transaction = apply_compiled_manifest(<<-END)
         notify { "hi": } ~>
         exec { "/bin/this_command_does_not_exist":
@@ -169,7 +201,7 @@
       expect(rs["Exec[/bin/this_command_does_not_exist]"]['failed_to_restart']).to be true
       expect(rs["File[failing_file]"]['failed']).to be true
       expect(rs["File[skipped_file]"]['skipped']).to be true
-      expect(rs).to_not have_key(["File[#{test_dir}]"])
+      expect(rs["File[#{test_dir}]"]['changed']).to be false
     end
   end