Implement stdout callback and its logic as a collection

.gitignore

@@ -24,3 +24,4 @@ test/integration/containerized/priv_data/artifacts/
 *,cover
 .venv
 .env
+/test/integration/artifacts/

Dockerfile

@@ -6,17 +6,17 @@ ADD demo/project /runner/project
 ADD demo/env /runner/env
 ADD demo/inventory /runner/inventory
 
+# Install the collection for ansible-runner integrations
+ADD ansible_runner/lib/ansible_collections/runner /usr/share/ansible/collections/ansible_collections/runner
+
 # UNDO Before 2.0 Release:
-# Install Ansible and Runner
-#ADD https://releases.ansible.com/ansible-runner/ansible-runner.el8.repo /etc/yum.repos.d/ansible-runner.repo
-#RUN dnf install -y ansible-runner
+# Install Ansible
 RUN dnf install -y python3-pip rsync openssh-clients sshpass glibc-langpack-en git \
     https://github.com/krallin/tini/releases/download/v0.19.0/tini_0.19.0-amd64.rpm && \
     rm -rf /var/cache/dnf
 
 RUN dnf install -y gcc python3-devel
-RUN pip3 install bindep https://github.com/ansible/ansible/archive/devel.tar.gz \
-    https://github.com/ansible/ansible-runner/archive/devel.tar.gz
+RUN pip3 install bindep psutil https://github.com/ansible/ansible/archive/devel.tar.gz
 
 RUN useradd runner && usermod -aG root runner
 

Makefile

@@ -75,6 +75,7 @@ clean:
 	rm -rf deb-build
 	find . -type f -regex ".*\py[co]$$" -delete
 	rm -rf $(shell find test/ -type d -name "artifacts")
+	find . -type d -name "__pycache__" -delete
 
 dist:
 	poetry build

ansible_runner/lib/ansible_collections/runner/wrapper/LICENSE.md

@@ -0,0 +1,168 @@
+Apache License
+==============
+
+_Version 2.0, January 2004_  
+_&lt;<http://www.apache.org/licenses/>&gt;_
+
+### Terms and Conditions for use, reproduction, and distribution
+
+#### 1. Definitions
+
+“License” shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+“Licensor” shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+“Legal Entity” shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, “control” means **(i)** the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the
+outstanding shares, or **(iii)** beneficial ownership of such entity.
+
+“You” (or “Your”) shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+“Source” form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+“Object” form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+“Work” shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+“Derivative Works” shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+“Contribution” shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+“submitted” means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as “Not a Contribution.”
+
+“Contributor” shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+#### 2. Grant of Copyright License
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+#### 3. Grant of Patent License
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+#### 4. Redistribution
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+* **(a)** You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+* **(b)** You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+* **(c)** You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+* **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+#### 5. Submission of Contributions
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+#### 6. Trademarks
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+#### 7. Disclaimer of Warranty
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an “AS IS” BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+#### 8. Limitation of Liability
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+#### 9. Accepting Warranty or Additional Liability
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.

ansible_runner/lib/ansible_collections/runner/wrapper/galaxy.yml

@@ -0,0 +1,11 @@
+---
+namespace: runner
+name: wrapper
+version: 1.0.0
+authors:
+  - Ansible (https://github.com/ansible)
+description: Ansible plugins needed for ansible-runner to function correctly.
+license_file: LICENSE.md
+repository: https://github.com/ansible/ansible-runner/
+homepage: https://ansible-runner.readthedocs.io/
+issues: https://github.com/ansible/ansible-runner/issues

ansible_runner/callbacks/awx_display.py → ansible_runner/lib/ansible_collections/runner/wrapper/plugins/callback/awx_display.py

@@ -31,17 +31,10 @@
       - Set as stdout in config
 '''
 
-# Python
-import os  # noqa
-import sys  # noqa
-
-# Add awx/lib to sys.path.
-awx_lib_path = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
-if awx_lib_path not in sys.path:
-    sys.path.insert(0, awx_lib_path)
-
-# Tower Display Callback
-from display_callback import AWXDefaultCallbackModule  # noqa
+# AWX Display Callback
+from ..module_utils import cleanup  # noqa (registers control persistent cleanup)
+from ..module_utils import display  # noqa (wraps ansible.display.Display methods)
+from ..module_utils.module import AWXDefaultCallbackModule  # noqa
 
 
 # In order to be recognized correctly, self.__class__.__name__ needs to

ansible_runner/callbacks/minimal.py → ansible_runner/lib/ansible_collections/runner/wrapper/plugins/callback/minimal.py

@@ -31,17 +31,10 @@
       - Set as stdout in config
 '''
 
-# Python
-import os  # noqa
-import sys  # noqa
-
-# Add awx/lib to sys.path.
-awx_lib_path = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
-if awx_lib_path not in sys.path:
-    sys.path.insert(0, awx_lib_path)
-
-# Tower Display Callback
-from display_callback import AWXMinimalCallbackModule  # noqa
+# AWX Display Callback
+from ..module_utils import cleanup  # noqa (registers control persistent cleanup)
+from ..module_utils import display  # noqa (wraps ansible.display.Display methods)
+from ..module_utils.module import AWXMinimalCallbackModule  # noqa
 
 
 # In order to be recognized correctly, self.__class__.__name__ needs to

ansible_runner/display_callback/module.py → ansible_runner/lib/ansible_collections/runner/wrapper/plugins/module_utils/module.py

@@ -534,12 +534,12 @@ def v2_runner_on_start(self, host, task):
 
 class AWXDefaultCallbackModule(BaseCallbackModule, DefaultCallbackModule):
 
-    CALLBACK_NAME = 'awx_display'
+    CALLBACK_NAME = 'runner.wrapper.awx_display'
 
 
 class AWXMinimalCallbackModule(BaseCallbackModule, MinimalCallbackModule):
 
-    CALLBACK_NAME = 'minimal'
+    CALLBACK_NAME = 'runner.wrapper.minimal'
 
     def v2_playbook_on_play_start(self, play):
         pass

ansible_runner/lib/ansible_collections/runner/wrapper/requirements.txt

@@ -0,0 +1 @@
+psutil

ansible_runner/runner_config.py

@@ -176,9 +176,6 @@ def prepare(self):
         It's also responsible for wrapping the command with the proper ssh agent invocation
         and setting early ANSIBLE_ environment variables.
         """
-        # ansible_path = find_executable('ansible')
-        # if ansible_path is None or not os.access(ansible_path, os.X_OK):
-        #     raise ConfigurationError("Ansible not found. Make sure that it is installed.")
         if self.private_data_dir is None:
             raise ConfigurationError("Runner Base Directory is not defined")
         if self.module and self.playbook:
@@ -211,21 +208,22 @@ def prepare(self):
             open_fifo_write(self.ssh_key_path, self.ssh_key_data)
             self.command = self.wrap_args_with_ssh_agent(self.command, self.ssh_key_path)
 
-        # Use local callback directory
+        # Use local collection directory
+        collection_dir = self.env.get('AWX_LIB_DIRECTORY', os.getenv('AWX_LIB_DIRECTORY'))
+
         if not self.containerized:
-            callback_dir = self.env.get('AWX_LIB_DIRECTORY', os.getenv('AWX_LIB_DIRECTORY'))
-            if callback_dir is None:
-                callback_dir = os.path.join(os.path.split(os.path.abspath(__file__))[0], "callbacks")
+            if collection_dir is None:
+                collection_dir = os.path.join(os.path.split(os.path.abspath(__file__))[0], "lib")
             python_path = self.env.get('PYTHONPATH', os.getenv('PYTHONPATH', ''))
-            self.env['PYTHONPATH'] = ':'.join([python_path, callback_dir])
+            self.env['PYTHONPATH'] = ':'.join([python_path, collection_dir])
             if python_path and not python_path.endswith(':'):
                 python_path += ':'
-            self.env['ANSIBLE_CALLBACK_PLUGINS'] = ':'.join(filter(None,(self.env.get('ANSIBLE_CALLBACK_PLUGINS'), callback_dir)))
+            self.env['ANSIBLE_COLLECTIONS_PATHS'] = ':'.join(filter(None,(self.env.get('ANSIBLE_COLLECTIONS_PATHS'), collection_dir)))
 
         if 'AD_HOC_COMMAND_ID' in self.env:
-            self.env['ANSIBLE_STDOUT_CALLBACK'] = 'minimal'
+            self.env['ANSIBLE_STDOUT_CALLBACK'] = 'runner.wrapper.minimal'
         else:
-            self.env['ANSIBLE_STDOUT_CALLBACK'] = 'awx_display'
+            self.env['ANSIBLE_STDOUT_CALLBACK'] = 'runner.wrapper.awx_display'
         self.env['ANSIBLE_RETRY_FILES_ENABLED'] = 'False'
         if 'ANSIBLE_HOST_KEY_CHECKING' not in self.env:
             self.env['ANSIBLE_HOST_KEY_CHECKING'] = 'False'

test/data/job_env/env/settings

@@ -1,3 +1,3 @@
 ---
-process_isolation_executable: podman
+process_isolation_executable: docker
 process_isolation: true

test/unit/test_runner_config.py

@@ -364,18 +364,12 @@ def test_prepare():
     assert not hasattr(rc, 'ssh_key_path')
     assert not hasattr(rc, 'command')
 
-    assert rc.env['ANSIBLE_STDOUT_CALLBACK'] == 'awx_display'
+    assert rc.env['ANSIBLE_STDOUT_CALLBACK'] == 'runner.wrapper.awx_display'
     assert rc.env['ANSIBLE_RETRY_FILES_ENABLED'] == 'False'
     assert rc.env['ANSIBLE_HOST_KEY_CHECKING'] == 'False'
     assert rc.env['AWX_ISOLATED_DATA_DIR'] == '/'
-    assert rc.env['PYTHONPATH'] == '/python_path_via_environ:/awx_lib_directory_via_environ', \
-        "PYTHONPATH is the union of the env PYTHONPATH and AWX_LIB_DIRECTORY"
 
-    del rc.env['PYTHONPATH']
-    os.environ['PYTHONPATH'] = "/foo/bar/python_path_via_environ"
     rc.prepare()
-    assert rc.env['PYTHONPATH'] == "/foo/bar/python_path_via_environ:/awx_lib_directory_via_environ", \
-        "PYTHONPATH is the union of the explicit env['PYTHONPATH'] override and AWX_LIB_DIRECTORY"
 
 
 @patch('ansible_runner.runner_config.open_fifo_write')

utils/entrypoint.sh

@@ -11,12 +11,4 @@ runner:x:`id -u`:`id -g`:,,,:/home/runner:/bin/bash
 EOF
 fi
 
-if [[ -n "${LAUNCHED_BY_RUNNER}" ]]; then
-    RUNNER_CALLBACKS=$(python3 -c "import ansible_runner.callbacks; print(ansible_runner.callbacks.__file__)")
-
-    # TODO: respect user callback settings via
-    # env ANSIBLE_CALLBACK_PLUGINS or ansible.cfg
-    export ANSIBLE_CALLBACK_PLUGINS="$(dirname $RUNNER_CALLBACKS)"
-fi
-
 exec tini -- "${@}"