ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

allow ANSIBLE_KEEP_REMOTE_FILES for local test runner (#33357)

Browse source 
* allow ANSIBLE_KEEP_REMOTE_FILES for local test runner
* add ANSIBLE_KEEP_REMOTE_FILES to tox.ini, update docs
* Clarify handling of environment variables.
This commit is contained in:
Adam Miller 2018-03-06 18:28:06 -06:00 committed by Matt Clay
parent efb8b539c1
commit 3fd5b0740e
3 changed files with 16 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/docsite/rst/dev_guide/testing_running_locally.rst
View file

@ -33,6 +33,19 @@ An API key is required to use this feature.
See the `list of supported platforms and versions <https://github.com/ansible/ansible/blob/devel/test/runner/completion/remote.txt>`_ for additional details. See the `list of supported platforms and versions <https://github.com/ansible/ansible/blob/devel/test/runner/completion/remote.txt>`_ for additional details.
Environment Variables
---------------------
When using environment variables to manipulate tests there some limitations to keep in mind. Environment variables are:
* Not propagated from the host to the test environment when using the ``--docker`` or ``--remote`` options.
* Not exposed to the test environment unless whitelisted in ``test/runner/lib/util.py`` in the ``common_environment`` function.
* Not exposed to the test environment when using the ``--tox`` option unless whitelisted in ``test/runner/tox.ini`` by the ``passenv`` definition.
Example: ``ANSIBLE_KEEP_REMOTE_FILES=1`` can be set when running ``ansible-test integration --tox``. However, using the ``--docker`` option would
require running ``ansible-test shell`` to gain access to the Docker environment. Once at the shell prompt, the environment variable could be set
and the tests executed. This is useful for debugging tests inside a container by following the
:ref:`Debugging AnsibleModule-based modules <debugging_ansiblemodule_based_modules>` instructions.
Interactive Shell Interactive Shell
================= =================
@ -42,6 +55,7 @@ Use the ``ansible-test shell`` command to get an interactive shell in the same e
* ``ansible-test shell --docker`` - Open a shell in the default docker container. * ``ansible-test shell --docker`` - Open a shell in the default docker container.
* ``ansible-test shell --tox --python 3.6`` - Open a shell in the Python 3.6 ``tox`` environment. * ``ansible-test shell --tox --python 3.6`` - Open a shell in the Python 3.6 ``tox`` environment.
Code Coverage Code Coverage
============= =============

1
test/runner/lib/util.py
View file

@ -385,6 +385,7 @@ def common_environment():
# MacOS High Sierra Compatibility # MacOS High Sierra Compatibility
# http://sealiesoftware.com/blog/archive/2017/6/5/Objective-C_and_fork_in_macOS_1013.html # http://sealiesoftware.com/blog/archive/2017/6/5/Objective-C_and_fork_in_macOS_1013.html
'OBJC_DISABLE_INITIALIZE_FORK_SAFETY', 'OBJC_DISABLE_INITIALIZE_FORK_SAFETY',
'ANSIBLE_KEEP_REMOTE_FILES',
) )
env.update(pass_vars(required=required, optional=optional)) env.update(pass_vars(required=required, optional=optional))

2
test/runner/tox.ini
View file

@ -5,7 +5,7 @@ minversion = 2.5.0
[testenv] [testenv]
changedir = {toxinidir}/../../ changedir = {toxinidir}/../../
commands = {posargs} commands = {posargs}
passenv = HOME LC_ALL SHIPPABLE* passenv = HOME LC_ALL SHIPPABLE* ANSIBLE_KEEP_REMOTE_FILES
args_are_paths = False args_are_paths = False
deps = setuptools == 35.0.2 deps = setuptools == 35.0.2
wheel < 0.30.0 ; python_version < '2.7' wheel < 0.30.0 ; python_version < '2.7'