QADOCS tool use guide

How to use qa-docs tool

After installing qa-docs(you can follow the installation guide steps), you can check the qa-docs help.

• -h, --help: Print the qa-docs help message.
• -s, --sanity-check: Perform a sanity check using the data previously parsed. Tests coverage, errors, and tests count.
• -v, --version: Print the qa-docs version.
• -d, --debug: Run in debug mode.
• -I, --tests-path: Specify the path of the tests to be parsed. Set it when you want to parse or run a sanity check.
• -t, --tests: Parse the test(s) you specify as an argument.
• --types: Parse the tests from type(s) that it is passed as an argument. Some types examples are integration, system, etc.
• --modules: Parse the tests from module(s) that it is passed as an argument. Some module examples are test_active_response, test_fim, etc.
• -o: Select the output directory. python -m site --user-site as default, where the setup.py installs the framework.
• -e: Check if the test(s) exist(s).
• -i: Index the data previously parsed.
• -l: Launch search-uiwith the data previously indexed.
• -il: Index the data previously parsed and launch search-ui

Parameter restrictions

• -t and -e cannot be launched with --types and --modules parameters. They store the parsed data into /output and -t save it where the user specifies with -o.
• -t, --types, --modules, -t, -eand-sneed the-I` parameter.
• -o cannot be launched with --types or --modules.
• -t and e cannot be launched with -i, -l and -il.
• -s only allows a run with the -I parameter.

Examples:

Generate the documentation in YAML and JSON formats in the framework installation directory

qa-docs -I /path/to/tests/

Parse integration tests

qa-docs -I /path/to/tests/ --types integration

Parse test_active_response and test_agentd tests

qa-docs -I /path/to/tests/ --types integration --modules test_active_response test_agentd

Create an index with the data previously parsed

qa-docs -i index_name

Launch search-ui the data previously indexed via web browser

qa-docs -l index_name

Index the data previously parsed and launch search-ui

qa-docs -il index_name

Parse integration tests modules, index the data and launch search-ui to visualize it via web browser

qa-docs -I /path/to/tests/ --types integration --modules test_active_response test_agentd -il index_name

Perform a sanity check after a previous parse run

qa-docs -I /path/to/tests/ -s

Parse a list of tests

qa-docs -I /path/to/tests/ -t test_cache test_general_settings_enabled

Check if a list of tests exists

qa-docs -I /path/to/tests/ -e test_cache test_general_settings_enabled

More details and examples can be found in the qa-docs README.MD.

Docker deployment

By running a script you can parse the types/modules tests that you want, just need a branch as input. Optionally, you can pass the types or types and modules that you want to parse using the tests allocated in that branch.

Parse all test types and launch search-ui to visualize the documentation.

./deploy_qa_docs.sh 1796-migrate-doc-schema-2

Parse integration tests and launch search-ui to visualize the documentation.

./deploy_qa_docs.sh 1796-migrate-doc-schema-2 integration

Parse some integration modules and launch search-ui to visualize the documentation.

./deploy_qa_docs.sh 1796-migrate-doc-schema-2 integration test_active_response test_agentd