Skip to content

write_all_response_examples_for_tests

Write all example responses to a file in the tests/test_data directory.

write_all_example_responses 

write_all_example_responses(
    *, test_data_path: Path | None = None
) -> None

Write all example responses to a file in the test_data directory.

Source code in horde_sdk/scripts/write_all_response_examples_for_tests.py 
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
def write_all_example_responses(*, test_data_path: Path | None = None) -> None:
    """Write all example responses to a file in the test_data directory."""
    ai_horde_swagger_doc = SwaggerParser(
        swagger_doc_url=get_ai_horde_swagger_url(),
    ).get_swagger_doc()
    if not test_data_path:
        test_data_path = (
            Path(__file__).parent.parent.parent / "tests" / "test_data" / "ai_horde_api" / "example_responses"
        )
    ai_horde_swagger_doc.write_all_response_examples_to_file(test_data_path)

    files_to_make_arrays = [
        "_v2_users_get_200.json",
    ]
    # Compatibility hacks:

    for file_name in files_to_make_arrays:
        if not (test_data_path / file_name).exists():
            logger.warning(f"File {file_name} does not exist, skipping compatibility hack.")
            continue

        file_contents: str | None = None
        with open(test_data_path / file_name) as f:
            file_contents = f.read()

        if file_contents is None:
            logger.warning(f"File {file_name} is empty, skipping compatibility hack.")
            continue

        if not file_contents.startswith("["):
            logger.warning(
                f"The {file_name} file is not an array, converting it to one to make it compatible with the tests. "
                f"This is a compatibility hack due to the API docs not being correct.",
            )
            file_contents = f"[{file_contents}]"
            file_contents = json.loads(file_contents)

            with open(test_data_path / file_name, "w") as f:
                json.dump(file_contents, f, indent=4)
                f.write("\n")
        else:
            logger.info(f"The {file_name} file is already compatible with the tests.")
            logger.info("This script should be updated to remove this compatibility hack.")

    files_to_make_objects = [
        "_v2_filters_filter_id_get_200.json",
    ]

    # Compatibility hacks:
    for file_name in files_to_make_objects:
        if not (test_data_path / file_name).exists():
            logger.warning(f"File {file_name} does not exist, skipping compatibility hack.")
            continue

        file_contents_object: str | None = None
        with open(test_data_path / file_name) as f:
            file_contents_object = f.read()

        if file_contents_object is None:
            logger.warning(f"File {file_name} is empty, skipping compatibility hack.")
            continue

        if file_contents_object.startswith("["):
            logger.warning(
                f"The {file_name} file is an array, converting it to an object to make it compatible with the tests. "
                f"This is a compatibility hack due to the API docs not being correct.",
            )
            file_contents_object = file_contents_object.strip().strip("[]").strip()
            file_contents_object = json.loads(file_contents_object)

            with open(test_data_path / file_name, "w") as f:
                json.dump(file_contents_object, f, indent=4)
                f.write("\n")

        else:
            logger.info(f"The {file_name} file is already compatible with the tests.")
            logger.info("This script should be updated to remove this compatibility hack.")