ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

[PR #5486/4caa6574 backport][stable-6] snap_alias: using CmdRunner (#5801)

Browse source 
snap_alias: using CmdRunner (#5486)

* snap_alias: using CmdRunner

* add changelog fragment

* fix changelog fragment

* invert order of initialization in __init_module__()

* comment extra changed=True from code

* add extra info when verbose

* add extra info when verbose - fix blank line

* handle check_mode the old way

* fix logical test

* fix error when using multiple aliases

* fix error when using multiple aliases, part 2

* revert to using check_mode_skip=True again

(cherry picked from commit 4caa6574de)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2023-01-08 22:02:27 +01:00 committed by GitHub
parent efc2cbf840
commit a17124f3c4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 31 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
changelogs/fragments/5486-snap-alias-cmd-runner.yml Normal file
View file

@ -0,0 +1,2 @@
minor_changes:
- snap_alias - refactored module to use ``CmdRunner`` to execute ``snap`` (https://github.com/ansible-collections/community.general/pull/5486).

53
plugins/modules/snap_alias.py
View file

@ -79,9 +79,8 @@ snap_aliases:
import re import re
from ansible_collections.community.general.plugins.module_utils.module_helper import ( from ansible_collections.community.general.plugins.module_utils.cmd_runner import CmdRunner, cmd_runner_fmt
CmdStateModuleHelper from ansible_collections.community.general.plugins.module_utils.module_helper import StateModuleHelper
)
_state_map = dict( _state_map = dict(
@ -91,7 +90,7 @@ _state_map = dict(
) )
class SnapAlias(CmdStateModuleHelper): class SnapAlias(StateModuleHelper):
_RE_ALIAS_LIST = re.compile(r"^(?P<snap>[\w-]+)\s+(?P<alias>[\w-]+)\s+.*$") _RE_ALIAS_LIST = re.compile(r"^(?P<snap>[\w-]+)\s+(?P<alias>[\w-]+)\s+.*$")
module = dict( module = dict(
@ -106,25 +105,26 @@ class SnapAlias(CmdStateModuleHelper):
], ],
supports_check_mode=True, supports_check_mode=True,
) )
command = "snap"
command_args_formats = dict( command_args_formats = {
_alias=dict(fmt=lambda v: [v]), "state": cmd_runner_fmt.as_map(_state_map),
state=dict(fmt=lambda v: [_state_map[v]]), "name": cmd_runner_fmt.as_list(),
) "alias": cmd_runner_fmt.as_list(),
check_rc = False }
def _aliases(self): def _aliases(self):
n = self.vars.name n = self.vars.name
return {n: self._get_aliases_for(n)} if n else self._get_aliases() return {n: self._get_aliases_for(n)} if n else self._get_aliases()
def __init_module__(self): def __init_module__(self):
self.runner = CmdRunner(self.module, "snap", self.command_args_formats, check_rc=False)
self.vars.set("snap_aliases", self._aliases(), change=True, diff=True) self.vars.set("snap_aliases", self._aliases(), change=True, diff=True)
def __quit_module__(self): def __quit_module__(self):
self.vars.snap_aliases = self._aliases() self.vars.snap_aliases = self._aliases()
def _get_aliases(self): def _get_aliases(self):
def process_get_aliases(rc, out, err): def process(rc, out, err):
if err: if err:
return {} return {}
aliases = [self._RE_ALIAS_LIST.match(a.strip()) for a in out.splitlines()[1:]] aliases = [self._RE_ALIAS_LIST.match(a.strip()) for a in out.splitlines()[1:]]
@ -134,9 +134,8 @@ class SnapAlias(CmdStateModuleHelper):
results[snap] = results.get(snap, []) + [alias] results[snap] = results.get(snap, []) + [alias]
return results return results
return self.run_command(params=[{'state': 'info'}, 'name'], check_rc=True, with self.runner("state name", check_rc=True, output_process=process) as ctx:
publish_rc=False, publish_out=False, publish_err=False, publish_cmd=False, return ctx.run(state="info")
process_output=process_get_aliases)
def _get_aliases_for(self, name): def _get_aliases_for(self, name):
return self._get_aliases().get(name, []) return self._get_aliases().get(name, [])
@ -152,24 +151,30 @@ class SnapAlias(CmdStateModuleHelper):
return any(alias in aliases for aliases in self.vars.snap_aliases.values()) return any(alias in aliases for aliases in self.vars.snap_aliases.values())
def state_present(self): def state_present(self):
for alias in self.vars.alias: for _alias in self.vars.alias:
if not self._has_alias(self.vars.name, alias): if not self._has_alias(self.vars.name, _alias):
self.changed = True self.changed = True
if not self.module.check_mode: with self.runner("state name alias", check_mode_skip=True) as ctx:
self.run_command(params=['state', 'name', {'_alias': alias}]) ctx.run(alias=_alias)
if self.verbosity >= 4:
self.vars.run_info = ctx.run_info
def state_absent(self): def state_absent(self):
if not self.vars.alias: if not self.vars.alias:
if self._has_alias(self.vars.name): if self._has_alias(self.vars.name):
self.changed = True self.changed = True
if not self.module.check_mode: with self.runner("state name", check_mode_skip=True) as ctx:
self.run_command(params=['state', 'name']) ctx.run()
if self.verbosity >= 4:
self.vars.run_info = ctx.run_info
else: else:
for alias in self.vars.alias: for _alias in self.vars.alias:
if self._has_alias(self.vars.name, alias): if self._has_alias(self.vars.name, _alias):
self.changed = True self.changed = True
if not self.module.check_mode: with self.runner("state alias", check_mode_skip=True) as ctx:
self.run_command(params=['state', {'_alias': alias}]) ctx.run(alias=_alias)
if self.verbosity >= 4:
self.vars.run_info = ctx.run_info
def main(): def main():