Skip to content

Commit

Permalink
Update tests.
Browse files Browse the repository at this point in the history
  • Loading branch information
@felixfontein
felixfontein committed Nov 26, 2022
1 parent aea5933 commit 6aaa181
Show file tree
Hide file tree
Showing 26 changed files with 247 additions and 40 deletions.
41 changes: 41 additions & 0 deletions tests/functional/baseline-default/collections/environment_variables.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@

:orphan:

.. _list_of_collection_env_vars:

Index of all Collection Environment Variables
=============================================

The following index documents all environment variables declared by plugins and modules in collections.
Environment variables used by the ansible-core configuation are documented in :ref:`ansible_configuration_settings`.

.. envvar:: ANSIBLE_FOO_EXE

Foo executable.

*Used by:*
:ref:`ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become>`
.. envvar:: ANSIBLE_FOO_FILENAME_EXT

All extensions to check.

*Used by:*
:ref:`ns2.col.foo vars plugin <ansible_collections.ns2.col.foo_vars>`
.. envvar:: ANSIBLE_FOO_USER

User you 'become' to execute the task.

*Used by:*
:ref:`ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become>`
.. envvar:: ANSIBLE_REMOTE_TEMP

Temporary directory to use on targets when executing tasks.

*Used by:*
:ref:`ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell>`
.. envvar:: ANSIBLE_REMOTE_TMP

Temporary directory to use on targets when executing tasks.

*Used by:*
:ref:`ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell>`
8 changes: 4 additions & 4 deletions tests/functional/baseline-default/collections/ns2/col/foo_become.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -211,9 +211,9 @@ Parameters
Alternative: nothing


- Environment variable: ANSIBLE\_BECOME\_EXE
- Environment variable: :envvar:`ANSIBLE\_BECOME\_EXE`

- Environment variable: ANSIBLE\_FOO\_EXE
- Environment variable: :envvar:`ANSIBLE\_FOO\_EXE`

Removed in: version 3.0.0

Expand Down Expand Up @@ -297,11 +297,11 @@ Parameters
user = root
- Environment variable: ANSIBLE\_BECOME\_USER
- Environment variable: :envvar:`ANSIBLE\_BECOME\_USER`

:ansible-option-versionadded:`added in ns2.col 0.1.0`

- Environment variable: ANSIBLE\_FOO\_USER
- Environment variable: :envvar:`ANSIBLE\_FOO\_USER`

- Variable: ansible\_become\_user

Expand Down
2 changes: 1 addition & 1 deletion tests/functional/baseline-default/collections/ns2/col/foo_cache.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Parameters
fact_caching_connection = VALUE
- Environment variable: ANSIBLE\_CACHE\_PLUGIN\_CONNECTION
- Environment variable: :envvar:`ANSIBLE\_CACHE\_PLUGIN\_CONNECTION`


.. raw:: html
Expand Down
4 changes: 2 additions & 2 deletions tests/functional/baseline-default/collections/ns2/col/foo_shell.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,9 +148,9 @@ Parameters
remote_tmp = ~/.ansible/tmp
- Environment variable: ANSIBLE\_REMOTE\_TEMP
- Environment variable: :envvar:`ANSIBLE\_REMOTE\_TEMP`

- Environment variable: ANSIBLE\_REMOTE\_TMP
- Environment variable: :envvar:`ANSIBLE\_REMOTE\_TMP`

- Variable: ansible\_remote\_tmp

Expand Down
2 changes: 1 addition & 1 deletion tests/functional/baseline-default/collections/ns2/col/foo_vars.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Parameters
foo_valid_extensions = .foo, .foobar
- Environment variable: ANSIBLE\_FOO\_FILENAME\_EXT
- Environment variable: :envvar:`ANSIBLE\_FOO\_FILENAME\_EXT`


.. raw:: html
Expand Down
41 changes: 41 additions & 0 deletions tests/functional/baseline-no-breadcrumbs/collections/environment_variables.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@

:orphan:

.. _list_of_collection_env_vars:

Index of all Collection Environment Variables
=============================================

The following index documents all environment variables declared by plugins and modules in collections.
Environment variables used by the ansible-core configuation are documented in :ref:`ansible_configuration_settings`.

.. envvar:: ANSIBLE_FOO_EXE

Foo executable.

*Used by:*
:ref:`ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become>`
.. envvar:: ANSIBLE_FOO_FILENAME_EXT

All extensions to check.

*Used by:*
:ref:`ns2.col.foo vars plugin <ansible_collections.ns2.col.foo_vars>`
.. envvar:: ANSIBLE_FOO_USER

User you 'become' to execute the task.

*Used by:*
:ref:`ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become>`
.. envvar:: ANSIBLE_REMOTE_TEMP

Temporary directory to use on targets when executing tasks.

*Used by:*
:ref:`ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell>`
.. envvar:: ANSIBLE_REMOTE_TMP

Temporary directory to use on targets when executing tasks.

*Used by:*
:ref:`ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell>`
8 changes: 4 additions & 4 deletions tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_become.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -211,9 +211,9 @@ Parameters
Alternative: nothing


- Environment variable: ANSIBLE\_BECOME\_EXE
- Environment variable: :envvar:`ANSIBLE\_BECOME\_EXE`

- Environment variable: ANSIBLE\_FOO\_EXE
- Environment variable: :envvar:`ANSIBLE\_FOO\_EXE`

Removed in: version 3.0.0

Expand Down Expand Up @@ -297,11 +297,11 @@ Parameters
user = root
- Environment variable: ANSIBLE\_BECOME\_USER
- Environment variable: :envvar:`ANSIBLE\_BECOME\_USER`

:ansible-option-versionadded:`added in ns2.col 0.1.0`

- Environment variable: ANSIBLE\_FOO\_USER
- Environment variable: :envvar:`ANSIBLE\_FOO\_USER`

- Variable: ansible\_become\_user

Expand Down
2 changes: 1 addition & 1 deletion tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_cache.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Parameters
fact_caching_connection = VALUE
- Environment variable: ANSIBLE\_CACHE\_PLUGIN\_CONNECTION
- Environment variable: :envvar:`ANSIBLE\_CACHE\_PLUGIN\_CONNECTION`


.. raw:: html
Expand Down
4 changes: 2 additions & 2 deletions tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_shell.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,9 +148,9 @@ Parameters
remote_tmp = ~/.ansible/tmp
- Environment variable: ANSIBLE\_REMOTE\_TEMP
- Environment variable: :envvar:`ANSIBLE\_REMOTE\_TEMP`

- Environment variable: ANSIBLE\_REMOTE\_TMP
- Environment variable: :envvar:`ANSIBLE\_REMOTE\_TMP`

- Variable: ansible\_remote\_tmp

Expand Down
2 changes: 1 addition & 1 deletion tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_vars.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Parameters
foo_valid_extensions = .foo, .foobar
- Environment variable: ANSIBLE\_FOO\_FILENAME\_EXT
- Environment variable: :envvar:`ANSIBLE\_FOO\_FILENAME\_EXT`


.. raw:: html
Expand Down
41 changes: 41 additions & 0 deletions tests/functional/baseline-no-indexes/collections/environment_variables.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@

:orphan:

.. _list_of_collection_env_vars:

Index of all Collection Environment Variables
=============================================

The following index documents all environment variables declared by plugins and modules in collections.
Environment variables used by the ansible-core configuation are documented in :ref:`ansible_configuration_settings`.

.. envvar:: ANSIBLE_FOO_EXE

Foo executable.

*Used by:*
:ref:`ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become>`
.. envvar:: ANSIBLE_FOO_FILENAME_EXT

All extensions to check.

*Used by:*
:ref:`ns2.col.foo vars plugin <ansible_collections.ns2.col.foo_vars>`
.. envvar:: ANSIBLE_FOO_USER

User you 'become' to execute the task.

*Used by:*
:ref:`ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become>`
.. envvar:: ANSIBLE_REMOTE_TEMP

Temporary directory to use on targets when executing tasks.

*Used by:*
:ref:`ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell>`
.. envvar:: ANSIBLE_REMOTE_TMP

Temporary directory to use on targets when executing tasks.

*Used by:*
:ref:`ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell>`
8 changes: 4 additions & 4 deletions tests/functional/baseline-no-indexes/collections/ns2/col/foo_become.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -211,9 +211,9 @@ Parameters
Alternative: nothing


- Environment variable: ANSIBLE\_BECOME\_EXE
- Environment variable: :envvar:`ANSIBLE\_BECOME\_EXE`

- Environment variable: ANSIBLE\_FOO\_EXE
- Environment variable: :envvar:`ANSIBLE\_FOO\_EXE`

Removed in: version 3.0.0

Expand Down Expand Up @@ -297,11 +297,11 @@ Parameters
user = root
- Environment variable: ANSIBLE\_BECOME\_USER
- Environment variable: :envvar:`ANSIBLE\_BECOME\_USER`

:ansible-option-versionadded:`added in ns2.col 0.1.0`

- Environment variable: ANSIBLE\_FOO\_USER
- Environment variable: :envvar:`ANSIBLE\_FOO\_USER`

- Variable: ansible\_become\_user

Expand Down
2 changes: 1 addition & 1 deletion tests/functional/baseline-no-indexes/collections/ns2/col/foo_cache.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Parameters
fact_caching_connection = VALUE
- Environment variable: ANSIBLE\_CACHE\_PLUGIN\_CONNECTION
- Environment variable: :envvar:`ANSIBLE\_CACHE\_PLUGIN\_CONNECTION`


.. raw:: html
Expand Down
4 changes: 2 additions & 2 deletions tests/functional/baseline-no-indexes/collections/ns2/col/foo_shell.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,9 +148,9 @@ Parameters
remote_tmp = ~/.ansible/tmp
- Environment variable: ANSIBLE\_REMOTE\_TEMP
- Environment variable: :envvar:`ANSIBLE\_REMOTE\_TEMP`

- Environment variable: ANSIBLE\_REMOTE\_TMP
- Environment variable: :envvar:`ANSIBLE\_REMOTE\_TMP`

- Variable: ansible\_remote\_tmp

Expand Down
2 changes: 1 addition & 1 deletion tests/functional/baseline-no-indexes/collections/ns2/col/foo_vars.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Parameters
foo_valid_extensions = .foo, .foobar
- Environment variable: ANSIBLE\_FOO\_FILENAME\_EXT
- Environment variable: :envvar:`ANSIBLE\_FOO\_FILENAME\_EXT`


.. raw:: html
Expand Down
41 changes: 41 additions & 0 deletions tests/functional/baseline-squash-hierarchy/environment_variables.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@

:orphan:

.. _list_of_collection_env_vars:

Index of all Collection Environment Variables
=============================================

The following index documents all environment variables declared by plugins and modules in collections.
Environment variables used by the ansible-core configuation are documented in :ref:`ansible_configuration_settings`.

.. envvar:: ANSIBLE_FOO_EXE

Foo executable.

*Used by:*
:ref:`ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become>`
.. envvar:: ANSIBLE_FOO_FILENAME_EXT

All extensions to check.

*Used by:*
:ref:`ns2.col.foo vars plugin <ansible_collections.ns2.col.foo_vars>`
.. envvar:: ANSIBLE_FOO_USER

User you 'become' to execute the task.

*Used by:*
:ref:`ns2.col.foo become plugin <ansible_collections.ns2.col.foo_become>`
.. envvar:: ANSIBLE_REMOTE_TEMP

Temporary directory to use on targets when executing tasks.

*Used by:*
:ref:`ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell>`
.. envvar:: ANSIBLE_REMOTE_TMP

Temporary directory to use on targets when executing tasks.

*Used by:*
:ref:`ns2.col.foo shell plugin <ansible_collections.ns2.col.foo_shell>`
8 changes: 4 additions & 4 deletions tests/functional/baseline-squash-hierarchy/foo_become.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -211,9 +211,9 @@ Parameters
Alternative: nothing


- Environment variable: ANSIBLE\_BECOME\_EXE
- Environment variable: :envvar:`ANSIBLE\_BECOME\_EXE`

- Environment variable: ANSIBLE\_FOO\_EXE
- Environment variable: :envvar:`ANSIBLE\_FOO\_EXE`

Removed in: version 3.0.0

Expand Down Expand Up @@ -297,11 +297,11 @@ Parameters
user = root
- Environment variable: ANSIBLE\_BECOME\_USER
- Environment variable: :envvar:`ANSIBLE\_BECOME\_USER`

:ansible-option-versionadded:`added in ns2.col 0.1.0`

- Environment variable: ANSIBLE\_FOO\_USER
- Environment variable: :envvar:`ANSIBLE\_FOO\_USER`

- Variable: ansible\_become\_user

Expand Down
2 changes: 1 addition & 1 deletion tests/functional/baseline-squash-hierarchy/foo_cache.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Parameters
fact_caching_connection = VALUE
- Environment variable: ANSIBLE\_CACHE\_PLUGIN\_CONNECTION
- Environment variable: :envvar:`ANSIBLE\_CACHE\_PLUGIN\_CONNECTION`


.. raw:: html
Expand Down
4 changes: 2 additions & 2 deletions tests/functional/baseline-squash-hierarchy/foo_shell.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,9 +148,9 @@ Parameters
remote_tmp = ~/.ansible/tmp
- Environment variable: ANSIBLE\_REMOTE\_TEMP
- Environment variable: :envvar:`ANSIBLE\_REMOTE\_TEMP`

- Environment variable: ANSIBLE\_REMOTE\_TMP
- Environment variable: :envvar:`ANSIBLE\_REMOTE\_TMP`

- Variable: ansible\_remote\_tmp

Expand Down
2 changes: 1 addition & 1 deletion tests/functional/baseline-squash-hierarchy/foo_vars.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Parameters
foo_valid_extensions = .foo, .foobar
- Environment variable: ANSIBLE\_FOO\_FILENAME\_EXT
- Environment variable: :envvar:`ANSIBLE\_FOO\_FILENAME\_EXT`


.. raw:: html
Expand Down
Loading

0 comments on commit 6aaa181

Please sign in to comment.