Merge pull request #7264 from jeremymv2/jeremymv2/fix_normalize_hash

object validation for DataHandlerBase#normalize_hash

2 files changed, 73 insertions, 4 deletions

diff --git a/lib/chef/chef_fs/data_handler/data_handler_base.rb b/lib/chef/chef_fs/data_handler/data_handler_base.rb
index 4b4696ce5e..c3cbb96ecc 100644
--- a/lib/chef/chef_fs/data_handler/data_handler_base.rb
+++ b/lib/chef/chef_fs/data_handler/data_handler_base.rb
@@ -63,11 +63,15 @@ class Chef
         def normalize_hash(object, defaults)
           # Make a normalized result in the specified order for diffing
           result = {}
-          defaults.each_pair do |key, default|
-            result[key] = object.has_key?(key) ? object[key] : default
+          defaults.each_pair do |key, value|
+            result[key] = object.is_a?(Hash) && object.key?(key) ? object[key] : value
           end
-          object.each_pair do |key, value|
-            result[key] = value if !result.has_key?(key)
+          if object.is_a?(Hash)
+            object.each_pair do |key, value|
+              result[key] = value unless result.key?(key)
+            end
+          else
+            Chef::Log.warn "Encountered invalid object during normalization. Using these defaults #{defaults}"
           end
           result
         end
diff --git a/spec/unit/chef_fs/data_handler/data_handler_base_spec.rb b/spec/unit/chef_fs/data_handler/data_handler_base_spec.rb
new file mode 100644
index 0000000000..a5d177c878
--- /dev/null
+++ b/spec/unit/chef_fs/data_handler/data_handler_base_spec.rb
@@ -0,0 +1,65 @@
+#
+# Author:: Jeremy Miller (<jm@chef.io>)
+# Copyright:: Copyright 2014-2018, Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "spec_helper"
+require "lib/chef/chef_fs/data_handler/data_handler_base"
+
+describe Chef::ChefFS::DataHandler::DataHandlerBase do
+  describe "#normalize_hash" do
+    let(:some_item) do
+      { "name" => "grizzly",
+        "gender" => "female",
+        "age" => 3,
+        "food" => "honey"
+      }
+    end
+
+    let(:item_defaults) do
+      { "family" => "ursidae",
+        "hibernate" => true,
+        "food" => "berries",
+        "avg_lifespan_years" => 22
+      }
+    end
+
+    let(:normalized) do
+      { "name" => "grizzly",
+        "gender" => "female",
+        "family" => "ursidae",
+        "hibernate" => true,
+        "avg_lifespan_years" => 22,
+        "age" => 3,
+        "food" => "honey"
+      }
+    end
+
+    let(:handler) { described_class.new }
+
+    it "normalizes the Hash, filling in default values" do
+      expect(handler.normalize_hash(some_item, item_defaults)).to eq(normalized)
+    end
+
+    it "prefers already existing values over default values" do
+      expect(handler.normalize_hash(some_item, item_defaults)["food"]).to eq("honey")
+    end
+
+    it "handles being passed a nil value instead of Hash" do
+      expect(handler.normalize_hash(nil, item_defaults)).to eq(item_defaults)
+    end
+  end
+end