-
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
Integrate qa-docs into wazuh-qa framework #1854
Merged
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
Logic added, now it has to be implemented.
It will help to classify DocGenerator behaviour, even if we keep adding new functionalities
The test doc is printed to standard output, now requires to use the keys that QACTL needs. Also add the output file functionality.
Using the config.yaml, now the fields printed are specified in `Module info` and `Test info`, so you can get the info you want.
#1800 This file contains the module and test info that you specify in config.yaml
Also added missing last newline
The following tests have been documented: * test_execd_firewall_drop.py * test_execd_restart.py * test_cache.py * test_cache.py The tests have been documented following the schema proposed by the qactl team. Update DocGenerator/config.yaml PEP-8 fixes Closes: #1840
Few test examples to test QADOCS
All working except `-l` option, `search_ui` folder is not installed properly. Folders missing inside.
roronoasins
added
team/qa
refactor
Redesign and implement an existing development/feature
labels
Sep 8, 2021
jmv74211
suggested changes
Sep 8, 2021
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.
Good job, but a lot of changes are required. We will see all this in a live review.
tests/integration/test_vulnerability_detector/test_scan_results/test_scan_nvd_feed.py
Outdated
Show resolved
Hide resolved
snaow
approved these changes
Sep 9, 2021
jmv74211
approved these changes
Sep 9, 2021
12 tasks
roronoasins
changed the title
Integrate QADOCS into wazuh-qa framework
Integrate qa-docs into wazuh-qa framework
Oct 7, 2021
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
QADOCS use is required not only for users but the QA framework. We decided to include this tool within the QA framework so there are no path dependencies.
It has been moved from
docs/DocGenerator
todeps/wazuh_testing/qa_docs
and is installed running thedeps/wazuh_testing/setup.py
(npm modules installation needed, now working if you manually install them. It has to be changed).The new use is specified here. The wiki will be updated once this branch is merged.
The entire changes in QADOCS are located in #1800.
Few examples:
In order to run
qa-docs
, you need to specify the tests directory that you want to parse.