mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2025-04-17 07:55:15 +00:00
1866055478
Add documentation that covers: - Prediction - Measuremnt - REST API Add Python scripts that support automatic documentation generation using the Sphinx sphinxcontrib.eval extension. Add automatic update/ test for REST API documentation. Filter proxy endpoints from REST API documentation. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
57 lines
2.1 KiB
Python
57 lines
2.1 KiB
Python
import json
|
||
import sys
|
||
from pathlib import Path
|
||
from unittest.mock import patch
|
||
|
||
import pytest
|
||
|
||
DIR_PROJECT_ROOT = Path(__file__).parent.parent
|
||
DIR_TESTDATA = Path(__file__).parent / "testdata"
|
||
|
||
|
||
def test_openapi_spec_current(config_eos):
|
||
"""Verify the openapi spec hasn´t changed."""
|
||
expected_spec_path = DIR_PROJECT_ROOT / "openapi.json"
|
||
new_spec_path = DIR_TESTDATA / "openapi-new.json"
|
||
expected_spec_md_path = DIR_TESTDATA / "openapi.md"
|
||
new_spec_md_path = DIR_TESTDATA / "openapi-new.md"
|
||
|
||
with open(expected_spec_path) as f_expected:
|
||
expected_spec = json.load(f_expected)
|
||
with open(expected_spec_md_path) as f_expected:
|
||
expected_spec_md = f_expected.read()
|
||
|
||
# Patch get_config and import within guard to patch global variables within the fastapi_server module.
|
||
with patch("akkudoktoreos.config.config.get_config", return_value=config_eos):
|
||
# Ensure the script works correctly as part of a package
|
||
root_dir = Path(__file__).resolve().parent.parent
|
||
sys.path.insert(0, str(root_dir))
|
||
from scripts import generate_openapi, generate_openapi_md
|
||
|
||
spec = generate_openapi.generate_openapi()
|
||
spec_md = generate_openapi_md.generate_openapi_md()
|
||
|
||
with open(new_spec_path, "w") as f_new:
|
||
json.dump(spec, f_new, indent=4, sort_keys=True)
|
||
with open(new_spec_md_path, "w") as f_new:
|
||
f_new.write(spec_md)
|
||
|
||
# Serialize to ensure comparison is consistent
|
||
spec_str = json.dumps(spec, indent=4, sort_keys=True)
|
||
expected_spec_str = json.dumps(expected_spec, indent=4, sort_keys=True)
|
||
|
||
try:
|
||
assert spec_str == expected_spec_str
|
||
except AssertionError as e:
|
||
pytest.fail(
|
||
f"Expected {new_spec_path} to equal {expected_spec_path}.\n"
|
||
+ f"If ok: cp {new_spec_path} {expected_spec_path}\n"
|
||
)
|
||
try:
|
||
assert spec_md == expected_spec_md
|
||
except AssertionError as e:
|
||
pytest.fail(
|
||
f"Expected {new_spec_md_path} to equal {expected_spec_md_path}.\n"
|
||
+ f"If ok: cp {new_spec_md_path} {expected_spec_md_path}\n"
|
||
)
|