Update test_end_to_end.py,openapi_python_client/__init__.py : various imprv

Co-authored-by: Dylan Anthony <[email protected]>

Author: p1-ra

Diff for: end_to_end_tests/test_end_to_end.py

@@ -1,7 +1,7 @@
 import shutil
 from filecmp import cmpfiles, dircmp
 from pathlib import Path
-from typing import Dict, Optional
+from typing import Dict, List, Optional
 
 import pytest
 from typer.testing import CliRunner
@@ -12,11 +12,18 @@
 def _compare_directories(
     record: Path,
     test_subject: Path,
-    expected_differences: Optional[
-        Dict[Path, str]
-    ] = None,  # key: path relative to generated directory, value: expected generated content
+    expected_differences: Dict[Path, str],
     depth=0,
 ):
+    """
+    Compare two directories and assert that only expected_differences are different
+
+    Args:
+        record: Path to the expected output
+        test_subject: Path to the generated code being checked
+        expected_differences: key: path relative to generated directory, value: expected generated content
+        depth: Used to track recursion
+    """
     first_printable = record.relative_to(Path.cwd())
     second_printable = test_subject.relative_to(Path.cwd())
     dc = dircmp(record, test_subject)
@@ -30,16 +37,14 @@ def _compare_directories(
 
     expected_path_mismatches = []
     for file_name in mismatches:
-
         mismatch_file_path = test_subject.joinpath(file_name)
-        for expected_differences_path in expected_differences.keys():
-
-            if mismatch_file_path.match(str(expected_differences_path)):
+        expected_content = expected_differences.get(mismatch_file_path)
+        if expected_content is None:
+            continue
 
-                generated_content = (test_subject / file_name).read_text()
-                expected_content = expected_differences[expected_differences_path]
-                assert generated_content == expected_content, f"Unexpected output in {mismatch_file_path}"
-                expected_path_mismatches.append(expected_differences_path)
+        generated_content = (test_subject / file_name).read_text()
+        assert generated_content == expected_content, f"Unexpected output in {mismatch_file_path}"
+        expected_path_mismatches.append(mismatch_file_path)
 
     for path_mismatch in expected_path_mismatches:
         matched_file_name = path_mismatch.name
@@ -62,7 +67,7 @@ def _compare_directories(
         pytest.fail(failure, pytrace=False)
 
 
-def run_e2e_test(extra_args=None, expected_differences=None):
+def run_e2e_test(extra_args: List[str], expected_differences: Dict[Path, str]):
     runner = CliRunner()
     openapi_path = Path(__file__).parent / "openapi.json"
     config_path = Path(__file__).parent / "config.yml"
@@ -78,6 +83,8 @@ def run_e2e_test(extra_args=None, expected_differences=None):
     if result.exit_code != 0:
         raise result.exception
 
+    # Use absolute paths for expected differences for easier comparisons
+    expected_differences = {output_path.joinpath(key): value for key, value in expected_differences.items()}
     _compare_directories(gr_path, output_path, expected_differences=expected_differences)
 
     import mypy.api
@@ -89,7 +96,7 @@ def run_e2e_test(extra_args=None, expected_differences=None):
 
 
 def test_end_to_end():
-    run_e2e_test()
+    run_e2e_test([], {})
 
 
 def test_custom_templates():
@@ -104,8 +111,7 @@ def test_custom_templates():
 
     golden_tpls_root_dir = Path(__file__).parent.joinpath("custom-templates-golden-record")
     for expected_difference_path in expected_difference_paths:
-        path = Path("my-test-api-client").joinpath(expected_difference_path)
-        expected_differences[path] = (golden_tpls_root_dir / expected_difference_path).read_text()
+        expected_differences[expected_difference_path] = (golden_tpls_root_dir / expected_difference_path).read_text()
 
     run_e2e_test(
         extra_args=["--custom-template-path=end_to_end_tests/test_custom_templates/"],

Diff for: openapi_python_client/__init__.py

@@ -257,7 +257,6 @@ def _build_api(self) -> None:
                 endpoint_init_template.render(endpoint_collection=collection),
                 encoding=self.file_encoding,
             )
-            (tag_dir / "__init__.py").touch()
 
             for endpoint in collection.endpoints:
                 module_path = tag_dir / f"{snake_case(endpoint.name)}.py"