Support --check mode for pip install --user

[ddimtirov]

SUMMARY

Currently when we need to specify pip install --user ..., the --user argument goes in as extra argument. This breaks the ansible --check mode, as illustrated byt he following commands:

# OK
ansible -m pip -a "extra_args=--user name=pytz" $HOSTNAME

# CHANGED
ansible -m pip -a "extra_args=--user name=pytz" $HOSTNAME --check

The code responsible for this behaviour is here:

ansible/lib/ansible/modules/pip.py

Line 719 in 195c8b4

if extra_args or requirements or state == 'latest' or not name:

I would like to request that we either add a separate parameter to request that pip installation is in the user site, or add a further analysis of the content of the extra args (and if it is only --user run the check mode). The latter option would transparently fix all current playbooks which erroneously report changed.

ISSUE TYPE

• Feature Idea

COMPONENT NAME

pip module

ADDITIONAL INFORMATION

- name: Install ansible and dependencies on all hosts
  pip:
    name: ['ansible==2.9.6', 'pytz', 'lxml', 'ansible-lint', 'python-dateutil']
    extra_args: --user

Could become:

- name: Install ansible and dependencies on all hosts
  pip:
    name: ['ansible==2.9.6', 'pytz', 'lxml', 'ansible-lint', 'python-dateutil']
    user_site: on

[ansibot]

Files identified in the description:

• lib/ansible/modules/pip.py

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help

[samdoran]

Currently we just exit with change=True if there are any extra_args in check_mode. To solve this properly, we would need to make the --user a module parameter rather than going into the extra_args and having to special case that string in a sea of args.

[ansibot]

Thank you very much for your submission to Ansible. It means a lot to us that you've taken time to contribute.

Unfortunately, this issue has been open for some time while waiting for a contributor to take it up but there does not seem to have been anyone that did so. So we are going to close this issue to clear up the queues and make it easier for contributors to browse possible implementation targets.

However, we're absolutely always up for discussion. Because this project is very active, we're unlikely to see comments made on closed tickets and we lock them after some time. If you or anyone else has any further questions, please let us know by using any of the communication methods listed in the page below:

• https://docs.ansible.com/ansible/latest/community/communication.html

In the future, sometimes starting a discussion on the development list prior to proposing or implementing a feature can make getting things included a little easier, but it's not always necessary.

Thank you once again for this and your interest in Ansible!

click here for bot help