[PR #2411/345d5f2d backport][stable-3] snap - revamp + implementing enabled/disabled states

[patchback]

This is a backport of PR #2411 as merged into main (345d5f2).

SUMMARY

Adding the states enabled and disabled, and while at it, did a major revamp of the module.

Fixes #1990

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

plugins/modules/packaging/os/snap.py

[ansibullbot]

cc @angristan @vcarceler
click here for bot help

[felixfontein]

@russoz @aminvakil did one of you happen to run some tests for #2411 (resp. this PR)? There are unfortunately no tests for this module...

[russoz]

Not really, but I think I can come up with some tests for that module.

[aminvakil]

@felixfontein no, I don't use snap, but I can run @russoz integration tests on a temporary VM/OS if it was destructive or anything (although I don't think a package manager's integration test could be destructive :))

[felixfontein]

@jkman340, since you seem to be using the snap module, would you mind to help testing this PR? You can find instructions on how that works here: https://github.com/ansible/community-docs/blob/main/test_pr_locally_guide.rst

[staticdev]

@felixfontein seems to be working here! I also have the problem in #2835.

[felixfontein]

@staticdev thanks a lot for testing this :) It's not supposed to fix #2835 (resp. if it would, it would be coincidental), but at least now we can continue with the new codebase (which this backports also adds to stable-3).

[russoz]

@staticdev thanks for testing! Valeu!! ;-)

[jkman340]

Sorry for delay, was on travel. I've tested the latest stable-3 and see no additional errors. However, #2835 is not fixed for me and still getting same error (Which sounds like is expected for this PR).

[felixfontein]

@jkman340 thanks for testig! I hope you travelled well :)

[staticdev]

@russoz I just did some new tests with the newly released 3.3.0 and I am getting a new error in my workstation:

- name: Install pycharm
  community.general.snap:
    name: "pycharm-professional"
    classic: true
  become: true

snap is installed and running and same task work on previous version.

Output with -vvv:

task path: /home/workuser/workspace/linux-developer-playbook/roles/staticdev.python_developer/tasks/pycharm.yml:8
<127.0.0.1> ESTABLISH LOCAL CONNECTION FOR USER: static
<127.0.0.1> EXEC /bin/sh -c 'echo ~static && sleep 0'
<127.0.0.1> EXEC /bin/sh -c '( umask 77 && mkdir -p "` echo /home/workuser/.ansible/tmp `"&& mkdir "` echo /home/workuser/.ansible/tmp/ansible-tmp-1625049418.5947723-17123-195735620733486 `" && echo ansible-tmp-1625049418.5947723-17123-195735620733486="` echo /home/workuser/.ansible/tmp/ansible-tmp-1625049418.5947723-17123-195735620733486 `" ) && sleep 0'
Using module file /home/workuser/.ansible/collections/ansible_collections/community/general/plugins/modules/snap.py
<127.0.0.1> PUT /home/workuser/.ansible/tmp/ansible-local-14024r06yc4gb/tmp_mn2vdpf TO /home/workuser/.ansible/tmp/ansible-tmp-1625049418.5947723-17123-195735620733486/AnsiballZ_snap.py
<127.0.0.1> EXEC /bin/sh -c 'chmod u+x /home/workuser/.ansible/tmp/ansible-tmp-1625049418.5947723-17123-195735620733486/ /home/workuser/.ansible/tmp/ansible-tmp-1625049418.5947723-17123-195735620733486/AnsiballZ_snap.py && sleep 0'
<127.0.0.1> EXEC /bin/sh -c 'sudo -H -S  -p "[sudo via ansible, key=agogffepwsrldbmzyevgmnvabgykeohg] password:" -u root /bin/sh -c '"'"'echo BECOME-SUCCESS-agogffepwsrldbmzyevgmnvabgykeohg ; /usr/bin/python3 /home/workuser/.ansible/tmp/ansible-tmp-1625049418.5947723-17123-195735620733486/AnsiballZ_snap.py'"'"' && sleep 0'
<127.0.0.1> EXEC /bin/sh -c 'rm -f -r /home/workuser/.ansible/tmp/ansible-tmp-1625049418.5947723-17123-195735620733486/ > /dev/null 2>&1 && sleep 0'
The full traceback is:
Traceback (most recent call last):
  File "/tmp/ansible_community.general.snap_payload_8njs35hv/ansible_community.general.snap_payload.zip/ansible_collections/community/general/plugins/module_utils/mh/deco.py", line 42, in wrapper
    func(self, *args, **kwargs)
  File "/tmp/ansible_community.general.snap_payload_8njs35hv/ansible_community.general.snap_payload.zip/ansible_collections/community/general/plugins/module_utils/mh/base.py", line 60, in run
    self.__run__()
  File "/tmp/ansible_community.general.snap_payload_8njs35hv/ansible_community.general.snap_payload.zip/ansible_collections/community/general/plugins/module_utils/mh/mixins/state.py", line 36, in __run__
    return func()
  File "/tmp/ansible_community.general.snap_payload_8njs35hv/ansible_community.general.snap_payload.zip/ansible_collections/community/general/plugins/modules/snap.py", line 196, in state_present
  File "/tmp/ansible_community.general.snap_payload_8njs35hv/ansible_community.general.snap_payload.zip/ansible_collections/community/general/plugins/modules/snap.py", line 193, in validate_input_snaps
ansible_collections.community.general.plugins.module_utils.mh.exceptions.ModuleHelperException
fatal: [127.0.0.1]: FAILED! => {
    "changed": false,
    "cmd_args": [
        "/usr/bin/snap",
        "i",
        "n",
        "f",
        "o",
        "['pycharm-professional']"
    ],
    "force_lang": "C",
    "invocation": {
        "module_args": {
            "channel": "stable",
            "classic": true,
            "name": [
                "pycharm-professional"
            ],
            "state": "present"
        }
    },
    "msg": "No snap matching 'pycharm-professional' available.",
    "output": {
        "cmd_args": [
            "/usr/bin/snap",
            "i",
            "n",
            "f",
            "o",
            "['pycharm-professional']"
        ],
        "force_lang": "C",
        "rc": 64,
        "stderr": "error: unknown command \"i\", see 'snap help'.\n",
        "stdout": ""
    },
    "rc": 64,
    "stderr": "error: unknown command \"i\", see 'snap help'.\n",
    "stderr_lines": [
        "error: unknown command \"i\", see 'snap help'."
    ],
    "stdout": "",
    "stdout_lines": [],
    "vars": {
        "cmd_args": [
            "/usr/bin/snap",
            "i",
            "n",
            "f",
            "o",
            "['pycharm-professional']"
        ],
        "force_lang": "C",
        "rc": 64,
        "stderr": "error: unknown command \"i\", see 'snap help'.\n",
        "stdout": ""
    }
}

[aminvakil]

@staticdev Just to keep all the conversations in one place, is your issue same as #2906 ?
If so can you please paste your log there?

[felixfontein]

FYI: the version of the module in 3.3.0 is identical to the version in this PR.

[staticdev]

Exactly @aminvakil.. and yes, I am sorry @felixfontein, but my initial tests were obviously flawed =/
My mistake.

[russoz]

@staticdev No worries, man. Thanks for your time on it. Any way, Felix has put up a neat set of automated tests in place, so it should be easier to test (and to add more tests) the next time! Thanks for your support! 👍

[felixfontein]

The tests are based on work by @aminvakil, it unfortunately turned out that snap doesn't work inside docker (not even for just installing/uninstalling snaps) so I had to spend a bit more work to make them run on the RHEL VMs we have in CI :)

[staticdev]

@felixfontein this problem to run on docker I am having for quite some time now, even before this PR. I thought it was related to #2835, but seems not.

I have a molecule scenario that works on a Debian 11 machine, but not on a Debian 11 image on docker (https://github.com/staticdev/ansible-role-python-developer). Scenario is this one: molecule test -s pycharm-install

[aminvakil]

@staticdev snap does not work on docker, I learnt it just yesterday :)
This is not related to this module or any PR.

[staticdev]

@aminvakil this is strange, I even saw some specific Go code on their repo for docker support: https://github.com/snapcore/snapd/search?q=docker

[russoz]

@staticdev Apparently snap can interact with docker, but not run from within a container.

See:

• https://snapcraft.io/docs/interface-management
• https://snapcraft.io/docs/docker-interface
• https://snapcraft.io/docs/docker-support-interface