Merge pull request #251 from riscv-software-src/mref-fix

Fix recursive $mref

Author: dhower-qc

lib/test/test_yaml_loader.rb

@@ -1,3 +1,4 @@
+
 require "minitest/autorun"
 
 $root ||= (Pathname.new(__FILE__) / ".." / ".." ).realpath
@@ -6,6 +7,163 @@
 
 class TestYamlLoader < Minitest::Test
 
+  def test_that_mref_with_nested_replace_works
+    yaml = <<~YAML
+      base:
+        key1:
+          sub_key1: value1
+        key2: value2
+
+      middle:
+        $mref: "#/base"
+        key3: value3
+        key4: value4
+
+      bottom:
+        $mref:
+        - "#/base"
+        - "#/middle"
+        key1:
+          sub_key6: value6
+        key2: value2_new
+        key4: value4_new
+        key5: value5
+    YAML
+
+    f = Tempfile.new("yml")
+    f.write(yaml)
+    f.flush
+
+    doc = YamlLoader.load(f.path)
+    assert_equal({ "key1" => {"sub_key1" => "value1", "sub_key6" => "value6"}, "key2" => "value2_new", "key3" => "value3", "key4" => "value4_new", "key5" => "value5" }, doc["bottom"])
+  end
+
+  def test_that_spurious_recursive_mref_works
+    yaml = <<~YAML
+      base:
+        key1: value1
+        key2: value2
+
+      middle:
+        $mref: "#/base"
+        key3: value3
+        key4: value4
+
+      bottom:
+        $mref:
+        - "#/base"
+        - "#/middle"
+        key2: value2_new
+        key4: value4_new
+        key5: value5
+    YAML
+
+    f = Tempfile.new("yml")
+    f.write(yaml)
+    f.flush
+
+    doc = YamlLoader.load(f.path)
+    assert_equal({ "key1" => "value1", "key2" => "value2", "key3" => "value3", "key4" => "value4" }, doc["middle"])
+    assert_equal({ "key1" => "value1", "key2" => "value2_new", "key3" => "value3", "key4" => "value4_new", "key5" => "value5" }, doc["bottom"])
+  end
+
+  def test_that_recursive_mref_works
+    yaml = <<~YAML
+      base:
+        key1: value1
+        key2: value2
+
+      middle:
+        $mref: "#/base"
+        key3: value3
+        key4: value4
+
+      bottom:
+        $mref: "#/middle"
+        key2: value2_new
+        key4: value4_new
+        key5: value5
+    YAML
+
+    f = Tempfile.new("yml")
+    f.write(yaml)
+    f.flush
+
+    doc = YamlLoader.load(f.path)
+    assert_equal({ "key1" => "value1", "key2" => "value2", "key3" => "value3", "key4" => "value4" }, doc["middle"])
+    assert_equal({ "key1" => "value1", "key2" => "value2_new", "key3" => "value3", "key4" => "value4_new", "key5" => "value5" }, doc["bottom"])
+  end
+
+  def test_that_nested_mref_works
+    yaml = <<~YAML
+    top:
+      base:
+        key1: value1
+        key2: value2
+        key3: value3
+
+    bottom:
+      child:
+        $mref: "#/top/base"
+        key3: value3_new
+    YAML
+
+    f = Tempfile.new("yml")
+    f.write(yaml)
+    f.flush
+
+    doc = YamlLoader.load(f.path)
+    assert_equal({ "key1" => "value1", "key2" => "value2", "key3" => "value3_new" }, doc["bottom"]["child"])
+  end
+
+  def test_that_mref_doesnt_delete_keys
+    yaml = <<~YAML
+    base:
+      key1: value1
+      key2: value2
+      key3: value3
+
+    child:
+      $mref: "#/base"
+      key3: value3_new
+    YAML
+
+    f = Tempfile.new("yml")
+    f.write(yaml)
+    f.flush
+
+    doc = YamlLoader.load(f.path)
+    assert_equal({ "key1" => "value1", "key2" => "value2", "key3" => "value3_new" }, doc["child"])
+  end
+
+  def test_that_double_mref_doesnt_delete_keys
+    yaml = <<~YAML
+    base1:
+      key1: value1
+      key2: value2
+      key3: value3
+
+    base2:
+      key4: value4
+      key5: value5
+      key6: value6
+
+    child:
+      $mref:
+      - "#/base1"
+      - "#/base2"
+      key3: value3_new
+      key6: value6_new
+    YAML
+
+    f = Tempfile.new("yml")
+    f.write(yaml)
+    f.flush
+
+    doc = YamlLoader.load(f.path)
+    assert_equal({ "key1" => "value1", "key2" => "value2", "key3" => "value3_new", "key4" => "value4", "key5" => "value5", "key6" => "value6_new" }, doc["child"])
+  end
+
   def test_refs_in_the_same_document
     yaml = <<~YAML
       $defs:

lib/yaml_loader.rb

@@ -72,19 +72,38 @@ def self.expand(filename, obj, yaml_opts = {})
           raise DereferenceError, "JSON Path #{mref_target.split('#')[1]} does not exist in #{relative_path}"
         end
 
+        target_obj = expand(filename, target_obj, yaml_opts)
         target_obj.each do |target_key, target_value|
-          new_obj[target_key] = expand(filename, target_value, yaml_opts)
+          if (new_obj[target_key].is_a?(Hash))
+            raise "Should be a hash" unless target_value.is_a?(Hash)
+            new_obj[target_key] = target_value.merge(new_obj[target_key])
+          else
+            new_obj[target_key] = target_value
+          end
         end
       end
 
       obj.delete("$mref")
-      obj_keys = obj.keys
-      obj_keys.each do |key|
-        value = obj[key]
-
-        new_obj[key] = expand(filename, value, yaml_opts)
+      # now merge target_obj and obj
+      keys = (obj.keys + new_obj.keys).uniq
+      final_obj = {}
+      keys.each do |key|
+        if !obj.key?(key)
+          final_obj[key] = new_obj[key]
+        elsif !new_obj.key?(key)
+          final_obj[key] = expand(filename, obj[key], yaml_opts)
+        else
+          value = obj[key]
+
+          if new_obj[key].is_a?(Hash)
+            raise "should be a hash" unless new_obj[key].is_a?(Hash)
+            final_obj[key] = new_obj[key].merge(obj[key])
+          else
+            final_obj[key] = expand(filename, obj[key], yaml_opts)
+          end
+        end
       end
-      new_obj
+      final_obj
     else
       obj_keys = obj.keys
       obj_keys.each do |key|