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
|
from __future__ import annotations
from argparse import Namespace
from pathlib import Path
from typing import TYPE_CHECKING
import pytest
from freezegun import freeze_time
from datamodel_code_generator import (
DataModelType,
InputFileType,
generate,
snooper_to_methods,
)
from datamodel_code_generator.__main__ import Config, Exit, main
from datamodel_code_generator.format import PythonVersion
if TYPE_CHECKING:
from pytest_mock import MockerFixture
DATA_PATH: Path = Path(__file__).parent.parent / "data"
PYTHON_DATA_PATH: Path = DATA_PATH / "python"
EXPECTED_MAIN_PATH = DATA_PATH / "expected" / "main"
TIMESTAMP = "1985-10-26T01:21:00-07:00"
@pytest.fixture(autouse=True)
def reset_namespace(monkeypatch: pytest.MonkeyPatch) -> None:
namespace_ = Namespace(no_color=False)
monkeypatch.setattr("datamodel_code_generator.__main__.namespace", namespace_)
monkeypatch.setattr("datamodel_code_generator.arguments.namespace", namespace_)
def test_debug(mocker: MockerFixture) -> None:
with pytest.raises(expected_exception=SystemExit):
main(["--debug", "--help"])
mocker.patch("datamodel_code_generator.pysnooper", None)
with pytest.raises(expected_exception=SystemExit):
main(["--debug", "--help"])
@freeze_time("2019-07-26")
def test_snooper_to_methods_without_pysnooper(mocker: MockerFixture) -> None:
mocker.patch("datamodel_code_generator.pysnooper", None)
mock = mocker.Mock()
assert snooper_to_methods()(mock) == mock
@pytest.mark.parametrize(argnames="no_color", argvalues=[False, True])
def test_show_help(no_color: bool, capsys: pytest.CaptureFixture[str]) -> None:
args = ["--no-color"] if no_color else []
args += ["--help"]
with pytest.raises(expected_exception=SystemExit) as context:
main(args)
assert context.value.code == Exit.OK
output = capsys.readouterr().out
assert ("\x1b" not in output) == no_color
def test_show_help_when_no_input(mocker: MockerFixture) -> None:
print_help_mock = mocker.patch("datamodel_code_generator.__main__.arg_parser.print_help")
isatty_mock = mocker.patch("sys.stdin.isatty", return_value=True)
return_code: Exit = main([])
assert return_code == Exit.ERROR
assert isatty_mock.called
assert print_help_mock.called
def test_no_args_has_default(monkeypatch: pytest.MonkeyPatch) -> None:
"""
No argument should have a default value set because it would override pyproject.toml values.
Default values are set in __main__.Config class.
"""
namespace = Namespace()
monkeypatch.setattr("datamodel_code_generator.__main__.namespace", namespace)
main([])
for field in Config.get_fields():
assert getattr(namespace, field, None) is None
@freeze_time("2019-07-26")
def test_space_and_special_characters_dict(tmp_path: Path) -> None:
output_file: Path = tmp_path / "output.py"
return_code: Exit = main([
"--input",
str(PYTHON_DATA_PATH / "space_and_special_characters_dict.py"),
"--output",
str(output_file),
"--input-file-type",
"dict",
])
assert return_code == Exit.OK
assert (
output_file.read_text(encoding="utf-8")
== (EXPECTED_MAIN_PATH / "space_and_special_characters_dict.py").read_text()
)
@freeze_time("2024-12-14")
def test_direct_input_dict(tmp_path: Path) -> None:
output_file = tmp_path / "output.py"
generate(
{"foo": 1, "bar": {"baz": 2}},
input_file_type=InputFileType.Dict,
output=output_file,
output_model_type=DataModelType.PydanticV2BaseModel,
snake_case_field=True,
)
assert output_file.read_text() == (EXPECTED_MAIN_PATH / "direct_input_dict.py").read_text()
@freeze_time(TIMESTAMP)
def test_frozen_dataclasses(tmp_path: Path) -> None:
"""Test --frozen-dataclasses flag functionality."""
output_file = tmp_path / "output.py"
generate(
DATA_PATH / "jsonschema" / "simple_frozen_test.json",
input_file_type=InputFileType.JsonSchema,
output=output_file,
output_model_type=DataModelType.DataclassesDataclass,
frozen_dataclasses=True,
)
assert output_file.read_text() == (EXPECTED_MAIN_PATH / "frozen_dataclasses.py").read_text()
@freeze_time(TIMESTAMP)
def test_frozen_dataclasses_with_keyword_only(tmp_path: Path) -> None:
"""Test --frozen-dataclasses with --keyword-only flag combination."""
output_file = tmp_path / "output.py"
generate(
DATA_PATH / "jsonschema" / "simple_frozen_test.json",
input_file_type=InputFileType.JsonSchema,
output=output_file,
output_model_type=DataModelType.DataclassesDataclass,
frozen_dataclasses=True,
keyword_only=True,
target_python_version=PythonVersion.PY_310,
)
assert output_file.read_text() == (EXPECTED_MAIN_PATH / "frozen_dataclasses_keyword_only.py").read_text()
@freeze_time(TIMESTAMP)
def test_frozen_dataclasses_command_line(tmp_path: Path) -> None:
"""Test --frozen-dataclasses flag via command line."""
output_file: Path = tmp_path / "output.py"
return_code: Exit = main([
"--input",
str(DATA_PATH / "jsonschema" / "simple_frozen_test.json"),
"--output",
str(output_file),
"--input-file-type",
"jsonschema",
"--output-model-type",
"dataclasses.dataclass",
"--frozen-dataclasses",
])
assert return_code == Exit.OK
assert output_file.read_text(encoding="utf-8") == (EXPECTED_MAIN_PATH / "frozen_dataclasses.py").read_text()
@freeze_time(TIMESTAMP)
def test_frozen_dataclasses_with_keyword_only_command_line(tmp_path: Path) -> None:
"""Test --frozen-dataclasses with --keyword-only flag via command line."""
output_file: Path = tmp_path / "output.py"
return_code: Exit = main([
"--input",
str(DATA_PATH / "jsonschema" / "simple_frozen_test.json"),
"--output",
str(output_file),
"--input-file-type",
"jsonschema",
"--output-model-type",
"dataclasses.dataclass",
"--frozen-dataclasses",
"--keyword-only",
"--target-python-version",
"3.10",
])
assert return_code == Exit.OK
assert (
output_file.read_text(encoding="utf-8")
== (EXPECTED_MAIN_PATH / "frozen_dataclasses_keyword_only.py").read_text()
)
def test_filename_with_newline_injection(tmp_path: Path) -> None:
"""Test that filenames with newlines cannot inject code into generated files"""
schema_content = """{"type": "object", "properties": {"name": {"type": "string"}}}"""
malicious_filename = """schema.json
# INJECTED CODE:
import os
os.system('echo INJECTED')
# END INJECTION"""
output_path = tmp_path / "output.py"
generate(
input_=schema_content,
input_filename=malicious_filename,
input_file_type=InputFileType.JsonSchema,
output=output_path,
)
generated_content = output_path.read_text()
assert "# filename: schema.json # INJECTED CODE: import os" in generated_content, (
"Filename not properly sanitized"
)
assert not any(
line.strip().startswith("import os") and not line.strip().startswith("#")
for line in generated_content.split("\n")
)
assert not any("os.system" in line and not line.strip().startswith("#") for line in generated_content.split("\n"))
compile(generated_content, str(output_path), "exec")
def test_filename_with_various_control_characters(tmp_path: Path) -> None:
"""Test that various control characters in filenames are properly sanitized"""
schema_content = """{"type": "object", "properties": {"test": {"type": "string"}}}"""
test_cases = [
("newline", "schema.json\nimport os; os.system('echo INJECTED')"),
("carriage_return", "schema.json\rimport os; os.system('echo INJECTED')"),
("crlf", "schema.json\r\nimport os; os.system('echo INJECTED')"),
("tab_newline", "schema.json\t\nimport os; os.system('echo TAB')"),
("form_feed", "schema.json\f\nimport os; os.system('echo FF')"),
("vertical_tab", "schema.json\v\nimport os; os.system('echo VT')"),
("unicode_line_separator", "schema.json\u2028import os; os.system('echo U2028')"),
("unicode_paragraph_separator", "schema.json\u2029import os; os.system('echo U2029')"),
("multiple_newlines", "schema.json\n\n\nimport os; os.system('echo MULTI')"),
("mixed_characters", "schema.json\n\r\t\nimport os; os.system('echo MIXED')"),
]
for test_name, malicious_filename in test_cases:
output_path = tmp_path / "output.py"
generate(
input_=schema_content,
input_filename=malicious_filename,
input_file_type=InputFileType.JsonSchema,
output=output_path,
)
generated_content = output_path.read_text()
assert not any(
line.strip().startswith("import ") and not line.strip().startswith("#")
for line in generated_content.split("\n")
), f"Injection found for {test_name}"
assert not any(
"os.system" in line and not line.strip().startswith("#") for line in generated_content.split("\n")
), f"System call found for {test_name}"
compile(generated_content, str(output_path), "exec")
|