mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2025-11-04 00:36:21 +00:00
3421b2303b
Added bandit checks to continuous integration. Updated sources to pass bandit checks: - replaced asserts - added timeouts to requests - added checks for process command execution - changed to 127.0.0.1 as default IP address for EOS and EOSdash for security reasons Added a rudimentary check for outdated config files. BREAKING CHANGE: Default IP address for EOS and EOSdash changed to 127.0.0.1 Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
104 lines
4.0 KiB
Python
104 lines
4.0 KiB
Python
import json
|
||
import os
|
||
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"
|
||
|
||
with expected_spec_path.open("r", encoding="utf-8", newline=None) as f_expected:
|
||
expected_spec = json.load(f_expected)
|
||
|
||
# Patch get_config and import within guard to patch global variables within the eos 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
|
||
|
||
spec = generate_openapi.generate_openapi()
|
||
spec_str = json.dumps(spec, indent=4, sort_keys=True)
|
||
|
||
with new_spec_path.open("w", encoding="utf-8", newline="\n") as f_new:
|
||
f_new.write(spec_str)
|
||
|
||
# Serialize to ensure comparison is consistent
|
||
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: `make gen-docs` or `cp {new_spec_path} {expected_spec_path}`\n"
|
||
)
|
||
|
||
|
||
def test_openapi_md_current(config_eos):
|
||
"""Verify the generated openapi markdown hasn´t changed."""
|
||
expected_spec_md_path = DIR_PROJECT_ROOT / "docs" / "_generated" / "openapi.md"
|
||
new_spec_md_path = DIR_TESTDATA / "openapi-new.md"
|
||
|
||
with expected_spec_md_path.open("r", encoding="utf-8", newline=None) as f_expected:
|
||
expected_spec_md = f_expected.read()
|
||
|
||
# Patch get_config and import within guard to patch global variables within the eos 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_md
|
||
|
||
spec_md = generate_openapi_md.generate_openapi_md()
|
||
|
||
with new_spec_md_path.open("w", encoding="utf-8", newline="\n") as f_new:
|
||
f_new.write(spec_md)
|
||
|
||
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: `make gen-docs` or `cp {new_spec_md_path} {expected_spec_md_path}`\n"
|
||
)
|
||
|
||
|
||
def test_config_md_current(config_eos):
|
||
"""Verify the generated configuration markdown hasn´t changed."""
|
||
expected_config_md_path = DIR_PROJECT_ROOT / "docs" / "_generated" / "config.md"
|
||
new_config_md_path = DIR_TESTDATA / "config-new.md"
|
||
|
||
with expected_config_md_path.open("r", encoding="utf-8", newline=None) as f_expected:
|
||
expected_config_md = f_expected.read()
|
||
|
||
# Patch get_config and import within guard to patch global variables within the eos 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_config_md
|
||
|
||
config_md = generate_config_md.generate_config_md(config_eos)
|
||
|
||
if os.name == "nt":
|
||
config_md = config_md.replace("\\\\", "/")
|
||
with new_config_md_path.open("w", encoding="utf-8", newline="\n") as f_new:
|
||
f_new.write(config_md)
|
||
|
||
try:
|
||
assert config_md == expected_config_md
|
||
except AssertionError as e:
|
||
pytest.fail(
|
||
f"Expected {new_config_md_path} to equal {expected_config_md_path}.\n"
|
||
+ f"If ok: `make gen-docs` or `cp {new_config_md_path} {expected_config_md_path}`\n"
|
||
)
|