Migrate test_office365 documentation to qa-docs
#2181
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
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, 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
New tags
The following tags are added to the wiki:
office365_configurationGenerated documentation
test_invalid.json
{ "copyright": "Copyright (C) 2015-2021, Wazuh Inc.\nCreated by Wazuh, Inc. <info@wazuh.com>.\nThis program is free software; you can redistribute it and/or modify it under the terms of GPLv2", "type": "integration", "brief": "The Wazuh 'office365' module allows you to collect all the logs from Office 365 using its API. Specifically, these tests will check if that module detects invalid configurations and indicates the location of the errors detected. The Office 365 Management Activity API aggregates actions and events into tenant-specific content blobs, which are classified by the type and source of the content they contain.", "tier": 0, "modules": [ "office365" ], "components": [ "manager" ], "daemons": [ "wazuh-analysisd", "wazuh-monitord", "wazuh-modulesd" ], "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://github.com/wazuh/wazuh-documentation/blob/develop/source/office365/index.rst", "https://github.com/wazuh/wazuh-documentation/blob/develop/source/office365/monitoring-office365-activity.rst" ], "tags": [ "office365_configuration" ], "name": "test_invalid.py", "id": 1, "group_id": 0, "tests": [ { "description": "Check if the 'office365' module detects invalid configurations. For this purpose, the test will configure that module using invalid configuration settings with different attributes. Finally, it will verify that error events are generated indicating the source of the errors.", "wazuh_min_version": "4.2.0", "parameters": [ { "get_local_internal_options": { "type": "fixture", "brief": "Get internal configuration." } }, { "configure_local_internal_options": { "type": "fixture", "brief": "Set internal configuration for testing." } }, { "get_configuration": { "type": "fixture", "brief": "Get configurations from the module." } }, { "configure_environment": { "type": "fixture", "brief": "Configure a custom environment for testing." } }, { "reset_ossec_log": { "type": "fixture", "brief": "Reset the 'ossec.log' file and start a new monitor." } } ], "assertions": [ "Verify that the 'office365' module generates error events when invalid configurations are used." ], "input_description": "A configuration template (offic365_integration) is contained in an external YAML file (wazuh_conf.yaml). That template is combined with different test cases defined in the module. Those include configuration settings for the 'office365' module.", "expected_output": [ { "r'wm_office365_read()": "ERROR.* Invalid content for tag .*'" }, { "r'wm_office365_read()": "ERROR.* Empty content for tag .*'" } ], "tags": [ "invalid_settings" ], "name": "test_invalid", "inputs": [ "get_configuration0", "get_configuration1", "get_configuration2", "get_configuration3", "get_configuration4", "get_configuration5", "get_configuration6", "get_configuration7" ] } ] }test_invalid.yaml
Tests
pycodestyle --max-line-length=120 --show-source --show-pep8 file.py.python3 DocGenerator.py -s