Fix: to_dict returns wrong enum fields when numbering is not consecutive (#102)

Fixes #93 to_dict returns wrong enum fields when numbering is not consecutive

tests/inputs/config.py

@@ -5,7 +5,7 @@ xfail = {
     "namespace_keywords",  # 70
     "namespace_builtin_types",  # 53
     "googletypes_struct",  # 9
-    "googletypes_value",  # 9,
+    "googletypes_value",  # 9
     "import_capitalized_package",
     "example",  # This is the example in the readme. Not a test.
 }

tests/inputs/enum/enum.json

@@ -0,0 +1,9 @@
+{
+  "choice": "FOUR",
+  "choices": [
+    "ZERO",
+    "ONE",
+    "THREE",
+    "FOUR"
+  ]
+}

tests/inputs/enum/enum.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+// Tests that enums are correctly serialized and that it correctly handles skipped and out-of-order enum values
+message Test {
+  Choice choice = 1;
+  repeated Choice choices = 2;
+}
+
+enum Choice {
+  ZERO = 0;
+  ONE = 1;
+  // TWO = 2;
+  FOUR = 4;
+  THREE = 3;
+}

tests/inputs/enum/test_enum.py

@@ -0,0 +1,84 @@
+from tests.output_betterproto.enum import (
+    Test,
+    Choice,
+)
+
+
+def test_enum_set_and_get():
+    assert Test(choice=Choice.ZERO).choice == Choice.ZERO
+    assert Test(choice=Choice.ONE).choice == Choice.ONE
+    assert Test(choice=Choice.THREE).choice == Choice.THREE
+    assert Test(choice=Choice.FOUR).choice == Choice.FOUR
+
+
+def test_enum_set_with_int():
+    assert Test(choice=0).choice == Choice.ZERO
+    assert Test(choice=1).choice == Choice.ONE
+    assert Test(choice=3).choice == Choice.THREE
+    assert Test(choice=4).choice == Choice.FOUR
+
+
+def test_enum_is_comparable_with_int():
+    assert Test(choice=Choice.ZERO).choice == 0
+    assert Test(choice=Choice.ONE).choice == 1
+    assert Test(choice=Choice.THREE).choice == 3
+    assert Test(choice=Choice.FOUR).choice == 4
+
+
+def test_enum_to_dict():
+    assert (
+        "choice" not in Test(choice=Choice.ZERO).to_dict()
+    ), "Default enum value is not serialized"
+    assert (
+        Test(choice=Choice.ZERO).to_dict(include_default_values=True)["choice"]
+        == "ZERO"
+    )
+    assert Test(choice=Choice.ONE).to_dict()["choice"] == "ONE"
+    assert Test(choice=Choice.THREE).to_dict()["choice"] == "THREE"
+    assert Test(choice=Choice.FOUR).to_dict()["choice"] == "FOUR"
+
+
+def test_repeated_enum_is_comparable_with_int():
+    assert Test(choices=[Choice.ZERO]).choices == [0]
+    assert Test(choices=[Choice.ONE]).choices == [1]
+    assert Test(choices=[Choice.THREE]).choices == [3]
+    assert Test(choices=[Choice.FOUR]).choices == [4]
+
+
+def test_repeated_enum_set_and_get():
+    assert Test(choices=[Choice.ZERO]).choices == [Choice.ZERO]
+    assert Test(choices=[Choice.ONE]).choices == [Choice.ONE]
+    assert Test(choices=[Choice.THREE]).choices == [Choice.THREE]
+    assert Test(choices=[Choice.FOUR]).choices == [Choice.FOUR]
+
+
+def test_repeated_enum_to_dict():
+    assert Test(choices=[Choice.ZERO]).to_dict()["choices"] == ["ZERO"]
+    assert Test(choices=[Choice.ONE]).to_dict()["choices"] == ["ONE"]
+    assert Test(choices=[Choice.THREE]).to_dict()["choices"] == ["THREE"]
+    assert Test(choices=[Choice.FOUR]).to_dict()["choices"] == ["FOUR"]
+
+    all_enums_dict = Test(
+        choices=[Choice.ZERO, Choice.ONE, Choice.THREE, Choice.FOUR]
+    ).to_dict()
+    assert (all_enums_dict["choices"]) == ["ZERO", "ONE", "THREE", "FOUR"]
+
+
+def test_repeated_enum_with_single_value_to_dict():
+    assert Test(choices=Choice.ONE).to_dict()["choices"] == ["ONE"]
+    assert Test(choices=1).to_dict()["choices"] == ["ONE"]
+
+
+def test_repeated_enum_with_non_list_iterables_to_dict():
+    assert Test(choices=(1, 3)).to_dict()["choices"] == ["ONE", "THREE"]
+    assert Test(choices=(1, 3)).to_dict()["choices"] == ["ONE", "THREE"]
+    assert Test(choices=(Choice.ONE, Choice.THREE)).to_dict()["choices"] == [
+        "ONE",
+        "THREE",
+    ]
+
+    def enum_generator():
+        yield Choice.ONE
+        yield Choice.THREE
+
+    assert Test(choices=enum_generator()).to_dict()["choices"] == ["ONE", "THREE"]

tests/inputs/enums/enums.json

@@ -1,3 +0,0 @@
-{
-  "greeting": "HEY"
-}

tests/inputs/enums/enums.proto

@@ -1,14 +0,0 @@
-syntax = "proto3";
-
-// Enum for the different greeting types
-enum Greeting {
-  HI = 0;
-  HEY = 1;
-  // Formal greeting
-  HELLO = 2;
-}
-
-message Test {
-  // Greeting enum example
-  Greeting greeting = 1;
-}