1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
|
"""Shared fixtures and utilities for main integration tests."""
from __future__ import annotations
import importlib.util
import inspect
import shutil
import sys
import time
from argparse import Namespace
from collections.abc import Callable, Generator, Sequence
from pathlib import Path
from typing import Literal
import black
import pytest
from packaging import version
from datamodel_code_generator import DataModelType
from datamodel_code_generator.__main__ import Exit, main
from datamodel_code_generator.util import PYDANTIC_V2
from tests.conftest import (
AssertFileContent,
_validation_stats,
assert_directory_content,
assert_output,
freeze_time,
validate_generated_code,
)
InputFileTypeLiteral = Literal["auto", "openapi", "jsonschema", "json", "yaml", "dict", "csv", "graphql"]
CopyFilesMapping = Sequence[tuple[Path, Path]]
MSGSPEC_LEGACY_BLACK_SKIP = pytest.mark.skipif(
sys.version_info[:2] == (3, 12) and version.parse(black.__version__) < version.parse("24.0.0"),
reason="msgspec.Struct formatting differs with python3.12 + black < 24",
)
LEGACY_BLACK_SKIP = pytest.mark.skipif(
version.parse(black.__version__) < version.parse("24.0.0"),
reason="Type annotation formatting differs with black < 24",
)
from datamodel_code_generator.format import PythonVersion, is_supported_in_black # noqa: E402
BLACK_PY313_SKIP = pytest.mark.skipif(
not is_supported_in_black(PythonVersion.PY_313),
reason=f"Installed black ({black.__version__}) doesn't support Python 3.13",
)
BLACK_PY314_SKIP = pytest.mark.skipif(
not is_supported_in_black(PythonVersion.PY_314),
reason=f"Installed black ({black.__version__}) doesn't support Python 3.14",
)
DATA_PATH: Path = Path(__file__).parent.parent / "data"
EXPECTED_MAIN_PATH: Path = DATA_PATH / "expected" / "main"
PYTHON_DATA_PATH: Path = DATA_PATH / "python"
OPEN_API_DATA_PATH: Path = DATA_PATH / "openapi"
JSON_SCHEMA_DATA_PATH: Path = DATA_PATH / "jsonschema"
GRAPHQL_DATA_PATH: Path = DATA_PATH / "graphql"
JSON_DATA_PATH: Path = DATA_PATH / "json"
CSV_DATA_PATH: Path = DATA_PATH / "csv"
YAML_DATA_PATH: Path = DATA_PATH / "yaml"
ALIASES_DATA_PATH: Path = DATA_PATH / "aliases"
EXPECTED_OPENAPI_PATH: Path = EXPECTED_MAIN_PATH / "openapi"
EXPECTED_JSON_SCHEMA_PATH: Path = EXPECTED_MAIN_PATH / "jsonschema"
EXPECTED_GRAPHQL_PATH: Path = EXPECTED_MAIN_PATH / "graphql"
EXPECTED_JSON_PATH: Path = EXPECTED_MAIN_PATH / "json"
EXPECTED_CSV_PATH: Path = EXPECTED_MAIN_PATH / "csv"
TIMESTAMP = "1985-10-26T01:21:00-07:00"
DEFAULT_FREEZE_TIME = "2019-07-26"
@pytest.fixture(autouse=True)
def reset_namespace(monkeypatch: pytest.MonkeyPatch) -> None:
"""Reset argument namespace before each test."""
namespace_ = Namespace(no_color=False)
monkeypatch.setattr("datamodel_code_generator.__main__.namespace", namespace_)
monkeypatch.setattr("datamodel_code_generator.arguments.namespace", namespace_)
@pytest.fixture(autouse=True)
def auto_freeze_time() -> Generator[None, None, None]:
"""Auto-freeze time for all tests in main/ directory."""
with freeze_time(DEFAULT_FREEZE_TIME):
yield
@pytest.fixture
def output_file(tmp_path: Path) -> Path:
"""Return standard output file path."""
return tmp_path / "output.py"
@pytest.fixture
def output_dir(tmp_path: Path) -> Path:
"""Return standard output directory path."""
return tmp_path / "model"
def _copy_files(copy_files: CopyFilesMapping | None) -> None:
"""Copy files from source to destination paths."""
if copy_files is not None:
for src, dst in copy_files:
shutil.copy(src, dst)
def _assert_exit_code(return_code: Exit, expected_exit: Exit, context: str) -> None:
"""Assert exit code matches expected value."""
if return_code != expected_exit: # pragma: no cover
pytest.fail(f"Expected exit code {expected_exit!r}, got {return_code!r}\n{context}")
def _extend_args(
args: list[str],
*,
input_path: Path | None = None,
output_path: Path | None = None,
input_file_type: InputFileTypeLiteral | None = None,
extra_args: Sequence[str] | None = None,
) -> None:
"""Extend args with optional input_path, output_path, input_file_type and extra_args."""
if input_path is not None:
args.extend(["--input", str(input_path)])
if output_path is not None:
args.extend(["--output", str(output_path)])
if input_file_type is not None:
args.extend(["--input-file-type", input_file_type])
if extra_args is not None:
args.extend(extra_args)
def _run_main(
input_path: Path,
output_path: Path,
input_file_type: InputFileTypeLiteral | None = None,
*,
extra_args: Sequence[str] | None = None,
copy_files: CopyFilesMapping | None = None,
) -> Exit:
"""Execute main() with standard arguments (internal use)."""
_copy_files(copy_files)
args: list[str] = []
_extend_args(
args, input_path=input_path, output_path=output_path, input_file_type=input_file_type, extra_args=extra_args
)
return main(args)
def _run_main_url(
url: str,
output_path: Path,
input_file_type: InputFileTypeLiteral | None = None,
*,
extra_args: Sequence[str] | None = None,
) -> Exit:
"""Execute main() with URL input (internal use)."""
args = ["--url", url]
_extend_args(args, output_path=output_path, input_file_type=input_file_type, extra_args=extra_args)
return main(args)
def run_main_with_args(
args: Sequence[str],
*,
expected_exit: Exit = Exit.OK,
capsys: pytest.CaptureFixture[str] | None = None,
expected_stdout_path: Path | None = None,
) -> Exit:
"""Execute main() with custom arguments.
Args:
args: Command line arguments to pass to main()
expected_exit: Expected exit code (default: Exit.OK)
capsys: pytest capsys fixture for capturing output (required if expected_stdout_path is set)
expected_stdout_path: Path to file with expected stdout content
Returns:
Exit code from main()
"""
__tracebackhide__ = True
return_code = main(list(args))
_assert_exit_code(return_code, expected_exit, f"Args: {args}")
if expected_stdout_path is not None: # pragma: no branch
if capsys is None: # pragma: no cover
pytest.fail("capsys is required when expected_stdout_path is set")
captured = capsys.readouterr()
assert_output(captured.out, expected_stdout_path)
return return_code
def run_main_and_assert( # noqa: PLR0912
*,
input_path: Path | None = None,
output_path: Path | None = None,
input_file_type: InputFileTypeLiteral | None = None,
extra_args: Sequence[str] | None = None,
expected_exit: Exit = Exit.OK,
# Output verification options (use one)
assert_func: AssertFileContent | None = None,
expected_file: str | Path | None = None,
expected_output: str | None = None,
expected_directory: Path | None = None,
output_to_expected: Sequence[tuple[str, str | Path]] | None = None,
file_should_not_exist: Path | None = None,
# Verification options
ignore_whitespace: bool = False,
transform: Callable[[str], str] | None = None,
# Capture options
capsys: pytest.CaptureFixture[str] | None = None,
expected_stdout_path: Path | None = None,
expected_stderr: str | None = None,
expected_stderr_contains: str | None = None,
assert_no_stderr: bool = False,
# Other options
copy_files: CopyFilesMapping | None = None,
# stdin options
stdin_path: Path | None = None,
monkeypatch: pytest.MonkeyPatch | None = None,
# Code validation options
skip_code_validation: bool = False,
) -> None:
"""Execute main() and assert output.
This is the unified helper function for testing file-based input.
Input options:
input_path: Path to input schema file
stdin_path: Path to file that will be used as stdin (requires monkeypatch)
monkeypatch: pytest monkeypatch fixture for mocking stdin
Output options:
output_path: Path to output file/directory (None for stdout-only tests)
Common options:
input_file_type: Type of input file (openapi, jsonschema, graphql, etc.)
extra_args: Additional CLI arguments
expected_exit: Expected exit code (default: Exit.OK)
copy_files: Files to copy before running
Output verification (use one):
assert_func + expected_file: Compare with expected file using assert function
expected_output: Compare with string directly
expected_directory: Compare entire directory
output_to_expected: Compare multiple files
file_should_not_exist: Assert a file does NOT exist
Verification modifiers:
ignore_whitespace: Ignore whitespace when comparing (for expected_output)
transform: Transform output before comparison
Capture verification:
capsys: pytest capsys fixture
expected_stdout_path: Compare stdout with file
expected_stderr: Assert exact stderr match
expected_stderr_contains: Assert stderr contains string
assert_no_stderr: Assert stderr is empty
"""
__tracebackhide__ = True
# Handle stdin input
if stdin_path is not None:
if monkeypatch is None: # pragma: no cover
pytest.fail("monkeypatch is required when using stdin_path")
monkeypatch.setattr("sys.stdin", stdin_path.open(encoding="utf-8"))
args: list[str] = []
_extend_args(args, output_path=output_path, input_file_type=input_file_type, extra_args=extra_args)
return_code = main(args)
# Handle stdout-only output (no output_path)
elif output_path is None:
if input_path is None: # pragma: no cover
pytest.fail("input_path is required when output_path is None")
args = []
_extend_args(args, input_path=input_path, input_file_type=input_file_type, extra_args=extra_args)
return_code = main(args)
# Standard file input
else:
if input_path is None: # pragma: no cover
pytest.fail("input_path is required")
return_code = _run_main(input_path, output_path, input_file_type, extra_args=extra_args, copy_files=copy_files)
_assert_exit_code(return_code, expected_exit, f"Input: {input_path}")
# Handle capture assertions
if capsys is not None and (
expected_stdout_path is not None
or expected_stderr is not None
or expected_stderr_contains is not None
or assert_no_stderr
):
captured = capsys.readouterr()
if expected_stdout_path is not None:
assert_output(captured.out, expected_stdout_path)
if expected_stderr is not None and captured.err != expected_stderr: # pragma: no cover
pytest.fail(f"Expected stderr:\n{expected_stderr}\n\nActual stderr:\n{captured.err}")
if expected_stderr_contains is not None and expected_stderr_contains not in captured.err: # pragma: no cover
pytest.fail(f"Expected stderr to contain: {expected_stderr_contains!r}\n\nActual stderr:\n{captured.err}")
if assert_no_stderr and captured.err: # pragma: no cover
pytest.fail(f"Expected no stderr, but got:\n{captured.err}")
# Skip output verification if expected_exit is not OK
if expected_exit != Exit.OK:
return
# Output verification
if expected_directory is not None:
if output_path is None: # pragma: no cover
pytest.fail("output_path is required when using expected_directory")
assert_directory_content(output_path, expected_directory)
elif output_to_expected is not None:
if output_path is None: # pragma: no cover
pytest.fail("output_path is required when using output_to_expected")
if assert_func is None: # pragma: no cover
pytest.fail("assert_func is required when using output_to_expected")
for output_relative, exp_file in output_to_expected:
assert_func(output_path / output_relative, exp_file)
elif expected_output is not None:
if output_path is None: # pragma: no cover
pytest.fail("output_path is required when using expected_output")
actual_output = output_path.read_text(encoding="utf-8")
if ignore_whitespace:
if "".join(actual_output.split()) != "".join(expected_output.split()): # pragma: no cover
pytest.fail(
f"Output mismatch (ignoring whitespace)\nExpected:\n{expected_output}\n\nActual:\n{actual_output}"
)
elif actual_output != expected_output: # pragma: no cover
pytest.fail(f"Output mismatch\nExpected:\n{expected_output}\n\nActual:\n{actual_output}")
elif file_should_not_exist is not None:
if file_should_not_exist.exists(): # pragma: no cover
pytest.fail(f"File should not exist: {file_should_not_exist}")
elif assert_func is not None:
if output_path is None: # pragma: no cover
pytest.fail("output_path is required when using assert_func")
if expected_file is None: # pragma: no branch
frame = inspect.currentframe()
assert frame is not None
assert frame.f_back is not None
func_name = frame.f_back.f_code.co_name
del frame
for prefix in ("test_main_", "test_"): # pragma: no branch
if func_name.startswith(prefix):
func_name = func_name[len(prefix) :]
break
expected_file = f"{func_name}.py"
assert_func(output_path, expected_file, transform=transform)
if output_path is not None and not skip_code_validation:
_validate_output_files(output_path, extra_args)
def _get_argument_value(arguments: Sequence[str] | None, argument_name: str) -> str | None:
"""Extract argument value from arguments."""
if arguments is None:
return None
argument_list = list(arguments)
for index, argument in enumerate(argument_list):
if argument == argument_name and index + 1 < len(argument_list):
return argument_list[index + 1]
return None
def _parse_target_version(extra_arguments: Sequence[str] | None) -> tuple[int, int] | None:
"""Parse target Python version from arguments."""
if (target_version := _get_argument_value(extra_arguments, "--target-python-version")) is None:
return None
try:
return tuple(int(part) for part in target_version.split(".")) # type: ignore[return-value]
except ValueError: # pragma: no cover
return None
def _should_skip_compile(extra_arguments: Sequence[str] | None) -> bool:
"""Check if compile should be skipped when target version > runtime version."""
if (target_version := _parse_target_version(extra_arguments)) is None:
return False
return target_version > sys.version_info[:2]
def _should_skip_exec(extra_arguments: Sequence[str] | None) -> bool:
"""Check if exec should be skipped based on model type, pydantic version, and Python version."""
output_model_type = _get_argument_value(extra_arguments, "--output-model-type")
is_pydantic_v1 = output_model_type is None or output_model_type == DataModelType.PydanticBaseModel.value
if (is_pydantic_v1 and PYDANTIC_V2) or (
output_model_type == DataModelType.PydanticV2BaseModel.value and not PYDANTIC_V2
):
return True
if (target_version := _parse_target_version(extra_arguments)) is None:
return True
if target_version != sys.version_info[:2]:
return True
return _get_argument_value(extra_arguments, "--base-class") is not None
def _validate_output_files(output_path: Path, extra_arguments: Sequence[str] | None = None) -> None:
"""Validate generated Python files by compiling/executing them."""
if _should_skip_compile(extra_arguments):
return
should_exec = not _should_skip_exec(extra_arguments)
if output_path.is_file() and output_path.suffix == ".py":
validate_generated_code(output_path.read_text(encoding="utf-8"), str(output_path), do_exec=should_exec)
elif output_path.is_dir(): # pragma: no cover
for python_file in output_path.rglob("*.py"):
validate_generated_code(python_file.read_text(encoding="utf-8"), str(python_file), do_exec=False)
if should_exec: # pragma: no cover
_import_package(output_path)
def _import_package(output_path: Path) -> None: # pragma: no cover # noqa: PLR0912
"""Import generated packages to validate they can be loaded."""
if (output_path / "__init__.py").exists():
packages = [(output_path.parent, output_path.name)]
else:
packages = [
(output_path, directory.name)
for directory in output_path.iterdir()
if directory.is_dir() and (directory / "__init__.py").exists()
]
if not packages:
return
imported_modules: list[str] = []
start_time = time.perf_counter()
try:
for parent_directory, package_name in packages:
package_path = parent_directory / package_name
sys.path.insert(0, str(parent_directory))
spec = importlib.util.spec_from_file_location(
package_name, package_path / "__init__.py", submodule_search_locations=[str(package_path)]
)
if spec is None or spec.loader is None:
continue
module = importlib.util.module_from_spec(spec)
sys.modules[package_name] = module
imported_modules.append(package_name)
spec.loader.exec_module(module)
for python_file in package_path.rglob("*.py"):
if python_file.name == "__init__.py":
continue
relative_path = python_file.relative_to(package_path)
module_name = f"{package_name}.{'.'.join(relative_path.with_suffix('').parts)}"
submodule_spec = importlib.util.spec_from_file_location(module_name, python_file)
if submodule_spec is None or submodule_spec.loader is None:
continue
submodule = importlib.util.module_from_spec(submodule_spec)
sys.modules[module_name] = submodule
imported_modules.append(module_name)
submodule_spec.loader.exec_module(submodule)
_validation_stats.record_exec(time.perf_counter() - start_time)
except Exception as exception:
_validation_stats.record_error(str(output_path), f"{type(exception).__name__}: {exception}")
raise
finally:
for parent_directory, _ in packages:
if str(parent_directory) in sys.path:
sys.path.remove(str(parent_directory))
for module_name in imported_modules:
sys.modules.pop(module_name, None)
def run_main_url_and_assert(
*,
url: str,
output_path: Path,
input_file_type: InputFileTypeLiteral | None,
assert_func: AssertFileContent,
expected_file: str | Path,
extra_args: Sequence[str] | None = None,
transform: Callable[[str], str] | None = None,
) -> None:
"""Execute main() with URL input and assert output.
Args:
url: URL to fetch schema from
output_path: Path to output file
input_file_type: Type of input file (openapi, jsonschema, graphql, etc.)
assert_func: The assert_file_content function to use for verification
expected_file: Expected output filename
extra_args: Additional CLI arguments
transform: Optional function to transform output before comparison
"""
__tracebackhide__ = True
return_code = _run_main_url(url, output_path, input_file_type, extra_args=extra_args)
_assert_exit_code(return_code, Exit.OK, f"URL: {url}")
assert_func(output_path, expected_file, transform=transform)
_validate_output_files(output_path, extra_args)
|