-
Notifications
You must be signed in to change notification settings - Fork 32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add wpk test documentation #2409
Conversation
The scheme of proposal 3 has been used until the definitive one is available. Update DocGenerator/config.yaml PEP-8 fixes Closes: #1801
The following tests have been documented: * test_agentd_state.py * test_agentd_state_config.py The scheme of proposal 3 has been used until the definitive one is available. Update DocGenerator/config.yaml PEP-8 fixes Closes: #1801
Migrate `test_agentd` documentation to QA Docs
The scheme of proposal 3 has been used until the definitive one is available. PEP-8 fixes Closes: #1599
…esponse Migrate `test_active_response` documentation to QA Docs
…documentation in QA Docs style The following tests have been documented: * test_check_rare_socket_responses.py * test_check_socket_responses.py * test_validate_linux_analysisd_alerts.py * test_validate_rare_analysisd_alerts.py * test_validate_win32_analysisd_alerts.py * test_validate_win32_analysisd_registry_alerts.py The scheme of proposal 3 has been used until the definitive one is available. Update DocGenerator/config.yaml PEP-8 fixes Closes: #1804
The following tests have been documented: * test_error_messages/test_error_messages.py * test_event_messages/test_event_messages.py * test_integrity_messages/test_integrity_messages.py * test_analysisd/test_scan_messages/test_scan_messages.py Migrated test_mitre/test_mitre_check_alert.py The scheme of proposal 3 has been used until the definitive one is available. PEP-8 fixes Closes: #1804
Migrate `test_analysisd` documentation to QA Docs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GJ, but some changes are required
brief: Register agents in the manager and test upgrading | ||
them through a command, which will made the agent | ||
to upgrade using WPK packages. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
brief: Register agents in the manager and test upgrading | |
them through a command, which will made the agent | |
to upgrade using WPK packages. | |
brief: Register agents in the manager and test upgrading | |
them through a command, which will make the agent | |
to upgrade using WPK packages. |
description: Register agents in the manager and test upgrading | ||
them through a command, which will made the agent | ||
to upgrade using WPK packages. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
description: Register agents in the manager and test upgrading | |
them through a command, which will made the agent | |
to upgrade using WPK packages. | |
description: Register agents in the manager and test upgrading | |
them through a command, which will make the agent | |
to upgrade using WPK packages. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GJ, some changes are required
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Description
As part of epic #1796, this PR adds the missing documentation and 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_wpk
test_wpk_agent.json
test_wpk_manager.json
test_manager_task_states.json
Tests
pycodestyle --max-line-length=120 --show-source --show-pep8 file.py
.python3 DocGenerator.py -s