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
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)

    # Compatibility hacks:
    # `_v2_users_get_200.json` needs to have the object added to an array and overwritten
    with open(test_data_path / "_v2_users_get_200.json") as f:
        _v2_users_get_200 = f.read()

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

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