ceb474bb9e
Batch of docs backports: * docs: Clarify include_task v import_tasks with conditionals (#43856) (cherry picked from commit6be42a2a0e) * Add single quotes around package name (#45152) (cherry picked from commit0d81386144) * prefer ansible_facts namespace and dict notation (#44980) (cherry picked from commit44510448b0) * fix cherrypick conflict - scenario_guides * Update implicit_localhost.rst (#45455) (cherry picked from commitf68cd1acc6) * updated fbsd install instructions (#45309) (cherry picked from commite9c2695ce7) * Change "Defaulting Undefined Variables" (#41379) (cherry picked from commite35c4be1c1) * adds license details to dev guide pages (#45574) (cherry picked from commit6e68d77f6d) * FAQ: fix a typo, add link to 'vars' lookup (#42412) (cherry picked from commit95649dc793) * Fix link and toctree (#45595) (cherry picked from commit6999bf318f) * Improve the local toctree (and title) (#45590) (cherry picked from commitafea00fa9f) * Add undocumented configuration parameter and explain in porting guide (#36059) (cherry picked from commita892a6ef03) * Simplify PPA installation for Ubuntu (#45690) (cherry picked from commit78e9f452a5) * adding git+ssh uri scheme (#36025) (cherry picked from commit84a4257774) * Add workaround for non-standard kerberos environments (#41465) (cherry picked from commit4e532e0ad9) * Restore license agreement (#45809) (cherry picked from commitf430f60541) * partial cherry-pick - lenovo doc update PR 45483
73 lines
1.9 KiB
ReStructuredText
73 lines
1.9 KiB
ReStructuredText
:orphan:
|
|
|
|
.. _testing_compile:
|
|
|
|
*************
|
|
Compile Tests
|
|
*************
|
|
|
|
.. contents:: Topics
|
|
|
|
Overview
|
|
========
|
|
|
|
Compile tests check source files for valid syntax on all supported python versions:
|
|
|
|
- 2.4 (Ansible 2.3 only)
|
|
- 2.6
|
|
- 2.7
|
|
- 3.5
|
|
- 3.6
|
|
|
|
NOTE: In Ansible 2.4 and earlier the compile test was provided by a dedicated sub-command ``ansible-test compile`` instead of a sanity test using ``ansible-test sanity --test compile``.
|
|
|
|
Running compile tests locally
|
|
=============================
|
|
|
|
Compile tests can be run across the whole code base by doing:
|
|
|
|
.. code:: shell
|
|
|
|
cd /path/to/ansible/source
|
|
source hacking/env-setup
|
|
ansible-test sanity --test compile
|
|
|
|
Against a single file by doing:
|
|
|
|
.. code:: shell
|
|
|
|
ansible-test sanity --test compile lineinfile
|
|
|
|
Or against a specific Python version by doing:
|
|
|
|
.. code:: shell
|
|
|
|
ansible-test sanity --test compile --python 2.7 lineinfile
|
|
|
|
For advanced usage see the help:
|
|
|
|
.. code:: shell
|
|
|
|
ansible-test sanity --help
|
|
|
|
|
|
Installing dependencies
|
|
=======================
|
|
|
|
``ansible-test`` has a number of dependencies , for ``compile`` tests we suggest running the tests with ``--local``, which is the default
|
|
|
|
The dependencies can be installed using the ``--requirements`` argument. For example:
|
|
|
|
.. code:: shell
|
|
|
|
ansible-test sanity --test compile --requirements lineinfile
|
|
|
|
|
|
|
|
The full list of requirements can be found at `test/runner/requirements <https://github.com/ansible/ansible/tree/devel/test/runner/requirements>`_. Requirements files are named after their respective commands. See also the `constraints <https://github.com/ansible/ansible/blob/devel/test/runner/requirements/constraints.txt>`_ applicable to all commands.
|
|
|
|
|
|
Extending compile tests
|
|
=======================
|
|
|
|
If you believe changes are needed to the compile tests please add a comment on the `Testing Working Group Agenda <https://github.com/ansible/community/blob/master/meetings/README.md>`_ so it can be discussed.
|