pip module: During --check, if latest is asked, check using pip list --outdated

[JulienPalard]

Mabe fixes #62826

SUMMARY

In the pip module, I'm using pip list --outdated to list outdated Python packages, in order for --check to be able to tell if a package with state=latest is to be upgraded or not.

Current situation is to always return changed=True when a packaged is state=latest, even if it's at the latest version.

The diff may be bigger than absolutely needed:

• During my "understand the code" phase, I noticed _is_present takes an unused parameter, so I dropped it, as it's really near my diffs anyway.
• Again during the reading phase, I found the if module.check_mode a bit long for what it does (30 lines) itself in a 195 lines of code main function, I had hard times understanding it. So I took care of decreasing the complexity instead of increasing it during my implementation by moving a part dedicated to clean and enhance currently installed packaged in the function dedicated to it, and by implementing my code in a dedicated function too. Now the main is 188 lines (a tad shorter), and the if module.check_mode is 23 lines (with a feature added!).
• I think there was a potential bug in the pkg_list = [p for p in out.split('\n')... line, using the out variable instead of the out_pip variable, the out variable could contain unexpected content from previous runs (setup venv, a few lines before).
• I think there was another potential bug, where _get_packages was used elsewhere, and only with a very old pip, as _get_packages was not adding pip and setuptools to the list, if the installation was to install pip or setuptools, it may get unnoticed by changed = out_freeze_before != out_freeze_after.

The whole thing clearly lacks tests, I only tested it myself and it worked as expected (--check telling a module should be updated, running the playbook upgrades the module, --check again tells it's OK), but I'm out of time for today and have no idea how to test it for now (any hint appreciated).

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

pip

[ansibot]

The test ansible-test sanity --test pylint [explain] failed with 2 errors:

lib/ansible/modules/pip.py:374:59: undefined-variable: Undefined variable 'env'
lib/ansible/modules/pip.py:376:16: undefined-variable: Undefined variable 'pkg_list'

The test ansible-test sanity --test compile --python 2.6 [explain] failed with 1 error:

lib/ansible/modules/pip.py:401:50: SyntaxError: return command, out, err, {package['name'] for package in json.loads(out)}

The test ansible-test sanity --test import --python 2.6 [explain] failed with 1 error:

lib/ansible/modules/pip.py:401:50: traceback: SyntaxError: invalid syntax

click here for bot help

[JulienPalard]

Python 2.6.

[ansibot]

The test ansible-test sanity --test compile --python 2.6 [explain] failed with 1 error:

lib/ansible/modules/pip.py:400:50: SyntaxError: return command, out, err, {package['name'] for package in json.loads(out)}

The test ansible-test sanity --test import --python 2.6 [explain] failed with 1 error:

lib/ansible/modules/pip.py:400:50: traceback: SyntaxError: invalid syntax

click here for bot help

[ansibot]

The test ansible-test sanity --test compile --python 2.6 [explain] failed with 1 error:

lib/ansible/modules/pip.py:761:68: SyntaxError: if not outdated.isdisjoint({package.package_name for package in packages}):

The test ansible-test sanity --test import --python 2.6 [explain] failed with 1 error:

lib/ansible/modules/pip.py:761:68: traceback: SyntaxError: invalid syntax

click here for bot help

[ArsenArsen]

Related to this, state=latest outside of check mode never returns changed, despite possibly reinstalling a package.

[jborean93]

Closing due to inactivity. If this is still something you wish to pursue then please open a new PR. We expect tests to be added for any changes made that fixes issues or updates the behaviour.