ansible/docs/docsite/rst/dev_guide/testing_sanity.rst

:orphan:

.. _testing_sanity:

************
Sanity Tests
************

.. contents:: Topics

Sanity tests are made up of scripts and tools used to perform static code analysis.
The primary purpose of these tests is to enforce Ansible coding standards and requirements.

Tests are run with ``ansible-test sanity``.
All available tests are run unless the ``--test`` option is used.


How to run
==========

.. code:: shell

   source hacking/env-setup

   # Run all sanity tests
   ansible-test sanity

   # Run all sanity tests against against certain files
   ansible-test sanity lib/ansible/modules/files/template.py

   # Run all tests inside docker (good if you don't have dependencies installed)
   ansible-test sanity --docker default

   # Run validate-modules against a specific file
   ansible-test sanity --test validate-modules lib/ansible/modules/files/template.py

Available Tests
===============

Tests can be listed with ``ansible-test sanity --list-tests``.

See the full list of :ref:`sanity tests <all_sanity_tests>`, which details the various tests and details how to fix identified issues.
Remove more docs build errors (#45364) * orphans testing pages to avoid not-in-toctree errors * orphans various pages pending reorg * adds module_utils and special_vars to main TOC * uses a glob for scenario_guide TOC * normalize and Sentence-case headings on community pages, typos * re-orgs community TOC, adds all pages to toctree * removes scenario guides index page * adds style guide to community index * basic update to style guide * fix typo that created a new error * removes not-in-toctree from ignore errors list * leave removing files for future cleanup task 2018-09-11 16:51:47 +00:00			`:orphan:`

rewrite of the developer guide, part 1 (#45179) * rewrite of the developer guide, part 1 2018-09-07 13:57:36 +00:00			`.. _testing_sanity:`

Docs how to test (2nd) (#24094) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail 2017-04-28 08:08:26 +00:00			`************`
Expand test documentation. (#23598) * Replace test README.md with new README.rst. * Add compile and sanity README.rst docs. 2017-04-14 00:46:21 +00:00			`Sanity Tests`
Docs how to test (2nd) (#24094) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail 2017-04-28 08:08:26 +00:00			`************`

			`.. contents:: Topics`
Expand test documentation. (#23598) * Replace test README.md with new README.rst. * Add compile and sanity README.rst docs. 2017-04-14 00:46:21 +00:00
			`Sanity tests are made up of scripts and tools used to perform static code analysis.`
			`The primary purpose of these tests is to enforce Ansible coding standards and requirements.`

			Tests are run with ``ansible-test sanity``.
			All available tests are run unless the ``--test`` option is used.


Docs: List of Sanity Tests (#52986) * Improve sanity test docs, how to run sanity tests section 2019-02-26 17:27:39 +00:00			`How to run`
			`==========`
Expand test documentation. (#23598) * Replace test README.md with new README.rst. * Add compile and sanity README.rst docs. 2017-04-14 00:46:21 +00:00
Docs: List of Sanity Tests (#52986) * Improve sanity test docs, how to run sanity tests section 2019-02-26 17:27:39 +00:00			`.. code:: shell`
Expand test documentation. (#23598) * Replace test README.md with new README.rst. * Add compile and sanity README.rst docs. 2017-04-14 00:46:21 +00:00
Docs: List of Sanity Tests (#52986) * Improve sanity test docs, how to run sanity tests section 2019-02-26 17:27:39 +00:00			`source hacking/env-setup`
Docs how to test (2nd) (#24094) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail 2017-04-28 08:08:26 +00:00
Docs: List of Sanity Tests (#52986) * Improve sanity test docs, how to run sanity tests section 2019-02-26 17:27:39 +00:00			`# Run all sanity tests`
			`ansible-test sanity`
Expand test documentation. (#23598) * Replace test README.md with new README.rst. * Add compile and sanity README.rst docs. 2017-04-14 00:46:21 +00:00
Docs: List of Sanity Tests (#52986) * Improve sanity test docs, how to run sanity tests section 2019-02-26 17:27:39 +00:00			`# Run all sanity tests against against certain files`
			`ansible-test sanity lib/ansible/modules/files/template.py`
Expand test documentation. (#23598) * Replace test README.md with new README.rst. * Add compile and sanity README.rst docs. 2017-04-14 00:46:21 +00:00
Docs: List of Sanity Tests (#52986) * Improve sanity test docs, how to run sanity tests section 2019-02-26 17:27:39 +00:00			`# Run all tests inside docker (good if you don't have dependencies installed)`
			`ansible-test sanity --docker default`
Expand test documentation. (#23598) * Replace test README.md with new README.rst. * Add compile and sanity README.rst docs. 2017-04-14 00:46:21 +00:00
Docs: List of Sanity Tests (#52986) * Improve sanity test docs, how to run sanity tests section 2019-02-26 17:27:39 +00:00			`# Run validate-modules against a specific file`
			`ansible-test sanity --test validate-modules lib/ansible/modules/files/template.py`
Expand test documentation. (#23598) * Replace test README.md with new README.rst. * Add compile and sanity README.rst docs. 2017-04-14 00:46:21 +00:00
Docs: List of Sanity Tests (#52986) * Improve sanity test docs, how to run sanity tests section 2019-02-26 17:27:39 +00:00			`Available Tests`
			`===============`
Expand test documentation. (#23598) * Replace test README.md with new README.rst. * Add compile and sanity README.rst docs. 2017-04-14 00:46:21 +00:00
Docs: List of Sanity Tests (#52986) * Improve sanity test docs, how to run sanity tests section 2019-02-26 17:27:39 +00:00			Tests can be listed with ``ansible-test sanity --list-tests``.
Expand test documentation. (#23598) * Replace test README.md with new README.rst. * Add compile and sanity README.rst docs. 2017-04-14 00:46:21 +00:00
Docs: List of Sanity Tests (#52986) * Improve sanity test docs, how to run sanity tests section 2019-02-26 17:27:39 +00:00			See the full list of :ref:`sanity tests <all_sanity_tests>`, which details the various tests and details how to fix identified issues.