Move patch_ansible_module to a pytest plugin
#66430
Draft
+825
−374
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This comment was marked as outdated.
This comment was marked as outdated.
ansibot
added
affects_2.10
This comment has been minimized.
This comment has been minimized.
ansibot
added
needs_revision
webknjaz
force-pushed
the
features/patch_ansible_module-pytest-fixture
branch
from
1d8fb63 to
4768355
Compare
ansibot
added
core_review
This comment has been minimized.
This comment has been minimized.
ansibot
added
has_issue
new_plugin
This comment has been minimized.
This comment has been minimized.
ansibot
added
ci_verified
webknjaz
force-pushed
the
features/patch_ansible_module-pytest-fixture
branch
from
4768355 to
c0ee9ee
Compare
ansibot
removed
the
ci_verified
webknjaz
force-pushed
the
features/patch_ansible_module-pytest-fixture
branch
from
c0ee9ee to
2b4e004
Compare
ansibot
removed
the
needs_revision
ansibot
added
needs_rebase
ansibot
added
the
stale_pr
Member
Author
|
(docs commit for history, could go into commit 5b4c415e55fcc5e8a4d988a25c29bee8144c0cca
Author: Sviatoslav Sydorenko <webknjaz@redhat.com>
Date: Thu Apr 1 23:19:26 2021 +0200
Document pytest fixtures for module unit-tests
diff --git a/docs/docsite/rst/dev_guide/testing_units_modules.rst b/docs/docsite/rst/dev_guide/testing_units_modules.rst
index d07dcff9448..276cdf9f91c 100644
--- a/docs/docsite/rst/dev_guide/testing_units_modules.rst
+++ b/docs/docsite/rst/dev_guide/testing_units_modules.rst
@@ -544,6 +544,72 @@ creation of module objects for testing.
The same restructuring technique can be valuable for testing other functionality, such as the part of the module which queries the object that the module configures.
+What About The Pytest Fixtures?
+===============================
+
+.. versionadded:: 2.15
+
+
+We now have some pytest-native fixture-based helpers that simplify
+calling modules from unit tests using an interface close to the one
+available in playbooks.
+
+
+.. code-block:: python
+ :caption: test_new_mod.py
+
+ import pytest
+
+
+ @pytest.fixture
+ def ansible_global_module_name():
+ return 'my_module'
+
+
+ def test_new_mod_caller(make_ansible_module_caller):
+ run_my_module = make_ansible_module_caller('my_module')
+
+ my_module_args = {'arg1': 'val1', 'arg2': 2, 'arg3': [1, 2, 3]}
+ expected_result = {}
+
+ assert run_my_module(**my_module_args) == expected_result
+
+
+ def test_new_mod_yaml(make_ansible_module_caller):
+ run_my_module = make_ansible_module_caller('my_module')
+
+ assert run_my_module.with_yaml("""
+ arg1: val1
+ arg2: val2
+ """) == {}
+
+
+ def test_new_mod_global(run_ansible_module):
+ my_module_args = {'arg1': 'val1', 'arg2': 2, 'arg3': [1, 2, 3]}
+ expected_result = {}
+
+ assert run_ansible_module(**my_module_args) == expected_result
+
+
+ def test_new_mod_error(run_ansible_module):
+ my_module_args = {'arg1': 'val1'}
+
+ failed_response = run_module(**my_module_args)
+
+ assert failed_response['failed']
+
+
+ @pytest.mark.parametrize(
+ 'ansible_module_name',
+ ('my_module2', ),
+ indirect=('ansible_module_name', ),
+ )
+ def test_new_mod2(run_ansible_module):
+ my_module_args = {'arg1': 'val1', 'arg2': 2, 'arg3': [1, 2, 3]}
+ expected_result = {}
+
+ assert run_ansible_module(**my_module_args) == expected_result
+
Traps for maintaining Python 2 compatibility
============================================ |
This patch automatically loads patch_ansible_module fixture into pytest when running `ansible-test units`. It previously existed in `conftest.py` hence only available to tests of ansible/ansible itself. Now, third-party collections will be able to use it without having to vendor the source code.
webknjaz
force-pushed
the
features/patch_ansible_module-pytest-fixture
branch
from
dfc1da5 to
2d088cf
Compare
ansibot
removed
needs_rebase
Contributor
|
The test The test The test The test The test The test The test The test The test |
ansibot
added
the
needs_rebase
ansibot
added
the
stale_ci
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch automatically loads
patch_ansible_modulefixture intopytest when running
ansible-test units. It previously existedin
conftest.pyhence only available to tests of ansible/ansibleitself. Now, third-party collections will be able to use it without
having to vendor the source code.
SUMMARY
As per above: this exposes
patch_ansible_modulefixture to any unit tests executed viaansible-test.ISSUE TYPE
COMPONENT NAME
ansible-test
ADDITIONAL INFORMATION
N/A