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 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
|
import logging
from textwrap import dedent
from unittest.mock import ANY
import pytest
from pytest_mock import MockerFixture
from dataclass_wizard.wizard_cli import main, PyCodeGenerator
from ..conftest import data_file_path
log = logging.getLogger(__name__)
def gen_schema(filename: str):
"""
Helper function to call `wiz gen-schema` and pass the full path to a test
file in the `testdata` directory.
"""
main(['gs', data_file_path(filename), '-'])
def assert_py_code(expected, capfd=None, py_code=None):
"""
Helper function to assert that generated Python code is as expected.
"""
if py_code is None:
py_code = _get_captured_py_code(capfd)
# TODO update to `info` level to see the output in terminal.
log.debug('Generated Python code:\n%s\n%s',
'-' * 20, py_code)
assert py_code == dedent(expected).lstrip()
def _get_captured_py_code(capfd) -> str:
"""Reads the Python code which is written to stdout."""
out, err = capfd.readouterr()
assert not err
py_code_lines = out.split('\n')[4:]
py_code = '\n'.join(py_code_lines)
return py_code
@pytest.fixture
def mock_path(mocker: MockerFixture):
return mocker.patch('dataclass_wizard.wizard_cli.schema.Path')
@pytest.fixture
def mock_stdin(mocker: MockerFixture):
return mocker.patch('sys.stdin')
@pytest.fixture
def mock_open(mocker: MockerFixture):
return mocker.patch('dataclass_wizard.wizard_cli.cli.open')
def test_call_py_code_generator_with_file_name(mock_path):
"""
Test calling the constructor for :class:`PyCodeGenerator` with the
`file_name` argument. Added for code coverage.
"""
mock_path().read_bytes.return_value = b'{"key": "1.23", "secondKey": null}'
expected = '''
from dataclasses import dataclass
from typing import Any
from dataclass_wizard import JSONWizard
@dataclass
class Data(JSONWizard):
"""
Data dataclass
"""
key: float
second_key: Any
'''
code_gen = PyCodeGenerator(file_name='my_file.txt',
force_strings=True)
assert_py_code(expected, py_code=code_gen.py_code)
def test_call_py_code_generator_with_experimental_features():
"""
Test calling the constructor for :class:`PyCodeGenerator` with the
`-x|--experimental` flag.
"""
string = """\
{"someField": null, "Some_List": [],
"Objects": [{"key1": false},
{"key1": 1.2, "key2": "string"},
{"key1": "val", "key2": null}]
}\
"""
expected = '''
from __future__ import annotations
from dataclasses import dataclass
from typing import Any
from dataclass_wizard import JSONWizard
@dataclass
class Data(JSONWizard):
"""
Data dataclass
"""
some_field: Any
some_list: list
objects: list[Object]
@dataclass
class Object:
"""
Object dataclass
"""
key1: bool | float | str
key2: str | None
'''
code_gen = PyCodeGenerator(file_contents=string,
experimental=True,
force_strings=True)
assert_py_code(expected, py_code=code_gen.py_code)
def test_call_wiz_cli_without_subcommand():
"""
Calling wiz-cli without a sub-command. Added for code coverage.
"""
with pytest.raises(SystemExit) as e:
main([])
assert e.value.code == 0
def test_call_wiz_cli_with_invalid_json_input(capsys, mock_stdin):
"""
Calling wiz-cli with invalid JSON as input. Added for code coverage.
"""
invalid_json = '{"key": "value"'
mock_stdin.name = '<stdin>'
mock_stdin.read.return_value = invalid_json
with capsys.disabled():
with pytest.raises(SystemExit) as e:
main(['gs', '-', '-'])
assert 'JSONDecodeError' in e.value.code
def test_call_wiz_cli_with_invalid_json_type(capsys, mock_stdin):
"""
Calling wiz-cli when input is valid JSON, but not a valid JSON object
(list or dictionary type). Added for code coverage.
"""
invalid_json = '"my string value"'
mock_stdin.name = '<stdin>'
mock_stdin.read.return_value = invalid_json
with capsys.disabled():
with pytest.raises(SystemExit) as e:
main(['gs', '-', '-'])
assert 'TypeError' in e.value.code
def test_call_wiz_cli_when_double_quotes_are_used_to_wrap_input(
capsys, mock_stdin):
"""
Calling wiz-cli when input is piped via stdin and the string is wrapped
with double quotes instead of single quotes. Added for code coverage.
"""
# Note: this can be the result of the following command:
# echo "{"key": "value"}" | wiz gs
invalid_json = '\"{"key": "value"}\"'
mock_stdin.name = '<stdin>'
mock_stdin.read.return_value = invalid_json
with capsys.disabled():
with pytest.raises(SystemExit) as e:
main(['gs', '-'])
log.debug(e.value.code)
assert 'double quotes' in e.value.code
def test_call_wiz_cli_with_mock_stdout(capsys, mock_stdin, mocker):
"""
Calling wiz-cli with mock stdout. Added for code coverage.
"""
valid_json = '{"key": "value"}'
mock_stdin.name = '<stdin>'
mock_stdin.read.return_value = valid_json
with capsys.disabled():
mock_stdout = mocker.patch('sys.stdout')
mock_stdout.name = '<stdout>'
mock_stdout.isatty.return_value = False
main(['gs', '-', '-'])
mock_stdout.write.assert_called()
def test_call_wiz_cli_with_output_filename_without_ext(
mocker, mock_stdin, mock_open):
"""
Calling wiz-cli with an output filename without an extension. The
extension should automatically be added.
"""
valid_json = '{"key": "value"}'
mock_out = mocker.Mock()
mock_out.name = 'testing'
mock_out.fileno.return_value = 0
mock_open.return_value = mock_out
mock_stdin.name = '<stdin>'
mock_stdin.read.return_value = valid_json
main(['gs', '-', 'testing'])
mock_open.assert_called_once_with(
'testing.py', 'w', ANY, ANY, ANY)
mock_out.write.assert_called_once()
def test_call_wiz_cli_when_open_raises_error(
mocker, mock_stdin, mock_open):
"""
Calling wiz-cli with an error is raised opening the JSON file.
"""
valid_json = '{"key": "value"}'
mock_open.side_effect = OSError
mock_stdin.name = '<stdin>'
mock_stdin.read.return_value = valid_json
with pytest.raises(SystemExit) as e:
main(['gs', '-', 'testing'])
mock_open.assert_called_once()
def test_star_wars(capfd):
expected = '''
from dataclasses import dataclass
from datetime import datetime
from typing import List, Union
from dataclass_wizard import JSONWizard
@dataclass
class Data(JSONWizard):
"""
Data dataclass
"""
name: str
rotation_period: Union[int, str]
orbital_period: Union[int, str]
diameter: Union[int, str]
climate: str
gravity: str
terrain: str
surface_water: Union[int, str]
population: Union[int, str]
residents: List
films: List[str]
created: datetime
edited: datetime
url: str
'''
gen_schema('star_wars.json')
assert_py_code(expected, capfd)
def test_input_1(capfd):
expected = '''
from dataclasses import dataclass
from dataclass_wizard import JSONWizard
@dataclass
class Data(JSONWizard):
"""
Data dataclass
"""
key: str
int_key: int
float_key: float
my_dict: 'MyDict'
@dataclass
class MyDict:
"""
MyDict dataclass
"""
key2: str
'''
gen_schema('test1.json')
assert_py_code(expected, capfd)
def test_input_2(capfd):
expected = '''
from dataclasses import dataclass
from datetime import datetime
from typing import Optional, Union
from dataclass_wizard import JSONWizard
@dataclass
class Container:
"""
Container dataclass
"""
data: 'Data'
field_1: int
field_2: str
@dataclass
class Data(JSONWizard):
"""
Data dataclass
"""
key: Optional[str]
another_key: Optional[Union[str, int]]
truth: int
my_list: 'MyList'
my_date: datetime
my_id: str
@dataclass
class MyList:
"""
MyList dataclass
"""
pass
'''
gen_schema('test2.json')
assert_py_code(expected, capfd)
def test_input_3(capfd):
expected = '''
from dataclasses import dataclass
from typing import List, Union
from dataclass_wizard import JSONWizard
@dataclass
class Container:
"""
Container dataclass
"""
data: 'Data'
field_1: int
field_2: int
field_3: str
field_4: bool
@dataclass
class Data(JSONWizard):
"""
Data dataclass
"""
true_story: Union[str, int]
true_bool: bool
my_list: List[Union[int, 'MyList']]
@dataclass
class MyList:
"""
MyList dataclass
"""
hey: str
'''
gen_schema('test3.json')
assert_py_code(expected, capfd)
def test_input_4(capfd):
expected = '''
from dataclasses import dataclass
from typing import Union
from dataclass_wizard import JSONWizard
@dataclass
class Container:
"""
Container dataclass
"""
data: 'Data'
@dataclass
class Data(JSONWizard):
"""
Data dataclass
"""
input_index: int
candidate_index: int
delivery_line_1: str
last_line: str
delivery_point_barcode: Union[int, str]
components: 'Components'
metadata: 'Metadata'
analysis: 'Analysis'
@dataclass
class Components:
"""
Components dataclass
"""
primary_number: Union[int, str]
street_predirection: Union[bool, str]
street_name: str
street_suffix: str
city_name: str
state_abbreviation: str
zipcode: Union[int, str]
plus4_code: Union[int, str]
delivery_point: Union[int, str]
delivery_point_check_digit: Union[int, str]
@dataclass
class Metadata:
"""
Metadata dataclass
"""
record_type: str
zip_type: str
county_fips: Union[int, str]
county_name: str
carrier_route: str
congressional_district: Union[int, str]
rdi: str
elot_sequence: Union[int, str]
elot_sort: str
latitude: float
longitude: float
precision: str
time_zone: str
utc_offset: int
dst: bool
@dataclass
class Analysis:
"""
Analysis dataclass
"""
dpv_match_code: Union[bool, str]
dpv_footnotes: str
dpv_cmra: Union[bool, str]
dpv_vacant: Union[bool, str]
active: Union[bool, str]
'''
gen_schema('test4.json')
assert_py_code(expected, capfd)
def test_input_5(capfd):
expected = '''
from dataclasses import dataclass
from typing import List, Union
from dataclass_wizard import JSONWizard
@dataclass
class Container:
"""
Container dataclass
"""
data: 'Data'
field_1: List[Union[List[Union[str, 'Data2']], int, str]]
@dataclass
class Data(JSONWizard):
"""
Data dataclass
"""
key: str
@dataclass
class Data2:
"""
Data2 dataclass
"""
key: int
nested_classes: 'NestedClasses'
@dataclass
class NestedClasses:
"""
NestedClasses dataclass
"""
blah: str
another_one: List['AnotherOne']
just_something_with_a_space: int
@dataclass
class AnotherOne:
"""
AnotherOne dataclass
"""
testing: str
'''
gen_schema('test5.json')
assert_py_code(expected, capfd)
def test_input_6(capfd):
expected = '''
from dataclasses import dataclass
from datetime import date, time
from typing import List, Union
from dataclass_wizard import JSONWizard
@dataclass
class Data(JSONWizard):
"""
Data dataclass
"""
my_field: str
another_field: date
my_list: List[Union[int, 'MyList', List['Data2']]]
@dataclass
class MyList:
"""
MyList dataclass
"""
another_key: str
@dataclass
class Data2:
"""
Data2 dataclass
"""
key: str
my_time: time
'''
gen_schema('test6.json')
assert_py_code(expected, capfd)
def test_input_7(capfd):
expected = '''
from dataclasses import dataclass
from typing import List, Union
from dataclass_wizard import JSONWizard
@dataclass
class Container:
"""
Container dataclass
"""
data: 'Data'
@dataclass
class Data(JSONWizard):
"""
Data dataclass
"""
my_test_apis: List['MyTestApi']
people: List['Person']
children: List['Child']
activities: List['Activity']
equipment: List['Equipment']
key: int
nested_classes: 'NestedClasses'
something_else: str
@dataclass
class MyTestApi:
"""
MyTestApi dataclass
"""
first_api: str
@dataclass
class Person:
"""
Person dataclass
"""
name: str
age: Union[int, str]
@dataclass
class Child:
"""
Child dataclass
"""
name: str
age: Union[int, float]
@dataclass
class Activity:
"""
Activity dataclass
"""
name: str
@dataclass
class Equipment:
"""
Equipment dataclass
"""
count: int
@dataclass
class NestedClasses:
"""
NestedClasses dataclass
"""
blah: str
another_one: List['AnotherOne']
just_something: int
@dataclass
class AnotherOne:
"""
AnotherOne dataclass
"""
testing: str
'''
gen_schema('test7.json')
assert_py_code(expected, capfd)
def test_input_8(capfd):
expected = '''
from dataclasses import dataclass
from typing import List, Optional, Union
from dataclass_wizard import JSONWizard
@dataclass
class Container:
"""
Container dataclass
"""
data: 'Data'
field_1: List['Data1']
field_2: List['Data2']
field_3: List['Data3']
@dataclass
class Data(JSONWizard):
"""
Data dataclass
"""
list_of_dictionaries: List['ListOfDictionary']
@dataclass
class ListOfDictionary:
"""
ListOfDictionary dataclass
"""
my_energies: List[Union['MyEnergy', int, str]]
key: Optional[str]
@dataclass
class MyEnergy:
"""
MyEnergy dataclass
"""
my_test_val: Union[bool, int]
another_val: str
string_val: str
merged_float: float
@dataclass
class Data1:
"""
Data1 dataclass
"""
key: str
another_key: str
@dataclass
class Data2:
"""
Data2 dataclass
"""
question: str
@dataclass
class Data3:
"""
Data3 dataclass
"""
explanation: str
'''
gen_schema('test8.json')
assert_py_code(expected, capfd)
|