chef 18.7.3 → 18.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd6c311d620e980620e3c1933de98f896da522386e84cee0c0fa92ea8615c3b3
-  data.tar.gz: 8799e439771a8061aa5fada7f5b94c76001e4cab27ebf081741664db1b0dbeb4
+  metadata.gz: c7b55454579a7afa310852f734fff0049c58da87b1ac48b6a16cfb98837faa2f
+  data.tar.gz: 3904033b7482a4cacf06e68bd4d45540db6ed3ab8e5bf5dfdfbcd56fe99d14df
 SHA512:
-  metadata.gz: 224fe24ecc76d00d1bded47e7007225cc21479080582e25c6d792aa6d12b988a86d5205de3a3be29eb362f7880cdc884f6c746aee037ce0afec10402b49297d0
-  data.tar.gz: 16ef3b5a6b8c9c0ecb206d41b8353c63e2e1cf94240cfae67290f964d6bbd5f0b3578bb11322fdc617e28e502b1106cf9438ca897f8eecfbd0788153cb893af4
+  metadata.gz: 46a1c9a9475a3cbab9d945c77ada117ad42a9499afb2fc23c162177127318931a4d724b585e796491bc4415db10fe5d06c3c46164f37d908844db9ec38e51b8a
+  data.tar.gz: b34573bd31fbb8dadb86b09ab9b91236fd5f66d28b10f7e12be668b052a8d10111c01fdce243c18f49f4a2e70aef87bcac964b21ed4500f3397f411b71e6f872

data/chef.gemspec

@@ -39,7 +39,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "license-acceptance", ">= 1.0.5", "< 3"
   s.add_dependency "mixlib-cli", ">= 2.1.1", "< 3.0"
-  s.add_dependency "mixlib-log", ">= 2.0.3", "<= 3.1.1"
+  s.add_dependency "mixlib-log", ">= 2.0.3", "< 3.2"
   s.add_dependency "mixlib-authentication", ">= 2.1", "< 4"
   s.add_dependency "mixlib-shellout", ">= 3.1.1", "< 4.0"
   s.add_dependency "mixlib-archive", ">= 0.4", "< 2.0"

data/lib/chef/data_collector.rb

@@ -270,6 +270,20 @@ class Chef
         send_run_start unless sent_run_start?
 
         message = Chef::DataCollector::RunEndMessage.construct_message(self, status)
+
+        begin
+          if ChefUtils.windows?
+            # Remove registry key values that are not present in the after state - CHEF-9126
+            message["resources"]&.each do |resource|
+              next unless resource["type"] == :registry_key
+
+              resource["before"][:values]&.reject! { |value| !resource["after"][:values].any? { |after_value| after_value[:name] == value[:name] } }
+            end
+          end
+        rescue StandardError => e
+          Chef::Log.warn("Error while processing registry key values: #{e.message}, #{e.backtrace[0..5]}")
+        end
+
         send_to_data_collector(message)
         send_to_output_locations(message)
       end

data/lib/chef/provider/registry_key.rb

@@ -51,10 +51,6 @@ class Chef
         current_resource.recursive(new_resource.recursive)
         if registry.key_exists?(new_resource.key)
           current_registry_values = registry.get_values(new_resource.key) || []
-
-          if new_resource.only_record_changes
-            current_registry_values.select! { |v| new_resource.values.any? { |nv| nv[:name] == v[:name] } }
-          end
           current_resource.values(current_registry_values)
         end
         values_to_hash(current_resource.unscrubbed_values)

data/lib/chef/resource/apt_repository.rb

@@ -308,8 +308,8 @@ class Chef
         def install_key_from_uri(key)
           key_name = key.gsub(/[^0-9A-Za-z\-]/, "_")
           keyfile_path = ::File.join(Chef::Config[:file_cache_path], key_name)
-          tmp_dir = TargetIO::Dir.mktmpdir(".gpg")
-          at_exit { TargetIO::FileUtils.remove_entry(tmp_dir) }
+          tmp_dir = Dir.mktmpdir(".gpg")
+          at_exit { FileUtils.remove_entry(tmp_dir) }
 
           if new_resource.signed_by
             keyfile_path = keyring_path

data/lib/chef/resource/registry_key.rb

@@ -41,19 +41,6 @@ class Chef
       end
       ```
 
-      ```ruby
-      **Suppress reporting the sibling values of the values being updated in a registry key**
-      registry 'HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\CONTROL\Session Manager' do
-        values [{
-          name: 'ProtectionMode',
-          type: :dword,
-          data: 1
-        }]
-        only_record_changes true
-        action :create
-      end
-      ```
-
       **Create a registry key with binary data: "\x01\x02\x03"**:
 
       ```ruby
@@ -165,9 +152,10 @@ class Chef
       property :recursive, [TrueClass, FalseClass], default: false
       property :architecture, Symbol, default: :machine, equal_to: %i{machine x86_64 i386}
       property :only_record_changes, [TrueClass, FalseClass],
-               default: true,
-               introduced: "19.0",
-               description: "Suppress reporting of the current value of sibling values in a registry key. Setting this to false may result in a large number of values reported."
+         default: true,
+         introduced: "18.7.3",
+         description: "(no-op) disabled functionality to only record registry value changes",
+         deprecated: true
 
       # Some registry key data types may not be safely reported as json.
       # Example (CHEF-5323):

data/lib/chef/resource_reporter.rb

@@ -33,6 +33,9 @@ class Chef
       as_hash["id"]       = new_resource.identity.to_s
       as_hash["after"]    = new_resource.state_for_resource_reporter
       as_hash["before"]   = current_resource ? current_resource.state_for_resource_reporter : {}
+      # if the "before" hash is too large, we need to truncate it to avoid 413 errors
+      # 640K ought be enough for every Windows registry entry
+      as_hash["before"]   = {} if as_hash["before"].to_json.length > 657920
       as_hash["duration"] = ( action_record.elapsed_time * 1000 ).to_i.to_s
       as_hash["delta"]    = new_resource.diff if new_resource.respond_to?(:diff)
       as_hash["delta"]    = "" if as_hash["delta"].nil?

data/lib/chef/version.rb

@@ -23,7 +23,7 @@ require_relative "version_string"
 
 class Chef
   CHEF_ROOT = File.expand_path("..", __dir__)
-  VERSION = Chef::VersionString.new("18.7.3")
+  VERSION = Chef::VersionString.new("18.7.6")
 end
 
 #

data/spec/functional/resource/registry_spec.rb

@@ -294,49 +294,6 @@ describe Chef::Resource::RegistryKey do
             expect(registry.value_exists?(registry_key, value)).to be true
           end
         end
-
-        context "when only_record_changes is the default (true)" do
-          before do
-            prepopulate(registry_key, prepopulated_values)
-          end
-          let(:registry_key) { "#{reg_child}\\OnlyRecordChanges" }
-          let(:registry_key_values) { [{ name: "ReportingVal1", type: :string, data: rand(1235..10000) }] }
-
-          it "should only report the changed value" do
-            subject
-            report = resource_reporter.prepare_run_data
-
-            expect(report["action"]).to eq("end")
-            expect(report["resources"][0]["type"]).to eq(:registry_key)
-            expect(report["resources"][0]["name"]).to eq(resource_name)
-            expect(report["resources"][0]["id"]).to eq(registry_key)
-            expect(report["resources"][0]["after"][:values]).to eq(registry_key_values)
-            expect(report["resources"][0]["before"][:values]).to eq(prepopulated_values.select { |ppv| ppv[:name] == "ReportingVal1" })
-            expect(report["resources"][0]["result"]).to eq("create")
-            expect(report["status"]).to eq("success")
-            expect(report["total_res_count"]).to eq("1")
-          end
-        end
-
-        context "when only_record_changes is false" do
-          before do
-            new_resource.only_record_changes(false)
-            prepopulate(registry_key, prepopulated_values)
-          end
-          let(:registry_key) { "#{reg_child}\\RecordItAll" }
-          let(:registry_key_values) { [{ name: "ReportingVal1", type: :string, data: rand(1235..10000) }] }
-
-          it "should only report the changed value" do
-            subject
-            report = resource_reporter.prepare_run_data
-
-            expect(report["resources"][0]["after"][:values]).to eq(registry_key_values)
-            expect(report["resources"][0]["before"][:values]).to eq(prepopulated_values)
-            expect(report["status"]).to eq("success")
-            expect(report["total_res_count"]).to eq("1")
-          end
-
-        end
       end
     end
   end

data/spec/unit/data_collector_spec.rb

@@ -627,7 +627,7 @@ describe Chef::DataCollector do
           events.resource_action_start(new_resource, :create)
           events.resource_current_state_loaded(new_resource, :create, current_resource)
 
-          events.resource_action_start(implementation_resource , :create)
+          events.resource_action_start(implementation_resource, :create)
           events.resource_current_state_loaded(implementation_resource, :create, implementation_resource)
           events.resource_updated(implementation_resource, :create)
           events.resource_after_state_loaded(implementation_resource, :create, implementation_resource)
@@ -876,7 +876,6 @@ describe Chef::DataCollector do
           send_run_failed_or_completed_event
         end
       end
-
     end
   end
 
@@ -968,5 +967,110 @@ describe Chef::DataCollector do
         data_collector.send(:send_to_data_collector, message)
       end
     end
+
+    context "when processing Windows registry keys" do
+      let(:total_resource_count) { 1 }
+      let(:updated_resource_count) { 1 }
+      let(:status) { "success" }
+
+      before do
+        allow(ChefUtils).to receive(:windows?).and_return(true)
+        run_status.stop_clock
+      end
+
+      it "removes registry key values not present in after state" do
+        resource = {
+          "type" => :registry_key,
+          "before" => {
+            values: [
+              { name: "key1", value: "val1" },
+              { name: "key2", value: "val2" },
+              { name: "key3", value: "val3" },
+            ],
+          },
+          "after" => {
+            values: [
+              { name: "key1", value: "new_val1" },
+              { name: "key3", value: "new_val3" },
+            ],
+          },
+        }
+
+        message = {
+          "resources" => [resource],
+        }
+
+        # Verify that key2 was removed from before values
+        expected_before_values = [
+          { name: "key1", value: "val1" },
+          { name: "key3", value: "val3" },
+        ]
+
+        expect(http_client).to receive(:post).with(
+          nil,
+          hash_including("message_type" => "run_start"),
+          { "Content-Type" => "application/json" }
+        )
+
+        expect(http_client).to receive(:post).with(
+          nil,
+          hash_including(
+            "resources" => array_including(
+              hash_including(
+                "before" => hash_including(
+                  values: array_including(expected_before_values)
+                )
+              )
+            )
+          ),
+          { "Content-Type" => "application/json" }
+        )
+        allow(Chef::DataCollector::RunEndMessage).to receive(:construct_message).and_return(message)
+        data_collector.send(:send_run_completion, message)
+      end
+
+      it "handles missing values gracefully" do
+        resource = {
+          "type" => :registry_key,
+          "before" => {},
+          "after" => { values: [] },
+        }
+
+        message = {
+          "resources" => [resource],
+        }
+
+        expect(http_client).to receive(:post).with(
+          nil,
+          hash_including("message_type" => "run_start"),
+          { "Content-Type" => "application/json" }
+        )
+
+        expect(http_client).to receive(:post).with(nil, message, { "Content-Type" => "application/json" })
+
+        allow(Chef::DataCollector::RunEndMessage).to receive(:construct_message).and_return(message)
+        expect { data_collector.send(:send_run_completion, "success") }.not_to raise_error
+      end
+
+      it "ignores non-registry resources" do
+        resource = {
+          "type" => :file,
+          "before" => { content: "old" },
+          "after" => { content: "new" },
+        }
+
+        message = {
+          "resources" => [resource],
+        }
+        expect(http_client).to receive(:post).with(nil,
+          hash_including("message_type" => "run_start"),
+          { "Content-Type" => "application/json" })
+
+        expect(http_client).to receive(:post).with(nil, message, { "Content-Type" => "application/json" })
+
+        allow(Chef::DataCollector::RunEndMessage).to receive(:construct_message).and_return(message)
+        expect { data_collector.send(:send_run_completion, "success") }.not_to raise_error
+      end
+    end
   end
 end

data/spec/unit/provider/registry_key_spec.rb

@@ -27,7 +27,6 @@ shared_examples_for "a registry key" do
       before(:each) do
         expect(@double_registry).to receive(:key_exists?).with(keyname).and_return(true)
         expect(@double_registry).to receive(:get_values).with(keyname).and_return( [testval2] )
-        @new_resource.only_record_changes false
         @provider.load_current_resource
       end
 

data/spec/unit/resource_reporter_spec.rb

@@ -73,7 +73,6 @@ describe Chef::ResourceReporter do
   end
 
   context "when first created" do
-
     it "has no updated resources" do
       expect(resource_reporter.updated_resources.count).to eq(0)
     end
@@ -89,7 +88,6 @@ describe Chef::ResourceReporter do
     it "should have no error_descriptions" do
       expect(resource_reporter.error_descriptions).to eq({})
     end
-
   end
 
   context "after the chef run completes" do
@@ -107,7 +105,6 @@ describe Chef::ResourceReporter do
     before do
       allow(rest_client).to receive(:raw_request).and_return({ "result" => "ok" })
       allow(rest_client).to receive(:post).and_return({ "uri" => "https://example.com/reports/nodes/spitfire/runs/#{@run_id}" })
-
     end
 
     context "before converging any resources" do
@@ -510,6 +507,63 @@ describe Chef::ResourceReporter do
       it_should_behave_like "a successful client run"
     end
 
+    context "windows registry_key resource" do
+      let(:current_resource) do
+        resource = Chef::Resource::RegistryKey.new('HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager')
+        resource.values([{ name: "PendingFileRenameOperations", type: :multi_string, data: 10000.times.map { |n| "C:\\Windows\\System32\\config\\systemprofile\\AppData\\Local\\Temp\\2\\Chef-20140107123456-1234-#{n}" } } ])
+        resource
+      end
+
+      let(:new_resource) do
+        resource = Chef::Resource::RegistryKey.new('HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager')
+        resource.values([ { name: "ProtectionMode", type: :dword, data: 1 } ])
+        allow(resource).to receive(:cookbook_name).and_return(cookbook_name)
+        allow(resource).to receive(:cookbook_version).and_return(cookbook_version)
+        resource
+      end
+
+      it "should raise an error when the data is too large" do
+        pending "Need to test truncation properly"
+        # Start the run
+        resource_reporter.run_started(run_status)
+        run_status.start_clock
+
+        # These 4 event callbacks are essential to populate resource state:
+        events.resource_action_start(new_resource, :create)
+        events.resource_current_state_loaded(new_resource, :create, current_resource)
+        events.resource_updated(new_resource, :create)
+        events.resource_completed(new_resource)
+
+        # Stop the run
+        run_status.stop_clock
+
+        # Prepare the run data - this will include the resource states
+        report_data = resource_reporter.prepare_run_data
+
+        # Verify the report includes our resource
+        expect(report_data["resources"].length).to eq(1)
+        expect(report_data["resources"][0]["before"]).to eq(current_resource.state_for_resource_reporter)
+        expect(report_data["resources"][0]["after"]).to eq(new_resource.state_for_resource_reporter)
+
+        expect(rest_client).to receive(:post) do |path, data, headers|
+          expect(path).to eq("reports/nodes/spitfire/runs")
+          raise Chef::Exceptions::ValidationFailed, "data too large" if data.length > 10000
+        end
+
+        # Now mock the actual post request to fail due to size
+        expect(rest_client).to receive(:raw_request) do |method, url, headers, data|
+          data_stream = Zlib::GzipReader.new(StringIO.new(data))
+          data = data_stream.read
+          expect(data).to include('"before":')  # Verify current_resource state is included
+          expect(data).to include('"after":')   # Verify new_resource state is included
+          raise Chef::Exceptions::ValidationFailed, "data too large"
+        end
+
+        # Assert that the post fails due to validation
+        expect { resource_reporter.run_completed(node) }.to raise_error(Chef::Exceptions::ValidationFailed)
+      end
+    end
+
     context "for an unsuccessful run" do
 
       before do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef
 version: !ruby/object:Gem::Version
-  version: 18.7.3
+  version: 18.7.6
 platform: ruby
 authors:
 - Adam Jacob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-03-31 00:00:00.000000000 Z
+date: 2025-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-config
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 18.7.3
+        version: 18.7.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 18.7.3
+        version: 18.7.6
 - !ruby/object:Gem::Dependency
   name: chef-utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 18.7.3
+        version: 18.7.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 18.7.3
+        version: 18.7.6
 - !ruby/object:Gem::Dependency
   name: train-core
   requirement: !ruby/object:Gem::Requirement
@@ -133,9 +133,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.3
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.1.1
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -143,9 +143,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.3
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.1.1
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: mixlib-authentication
   requirement: !ruby/object:Gem::Requirement