Organize test-cases into folders, extract compatibility test into proper test, support adding test-case specific tests

betterproto/tests/test_inputs.py

@@ -1,32 +1,99 @@
 import importlib
 import json
-
+import os
+import sys
 import pytest
 
-from .generate import get_base, get_files
+# Force pure-python implementation instead of C++, otherwise imports
+# break things because we can't properly reset the symbol database.
+os.environ["PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION"] = "python"
 
-inputs = get_files(".bin")
+from google.protobuf import symbol_database
+from google.protobuf.descriptor_pool import DescriptorPool
+from google.protobuf.json_format import Parse
+
+import betterproto
+from betterproto.tests.util import get_directories, inputs_path
+
+excluded_test_cases = {'googletypes_response', 'service'}
+test_case_names = {*get_directories(inputs_path)} - excluded_test_cases
+
+plugin_output_package = 'betterproto.tests.output_betterproto'
+reference_output_package = 'betterproto.tests.output_reference'
 
 
-@pytest.mark.parametrize("filename", inputs)
-def test_sample(filename: str) -> None:
-    module = get_base(filename).split("-")[0]
-    imported = importlib.import_module(f"betterproto.tests.{module}")
-    data_binary = open(filename, "rb").read()
-    data_dict = json.loads(open(filename.replace(".bin", ".json")).read())
-    t1 = imported.Test().parse(data_binary)
-    t2 = imported.Test().from_dict(data_dict)
-    print(t1)
-    print(t2)
+@pytest.mark.parametrize("test_case_name", test_case_names)
+def test_message_can_be_imported(test_case_name: str) -> None:
+    importlib.import_module(f"{plugin_output_package}.{test_case_name}.{test_case_name}")
 
-    # Equality should automagically work for dataclasses!
-    assert t1 == t2
 
-    # Generally this can't be relied on, but here we are aiming to match the
-    # existing Python implementation and aren't doing anything tricky.
-    # https://developers.google.com/protocol-buffers/docs/encoding#implications
-    assert bytes(t1) == data_binary
-    assert bytes(t2) == data_binary
+@pytest.mark.parametrize("test_case_name", test_case_names)
+def test_message_can_instantiated(test_case_name: str) -> None:
+    plugin_module = importlib.import_module(f"{plugin_output_package}.{test_case_name}.{test_case_name}")
+    plugin_module.Test()
 
-    assert t1.to_dict() == data_dict
-    assert t2.to_dict() == data_dict
+
+@pytest.mark.parametrize("test_case_name", test_case_names)
+def test_message_equality(test_case_name: str) -> None:
+    plugin_module = importlib.import_module(f"{plugin_output_package}.{test_case_name}.{test_case_name}")
+    message1 = plugin_module.Test()
+    message2 = plugin_module.Test()
+    assert message1 == message2
+
+
+@pytest.mark.parametrize("test_case_name", test_case_names)
+def test_message_json(test_case_name: str) -> None:
+    plugin_module = importlib.import_module(f"{plugin_output_package}.{test_case_name}.{test_case_name}")
+    message: betterproto.Message = plugin_module.Test()
+    reference_json_data = get_test_case_json_data(test_case_name)
+
+    message.from_json(reference_json_data)
+    message_json = message.to_json(0)
+
+    assert json.loads(message_json) == json.loads(reference_json_data)
+
+
+@pytest.mark.parametrize("test_case_name", test_case_names)
+def test_binary_compatibility(test_case_name: str) -> None:
+    # Reset the internal symbol database so we can import the `Test` message
+    # multiple times. Ugh.
+    sym = symbol_database.Default()
+    sym.pool = DescriptorPool()
+
+    reference_module_root = os.path.join(*reference_output_package.split('.'), test_case_name)
+
+    print(f'Appending {reference_module_root}')
+    sys.path.append(reference_module_root)
+
+    # import reference message
+    reference_module = importlib.import_module(f"{reference_output_package}.{test_case_name}.{test_case_name}_pb2")
+    plugin_module = importlib.import_module(f"{plugin_output_package}.{test_case_name}.{test_case_name}")
+
+    test_data = get_test_case_json_data(test_case_name)
+
+    reference_instance = Parse(test_data, reference_module.Test())
+    reference_binary_output = reference_instance.SerializeToString()
+
+    plugin_instance_from_json: betterproto.Message = plugin_module.Test().from_json(test_data)
+    plugin_instance_from_binary = plugin_module.Test.FromString(reference_binary_output)
+
+    # # Generally this can't be relied on, but here we are aiming to match the
+    # # existing Python implementation and aren't doing anything tricky.
+    # # https://developers.google.com/protocol-buffers/docs/encoding#implications
+    assert plugin_instance_from_json == plugin_instance_from_binary
+    assert plugin_instance_from_json.to_dict() == plugin_instance_from_binary.to_dict()
+
+    sys.path.remove(reference_module_root)
+
+
+'''
+helper methods
+'''
+
+def get_test_case_json_data(test_case_name):
+    test_data_path = os.path.join(inputs_path, test_case_name, f'{test_case_name}.json')
+    if not os.path.exists(test_data_path):
+        return None
+
+    with open(test_data_path) as fh:
+        return fh.read()