Merge pull request #51 from boukeversteegh/pr/refactor-tests

Reorganize tests and add some extra documentation.

Author: nat-n

.gitignore

@@ -4,12 +4,9 @@
 .pytest_cache
 .python-version
 build/
-betterproto/tests/*.bin
-betterproto/tests/*_pb2.py
-betterproto/tests/*.py
-!betterproto/tests/generate.py
-!betterproto/tests/test_*.py
+betterproto/tests/output_*
 **/__pycache__
 dist
 **/*.egg-info
 output
+.idea

README.md

@@ -0,0 +1,2 @@
+@SET plugin_dir=%~dp0
+@python %plugin_dir%/plugin.py %*

betterproto/plugin.bat

@@ -1,84 +1,60 @@
 #!/usr/bin/env python
 import os
+import sys
+from typing import Set
+
+from betterproto.tests.util import get_directories, inputs_path, output_path_betterproto, output_path_reference, \
+    protoc_plugin, protoc_reference
 
 # 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"
 
-import importlib
-import json
-import subprocess
-import sys
-from typing import Generator, Tuple
 
-from google.protobuf import symbol_database
-from google.protobuf.descriptor_pool import DescriptorPool
-from google.protobuf.json_format import MessageToJson, Parse
+def generate(whitelist: Set[str]):
+    path_whitelist = {os.path.realpath(e) for e in whitelist if os.path.exists(e)}
+    name_whitelist = {e for e in whitelist if not os.path.exists(e)}
+
+    test_case_names = set(get_directories(inputs_path))
+
+    for test_case_name in sorted(test_case_names):
+        test_case_path = os.path.realpath(os.path.join(inputs_path, test_case_name))
+
+        if whitelist and test_case_path not in path_whitelist and test_case_name not in name_whitelist:
+            continue
 
+        case_output_dir_reference = os.path.join(output_path_reference, test_case_name)
+        case_output_dir_betterproto = os.path.join(output_path_betterproto, test_case_name)
 
-root = os.path.dirname(os.path.realpath(__file__))
+        print(f'Generating output for {test_case_name}')
+        os.makedirs(case_output_dir_reference, exist_ok=True)
+        os.makedirs(case_output_dir_betterproto, exist_ok=True)
 
+        protoc_reference(test_case_path, case_output_dir_reference)
+        protoc_plugin(test_case_path, case_output_dir_betterproto)
 
-def get_files(end: str) -> Generator[str, None, None]:
-    for r, dirs, files in os.walk(root):
-        for filename in [f for f in files if f.endswith(end)]:
-            yield os.path.join(r, filename)
 
+HELP = "\n".join([
+    'Usage: python generate.py',
+    '       python generate.py [DIRECTORIES or NAMES]',
+    'Generate python classes for standard tests.',
+    '',
+    'DIRECTORIES    One or more relative or absolute directories of test-cases to generate classes for.',
+    '               python generate.py inputs/bool inputs/double inputs/enum',
+    '',
+    'NAMES          One or more test-case names to generate classes for.',
+    '               python generate.py bool double enums'
+])
 
-def get_base(filename: str) -> str:
-    return os.path.splitext(os.path.basename(filename))[0]
 
+def main():
+    if set(sys.argv).intersection({'-h', '--help'}):
+        print(HELP)
+        return
+    whitelist = set(sys.argv[1:])
 
-def ensure_ext(filename: str, ext: str) -> str:
-    if not filename.endswith(ext):
-        return filename + ext
-    return filename
+    generate(whitelist)
 
 
 if __name__ == "__main__":
-    os.chdir(root)
-
-    if len(sys.argv) > 1:
-        proto_files = [ensure_ext(f, ".proto") for f in sys.argv[1:]]
-        bases = {get_base(f) for f in proto_files}
-        json_files = [
-            f for f in get_files(".json") if get_base(f).split("-")[0] in bases
-        ]
-    else:
-        proto_files = get_files(".proto")
-        json_files = get_files(".json")
-
-    for filename in proto_files:
-        print(f"Generating code for {os.path.basename(filename)}")
-        subprocess.run(
-            f"protoc --python_out=. {os.path.basename(filename)}", shell=True
-        )
-        subprocess.run(
-            f"protoc --plugin=protoc-gen-custom=../plugin.py --custom_out=. {os.path.basename(filename)}",
-            shell=True,
-        )
-
-    for filename in json_files:
-        # Reset the internal symbol database so we can import the `Test` message
-        # multiple times. Ugh.
-        sym = symbol_database.Default()
-        sym.pool = DescriptorPool()
-
-        parts = get_base(filename).split("-")
-        out = filename.replace(".json", ".bin")
-        print(f"Using {parts[0]}_pb2 to generate {os.path.basename(out)}")
-
-        imported = importlib.import_module(f"{parts[0]}_pb2")
-        input_json = open(filename).read()
-        parsed = Parse(input_json, imported.Test())
-        serialized = parsed.SerializeToString()
-        preserve = "casing" not in filename
-        serialized_json = MessageToJson(parsed, preserving_proto_field_name=preserve)
-
-        s_loaded = json.loads(serialized_json)
-        in_loaded = json.loads(input_json)
-
-        if s_loaded != in_loaded:
-            raise AssertionError("Expected JSON to be equal:", s_loaded, in_loaded)
-
-        open(out, "wb").write(serialized)
+    main()

betterproto/tests/README.md

@@ -0,0 +1,6 @@
+from betterproto.tests.output_betterproto.bool.bool import Test
+
+
+def test_value():
+    message = Test()
+    assert not message.value, "Boolean is False by default"

betterproto/tests/generate.py

@@ -9,4 +9,9 @@ enum my_enum {
 message Test {
   int32 camelCase = 1;
   my_enum snake_case = 2;
+  snake_case_message snake_case_message = 3;
 }
+
+message snake_case_message {
+
+}

betterproto/tests/bool.json renamed to betterproto/tests/inputs/bool/bool.json

@@ -0,0 +1,16 @@
+import betterproto.tests.output_betterproto.casing.casing as casing
+from betterproto.tests.output_betterproto.casing.casing import Test
+
+
+def test_message_attributes():
+    message = Test()
+    assert hasattr(message, 'snake_case_message'), 'snake_case field name is same in python'
+    assert hasattr(message, 'camel_case'), 'CamelCase field is snake_case in python'
+
+
+def test_message_casing():
+    assert hasattr(casing, 'SnakeCaseMessage'), 'snake_case Message name is converted to CamelCase in python'
+
+
+def test_enum_casing():
+    assert hasattr(casing, 'MyEnum'), 'snake_case Enum name is converted to CamelCase in python'

betterproto/tests/bool.proto renamed to betterproto/tests/inputs/bool/bool.proto

@@ -0,0 +1,18 @@
+syntax = "proto3";
+
+import "google/protobuf/wrappers.proto";
+
+service Test {
+    rpc GetInt32 (Input) returns (google.protobuf.Int32Value);
+    rpc GetAnotherInt32 (Input) returns (google.protobuf.Int32Value);
+    rpc GetInt64 (Input) returns (google.protobuf.Int64Value);
+    rpc GetOutput (Input) returns (Output);
+}
+
+message Input {
+
+}
+
+message Output {
+    google.protobuf.Int64Value int64 = 1;
+}

betterproto/tests/inputs/bool/test_bool.py

@@ -0,0 +1,18 @@
+from typing import Optional
+
+import pytest
+
+from betterproto.tests.output_betterproto.googletypes_response.googletypes_response import TestStub
+
+
+class TestStubChild(TestStub):
+    async def _unary_unary(self, route, request, response_type, **kwargs):
+        self.response_type = response_type
+
+
+@pytest.mark.asyncio
+async def test():
+    pytest.skip('todo')
+    stub = TestStubChild(None)
+    await stub.get_int64()
+    assert stub.response_type != Optional[int]

betterproto/tests/bytes.json renamed to betterproto/tests/inputs/bytes/bytes.json

@@ -0,0 +1,4 @@
+{
+  "positive": 150,
+  "negative": -150
+}

betterproto/tests/bytes.proto renamed to betterproto/tests/inputs/bytes/bytes.proto

@@ -3,5 +3,6 @@ syntax = "proto3";
 // Some documentation about the Test message.
 message Test {
     // Some documentation about the count.
-    int32 count = 1;
+    int32 positive = 1;
+    int32 negative = 2;
 }

betterproto/tests/casing.json renamed to betterproto/tests/inputs/casing/casing.json

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+package repeatedmessage;
+
+message Test {
+  repeated Sub greetings = 1;
+}
+
+message Sub {
+  string greeting = 1;
+}

betterproto/tests/casing.proto renamed to betterproto/tests/inputs/casing/casing.proto

@@ -0,0 +1,6 @@
+{
+  "signed32": 150,
+  "negative32": -150,
+  "string64": "150",
+  "negative64": "-150"
+}

betterproto/tests/inputs/casing/test_casing.py

@@ -0,0 +1,9 @@
+syntax = "proto3";
+
+message Test {
+    // todo: rename fields after fixing bug where 'signed_32_positive' will map to 'signed_32Positive' as output json
+    sint32 signed32 = 1;    //  signed_32_positive
+    sint32 negative32 = 2;  //  signed_32_negative
+    sint64 string64 = 3;    //  signed_64_positive
+    sint64 negative64 = 4;  //  signed_64_negative
+}