Migrate test_rootcheck documentation to qa-docs
#2194
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fernandolojano
changed the title
test_rootcheck documentation to qa-docs
5 tasks
snaow
approved these changes
Nov 30, 2021
snaow
deleted the
1818-migrate-test-rootcheck-documentation-schema-2.0
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
As part of epic #1796 and the issue #1818, this PR adds the missing documentation of
test_rootcheckand migrates the current documentation to the new format used by qa-docs.The schema used is the one defined in issue #1694
Generated documentation
test_rootchecktest_rootcheck.json
{ "copyright": "Copyright (C) 2015-2021, Wazuh Inc. Created by Wazuh, Inc. <info@wazuh.com>. This program is free software; you can redistribute it and/or modify it under the terms of GPLv2", "type": "integration", "brief": "The 'rootcheck' tool allows to define policies in order to check if the agents meet the requirement specified. The rootcheck engine can check if a process is running, if a file is present and if the content of a file contains a pattern, or if a Windows registry key contains a string or is simply present.", "tier": 0, "modules": [ "rootcheck" ], "components": [ "manager" ], "daemons": [ "wazuh-analysisd" ], "os_platform": [ "linux" ], "os_version": [ "Arch Linux", "Amazon Linux 2", "Amazon Linux 1", "CentOS 8", "CentOS 7", "CentOS 6", "Ubuntu Focal", "Ubuntu Bionic", "Ubuntu Xenial", "Ubuntu Trusty", "Debian Buster", "Debian Stretch", "Debian Jessie", "Debian Wheezy", "Red Hat 8", "Red Hat 7", "Red Hat 6" ], "references": [ "https://documentation.wazuh.com/current/user-manual/capabilities/policy-monitoring/rootcheck", "https://documentation.wazuh.com/current/user-manual/reference/daemons/wazuh-analysisd.html" ], "tags": [ "rootcheck" ], "name": "test_rootcheck.py", "id": 1, "group_id": 0, "path": "tests/integration/test_rootcheck/test_rootcheck.py", "tests": [ { "description": "Check if the 'rootcheck' modules is working properly, that is, by checking if the created logs are added, updated and deleted correctly. For this purpose, the test will create a specific number of agents, and will check if they have the rootcheck module enabled. Once this check is proven, it lets the rootcheck events to be sent for 60 seconds. After the time has passed, the rootcheck module gets disabled and the test then checks if the logs have been added to the database. After this first procedure, the test restarts the service and let the rootcheck events to be sent for 60 seconds for checking after that time if the logs have been updated with the new entries. Lastly, the tests also checks if the logs are deleted from the database when sending the delete table request.", "wazuh_min_version": "4.2.0", "parameters": [ { "get_configuration": { "type": "fixture", "brief": "Get configurations from the module." } }, { "configure_environment": { "type": "fixture", "brief": "Configure a custom environment for testing." } }, { "restart_service": { "type": "fixture", "brief": "restart the services" } }, { "clean_alert_logs": [ { "type": "fixture" }, { "brief": "reset the content of the alert logs" } ] } ], "assertions": [ "Verify that rootcheck events are added into the database", "Verify that the rootcheck events are updated on the database", "Verify that the rootcheck events are deletet from the database" ], "input_description": "Different test cases are contained in an external YAML file (wazuh_manager_conf.yaml) which includes configuration settings for the 'rootcheck' module.", "expected_output": [ "r'.*not found in Database'", "r'.*not found in alerts file'", "r'.*not found in Database'", "First time in log was updated after insertion", "Updated time in log was not updated", "Wazuh DB returned an error trying to delete the agent", "Rootcheck events were not deleted" ], "tags": [ "rootcheck" ], "name": "test_rootcheck", "inputs": [ "check_updates:False, check_delete:False, 1_agents", "check_updates:False, check_delete:False, 3_agents", "check_updates:True, check_delete:False, 1_agents", "check_updates:True, check_delete:False, 3_agents", "check_updates:False, check_delete:True, 1_agents", "check_updates:False, check_delete:True, 3_agents" ] } ] }test_rootcheck.yaml
Tests
pycodestyle --max-line-length=120 --show-source --show-pep8 file.py.qa-docstool does not raise any error.