feat: use json_format.ParseDict to convert dicts to structs

crossplane · Nov 25, 2024 · 8724e2d · 8724e2d
1 parent 25e49cf
commit 8724e2d
Show file tree

Hide file tree

Showing 2 changed files with 61 additions and 3 deletions.
diff --git a/crossplane/function/resource.py b/crossplane/function/resource.py
@@ -58,9 +58,7 @@ def dict_to_struct(d: dict) -> structpb.Struct:
     function makes it possible to work with a Python dict, then convert it to a
     struct in a RunFunctionResponse.
     """
-    s = structpb.Struct()
-    s.update(d)
-    return s
+    return json_format.ParseDict(d, structpb.Struct())
 
 
 def struct_to_dict(s: structpb.Struct) -> dict:

diff --git a/tests/test_resource.py b/tests/test_resource.py
@@ -244,6 +244,66 @@ class TestCase:
                 dataclasses.asdict(case.want), dataclasses.asdict(got), "-want, +got"
             )
 
+    def test_dict_to_struct(self) -> None:
+        @dataclasses.dataclass
+        class TestCase:
+            reason: str
+            d: dict
+            want: structpb.Struct
+
+        cases = [
+            TestCase(
+                reason="Convert an empty dictionary to a struct.",
+                d={},
+                want=structpb.Struct(),
+            ),
+            TestCase(
+                reason="Convert a dictionary with a single field to a struct.",
+                d={"foo": "bar"},
+                want=structpb.Struct(
+                    fields={"foo": structpb.Value(string_value="bar")}
+                ),
+            ),
+            TestCase(
+                reason="Convert a nested dictionary to a struct.",
+                d={"foo": {"bar": "baz"}},
+                want=structpb.Struct(
+                    fields={
+                        "foo": structpb.Value(
+                            struct_value=structpb.Struct(
+                                fields={"bar": structpb.Value(string_value="baz")}
+                            )
+                        )
+                    }
+                ),
+            ),
+            TestCase(
+                reason="Convert a nested dictionary containing lists to a struct.",
+                d={"foo": {"bar": ["baz", "qux"]}},
+                want=structpb.Struct(
+                    fields={
+                        "foo": structpb.Value(
+                            struct_value=structpb.Struct(
+                                fields={
+                                    "bar": structpb.Value(
+                                        list_value=structpb.ListValue(
+                                            values=[
+                                                structpb.Value(string_value="baz"),
+                                                structpb.Value(string_value="qux"),
+                                            ]
+                                        )
+                                    )
+                                }
+                            )
+                        )
+                    }
+                ),
+            ),
+        ]
+        for case in cases:
+            got = resource.dict_to_struct(case.d)
+            self.assertEqual(case.want, got, "-want, +got")
+
     def test_struct_to_dict(self) -> None:
         @dataclasses.dataclass
         class TestCase: