Ansible is a radically simple IT automation platform that makes your applications and systems easier to deploy and maintain. Automate everything from code deployment to network configuration to cloud management, in a language that approaches plain English, using SSH, with no agents to install on remote systems. https://docs.ansible.com.

SUMMARY

• Allow disabled, unsupported, unstable and destructive integration test targets to be selected using their respective prefixes.
• Allow unstable tests to run when targeted changes are made and the --allow-unstable-changed option is specified (resolves https://github.com/ansible/ansible/issues/74213).

ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME

ansible-test

Summary

When attempting to install a standalone deb package (none apt-get based) using the apt module the module does not report consistent information across two different types of runs.

This does not allow the correct handling of changed_when or failed_when calls since two different runs do not contain the same registered objects.

When installing a deb package on a host that does not have the defined package installed, you get "changed", "diff", "failed", "stderr", "stderr_lines", "stdout" defined vars returned.

When the package is already installed but the defined package is an older version then whats installed on the target host, you get: "changed","failed", "msg" vars.

This is not a consistent return method to handle errors or in this case a "msg".

Issue Type

Bug Report

Component Name

apt

Ansible Version

$ ansible --version
ansible [core 2.12.9]
  config file = /etc/ansible/ansible.cfg
  configured module search path = ['/home/<user>/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python3/dist-packages/ansible
  ansible collection location = /home/<user>/.ansible/collections:/usr/share/ansible/collections
  executable location = /usr/bin/ansible
  python version = 3.8.10 (default, Jun 22 2022, 20:18:18) [GCC 9.4.0]
  jinja version = 2.10.1
  libyaml = True

$ ansible --version
ansible 2.9.6
  config file = /etc/ansible/ansible.cfg
  configured module search path = ['/home/<user>/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python3/dist-packages/ansible
  executable location = /usr/bin/ansible
  python version = 3.8.10 (default, Jun 22 2022, 20:18:18) [GCC 9.4.0]

Configuration

Default Config

OS / Environment

Ubuntu 20.04 Kernel: 5.15.0-33-generic

Steps to Reproduce

---
- hosts: all
  become: true

  tasks:
    - name: Install Deb
      ansible.builtin.apt:
        deb: file.deb
      register: result

    - name: Deb Debug
      ansible.builtin.debug:
        var: result
...

Expected Results

1. A return code "result.rc"
2. A consistent return method for the registered vars no matter the result
   • 'stdout' vs 'msg'
3. Not to have to use ignore_errors to handle the particular issue
4. Potential module documentation mentions a msg return value

Overall I expected the job to not fail and/or at least place the "msg" into 'stdout' or 'stderr' so I could parse the return correctly and define my own failure. I can understand the type of failure I am encountering due to the versioning and it probbaly should be higher. I also do not want to downgrade.

Yes this is a valid error for the targeted deb package, the version of the deb package attempting to be installed is older then what is on the host.

Actual Results

TASK [<Deb Package>] **************************************************************
Wednesday 21 September 2022  17:54:47 +0000 (0:00:37.424)       0:13:56.693 *** 
ok: [<targeted host>] => {
    "result": {
        "changed": true,
        "diff": {},
        "failed": true,
        "stderr": "",
        "stderr_lines": [],
        "stdout": "Reading package lists...\nBuilding dependency tree...\nReading state information...\nThe following NEW packages will be installed:\n  libegl1-mesa libgl1-mesa-glx libxcb-xtest0\n0 upgraded, 3 newly installed, 0 to remove and 53 not upgraded.\nNeed to get 16.7 kB of archives.\nAfter this operation, 180 kB of additional disk space will be used.\nGet:1 http://us.archive.ubuntu.com/ubuntu focal-updates/universe amd64 libegl1-mesa amd64 21.2.6-0ubuntu0.1~20.04.2 [6408 B]\nGet:2 http://us.archive.ubuntu.com/ubuntu focal-updates/main amd64 libgl1-mesa-glx amd64 21.2.6-0ubuntu0.1~20.04.2 [5536 B]\nGet:3 http://us.archive.ubuntu.com/ubuntu focal/main amd64 libxcb-xtest0 amd64 1.14-2 [4804 B]\nFetched 16.7 kB in 0s (106 kB/s)\nSelecting previously unselected package libegl1-mesa:amd64.\r\n(Reading database ... \r(Reading database ... 5%\r(Reading database ... 10%\r(Reading database ... 15%\r(Reading database ... 20%\r(Reading database ... 25%\r(Reading database ... 30%\r(Reading database ... 35%\r(Reading database ... 40%\r(Reading database ... 45%\r(Reading database ... 50%\r(Reading database ... 55%\r(Reading database ... 60%\r(Reading database ... 65%\r(Reading database ... 70%\r(Reading database ... 75%\r(Reading database ... 80%\r(Reading database ... 85%\r(Reading database ... 90%\r(Reading database ... 95%\r(Reading database ... 100%\r(Reading database ... 161798 files and directories currently installed.)\r\nPreparing to unpack .../libegl1-mesa_21.2.6-0ubuntu0.1~20.04.2_amd64.deb ...\r\nUnpacking libegl1-mesa:amd64 (21.2.6-0ubuntu0.1~20.04.2) ...\r\nSelecting previously unselected package libgl1-mesa-glx:amd64.\r\nPreparing to unpack .../libgl1-mesa-glx_21.2.6-0ubuntu0.1~20.04.2_amd64.deb ...\r\nUnpacking libgl1-mesa-glx:amd64 (21.2.6-0ubuntu0.1~20.04.2) ...\r\nSelecting previously unselected package libxcb-xtest0:amd64.\r\nPreparing to unpack .../libxcb-xtest0_1.14-2_amd64.deb ...\r\nUnpacking libxcb-xtest0:amd64 (1.14-2) ...\r\nSetting up libegl1-mesa:amd64 (21.2.6-0ubuntu0.1~20.04.2) ...\r\nSetting up libxcb-xtest0:amd64 (1.14-2) ...\r\nSetting up libgl1-mesa-glx:amd64 (21.2.6-0ubuntu0.1~20.04.2) ...\r\nProcessing triggers for libc-bin (2.31-0ubuntu9.7) ...\r\nSelecting previously unselected package <deb package>.\n(Reading database ... 161815 files and directories currently installed.)\nPreparing to unpack .../files/<deb package>.deb ...\nUnpacking <deb package> ...\nSetting up <deb package> ...\nrun post install script, action is configure...\nProcessing triggers for gnome-menus (3.36.0-1ubuntu1) ...\nProcessing triggers for desktop-file-utils (0.24-1ubuntu3) ...\nProcessing triggers for mime-support (3.64ubuntu1) ...\nProcessing triggers for shared-mime-info (1.15-1) ...\n",
        "stdout_lines": [
            "Reading package lists...",
            "Building dependency tree...",
            "Reading state information...",
            "The following NEW packages will be installed:",
            "  libegl1-mesa libgl1-mesa-glx libxcb-xtest0",
            "0 upgraded, 3 newly installed, 0 to remove and 53 not upgraded.",
            "Need to get 16.7 kB of archives.",
            "After this operation, 180 kB of additional disk space will be used.",
            "Get:1 http://us.archive.ubuntu.com/ubuntu focal-updates/universe amd64 libegl1-mesa amd64 21.2.6-0ubuntu0.1~20.04.2 [6408 B]",
            "Get:2 http://us.archive.ubuntu.com/ubuntu focal-updates/main amd64 libgl1-mesa-glx amd64 21.2.6-0ubuntu0.1~20.04.2 [5536 B]",
            "Get:3 http://us.archive.ubuntu.com/ubuntu focal/main amd64 libxcb-xtest0 amd64 1.14-2 [4804 B]",
            "Fetched 16.7 kB in 0s (106 kB/s)",
            "Selecting previously unselected package libegl1-mesa:amd64.",
            "(Reading database ... ",
            "(Reading database ... 5%",
            "(Reading database ... 10%",
            "(Reading database ... 15%",
            "(Reading database ... 20%",
            "(Reading database ... 25%",
            "(Reading database ... 30%",
            "(Reading database ... 35%",
            "(Reading database ... 40%",
            "(Reading database ... 45%",
            "(Reading database ... 50%",
            "(Reading database ... 55%",
            "(Reading database ... 60%",
            "(Reading database ... 65%",
            "(Reading database ... 70%",
            "(Reading database ... 75%",
            "(Reading database ... 80%",
            "(Reading database ... 85%",
            "(Reading database ... 90%",
            "(Reading database ... 95%",
            "(Reading database ... 100%",
            "(Reading database ... 161798 files and directories currently installed.)",
            "Preparing to unpack .../libegl1-mesa_21.2.6-0ubuntu0.1~20.04.2_amd64.deb ...",
            "Unpacking libegl1-mesa:amd64 (21.2.6-0ubuntu0.1~20.04.2) ...",
            "Selecting previously unselected package libgl1-mesa-glx:amd64.",
            "Preparing to unpack .../libgl1-mesa-glx_21.2.6-0ubuntu0.1~20.04.2_amd64.deb ...",
            "Unpacking libgl1-mesa-glx:amd64 (21.2.6-0ubuntu0.1~20.04.2) ...",
            "Selecting previously unselected package libxcb-xtest0:amd64.",
            "Preparing to unpack .../libxcb-xtest0_1.14-2_amd64.deb ...",
            "Unpacking libxcb-xtest0:amd64 (1.14-2) ...",
            "Setting up libegl1-mesa:amd64 (21.2.6-0ubuntu0.1~20.04.2) ...",
            "Setting up libxcb-xtest0:amd64 (1.14-2) ...",
            "Setting up libgl1-mesa-glx:amd64 (21.2.6-0ubuntu0.1~20.04.2) ...",
            "Processing triggers for libc-bin (2.31-0ubuntu9.7) ...",
            "Selecting previously unselected package <deb package>.",
            "(Reading database ... 161815 files and directories currently installed.)",
            "Preparing to unpack .../files/<deb package> ...",
            "Unpacking <deb package> ...",
            "Setting up <deb package> ...",
            "run post install script, action is configure...",
            "Processing triggers for gnome-menus (3.36.0-1ubuntu1) ...",
            "Processing triggers for desktop-file-utils (0.24-1ubuntu3) ...",
            "Processing triggers for mime-support (3.64ubuntu1) ...",
            "Processing triggers for shared-mime-info (1.15-1) ..."
        ]
    }
}


sudo ansible-playbook -i localhost, --connection local test_deb.yml -vvvv
ansible-playbook [core 2.12.9]
  config file = /etc/ansible/ansible.cfg
  configured module search path = ['/root/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python3/dist-packages/ansible
  ansible collection location = /root/.ansible/collections:/usr/share/ansible/collections
  executable location = /usr/bin/ansible-playbook
  python version = 3.8.10 (default, Jun 22 2022, 20:18:18) [GCC 9.4.0]
  jinja version = 2.10.1
  libyaml = True
Using /etc/ansible/ansible.cfg as config file
setting up inventory plugins
Set default localhost to localhost
Parsed localhost, inventory source with host_list plugin
Loading callback plugin default of type stdout, v2.0 from /usr/lib/python3/dist-packages/ansible/plugins/callback/default.py
Skipping callback 'default', as we already have a stdout callback.
Skipping callback 'minimal', as we already have a stdout callback.
Skipping callback 'oneline', as we already have a stdout callback.

PLAYBOOK: test_deb.yml *******************************************************************************************************************************************************************************************
Positional arguments: test_deb.yml
verbosity: 4
connection: local
timeout: 10
become_method: sudo
tags: ('all',)
inventory: ('localhost,',)
forks: 5
1 plays in test_deb.yml

PLAY [all] *******************************************************************************************************************************************************************************************************

TASK [Gathering Facts] *******************************************************************************************************************************************************************************************
task path: /home/<usr>/test_deb.yml:2
<localhost> ESTABLISH LOCAL CONNECTION FOR USER: root
<localhost> EXEC /bin/sh -c 'echo ~root && sleep 0'
<localhost> EXEC /bin/sh -c '( umask 77 && mkdir -p "` echo /root/.ansible/tmp `"&& mkdir "` echo /root/.ansible/tmp/ansible-tmp-1663863756.7363076-395839-205109198181144 `" && echo ansible-tmp-1663863756.7363076-395839-205109198181144="` echo /root/.ansible/tmp/ansible-tmp-1663863756.7363076-395839-205109198181144 `" ) && sleep 0'
<localhost> Attempting python interpreter discovery
<localhost> EXEC /bin/sh -c 'echo PLATFORM; uname; echo FOUND; command -v '"'"'python3.10'"'"'; command -v '"'"'python3.9'"'"'; command -v '"'"'python3.8'"'"'; command -v '"'"'python3.7'"'"'; command -v '"'"'python3.6'"'"'; command -v '"'"'python3.5'"'"'; command -v '"'"'/usr/bin/python3'"'"'; command -v '"'"'/usr/libexec/platform-python'"'"'; command -v '"'"'python2.7'"'"'; command -v '"'"'python2.6'"'"'; command -v '"'"'/usr/bin/python'"'"'; command -v '"'"'python'"'"'; echo ENDFOUND && sleep 0'
<localhost> EXEC /bin/sh -c '/usr/bin/python3.8 && sleep 0'
Using module file /usr/lib/python3/dist-packages/ansible/modules/setup.py
<localhost> PUT /root/.ansible/tmp/ansible-local-395831iitw6po2/tmpsquhozex TO /root/.ansible/tmp/ansible-tmp-1663863756.7363076-395839-205109198181144/AnsiballZ_setup.py
<localhost> EXEC /bin/sh -c 'chmod u+x /root/.ansible/tmp/ansible-tmp-1663863756.7363076-395839-205109198181144/ /root/.ansible/tmp/ansible-tmp-1663863756.7363076-395839-205109198181144/AnsiballZ_setup.py && sleep 0'
<localhost> EXEC /bin/sh -c '/usr/bin/python3 /root/.ansible/tmp/ansible-tmp-1663863756.7363076-395839-205109198181144/AnsiballZ_setup.py && sleep 0'
<localhost> EXEC /bin/sh -c 'rm -f -r /root/.ansible/tmp/ansible-tmp-1663863756.7363076-395839-205109198181144/ > /dev/null 2>&1 && sleep 0'
ok: [localhost]
META: ran handlers

TASK [Install Deb] **********************************************************************************************************************************************************************************************
task path: /home/<user>/test_deb.yml:6
<localhost> ESTABLISH LOCAL CONNECTION FOR USER: root
<localhost> EXEC /bin/sh -c 'echo ~root && sleep 0'
<localhost> EXEC /bin/sh -c '( umask 77 && mkdir -p "` echo /root/.ansible/tmp `"&& mkdir "` echo /root/.ansible/tmp/ansible-tmp-1663863758.8735003-395993-93000336538362 `" && echo ansible-tmp-1663863758.8735003-395993-93000336538362="` echo /root/.ansible/tmp/ansible-tmp-1663863758.8735003-395993-93000336538362 `" ) && sleep 0'
Using module file /usr/lib/python3/dist-packages/ansible/modules/apt.py
<localhost> PUT /root/.ansible/tmp/ansible-local-395831iitw6po2/tmpj29bt1jw TO /root/.ansible/tmp/ansible-tmp-1663863758.8735003-395993-93000336538362/AnsiballZ_apt.py
<localhost> EXEC /bin/sh -c 'chmod u+x /root/.ansible/tmp/ansible-tmp-1663863758.8735003-395993-93000336538362/ /root/.ansible/tmp/ansible-tmp-1663863758.8735003-395993-93000336538362/AnsiballZ_apt.py && sleep 0'
<localhost> EXEC /bin/sh -c '/usr/bin/python3 /root/.ansible/tmp/ansible-tmp-1663863758.8735003-395993-93000336538362/AnsiballZ_apt.py && sleep 0'
<localhost> EXEC /bin/sh -c 'rm -f -r /root/.ansible/tmp/ansible-tmp-1663863758.8735003-395993-93000336538362/ > /dev/null 2>&1 && sleep 0'
fatal: [localhost]: FAILED! => {
    "changed": false,
    "invocation": {
        "module_args": {
            "allow_downgrade": false,
            "allow_unauthenticated": false,
            "autoclean": false,
            "autoremove": false,
            "cache_valid_time": 0,
            "deb": "file.deb",
            "default_release": null,
            "dpkg_options": "force-confdef,force-confold",
            "fail_on_autoremove": false,
            "force": false,
            "force_apt_get": false,
            "install_recommends": null,
            "lock_timeout": 60,
            "only_upgrade": false,
            "package": null,
            "policy_rc_d": null,
            "purge": false,
            "state": "present",
            "update_cache": null,
            "update_cache_retries": 5,
            "update_cache_retry_max_delay": 12,
            "upgrade": null
        }
    },
    "msg": "A later version is already installed"
}

PLAY RECAP *******************************************************************************************************************************************************************************************************
localhost                  : ok=1    changed=0    unreachable=0    failed=1    skipped=0    rescued=0    ignored=0

Code of Conduct

• [X] I agree to follow the Ansible Code of Conduct

create specific function to find config entry to avoid repopulating constantly Fixes #78795 alt to #78856

ci_complete

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

plugin loader

SUMMARY

Adds a suggested note mentioned in https://github.com/ansible/ansible/issues/72389#issuecomment-1234750451 and polishes the sample_setup.rst file in general.

ISSUE TYPE

• Docs Pull Request

COMPONENT NAME

docs.ansible.com

ADDITIONAL INFORMATION

https://github.com/ansible/ansible/issues/72389

Summary

Note: First off I am not 100% that this is a bug. It could very well be that the short name behaviour that we and other uses is an unintended consequence, and if so confirmation of the same is probably enough. If we should be able to intercept, some guidance on how we should go about modifying the task executor would be appreciated and we can PR based on that.

Currently we have a number of action plugins which intercept upstream plugins to do things like inject passwords, or guard certain functions for our environment. General prerequisite work before modules execute as per the docs.

Example would be the jira plugin where we inject username and password for users instead of requiring it in definition or playbook header.

Our action plugin lives at plugins/action/jira.py and gets call when a user calls jira via the shortname. If a user switches over the the fqcn of community.general.jira, our action plugin no longer intercepts the call, reverting back to the normal action plugin.

Issue Type

Bug Report

Component Name

task_executor

Ansible Version

$ ansible --version
ansible [core 2.13.4]
  config file = /usr/share/ansible/ansible.cfg
  configured module search path = ['/usr/share/ansible/library']
  ansible python module location = /usr/lib/python3.8/site-packages/ansible
  ansible collection location = /usr/lib/python3.8/site-packages/ansible_collections
  executable location = /usr/bin/ansible
  python version = 3.8.13 (default, Apr 28 2022, 12:34:52) [GCC 8.3.1 20190311 (Red Hat 8.3.1-3)]
  jinja version = 3.1.2
  libyaml = True

Configuration

# if using a version older than ansible-core 2.12 you should omit the '-t all'
$ ansible-config dump --only-changed -t all
CALLBACKS_ENABLED(/usr/share/ansible/ansible.cfg) = ['syslog', 'timer', 'yaml']
COLLECTIONS_PATHS(/usr/share/ansible/ansible.cfg) = ['/usr/lib/python3.8/site-packages/ansible_collections']
COLOR_VERBOSE(/usr/share/ansible/ansible.cfg) = bright blue
DEFAULT_ACTION_PLUGIN_PATH(/usr/share/ansible/ansible.cfg) = ['/usr/share/ansible/plugins/action']
DEFAULT_CALLBACK_PLUGIN_PATH(/usr/share/ansible/ansible.cfg) = ['/usr/share/ansible/plugins/callback']
DEFAULT_FILTER_PLUGIN_PATH(/usr/share/ansible/ansible.cfg) = ['/usr/share/ansible/plugins/filter']
DEFAULT_GATHERING(/usr/share/ansible/ansible.cfg) = smart
DEFAULT_HOST_LIST(/usr/share/ansible/ansible.cfg) = ['/usr/share/ansible/inventory/consort.yml']
DEFAULT_INVENTORY_PLUGIN_PATH(/usr/share/ansible/ansible.cfg) = ['/usr/share/ansible/plugins/inventory']
DEFAULT_LOAD_CALLBACK_PLUGINS(/usr/share/ansible/ansible.cfg) = True
DEFAULT_LOG_PATH(/usr/share/ansible/ansible.cfg) = /root/.ansible/logs/ansible.log
DEFAULT_LOOKUP_PLUGIN_PATH(/usr/share/ansible/ansible.cfg) = ['/usr/share/ansible/plugins/lookup']
DEFAULT_MODULE_PATH(/usr/share/ansible/ansible.cfg) = ['/usr/share/ansible/library']
DEFAULT_MODULE_UTILS_PATH(/usr/share/ansible/ansible.cfg) = ['/usr/share/ansible/module_utils']
DEFAULT_ROLES_PATH(/usr/share/ansible/ansible.cfg) = ['/usr/share/ansible/roles']
DEFAULT_STDOUT_CALLBACK(/usr/share/ansible/ansible.cfg) = yaml
DEFAULT_TIMEOUT(/usr/share/ansible/ansible.cfg) = 15
DEFAULT_VAULT_PASSWORD_FILE(env: ANSIBLE_VAULT_PASSWORD_FILE) = /root/.ansible/.vault_pass.key
INVENTORY_CACHE_PLUGIN(/usr/share/ansible/ansible.cfg) = jsonfile
INVENTORY_CACHE_PLUGIN_CONNECTION(/usr/share/ansible/ansible.cfg) = /root/.ansible/cache
RETRY_FILES_ENABLED(/usr/share/ansible/ansible.cfg) = False
TRANSFORM_INVALID_GROUP_CHARS(/usr/share/ansible/ansible.cfg) = ignore

CONNECTION:
==========

ssh:
___
pipelining(/usr/share/ansible/ansible.cfg) = True
ssh_args(/usr/share/ansible/ansible.cfg) = -C -o ServerAliveInterval=5 -o ServerAliveCountMax=2 -o ControlMaster=auto -o ControlPersist=120s -o PreferredAuthentications=publickey,password -o UserKnownHostsFile=/dev/null -o StrictHostKe
timeout(/usr/share/ansible/ansible.cfg) = 15

INVENTORY:
=========

consort:
_______
cache_connection(/usr/share/ansible/ansible.cfg) = /root/.ansible/cache
cache_plugin(/usr/share/ansible/ansible.cfg) = jsonfile

OS / Environment

Centos 7 Docker container

Steps to Reproduce

Action plugin intercepts

jira:
    issue: 'TEST-1'
    operation: comment
    comment: A comment added by Ansible

Action plugin doe not intercept

community.general.jira:
    issue: 'TEST-1'
    operation: comment
    comment: A comment added by Ansible

Expected Results

A way to have action plugins intercept fqcn module calls when action plugins are stored in the top level action plugins directory.

Actual Results

`ansible.legacy.normal` is the action plugin handler called instead of the `jira` top level action plugin.

Code of Conduct

• [X] I agree to follow the Ansible Code of Conduct