Migrate test_rids documentation to qa-docs
#2422
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
added 2 commits
December 30, 2021 16:16
Double dots and quotes at the start of the line raise errors.
1 task
fedepacher
reviewed
Jan 3, 2022
Comment on lines
+23
to
+24
| daemons: | ||
| - wazuh-remoted |
There was a problem hiding this comment.
I would add wazuh-agentd
Suggested change
| daemons: | |
| - wazuh-remoted | |
| daemons: | |
| - wazuh-remoted | |
| - wazuh-agentd |
fedepacher
reviewed
Jan 3, 2022
Comment on lines
+23
to
+24
| daemons: | ||
| - wazuh-remoted |
There was a problem hiding this comment.
I would add wazuh-agentd
Suggested change
| daemons: | |
| - wazuh-remoted | |
| daemons: | |
| - wazuh-remoted | |
| - wazuh-agend |
fedepacher
reviewed
Jan 3, 2022
Comment on lines
171
to
173
| - configure_environment: | ||
| type: fixture | ||
| brief: Configure a custom environment for testing |
There was a problem hiding this comment.
I would add a dot (.) at the end of the brief description.
Suggested change
| - configure_environment: | |
| type: fixture | |
| brief: Configure a custom environment for testing | |
| - configure_environment: | |
| type: fixture | |
| brief: Configure a custom environment for testing. |
fedepacher
reviewed
Jan 3, 2022
Comment on lines
135
to
137
| - configure_environment: | ||
| type: fixture | ||
| brief: Configure a custom environment for testing |
There was a problem hiding this comment.
I would add a dot (.) at the end of the brief description.
Suggested change
| - configure_environment: | |
| type: fixture | |
| brief: Configure a custom environment for testing | |
| - configure_environment: | |
| type: fixture | |
| brief: Configure a custom environment for testing. |
fedepacher
reviewed
Jan 3, 2022
Comment on lines
139
to
140
| assertions: | ||
| - Verify that the RIDS configuration is applied correctly(or not) |
There was a problem hiding this comment.
I would add a dot (.) at the end of the phrase.
Suggested change
| assertions: | |
| - Verify that the RIDS configuration is applied correctly(or not) | |
| assertions: | |
| - Verify that the RIDS configuration is applied correctly(or not). |
fedepacher
reviewed
Jan 3, 2022
Comment on lines
178
to
180
| assertions: | ||
| - Verify that every agent rid is open | ||
| - Verify that every agent rid is closed |
There was a problem hiding this comment.
I would add a dot (.) at the end of each assertions phrase.
Suggested change
| assertions: | |
| - Verify that every agent rid is open | |
| - Verify that every agent rid is closed | |
| assertions: | |
| - Verify that every agent rid is open. | |
| - Verify that every agent rid is closed. |
snaow
approved these changes
Jan 7, 2022
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
Tests
pycodestyle --max-line-length=120 --show-source --show-pep8 file.py.qa-docstool does not raise any error.