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

qa-docs: Adapt the tool to the framework rework #2588

Closed
6 tasks done
Tracked by #2601
roronoasins opened this issue Feb 22, 2022 · 1 comment · Fixed by #2605
Closed
6 tasks done
Tracked by #2601

qa-docs: Adapt the tool to the framework rework #2588

roronoasins opened this issue Feb 22, 2022 · 1 comment · Fixed by #2605
Assignees
Labels
refactor Redesign and implement an existing development/feature tool/qa-docs

Comments

@roronoasins
Copy link
Contributor

roronoasins commented Feb 22, 2022

Description

As we are making a rework of the testing framework, we need to check and adapt the qa-docs tool to this rework.

Also, this issue will finish the 0.1 development that was blocked by SearchUI. So, this issue will extend #1864 and #2196 will be sent to the Icebox. Then, we can continue with #2075, closing both of them.

Tasks

  • Test the tool with the rework environment and get the needed changes
  • Adapt qa-docs to the framework rework
    • Add --suites parameter
    • Rename --modules as --components
    • Rename --tests as --modules
    • Change the behavior when parsing a single module. With the rework now different suites have modules with the same module name
@roronoasins roronoasins self-assigned this Feb 22, 2022
@roronoasins roronoasins added subteam/qa-thunder refactor Redesign and implement an existing development/feature labels Feb 22, 2022
@roronoasins
Copy link
Contributor Author

roronoasins commented Feb 23, 2022

The way we name the test framework items has changed, so it is needed to change some qa-docs parameters, code, and doc to avoid any confusion:

  • type: integration, system, etc.
  • component: test_vulnerability_detector, test_fim, etc.
  • suite: test_general_settings, test_scan_results, etc
  • module: test_enabled, test_min_full_scan_interval
  • test: test within a module

roronoasins pushed a commit that referenced this issue Feb 23, 2022
- Change `modules` to `components`
- Add `suites` parameter
- Change `tests` to `modules`
roronoasins pushed a commit that referenced this issue Feb 24, 2022
Now, it is needed the suite, the component and, the type when you want to parse a single module because there are modules with the same name
since the new framework changes.
@roronoasins roronoasins linked a pull request Feb 24, 2022 that will close this issue
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactor Redesign and implement an existing development/feature tool/qa-docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant