Skip to content
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

Add pending qa-docs 0.1 dev and new changes #2649

Merged
merged 119 commits into from
Mar 10, 2022

Conversation

roronoasins
Copy link
Contributor

@roronoasins roronoasins commented Mar 8, 2022

Related issues
Close #2601 #1864 #2075

This PR adds the missing development of qa-docs 0.1, which mostly was merged previously so qa-ctl could read the modules' documentation. The pending development issues that could not be closed because of #2196 will be closed with this PR, and #2196 will be sent to the icebox.

Also, the tool has been adapted to the new framework changes where different modules in different suites can have the
same name, so qa-ctl has been updated too. Besides, the module's terminology has been reworked.

The new changes for both qa-docs and qa-ctl are as follows:

QA-DOCS

Added

  • Added output format selection.

Changed

  • Change the docker deployment.
  • Adapt the tool to some framework changes. (#2605, #2640)
  • Change the schema since framework changes. (#2590)

QA-CTL

Added

  • Added new parameters related to the run method. (#2640)

Changed

  • Changed how the tool uses qa-docs. (#2640)

Checks

Jenkins checking

Test Result
Analysisd IT - Tier 0 - manager 🟢
Analysisd IT - Tier 1 - manager 🟢
AR IT - Tier 0 - manager 🟢
AR IT - Tier 1 - centos_agent 🟢
Authd IT - Tier 0 - manager 🟢
Authd IT - Tier 1 - manager 🟢
FIM IT - Tier 0 - centos_agent 🟢
FIM IT - Tier 0 - manager 🟢
FIM IT - Tier 1 - centos_agent 🟢
FIM IT - Tier 1 - manager 🟢
Logtest IT - Tier 0 - manager 🟢
Remoted IT - Tier 0 - manager 🟢
Remoted IT - Tier 1 - manager 🟢
Rids IT - Tier 0 - manager 🟢
Rootcheck IT - Tier 0 - manager 🟢
Rootcheck IT - Tier 1 - manager 🟢
Vul. Det. IT - Tier 0 - manager 🟢
Vul. Det. IT - Tier 1 - manager 🟢
Wazuh DB IT - Tier 0 - manager 🟢

Luis Gonzalez added 30 commits October 20, 2021 11:55
Now `qa-docs` allows the autogenerated fields.
When the autogenerated path is specified in the module documentation, it will raise an error.
New FIM tags added to `schema.yaml` file.
- Useless `schema.yaml` field removed.
- Refac how test_cases are stored.
Now `if-in` with `dict.keys()` is used instead of `try-except`.
Also added `run_local_command` to `utils.py`.
Instead of log error for subset of incompatible options, now, each incompatible possibility has its error message.
Fix `expected_output` content format to index it properly to ES
Also, `get_qa_docs_runs` has been renamed to `get_qa_docs_run_options` and placed in `utils.py`.
Also, a missing line added to qa-docs script.
@roronoasins roronoasins removed the request for review from snaow March 9, 2022 15:46
@jmv74211 jmv74211 merged commit 4248182 into master Mar 10, 2022
@jmv74211 jmv74211 deleted the 2601-qa-docs-framework-changes branch March 10, 2022 11:29
@wazuh wazuh deleted a comment from fedepacher Mar 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants