Migrate test_analysisd
documentation to QA Docs
#1834
Merged
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, this PR adds the missing documentation and migrates the current documentation to the new format used by QA Docs.
The used schema is provisional (third proposal of issue #1694) until we have the definitive one.
Docs example
test_check_rare_socket_responses.yaml
test_check_socket_responses.yaml
test_validate_linux_analysisd_alerts.yaml
test_validate_rare_analysisd_alerts.yaml
test_validate_win32_analysisd_alerts.yaml
test_validate_win32_analysisd_registry_alerts.yaml
test_error_messages.yaml
test_event_messages.yaml
test_integrity_messages.yaml
test_mitre_check_alert.yaml
test_scan_messages.yaml
Tests
pycodestyle --max-line-length=120 --show-source --show-pep8 file.py
.python3 DocGenerator.py -s