diff --git a/linux_os/guide/system/accounts/accounts-physical/screen_locking/smart_card_login/smartcard_configure_crl/tests/missing_crl.fail.sh b/linux_os/guide/system/accounts/accounts-physical/screen_locking/smart_card_login/smartcard_configure_crl/tests/missing_crl.fail.sh index e6b5f4db001..d84aa2d49d6 100644 --- a/linux_os/guide/system/accounts/accounts-physical/screen_locking/smart_card_login/smartcard_configure_crl/tests/missing_crl.fail.sh +++ b/linux_os/guide/system/accounts/accounts-physical/screen_locking/smart_card_login/smartcard_configure_crl/tests/missing_crl.fail.sh @@ -1,5 +1,5 @@ #!/bin/bash -# platfrom = multi_platfrom_ubuntu +# platform = multi_platform_ubuntu # packages = libpam-pkcs11 if [ ! -f /etc/pam_pkcs11/pam_pkcs11.conf ]; then diff --git a/linux_os/guide/system/network/network-ufw/check_ufw_active/tests/correct.pass.sh b/linux_os/guide/system/network/network-ufw/check_ufw_active/tests/correct.pass.sh index 5ee51b0f77e..9a2f8090b6e 100644 --- a/linux_os/guide/system/network/network-ufw/check_ufw_active/tests/correct.pass.sh +++ b/linux_os/guide/system/network/network-ufw/check_ufw_active/tests/correct.pass.sh @@ -1,4 +1,4 @@ -# package = ufw +# packages = ufw systemctl enable --now ufw ufw allow ssh diff --git a/linux_os/guide/system/network/network-ufw/check_ufw_active/tests/incorrect.fail.sh b/linux_os/guide/system/network/network-ufw/check_ufw_active/tests/incorrect.fail.sh index fb77c940da1..b82e43401e5 100644 --- a/linux_os/guide/system/network/network-ufw/check_ufw_active/tests/incorrect.fail.sh +++ b/linux_os/guide/system/network/network-ufw/check_ufw_active/tests/incorrect.fail.sh @@ -1,4 +1,4 @@ -# package = ufw +# packages = ufw # remediation = none systemctl enable --now ufw diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 5b1778f92d3..b819203fcbf 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -376,3 +376,11 @@ if(PYTHON_VERSION_MAJOR GREATER 2) set_tests_properties("utils-build_control_from_reference_sanity" PROPERTIES FIXTURES_REQUIRED "rule-dir-json") set_tests_properties("utils-build_control_from_reference_sanity" PROPERTIES DEPENDS "test-rule-dir-json") endif() + +if(PYTHON_VERSION_MAJOR GREATER 2 AND PYTHON_VERSION_MINOR GREATER 9) + add_test( + NAME "validate_automatus_metadata" + COMMAND env "PYTHONPATH=$ENV{PYTHONPATH}" "${PYTHON_EXECUTABLE}" "${CMAKE_CURRENT_SOURCE_DIR}/validate_automatus_metadata.py" "--root" "${CMAKE_SOURCE_DIR}" + ) +mypy_test("tests/validate_automatus_metadata.py" "normal") +endif() diff --git a/tests/validate_automatus_metadata.py b/tests/validate_automatus_metadata.py new file mode 100755 index 00000000000..47f5a5671e0 --- /dev/null +++ b/tests/validate_automatus_metadata.py @@ -0,0 +1,66 @@ +#!/usr/bin/python3 + +import argparse +import os +import glob +import sys + +SSG_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), "..")) +VALID_FIELDS = ['check', 'packages', 'platform', 'profiles', 'remediation', 'templates', + 'variables'] +VALID_STATES = ['pass', 'fail', 'notapplicable'] + + +def _parse_args() -> argparse.Namespace: + parser = argparse.ArgumentParser() + parser.add_argument("-r", "--root", required=False, default=SSG_ROOT, + help="Root directory of the project") + return parser.parse_args() + + +def get_files(root: str): + result = glob.glob("linux_os/**/tests/*.sh", recursive=True, root_dir=root) + return result + + +def _test_filename_valid(test_file: str) -> bool: + filename = os.path.basename(test_file) + end_state = filename.split('.') + if len(end_state) == 3 and end_state[1] not in VALID_STATES: + print(f"Invalid expected state '{end_state[1]}' in {test_file}", file=sys.stderr) + return False + return True + + +def _has_invalid_param(root: str, test_file: str) -> bool: + full_path = os.path.join(root, test_file) + with open(full_path, "r") as f: + for line in f: + if not line.startswith("#"): + break + line = line.removeprefix('#') + line = line.strip() + parts = line.split('=') + if len(parts) != 2: + continue + param_name = parts[0].strip() + if param_name not in VALID_FIELDS: + print(f"Invalid field '{param_name}' in {test_file}", file=sys.stderr) + return False + return True + + +def main() -> int: + args = _parse_args() + test_files = get_files(args.root) + return_value = 0 + for test_file in test_files: + if not _test_filename_valid(test_file): + return_value = 1 + if not _has_invalid_param(args.root, test_file): + return_value = 1 + return return_value + + +if __name__ == "__main__": + raise SystemExit(main())