Throw LockFailedException if apt cmd encounters a lock file

[chrispbailey]

SUMMARY

Fixes #78658

ISSUE TYPE

• Bugfix Pull Request

ADDITIONAL INFORMATION

An earlier attempt (#78658) to fix this issue didn't work for me because because DPkg::Lock::Timeout is an apt parameter not a dpkg one.

The code supports the lock_timeout parameter but the problem here is that the when the lock issue is encountered, the code subsequently runs m.fail_json which then calls sys.exit and this bypasses the except apt.cache.LockFailedException handler so the cmd is never re-tried.

I'm sure there are better solutions to this issue but I'm raising this PR here just in case others want to use this solution by overriding apt.py locally.

[ansibot]

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

lib/ansible/modules/apt.py:823:0: trailing-whitespace: Trailing whitespace
lib/ansible/modules/apt.py:825:0: trailing-whitespace: Trailing whitespace

The test ansible-test sanity --test pep8 [explain] failed with 3 errors:

lib/ansible/modules/apt.py:823:1: W293: blank line contains whitespace
lib/ansible/modules/apt.py:825:1: W293: blank line contains whitespace
lib/ansible/modules/apt.py:1548:1: E305: expected 2 blank lines after class or function definition, found 1

click here for bot help

[jborean93]

Thanks for PR, are you able to create a changelog fragment for this bugfix as per https://docs.ansible.com/ansible/latest/community/development_process.html#creating-changelog-fragments. It would also be great to have an integration test for at least some of the scenarios, it could potentially be done by having an async task that locks the file while you then run a normal task that expects the lock to be there and fail after the timeout.

[webknjaz]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[webknjaz]

@mattclay @sivel this is an example PR that #84375 / #84402 would've helped with.