Migrate test_remoted documentation to schema 2.0 #2426
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
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
The following tests have been documented: * test_bruteforce_blocking_system.py * test_cache.py * test_DOS_blocking_system.py The scheme of proposal 3 has been used until the definitive one is available. Update DocGenerator/config.yaml PEP-8 fixes Closes: #1806
The following tests have been documented: * test_cors.py * test_drop_privileges.py * test_experimental_features.py * test_host_port.py The scheme of proposal 3 has been used until the definitive one is available. Add new tags to: * test_bruteforce_blocking_system.py * test_DOS_blocking_system.py PEP-8 fixes Closes: #1806
Migrate `test_analysisd` documentation to QA Docs
The following tests have been documented: * test_bruteforce_blocking_system.py * test_cache.py * test_DOS_blocking_system.py The scheme of proposal 3 has been used until the definitive one is available. Update DocGenerator/config.yaml PEP-8 fixes Closes: #1806
The following tests have been documented: * test_cors.py * test_drop_privileges.py * test_experimental_features.py * test_host_port.py The scheme of proposal 3 has been used until the definitive one is available. Add new tags to: * test_bruteforce_blocking_system.py * test_DOS_blocking_system.py PEP-8 fixes Closes: #1806
The following tests have been documented: * test_https.py * test_jwt_token_exp_timeout.py * test_logs.py * test_rbac_mode.py * test_request_timeout.py The scheme of proposal 3 has been used until the definitive one is available. Update list of operating systems in the documented tests. PEP-8 fixes Closes: #1806
…-qa into 1806-qadocs-migrate-test-api fix: Resolve file conflicts
The following tests have been documented: * test_use_only_authd.py The scheme of proposal 3 has been used until the definitive one is available. Update DocGenerator/config.yaml PEP-8 fixes Closes: #1806
The following tests have been documented: * test_add_old_resource.py * test_admin_resources.py * test_policy_position.py The scheme of proposal 3 has been used until the definitive one is available. PEP-8 fixes Closes: #1806
The following tests have been documented: * test_remove_relationship.py The scheme of proposal 3 has been used until the definitive one is available. PEP-8 fixes Closes: #1806
The following tests have been updated: * test_DOS_blocking_system.py * test_bruteforce_blocking_system.py * test_cache.py * test_cors.py * test_drop_privileges.py * test_experimental_features.py * test_host_port.py * test_https.py * test_jwt_token_exp_timeout.py The current scheme of the issue #1694 has been used. Update DocGenerator/config.yaml PEP-8 fixes Closes: #1806
The following tests have been updated: * test_logs.py * test_rbac_mode.py * test_request_timeout.py * test_use_only_authd.py * test_add_old_resource.py * test_admin_resources.py Minor corrections in the documentation of the remaining tests. The current scheme of the issue #1694 has been used. PEP-8 fixes. Closes: #1806
The following tests have been updated: * test_add_old_resource.py * test_admin_resources.py * test_policy_position.py * test_remove_relationship.py Add new documentation for test_remove_resource.py Minor corrections in the documentation of the remaining tests. The current scheme of the issue #1694 has been used. PEP-8 fixes. Closes: #1806
Migrate `test_api` documentation to QA Docs
…esponse Migrate `test_active_response` documentation to QA Docs
The following tests have been updated: * test_agentd_multi_server.py * test_agentd_parametrized_reconnections.py * test_agentd_reconnection.py * test_agentd_state.py * test_agentd_state_config.py Minor corrections in the documentation of the remaining tests. The current scheme of the issue #1694 has been used. PEP-8 fixes. Closes: #1868
Migrate `test_agentd` documentation to `qa-docs`
The following tests have been updated: * 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 Updated config.yaml The current scheme of the issue #1694 has been used. PEP-8 fixes. Closes: #1869
The following tests have been updated:
* test_os_exec.py
* test_execd_firewall_drop.py
* test_execd_restart.py
Closes: #1870
…tyle A description of test cases has been manually added to the tests of test_all_syscheckd_configurations due to their large number. Closes: #1869
Migrate `test_analysisd` documentation to qa-docs
The following tests have been documentated: * test_authd.py * test_authd_local.py * test_authd_name_ip_pass.py * test_authd_ssl_certs.py * test_authd_ssl_options.py * test_authd_worker.py * test_remote_enrollment.py Minor corrections in the documentation of the remaining tests. The current scheme of the issue #1694 has been used. Updated config.yaml PEP-8 fixes. Closes: #1807
Migrate `test_authd` documentation to qa-docs
The path field has been removed as it is auto-generated. Remove line breaks in fields that do not contain arrays. Update os_version field. Some minor changes. Related: #1806
Migrate `test_cluster` documentation to qa-docs
Rebits
force-pushed
the
1816-migrate-remoted-doc
branch
from
8fc63bf to
fac4393
Compare
Rebits
requested changes
Jan 4, 2022
tests/integration/test_remoted/test_active_response/test_active_response_send_ar.py
Outdated
Show resolved
Hide resolved
..._remoted/test_agent_communication/test_agent_version_shared_configuration_startup_message.py
Outdated
Show resolved
Hide resolved
..._remoted/test_agent_communication/test_agent_version_shared_configuration_startup_message.py
Outdated
Show resolved
Hide resolved
tests/integration/test_remoted/test_agent_communication/test_agents_switching_protocols.py
Outdated
Show resolved
Hide resolved
tests/integration/test_remoted/test_agent_communication/test_invalid_protocol_communication.py
Outdated
Show resolved
Hide resolved
tests/integration/test_remoted/test_agent_communication/test_invalid_protocol_communication.py
Show resolved
Hide resolved
...ntegration/test_remoted/test_agent_communication/test_multi_agent_protocols_communication.py
Outdated
Show resolved
Hide resolved
tests/integration/test_remoted/test_agent_communication/test_multi_agent_status.py
Outdated
Show resolved
Hide resolved
tests/integration/test_remoted/test_agent_communication/test_protocols_communication.py
Outdated
Show resolved
Hide resolved
tests/integration/test_remoted/test_agent_communication/test_request_agent_info.py
Outdated
Show resolved
Hide resolved
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 #1796, this PR adds all the missing documentation of
test_remoted, as well as adding the existing one. This PR brings the changes that appear in branches1816-qadocs-migrate-test-remotedand1816-qadocs-migrate-remoted-configurationand add the remaining documentation test. Some changes have been made in order to pass theqa-doctest.Generated documentation
test_active_response
JSON and yaml
test_agent_communication
JSON and yaml
test_configuration
JSON and yaml
test_manager_messages
JSON and yaml
test_socket_communication
JSON and yaml
Tests
pycodestyle --max-line-length=120 --show-source --show-pep8 file.py.