test: switch to use the protogen.test method

Author: fischor

protogen/__init__.py

@@ -1704,8 +1704,8 @@ def __init__(
         self,
         *,
         py_import_func: Callable[[str, str], PyImportPath] = default_py_import_func,
-        input: BinaryIO | None = None,
-        output: BinaryIO | None = None,
+        input: Optional[BinaryIO] = None,
+        output: Optional[BinaryIO] = None,
         supported_features: List[
             "google.protobuf.compiler.plugin_pb2.CodeGeneratorResponse.Feature"
         ] = [],

test/optional/optional.proto

@@ -0,0 +1,8 @@
+syntax="proto3";
+
+package hello;
+
+message X {
+    string a = 1;
+    optional string b = 2;
+}

test/test_protogen.py

@@ -1,101 +1,45 @@
-import unittest
-import subprocess
-import os.path
-import os
-from typing import Tuple, List
+from protogen.test import run_plugin
 
 
 def test_protogen():
-    # test won't work if using relative path. protoc seems to have troubles
-    # finding files then:
-    #
-    #   - protoc-gen-empty=./test/plugin/main.py: warning: directory does not exist.
-    #   - vendor/google/api/annotations.proto: File does not reside within any path
-    #     specified using --proto_path (or -I).  You must specify a --proto_path which
-    #     encompasses this file.  Note that the proto_path must be an exact prefix of
-    #     the .proto file names -- protoc is too dumb to figure out when two paths
-    #     (e.g. absolute and relative) are equivalent (it's harder than you think).
-    #
-    pwd = os.getcwd()
-    vendor = os.path.join(pwd, "test", "vendor")
-    proto = os.path.join(pwd, "test", "vendor", "google", "api", "annotations.proto")
-    plugin = os.path.join(pwd, "test", "plugin", "main.py")
+    resp = run_plugin(
+        proto_paths=["test/vendor"],
+        files_to_generate=["google/api/annotations.proto"],
+        plugin="test.plugin.main",
+    )
 
-    # Create the output directory if it does not exists. protoc requires it
-    # to exist before generating output to it.
-    out_dir = os.path.join(pwd, "testout", "main")
-    if not os.path.exists(out_dir):
-        os.makedirs(out_dir)
+    assert resp.proto.error == ""
 
-    # Run protoc.
-    code, output = _run_protoc(
-        [
-            "protoc",
-            "-I",
-            vendor,
-            f"--plugin=protoc-gen-empty={plugin}",
-            f"--empty_out={out_dir}",
-            proto,
-        ]
-    )
-    assert output == ""
-    assert code == 0
+    generated, ok = resp.file_content("google/api/annotations.out")
+    assert ok
 
-    # Check content of directory.
     with open("test/golden/google/api/annotations.out") as f:
         golden = f.read()
-    with open("testout/main/google/api/annotations.out") as f:
-        generated = f.read()
 
     assert golden == generated
 
 
 def test_parameter():
-    pwd = os.getcwd()
-    vendor = os.path.join(pwd, "test", "vendor")
-    proto = os.path.join(pwd, "test", "vendor", "google", "api", "annotations.proto")
-    plugin = os.path.join(pwd, "test", "plugin", "parameter.py")
+    resp = run_plugin(
+        proto_paths=["test/vendor"],
+        files_to_generate=["google/api/annotations.proto"],
+        plugin="test.plugin.parameter",
+        parameter={
+            "k1": "v1",
+            "k2": "v2;k3=v3",
+            "k4": "",
+            "k5": "v5",
+            "abc": "x",
+            "5": "2",
+        },
+    )
 
-    # Create the output directory if it does not exists. protoc requires it
-    # to exist before generating output to it.
-    out_dir = os.path.join(pwd, "testout", "params")
-    if not os.path.exists(out_dir):
-        os.makedirs(out_dir)
+    assert resp.proto.error == ""
 
-    code, output = _run_protoc(
-        [
-            "protoc",
-            "-I",
-            vendor,
-            f"--plugin=protoc-gen-params={plugin}",
-            f"--params_opt=k1=v1,k2=v2;k3=v3,",
-            f"--params_opt=k4",
-            f"--params_opt=k5=v5",
-            f"--params_out=abc=x,5=2:{out_dir}",
-            proto,
-        ]
-    )
-    assert output == ""
-    assert code == 0
+    generated, ok = resp.file_content("out.txt")
+    assert ok
 
-    # Check content of directory.
     with open("test/golden/params.txt") as f:
         golden = f.read()
-    with open("testout/params/out.txt") as f:
-        generated = f.read()
 
     assert golden == generated
-
-
-def _run_protoc(args: List[str]) -> Tuple[int, str]:
-    proc = subprocess.Popen(
-        args, text=True, stderr=subprocess.PIPE, stdout=subprocess.PIPE
-    )
-    # Executed from current directory (repo root)
-    code = proc.wait()
-    if code == 0:
-        output = proc.stdout.read()
-    else:
-        output = proc.stderr.read()
-    proc.terminate()  # TODO necessary?
-    return code, output