Rewrite tests to ensure that the typescript output is identical for both v1 and v2 of pydantic; if a project upgrades to pydantic v2, the typescript definitions should not change unnecessarily

Author: phillipdupuis

tests/expected_results/computed_fields/v2/output.ts renamed to tests/expected_results/computed_fields/output.ts

@@ -1,5 +1,6 @@
+from typing import List, Optional
+
 from pydantic import BaseModel
-from typing import Optional, List
 
 
 class LoginCredentials(BaseModel):

tests/expected_results/computed_fields/v2/input.py renamed to tests/expected_results/computed_fields/v2_input.py

@@ -0,0 +1,29 @@
+try:
+    from pydantic.v1 import BaseConfig, BaseModel, Extra
+except ImportError:
+    from pydantic import BaseConfig, BaseModel, Extra
+
+
+class ModelExtraAllow(BaseModel):
+    a: str
+
+    class Config(BaseConfig):
+        extra = Extra.allow
+
+
+class ModelExtraForbid(BaseModel):
+    a: str
+
+    class Config(BaseConfig):
+        extra = Extra.forbid
+
+
+class ModelExtraIgnore(BaseModel):
+    a: str
+
+    class Config(BaseConfig):
+        extra = Extra.ignore
+
+
+class ModelExtraNone(BaseModel):
+    a: str

tests/expected_results/excluding_models/v1/output.ts renamed to tests/expected_results/excluding_models/output.ts

@@ -1,5 +1,6 @@
+from typing import List, Optional
+
 from pydantic import BaseModel
-from typing import Optional, List
 
 
 class LoginCredentials(BaseModel):

tests/expected_results/excluding_models/v1/input.py renamed to tests/expected_results/excluding_models/v1_input.py

@@ -5,8 +5,8 @@
 except ImportError:
     from pydantic import BaseModel
 
-from .animals.cats import Cat
-from .animals.dogs import Dog
+from .v1_animals.cats import Cat
+from .v1_animals.dogs import Dog
 
 
 class AnimalShelter(BaseModel):

tests/expected_results/excluding_models/v2/output.ts

@@ -1,7 +1,7 @@
-from pydantic import BaseModel
-from typing import Optional, Literal
 from enum import Enum
 
+from pydantic import BaseModel
+
 
 class CatBreed(str, Enum):
     domestic_shorthair = "domestic shorthair"

tests/expected_results/excluding_models/v2/input.py renamed to tests/expected_results/excluding_models/v2_input.py

@@ -1,7 +1,7 @@
-from pydantic import BaseModel
-from typing import Optional
 from enum import Enum
 
+from pydantic import BaseModel
+
 
 class DogBreed(str, Enum):
     mutt = "mutt"

tests/expected_results/extra_fields/v2/output.ts renamed to tests/expected_results/extra_fields/output.ts

@@ -2,8 +2,8 @@
 
 from pydantic import BaseModel
 
-from .animals.cats import Cat
-from .animals.dogs import Dog
+from .v2_animals.cats import Cat
+from .v2_animals.dogs import Dog
 
 
 class AnimalShelter(BaseModel):

tests/expected_results/extra_fields/v1/input.py

@@ -16,12 +16,12 @@
 )
 
 
-def _get_input_module(test_name: str, pydantic_version: int) -> str:
-    return str(_RESULTS_DIRECTORY / test_name / f"v{pydantic_version}" / "input.py")
+def _python_module_path(test_name: str, pydantic_version: int) -> str:
+    return str(_RESULTS_DIRECTORY / test_name / f"v{pydantic_version}_input.py")
 
 
-def _get_expected_output(test_name: str, pydantic_version: int) -> str:
-    return (_RESULTS_DIRECTORY / test_name / f"v{pydantic_version}" / "output.ts").read_text()
+def _expected_typescript_code(test_name: str) -> str:
+    return (_RESULTS_DIRECTORY / test_name / "output.ts").read_text()
 
 
 def _run_test(
@@ -37,7 +37,7 @@ def _run_test(
     Execute pydantic2ts logic for converting pydantic models into tyepscript definitions.
     Compare the output with the expected output, verifying it is identical.
     """
-    module_path = module_path or _get_input_module(test_name, pydantic_version)
+    module_path = module_path or _python_module_path(test_name, pydantic_version)
     output_path = str(tmp_path / f"{test_name}_v{pydantic_version}.ts")
 
     if call_from_python:
@@ -48,7 +48,7 @@ def _run_test(
             cmd += f" --exclude {model_to_exclude}"
         subprocess.run(cmd, shell=True, check=True)
 
-    assert Path(output_path).read_text() == _get_expected_output(test_name, pydantic_version)
+    assert Path(output_path).read_text() == _expected_typescript_code(test_name)
 
 
 @pytest.mark.parametrize(
@@ -108,9 +108,8 @@ def test_extra_fields(tmp_path: Path, pydantic_version: int, call_from_python: b
 def test_relative_filepath(tmp_path: Path):
     test_name = "single_module"
     pydantic_version = _PYDANTIC_VERSIONS[0]
-    relative_path = (
-        Path(".") / "tests" / "expected_results" / test_name / f"v{pydantic_version}" / "input.py"
-    )
+    absolute_path = _python_module_path(test_name, pydantic_version)
+    relative_path = Path(absolute_path).relative_to(Path.cwd())
     _run_test(
         tmp_path,
         test_name,
@@ -120,7 +119,7 @@ def test_relative_filepath(tmp_path: Path):
 
 
 def test_error_if_json2ts_not_installed(tmp_path: Path):
-    module_path = _get_input_module("single_module", _PYDANTIC_VERSIONS[0])
+    module_path = _python_module_path("single_module", _PYDANTIC_VERSIONS[0])
     output_path = str(tmp_path / "json2ts_test_output.ts")
 
     # If the json2ts command has no spaces and the executable cannot be found,