From b3392e7061c070e0a3fe1643bd5a81fec2e3eb4c Mon Sep 17 00:00:00 2001 From: Sandra McCann Date: Thu, 24 Oct 2024 15:00:11 -0400 Subject: [PATCH] Remove ansible-test sanity from local module development (#2034) * Remove ansible-test sanity from local module development * Update docs/docsite/rst/dev_guide/developing_modules_general.rst (cherry picked from commit ef72400cc2f70f974ffbb30b63098b31dbd36b07) --- .../rst/dev_guide/developing_modules_general.rst | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/docs/docsite/rst/dev_guide/developing_modules_general.rst b/docs/docsite/rst/dev_guide/developing_modules_general.rst index 44db07f92b4..324e1eb8654 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_general.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_general.rst @@ -33,7 +33,7 @@ It is highly recommended that you use a ``venv`` or ``virtualenv`` for Python de To create a module: -1. Create a ``library`` directory in your workspace, your test play should live in the same directory. +1. Create a ``library`` directory in your workspace. Your test play should live in the same directory. 2. Create your new module file: ``$ touch library/my_test.py``. Or just open/create it with your editor of choice. 3. Paste the content below into your new module file. It includes the :ref:`required Ansible format and documentation `, a simple :ref:`argument spec for declaring the module options `, and some example code. 4. Modify and extend the code to do what you want your new module to do. See the :ref:`programming tips ` and :ref:`Python 3 compatibility ` pages for pointers on writing clean and concise module code. @@ -142,23 +142,13 @@ You can easily run a full test by including it in a playbook, as long as the ``l Testing your newly-created module ================================= -The following two examples will get you started with testing your module code. Please review our :ref:`testing ` section for more detailed +Review our :ref:`testing ` section for more detailed information, including instructions for :ref:`testing module documentation `, adding :ref:`integration tests `, and more. .. note:: If contributing to Ansible, every new module and plugin should have integration tests, even if the tests cannot be run on Ansible CI infrastructure. In this case, the tests should be marked with the ``unsupported`` alias in `aliases file `_. -Performing sanity tests ------------------------ - -You can run through Ansible's sanity checks in a container: - -``$ ansible-test sanity -v --docker --python 3.10 MODULE_NAME`` - -.. note:: - Note that this example requires Docker to be installed and running. If you'd rather not use a container for this, you can choose to use ``--venv`` instead of ``--docker``. - Contributing back to Ansible ============================