Skip to content

Commit

Permalink
Added more checkers we use to README and Testing docs
Browse files Browse the repository at this point in the history
Signed-off-by: Andreas Maier <[email protected]>
  • Loading branch information
andy-maier committed Jul 8, 2024
1 parent 31382f9 commit 430b75f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,9 +178,12 @@ All releases will meet the following test criteria:
* 100% success for [Unit](https://github.com/zhmcclient/zhmc-ansible-modules/tree/master/tests/unit) tests.
* 100% success for [Function](https://github.com/zhmcclient/zhmc-ansible-modules/tree/master/tests/function) tests.
* 100% success for [End2end](https://github.com/zhmcclient/zhmc-ansible-modules/tree/master/tests/end2end) tests.
* 100% success for [Sanity](https://docs.ansible.com/ansible/latest/dev_guide/testing/sanity/index.html#all-sanity-tests) tests as part of [ansible-test](https://docs.ansible.com/ansible/latest/dev_guide/testing.html#run-sanity-tests).
* 100% success for [Ansible sanity](https://docs.ansible.com/ansible/latest/dev_guide/testing/sanity/index.html#all-sanity-tests) tests as part of [ansible-test](https://docs.ansible.com/ansible/latest/dev_guide/testing.html#run-sanity-tests).
* 100% success for [flake8](https://flake8.pycqa.org).
* 100% success for [pylint](https://pylint.readthedocs.io/en/stable/).
* 100% success for [ansible-lint](https://ansible.readthedocs.io/projects/lint/) allowing only false positives.
* 100% success for [safety](https://docs.safetycli.com/safety-docs) vulnerability checks.
* 100% success for [pip-missing-reqs](https://github.com/adamtheturtle/pip-check-reqs/blob/master/README.rst) checks for missing dependencies.

For more details on testing the IBM Z HMC collection, including the specific version
combinations that were tested, refer to documentation section
Expand Down
5 changes: 4 additions & 1 deletion docs/source/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,11 @@ Again, an invocation of Make runs against the currently active Python environmen
There are four kinds of tests currently, available as make targets:

* ``make check`` - Run flake8
* ``make pylint`` - Run pylint
* ``make linkcheck`` - Check links in documentation
* ``make sanity`` - Run Ansible sanity tests (includes flake8, pylint, validate-modules)
* ``make sanity`` - Run Ansible sanity tests
* ``make ansible_lint`` - Run ansible_lint
* ``make safety`` - Run safety vulnerability checks
* ``make check_reqs`` - Run pip-missing-reqs to perform missing dependency checks
* ``make test`` - Run unit and function tests with test coverage
* ``make end2end_mocked`` - Run end2end tests against a mocked environment
Expand Down

0 comments on commit 430b75f

Please sign in to comment.