pipx/pipx_info: multiple fixes (#9044)

* pipx_info: factored process_list out

* pipx_info: no need to pass param to _list

* pipx_info: minor adjustment

* pipx mod utils: make_process_list parameters

* fix test for state=install_all

* fix assertions

* pipx tests: fix detection of pipx 1.7.0

* pipx: use make_process_output

* add testcase

* pipx: remove import json

* pinned in pipx list is not always there

* Update plugins/modules/pipx_info.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* remove ensurepath and --user from pipx install

* add changelog frag

* Update changelogs/fragments/9044-pipx-fixes.yml

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update changelogs/fragments/9044-pipx-fixes.yml

* Update changelogs/fragments/9044-pipx-fixes.yml

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update changelogs/fragments/9044-pipx-fixes.yml

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>

changelogs/fragments/9044-pipx-fixes.yml

@@ -0,0 +1,7 @@
+minor_changes:
+  - pipx - refactor out parsing of ``pipx list`` output to module utils (https://github.com/ansible-collections/community.general/pull/9044).
+  - pipx_info - refactor out parsing of ``pipx list`` output to module utils (https://github.com/ansible-collections/community.general/pull/9044).
+  - pipx_info - add new return value ``pinned`` (https://github.com/ansible-collections/community.general/pull/9044).
+bugfixes:
+  - pipx module utils - add missing command line formatter for argument ``spec_metadata`` (https://github.com/ansible-collections/community.general/pull/9044).
+  - pipx - it was ignoring ``global`` when listing existing applications (https://github.com/ansible-collections/community.general/pull/9044).

plugins/module_utils/pipx.py

@@ -6,6 +6,10 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
+
+import json
+
+
 from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt as fmt
 
 
@@ -51,6 +55,7 @@ def pipx_runner(module, command, **kwargs):
         editable=fmt.as_bool("--editable"),
         pip_args=fmt.as_opt_eq_val('--pip-args'),
         suffix=fmt.as_opt_val('--suffix'),
+        spec_metadata=fmt.as_list(),
     )
     arg_formats["global"] = fmt.as_bool("--global")
 
@@ -63,3 +68,38 @@ def pipx_runner(module, command, **kwargs):
         **kwargs
     )
     return runner
+
+
+def make_process_list(mod_helper, **kwargs):
+    def process_list(rc, out, err):
+        if not out:
+            return []
+
+        results = []
+        raw_data = json.loads(out)
+        if kwargs.get("include_raw"):
+            mod_helper.vars.raw_output = raw_data
+
+        if kwargs["name"]:
+            if kwargs["name"] in raw_data['venvs']:
+                data = {kwargs["name"]: raw_data['venvs'][kwargs["name"]]}
+            else:
+                data = {}
+        else:
+            data = raw_data['venvs']
+
+        for venv_name, venv in data.items():
+            entry = {
+                'name': venv_name,
+                'version': venv['metadata']['main_package']['package_version'],
+                'pinned': venv['metadata']['main_package'].get('pinned'),
+            }
+            if kwargs.get("include_injected"):
+                entry['injected'] = {k: v['package_version'] for k, v in venv['metadata']['injected_packages'].items()}
+            if kwargs.get("include_deps"):
+                entry['dependencies'] = list(venv['metadata']['main_package']['app_paths_of_dependencies'])
+            results.append(entry)
+
+        return results
+
+    return process_list

plugins/modules/pipx.py

@@ -191,10 +191,8 @@ EXAMPLES = """
 """
 
 
-import json
-
 from ansible_collections.community.general.plugins.module_utils.module_helper import StateModuleHelper
-from ansible_collections.community.general.plugins.module_utils.pipx import pipx_runner, pipx_common_argspec
+from ansible_collections.community.general.plugins.module_utils.pipx import pipx_runner, pipx_common_argspec, make_process_list
 
 from ansible.module_utils.facts.compat import ansible_facts
 
@@ -251,26 +249,14 @@ class PipX(StateModuleHelper):
     use_old_vardict = False
 
     def _retrieve_installed(self):
-        def process_list(rc, out, err):
+        name = _make_name(self.vars.name, self.vars.suffix)
-            if not out:
+        output_process = make_process_list(self, include_injected=True, name=name)
-                return {}
+        installed = self.runner('_list global', output_process=output_process).run()
 
-            results = {}
+        if name is not None:
-            raw_data = json.loads(out)
+            app_list = [app for app in installed if app['name'] == name]
-            for venv_name, venv in raw_data['venvs'].items():
-                results[venv_name] = {
-                    'version': venv['metadata']['main_package']['package_version'],
-                    'injected': {k: v['package_version'] for k, v in venv['metadata']['injected_packages'].items()},
-                }
-            return results
-
-        installed = self.runner('_list', output_process=process_list).run(_list=1)
-
-        if self.vars.name is not None:
-            name = _make_name(self.vars.name, self.vars.suffix)
-            app_list = installed.get(name)
             if app_list:
-                return {name: app_list}
+                return {name: app_list[0]}
             else:
                 return {}
 

plugins/modules/pipx_info.py

@@ -98,6 +98,15 @@ application:
       type: dict
       sample:
         licenses: "0.6.1"
+    pinned:
+      description:
+      - Whether the installed application is pinned or not.
+      - When using C(pipx<=1.6.0), this returns C(null).
+      returned: success
+      type: bool
+      sample:
+        pinned: true
+      version_added: 10.0.0
 
 raw_output:
   description: The raw output of the C(pipx list) command, when O(include_raw=true). Used for debugging.
@@ -112,10 +121,8 @@ cmd:
   sample: ["/usr/bin/python3.10", "-m", "pipx", "list", "--include-injected", "--json"]
 """
 
-import json
-
 from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper
-from ansible_collections.community.general.plugins.module_utils.pipx import pipx_runner, pipx_common_argspec
+from ansible_collections.community.general.plugins.module_utils.pipx import pipx_runner, pipx_common_argspec, make_process_list
 
 from ansible.module_utils.facts.compat import ansible_facts
 
@@ -143,41 +150,10 @@ class PipXInfo(ModuleHelper):
             self.command = [facts['python']['executable'], '-m', 'pipx']
         self.runner = pipx_runner(self.module, self.command)
 
-        # self.vars.set('application', self._retrieve_installed(), change=True, diff=True)
-
     def __run__(self):
-        def process_list(rc, out, err):
+        output_process = make_process_list(self, **self.vars.as_dict())
-            if not out:
+        with self.runner('_list global', output_process=output_process) as ctx:
-                return []
+            self.vars.application = ctx.run()
-
-            results = []
-            raw_data = json.loads(out)
-            if self.vars.include_raw:
-                self.vars.raw_output = raw_data
-
-            if self.vars.name:
-                if self.vars.name in raw_data['venvs']:
-                    data = {self.vars.name: raw_data['venvs'][self.vars.name]}
-                else:
-                    data = {}
-            else:
-                data = raw_data['venvs']
-
-            for venv_name, venv in data.items():
-                entry = {
-                    'name': venv_name,
-                    'version': venv['metadata']['main_package']['package_version']
-                }
-                if self.vars.include_injected:
-                    entry['injected'] = {k: v['package_version'] for k, v in venv['metadata']['injected_packages'].items()}
-                if self.vars.include_deps:
-                    entry['dependencies'] = list(venv['metadata']['main_package']['app_paths_of_dependencies'])
-                results.append(entry)
-
-            return results
-
-        with self.runner('_list global', output_process=process_list) as ctx:
-            self.vars.application = ctx.run(_list=1)
             self._capture_results(ctx)
 
     def _capture_results(self, ctx):

tests/integration/targets/pipx/files/spec.json

@@ -1,91 +0,0 @@
-{
-    "pipx_spec_version": "0.1",
-    "venvs": {
-        "black": {
-            "metadata": {
-                "injected_packages": {},
-                "main_package": {
-                    "app_paths": [
-                        {
-                            "__Path__": "/home/az/.local/pipx/venvs/black/bin/black",
-                            "__type__": "Path"
-                        },
-                        {
-                            "__Path__": "/home/az/.local/pipx/venvs/black/bin/blackd",
-                            "__type__": "Path"
-                        }
-                    ],
-                    "app_paths_of_dependencies": {},
-                    "apps": [
-                        "black",
-                        "blackd"
-                    ],
-                    "apps_of_dependencies": [],
-                    "include_apps": true,
-                    "include_dependencies": false,
-                    "man_pages": [],
-                    "man_pages_of_dependencies": [],
-                    "man_paths": [],
-                    "man_paths_of_dependencies": {},
-                    "package": "black",
-                    "package_or_url": "black",
-                    "package_version": "24.8.0",
-                    "pinned": false,
-                    "pip_args": [],
-                    "suffix": ""
-                },
-                "pipx_metadata_version": "0.5",
-                "python_version": "Python 3.11.9",
-                "source_interpreter": {
-                    "__Path__": "/home/az/.pyenv/versions/3.11.9/bin/python3.11",
-                    "__type__": "Path"
-                },
-                "venv_args": []
-            }
-        },
-        "pycowsay": {
-            "metadata": {
-                "injected_packages": {},
-                "main_package": {
-                    "app_paths": [
-                        {
-                            "__Path__": "/home/az/.local/pipx/venvs/pycowsay/bin/pycowsay",
-                            "__type__": "Path"
-                        }
-                    ],
-                    "app_paths_of_dependencies": {},
-                    "apps": [
-                        "pycowsay"
-                    ],
-                    "apps_of_dependencies": [],
-                    "include_apps": true,
-                    "include_dependencies": false,
-                    "man_pages": [
-                        "man6/pycowsay.6"
-                    ],
-                    "man_pages_of_dependencies": [],
-                    "man_paths": [
-                        {
-                            "__Path__": "/home/az/.local/pipx/venvs/pycowsay/share/man/man6/pycowsay.6",
-                            "__type__": "Path"
-                        }
-                    ],
-                    "man_paths_of_dependencies": {},
-                    "package": "pycowsay",
-                    "package_or_url": "pycowsay",
-                    "package_version": "0.0.0.2",
-                    "pinned": false,
-                    "pip_args": [],
-                    "suffix": ""
-                },
-                "pipx_metadata_version": "0.5",
-                "python_version": "Python 3.11.9",
-                "source_interpreter": {
-                    "__Path__": "/home/az/.pyenv/versions/3.11.9/bin/python3.11",
-                    "__type__": "Path"
-                },
-                "venv_args": []
-            }
-        },
-    }
-}

tests/integration/targets/pipx/files/spec.json.license

@@ -1,3 +0,0 @@
-Copyright (c) Ansible Project
-GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
-SPDX-License-Identifier: GPL-3.0-or-later

tests/integration/targets/pipx/meta/main.yml

@@ -0,0 +1,7 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+dependencies:
+  - setup_remote_tmp_dir

tests/integration/targets/pipx/tasks/main.yml

@@ -3,10 +3,22 @@
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-- name: install pipx
+- name: Determine pipx level
-  pip:
+  block:
-    name: pipx
+    - name: Install pipx>=1.7.0
-    extra_args: --user
+      pip:
+        name: pipx>=1.7.0
+    - name: Set has_pipx170 fact true
+      ansible.builtin.set_fact:
+        has_pipx170: true
+  rescue:
+    - name: Set has_pipx170 fact false
+      ansible.builtin.set_fact:
+        has_pipx170: false
+    - name: Install pipx (no version spec)
+      pip:
+        name: pipx
+
 
 ##############################################################################
 - name: ensure application tox is uninstalled
@@ -233,26 +245,21 @@
 - name: Include testcase for issue 8656
   ansible.builtin.include_tasks: testcase-8656.yml
 
-- name: install pipx
-  pip:
-    name: pipx>=1.7.0
-    extra_args: --user
-  ignore_errors: true
-  register: pipx170_install
-
 - name: Recent features
   when:
-    - pipx170_install is not failed
+    - has_pipx170
-    - pipx170_install is changed
   block:
     - name: Include testcase for PR 8793 --global
       ansible.builtin.include_tasks: testcase-8793-global.yml
 
     - name: Include testcase for PR 8809 install-all
-      ansible.builtin.include_tasks: testcase-8809-install-all.yml
+      ansible.builtin.include_tasks: testcase-8809-installall.yml
 
     - name: Include testcase for PR 8809 pin
       ansible.builtin.include_tasks: testcase-8809-pin.yml
 
     - name: Include testcase for PR 8809 injectpkg
       ansible.builtin.include_tasks: testcase-8809-uninjectpkg.yml
+
+    - name: Include testcase for PR 9009 injectpkg --global
+      ansible.builtin.include_tasks: testcase-9009-fixglobal.yml

tests/integration/targets/pipx/tasks/testcase-8809-installall.yml

@@ -24,10 +24,39 @@
         - pycowsay
       register: uninstall_all_1
 
+    - name: Install pycowsay and black
+      community.general.pipx:
+        state: install
+        name: "{{ item }}"
+      loop:
+        - black
+        - pycowsay
+      register: install_all_1
+
+    - name: Generate JSON spec
+      community.general.pipx_info:
+        include_raw: true
+      register: pipx_list
+
+    - name: Copy content
+      ansible.builtin.copy:
+        content: "{{ pipx_list.raw_output }}"
+        dest: "{{ remote_tmp_dir }}/spec.json"
+        mode: "0644"
+
+    - name: Uninstall pycowsay and black (again)
+      community.general.pipx:
+        state: uninstall
+        name: "{{ item }}"
+      loop:
+        - black
+        - pycowsay
+      register: uninstall_all_2
+
     - name: Use install-all
       community.general.pipx:
-        state: install-all
+        state: install_all
-        spec_metadata: spec.json
+        spec_metadata: "{{ remote_tmp_dir }}/spec.json"
       register: install_all
 
     - name: Run pycowsay (should succeed)
@@ -47,13 +76,14 @@
       loop:
         - black
         - pycowsay
-      register: uninstall_all_2
+      register: uninstall_all_3
 
     - name: Assert uninstall-all
       ansible.builtin.assert:
         that:
           - uninstall_all_1 is not changed
+          - install_all_1 is changed
+          - uninstall_all_2 is changed
           - install_all is changed
           - "'Moooooooo!' in what_the_cow_said.stdout"
-          - "'/usr/local/bin/pycowsay' in which_cow.stdout"
+          - uninstall_all_3 is changed
-          - uninstall_all_2 is changed

tests/integration/targets/pipx/tasks/testcase-8809-pin.yml

@@ -60,10 +60,10 @@
         - pycowsay
       register: uninstall_all_2
 
-    - name: Assert uninstall-all
+    - name: Assert pin/unpin
       ansible.builtin.assert:
         that:
           - pin_cow is changed
-          - cow_info_1 == "0.0.0.1"
+          - cow_info_1.application.0.version == "0.0.0.1"
           - unpin_cow is changed
-          - cow_info_2 != "0.0.0.1"
+          - cow_info_2.application.0.version != "0.0.0.1"

tests/integration/targets/pipx/tasks/testcase-8809-uninjectpkg.yml

@@ -64,6 +64,6 @@
       ansible.builtin.assert:
         that:
           - pin_cow is changed
-          - cow_info_1 == "0.0.0.1"
+          - cow_info_1.application.0.version == "0.0.0.1"
           - unpin_cow is changed
-          - cow_info_2 != "0.0.0.1"
+          - cow_info_2.application.0.version != "0.0.0.1"

tests/integration/targets/pipx/tasks/testcase-9009-fixglobal.yml

@@ -0,0 +1,30 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+- name: 9009-Ensure application pylint is uninstalled
+  community.general.pipx:
+    name: pylint
+    state: absent
+    global: true
+
+- name: 9009-Install application pylint
+  community.general.pipx:
+    name: pylint
+    global: true
+  register: install_pylint
+
+- name: 9009-Inject packages
+  community.general.pipx:
+    state: inject
+    name: pylint
+    global: true
+    inject_packages:
+      - licenses
+
+- name: 9009-Ensure application pylint is uninstalled
+  community.general.pipx:
+    name: pylint
+    state: absent
+    global: true