407 lines
14 KiB
Python
407 lines
14 KiB
Python
|
#!/usr/bin/python
|
||
|
|
# -*- coding: utf-8 -*-
|
||
|
|
|
||
|
|
# Copyright: (c) 2021, Alexei Znamensky (russoz) <russoz@gmail.com>
|
||
|
|
# Copyright: (c) 2021, Marcus Rickert <marcus.rickert@web.de>
|
||
|
|
# Copyright: (c) 2018, Stanislas Lange (angristan) <angristan@pm.me>
|
||
|
|
# Copyright: (c) 2018, Victor Carceler <vcarceler@iespuigcastellar.xeill.net>
|
||
|
|
|
||
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||
|
|
|
||
|
|
from __future__ import absolute_import, division, print_function
|
||
|
|
__metaclass__ = type
|
||
|
|
|
||
|
|
DOCUMENTATION = '''
|
||
|
|
---
|
||
|
|
module: snap
|
||
|
|
short_description: Manages snaps
|
||
|
|
description:
|
||
|
|
- "Manages snaps packages."
|
||
|
|
options:
|
||
|
|
name:
|
||
|
|
description:
|
||
|
|
- Name of the snaps.
|
||
|
|
required: true
|
||
|
|
type: list
|
||
|
|
elements: str
|
||
|
|
state:
|
||
|
|
description:
|
||
|
|
- Desired state of the package.
|
||
|
|
required: false
|
||
|
|
default: present
|
||
|
|
choices: [ absent, present, enabled, disabled ]
|
||
|
|
type: str
|
||
|
|
classic:
|
||
|
|
description:
|
||
|
|
- Confinement policy. The classic confinement allows a snap to have
|
||
|
|
the same level of access to the system as "classic" packages,
|
||
|
|
like those managed by APT. This option corresponds to the --classic argument.
|
||
|
|
This option can only be specified if there is a single snap in the task.
|
||
|
|
type: bool
|
||
|
|
required: false
|
||
|
|
default: no
|
||
|
|
channel:
|
||
|
|
description:
|
||
|
|
- Define which release of a snap is installed and tracked for updates.
|
||
|
|
This option can only be specified if there is a single snap in the task.
|
||
|
|
type: str
|
||
|
|
required: false
|
||
|
|
default: stable
|
||
|
|
options:
|
||
|
|
description:
|
||
|
|
- Set options with pattern C(key=value) or C(snap:key=value). If a snap name is given, the option will be applied
|
||
|
|
to that snap only. If the snap name is omitted, the options will be applied to all snaps listed in I(name). Options will
|
||
|
|
only be applied to active snaps.
|
||
|
|
required: false
|
||
|
|
type: list
|
||
|
|
elements: str
|
||
|
|
version_added: 4.4.0
|
||
|
|
|
||
|
|
author:
|
||
|
|
- Victor Carceler (@vcarceler) <vcarceler@iespuigcastellar.xeill.net>
|
||
|
|
- Stanislas Lange (@angristan) <angristan@pm.me>
|
||
|
|
|
||
|
|
seealso:
|
||
|
|
- module: community.general.snap_alias
|
||
|
|
'''
|
||
|
|
|
||
|
|
EXAMPLES = '''
|
||
|
|
# Install "foo" and "bar" snap
|
||
|
|
- name: Install foo
|
||
|
|
community.general.snap:
|
||
|
|
name:
|
||
|
|
- foo
|
||
|
|
- bar
|
||
|
|
|
||
|
|
# Install "foo" snap with options par1=A and par2=B
|
||
|
|
- name: Install "foo" with options
|
||
|
|
community.general.snap:
|
||
|
|
name:
|
||
|
|
- foo
|
||
|
|
options:
|
||
|
|
- par1=A
|
||
|
|
- par2=B
|
||
|
|
|
||
|
|
# Install "foo" and "bar" snaps with common option com=A and specific options fooPar=X and barPar=Y
|
||
|
|
- name: Install "foo" and "bar" with options
|
||
|
|
community.general.snap:
|
||
|
|
name:
|
||
|
|
- foo
|
||
|
|
- bar
|
||
|
|
options:
|
||
|
|
- com=A
|
||
|
|
- foo:fooPar=X
|
||
|
|
- bar:barPar=Y
|
||
|
|
|
||
|
|
# Remove "foo" snap
|
||
|
|
- name: Remove foo
|
||
|
|
community.general.snap:
|
||
|
|
name: foo
|
||
|
|
state: absent
|
||
|
|
|
||
|
|
# Install a snap with classic confinement
|
||
|
|
- name: Install "foo" with option --classic
|
||
|
|
community.general.snap:
|
||
|
|
name: foo
|
||
|
|
classic: yes
|
||
|
|
|
||
|
|
# Install a snap with from a specific channel
|
||
|
|
- name: Install "foo" with option --channel=latest/edge
|
||
|
|
community.general.snap:
|
||
|
|
name: foo
|
||
|
|
channel: latest/edge
|
||
|
|
'''
|
||
|
|
|
||
|
|
RETURN = '''
|
||
|
|
classic:
|
||
|
|
description: Whether or not the snaps were installed with the classic confinement
|
||
|
|
type: bool
|
||
|
|
returned: When snaps are installed
|
||
|
|
channel:
|
||
|
|
description: The channel the snaps were installed from
|
||
|
|
type: str
|
||
|
|
returned: When snaps are installed
|
||
|
|
cmd:
|
||
|
|
description: The command that was executed on the host
|
||
|
|
type: str
|
||
|
|
returned: When changed is true
|
||
|
|
snaps_installed:
|
||
|
|
description: The list of actually installed snaps
|
||
|
|
type: list
|
||
|
|
returned: When any snaps have been installed
|
||
|
|
snaps_removed:
|
||
|
|
description: The list of actually removed snaps
|
||
|
|
type: list
|
||
|
|
returned: When any snaps have been removed
|
||
|
|
options_changed:
|
||
|
|
description: The list of options set/changed in format C(snap:key=value).
|
||
|
|
type: list
|
||
|
|
returned: When any options have been changed/set
|
||
|
|
version_added: 4.4.0
|
||
|
|
'''
|
||
|
|
|
||
|
|
import re
|
||
|
|
import json
|
||
|
|
import numbers
|
||
|
|
|
||
|
|
from ansible.module_utils.common.text.converters import to_native
|
||
|
|
|
||
|
|
from ansible_collections.community.general.plugins.module_utils.module_helper import (
|
||
|
|
CmdStateModuleHelper, ArgFormat, ModuleHelperException
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
__state_map = dict(
|
||
|
|
present='install',
|
||
|
|
absent='remove',
|
||
|
|
enabled='enable',
|
||
|
|
disabled='disable',
|
||
|
|
info='info', # not public
|
||
|
|
list='list', # not public
|
||
|
|
set='set', # not public
|
||
|
|
get='get', # not public
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
def _state_map(value):
|
||
|
|
return [__state_map[value]]
|
||
|
|
|
||
|
|
|
||
|
|
class Snap(CmdStateModuleHelper):
|
||
|
|
__disable_re = re.compile(r'(?:\S+\s+){5}(?P<notes>\S+)')
|
||
|
|
__set_param_re = re.compile(r'(?P<snap_prefix>\S+:)?(?P<key>\S+)=(?P<value>\S+)')
|
||
|
|
module = dict(
|
||
|
|
argument_spec={
|
||
|
|
'name': dict(type='list', elements='str', required=True),
|
||
|
|
'state': dict(type='str', default='present',
|
||
|
|
choices=['absent', 'present', 'enabled', 'disabled']),
|
||
|
|
'classic': dict(type='bool', default=False),
|
||
|
|
'channel': dict(type='str', default='stable'),
|
||
|
|
'options': dict(type='list', elements='str'),
|
||
|
|
},
|
||
|
|
supports_check_mode=True,
|
||
|
|
)
|
||
|
|
command = "snap"
|
||
|
|
command_args_formats = dict(
|
||
|
|
actionable_snaps=dict(fmt=lambda v: v),
|
||
|
|
state=dict(fmt=_state_map),
|
||
|
|
classic=dict(fmt="--classic", style=ArgFormat.BOOLEAN),
|
||
|
|
channel=dict(fmt=lambda v: [] if v == 'stable' else ['--channel', '{0}'.format(v)]),
|
||
|
|
options=dict(fmt=list),
|
||
|
|
json_format=dict(fmt="-d", style=ArgFormat.BOOLEAN),
|
||
|
|
)
|
||
|
|
check_rc = False
|
||
|
|
|
||
|
|
@staticmethod
|
||
|
|
def _first_non_zero(a):
|
||
|
|
for elem in a:
|
||
|
|
if elem != 0:
|
||
|
|
return elem
|
||
|
|
|
||
|
|
return 0
|
||
|
|
|
||
|
|
def _run_multiple_commands(self, commands):
|
||
|
|
outputs = [(c,) + self.run_command(params=c) for c in commands]
|
||
|
|
results = ([], [], [], [])
|
||
|
|
for output in outputs:
|
||
|
|
for i in range(4):
|
||
|
|
results[i].append(output[i])
|
||
|
|
|
||
|
|
return [
|
||
|
|
'; '.join([to_native(x) for x in results[0]]),
|
||
|
|
self._first_non_zero(results[1]),
|
||
|
|
'\n'.join(results[2]),
|
||
|
|
'\n'.join(results[3]),
|
||
|
|
]
|
||
|
|
|
||
|
|
def convert_json_subtree_to_map(self, json_subtree, prefix=None):
|
||
|
|
option_map = {}
|
||
|
|
|
||
|
|
if not isinstance(json_subtree, dict):
|
||
|
|
raise ModuleHelperException("Non-dict non-leaf element encountered while parsing option map. "
|
||
|
|
"The output format of 'snap set' may have changed. Aborting!")
|
||
|
|
|
||
|
|
for key, value in json_subtree.items():
|
||
|
|
full_key = key if prefix is None else prefix + "." + key
|
||
|
|
|
||
|
|
if isinstance(value, (str, float, bool, numbers.Integral)):
|
||
|
|
option_map[full_key] = str(value)
|
||
|
|
|
||
|
|
else:
|
||
|
|
option_map.update(self.convert_json_subtree_to_map(json_subtree=value, prefix=full_key))
|
||
|
|
|
||
|
|
return option_map
|
||
|
|
|
||
|
|
def convert_json_to_map(self, json_string):
|
||
|
|
json_object = json.loads(json_string)
|
||
|
|
return self.convert_json_subtree_to_map(json_object)
|
||
|
|
|
||
|
|
def retrieve_option_map(self, snap_name):
|
||
|
|
params = [{'state': 'get'}, {'name': snap_name}, {'json_format': True}]
|
||
|
|
rc, out, err = self.run_command(params=params)
|
||
|
|
|
||
|
|
if rc != 0:
|
||
|
|
return {}
|
||
|
|
|
||
|
|
result = out.splitlines()
|
||
|
|
|
||
|
|
if "has no configuration" in result[0]:
|
||
|
|
return {}
|
||
|
|
|
||
|
|
try:
|
||
|
|
option_map = self.convert_json_to_map(out)
|
||
|
|
|
||
|
|
except Exception as e:
|
||
|
|
raise ModuleHelperException(
|
||
|
|
msg="Parsing option map returned by 'snap get {0}' triggers exception '{1}', output:\n'{2}'".format(snap_name, str(e), out))
|
||
|
|
|
||
|
|
return option_map
|
||
|
|
|
||
|
|
def is_snap_installed(self, snap_name):
|
||
|
|
return 0 == self.run_command(params=[{'state': 'list'}, {'name': snap_name}])[0]
|
||
|
|
|
||
|
|
def is_snap_enabled(self, snap_name):
|
||
|
|
rc, out, err = self.run_command(params=[{'state': 'list'}, {'name': snap_name}])
|
||
|
|
if rc != 0:
|
||
|
|
return None
|
||
|
|
result = out.splitlines()[1]
|
||
|
|
match = self.__disable_re.match(result)
|
||
|
|
if not match:
|
||
|
|
raise ModuleHelperException(msg="Unable to parse 'snap list {0}' output:\n{1}".format(snap_name, out))
|
||
|
|
notes = match.group('notes')
|
||
|
|
return "disabled" not in notes.split(',')
|
||
|
|
|
||
|
|
def process_actionable_snaps(self, actionable_snaps):
|
||
|
|
self.changed = True
|
||
|
|
self.vars.snaps_installed = actionable_snaps
|
||
|
|
|
||
|
|
if self.module.check_mode:
|
||
|
|
return
|
||
|
|
|
||
|
|
params = ['state', 'classic', 'channel'] # get base cmd parts
|
||
|
|
has_one_pkg_params = bool(self.vars.classic) or self.vars.channel != 'stable'
|
||
|
|
has_multiple_snaps = len(actionable_snaps) > 1
|
||
|
|
|
||
|
|
if has_one_pkg_params and has_multiple_snaps:
|
||
|
|
commands = [params + [{'actionable_snaps': [s]}] for s in actionable_snaps]
|
||
|
|
else:
|
||
|
|
commands = [params + [{'actionable_snaps': actionable_snaps}]]
|
||
|
|
self.vars.cmd, rc, out, err = self._run_multiple_commands(commands)
|
||
|
|
|
||
|
|
if rc == 0:
|
||
|
|
return
|
||
|
|
|
||
|
|
classic_snap_pattern = re.compile(r'^error: This revision of snap "(?P<package_name>\w+)"'
|
||
|
|
r' was published using classic confinement')
|
||
|
|
match = classic_snap_pattern.match(err)
|
||
|
|
if match:
|
||
|
|
err_pkg = match.group('package_name')
|
||
|
|
msg = "Couldn't install {name} because it requires classic confinement".format(name=err_pkg)
|
||
|
|
else:
|
||
|
|
msg = "Ooops! Snap installation failed while executing '{cmd}', please examine logs and " \
|
||
|
|
"error output for more details.".format(cmd=self.vars.cmd)
|
||
|
|
raise ModuleHelperException(msg=msg)
|
||
|
|
|
||
|
|
def state_present(self):
|
||
|
|
|
||
|
|
self.vars.meta('classic').set(output=True)
|
||
|
|
self.vars.meta('channel').set(output=True)
|
||
|
|
actionable_snaps = [s for s in self.vars.name if not self.is_snap_installed(s)]
|
||
|
|
|
||
|
|
if actionable_snaps:
|
||
|
|
self.process_actionable_snaps(actionable_snaps)
|
||
|
|
|
||
|
|
self.set_options()
|
||
|
|
|
||
|
|
def set_options(self):
|
||
|
|
if self.vars.options is None:
|
||
|
|
return
|
||
|
|
|
||
|
|
actionable_snaps = [s for s in self.vars.name if self.is_snap_installed(s)]
|
||
|
|
overall_options_changed = []
|
||
|
|
|
||
|
|
for snap_name in actionable_snaps:
|
||
|
|
option_map = self.retrieve_option_map(snap_name=snap_name)
|
||
|
|
|
||
|
|
options_changed = []
|
||
|
|
|
||
|
|
for option_string in self.vars.options:
|
||
|
|
match = self.__set_param_re.match(option_string)
|
||
|
|
|
||
|
|
if not match:
|
||
|
|
msg = "Cannot parse set option '{option_string}'".format(option_string=option_string)
|
||
|
|
raise ModuleHelperException(msg)
|
||
|
|
|
||
|
|
snap_prefix = match.group("snap_prefix")
|
||
|
|
selected_snap_name = snap_prefix[:-1] if snap_prefix else None
|
||
|
|
|
||
|
|
if selected_snap_name is not None and selected_snap_name not in self.vars.name:
|
||
|
|
msg = "Snap option '{option_string}' refers to snap which is not in the list of snap names".format(option_string=option_string)
|
||
|
|
raise ModuleHelperException(msg)
|
||
|
|
|
||
|
|
if selected_snap_name is None or (snap_name is not None and snap_name == selected_snap_name):
|
||
|
|
key = match.group("key")
|
||
|
|
value = match.group("value")
|
||
|
|
|
||
|
|
if key not in option_map or key in option_map and option_map[key] != value:
|
||
|
|
option_without_prefix = key + "=" + value
|
||
|
|
option_with_prefix = option_string if selected_snap_name is not None else snap_name + ":" + option_string
|
||
|
|
options_changed.append(option_without_prefix)
|
||
|
|
overall_options_changed.append(option_with_prefix)
|
||
|
|
|
||
|
|
if options_changed:
|
||
|
|
self.changed = True
|
||
|
|
|
||
|
|
if not self.module.check_mode:
|
||
|
|
params = [{'state': 'set'}, {'name': snap_name}, {'options': options_changed}]
|
||
|
|
|
||
|
|
rc, out, err = self.run_command(params=params)
|
||
|
|
|
||
|
|
if rc != 0:
|
||
|
|
if 'has no "configure" hook' in err:
|
||
|
|
msg = "Snap '{snap}' does not have any configurable options".format(snap=snap_name)
|
||
|
|
raise ModuleHelperException(msg)
|
||
|
|
|
||
|
|
msg = "Cannot set options '{options}' for snap '{snap}': error={error}".format(
|
||
|
|
options=" ".join(options_changed), snap=snap_name, error=err)
|
||
|
|
raise ModuleHelperException(msg)
|
||
|
|
|
||
|
|
if overall_options_changed:
|
||
|
|
self.vars.options_changed = overall_options_changed
|
||
|
|
|
||
|
|
def _generic_state_action(self, actionable_func, actionable_var, params=None):
|
||
|
|
actionable_snaps = [s for s in self.vars.name if actionable_func(s)]
|
||
|
|
if not actionable_snaps:
|
||
|
|
return
|
||
|
|
self.changed = True
|
||
|
|
self.vars[actionable_var] = actionable_snaps
|
||
|
|
if self.module.check_mode:
|
||
|
|
return
|
||
|
|
if params is None:
|
||
|
|
params = ['state']
|
||
|
|
commands = [params + [{'actionable_snaps': actionable_snaps}]]
|
||
|
|
self.vars.cmd, rc, out, err = self._run_multiple_commands(commands)
|
||
|
|
if rc == 0:
|
||
|
|
return
|
||
|
|
msg = "Ooops! Snap operation failed while executing '{cmd}', please examine logs and " \
|
||
|
|
"error output for more details.".format(cmd=self.vars.cmd)
|
||
|
|
raise ModuleHelperException(msg=msg)
|
||
|
|
|
||
|
|
def state_absent(self):
|
||
|
|
self._generic_state_action(self.is_snap_installed, "snaps_removed", ['classic', 'channel', 'state'])
|
||
|
|
|
||
|
|
def state_enabled(self):
|
||
|
|
self._generic_state_action(lambda s: not self.is_snap_enabled(s), "snaps_enabled", ['classic', 'channel', 'state'])
|
||
|
|
|
||
|
|
def state_disabled(self):
|
||
|
|
self._generic_state_action(self.is_snap_enabled, "snaps_disabled", ['classic', 'channel', 'state'])
|
||
|
|
|
||
|
|
|
||
|
|
def main():
|
||
|
|
snap = Snap()
|
||
|
|
snap.run()
|
||
|
|
|
||
|
|
|
||
|
|
if __name__ == '__main__':
|
||
|
|
main()
|