mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-19 03:10:22 -07:00
Unflatmap community.general (#5461)
* Move files. * Update imports and references. * Move wrongly placed files. * Reverse redirects, deprecate long → short name redirects. * Simplify contribution guidelines for new modules. * Rewrite BOTMETA. * Add changelog fragment. * Fix ignore.txt files.
This commit is contained in:
parent
2b0bebc8fc
commit
b531ecdc9b
1033 changed files with 4802 additions and 1989 deletions
180
plugins/modules/snap_alias.py
Normal file
180
plugins/modules/snap_alias.py
Normal file
|
@ -0,0 +1,180 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright (c) 2021, Alexei Znamensky (russoz) <russoz@gmail.com>
|
||||
#
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: snap_alias
|
||||
short_description: Manages snap aliases
|
||||
version_added: 4.0.0
|
||||
description:
|
||||
- "Manages snaps aliases."
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
- Desired state of the alias.
|
||||
type: str
|
||||
choices: [ absent, present ]
|
||||
default: present
|
||||
name:
|
||||
description:
|
||||
- Name of the snap.
|
||||
type: str
|
||||
alias:
|
||||
description:
|
||||
- Aliases to be created or removed.
|
||||
type: list
|
||||
elements: str
|
||||
aliases: [aliases]
|
||||
|
||||
author:
|
||||
- Alexei Znamensky (@russoz) <russoz@gmail.com>
|
||||
|
||||
seealso:
|
||||
- module: community.general.snap
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Install "foo" and "bar" snap
|
||||
- name: Create snap alias
|
||||
community.general.snap_alias:
|
||||
name: hello-world
|
||||
alias: hw
|
||||
|
||||
- name: Create multiple aliases
|
||||
community.general.snap_alias:
|
||||
name: hello-world
|
||||
aliases:
|
||||
- hw
|
||||
- hw2
|
||||
- hw3
|
||||
state: present # optional
|
||||
|
||||
- name: Remove one specific aliases
|
||||
community.general.snap_alias:
|
||||
name: hw
|
||||
state: absent
|
||||
|
||||
- name: Remove all aliases for snap
|
||||
community.general.snap_alias:
|
||||
name: hello-world
|
||||
state: absent
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
snap_aliases:
|
||||
description: The snap aliases after execution. If called in check mode, then the list represents the state before execution.
|
||||
type: list
|
||||
elements: str
|
||||
returned: always
|
||||
'''
|
||||
|
||||
|
||||
import re
|
||||
|
||||
from ansible_collections.community.general.plugins.module_utils.module_helper import (
|
||||
CmdStateModuleHelper
|
||||
)
|
||||
|
||||
|
||||
_state_map = dict(
|
||||
present='alias',
|
||||
absent='unalias',
|
||||
info='aliases',
|
||||
)
|
||||
|
||||
|
||||
class SnapAlias(CmdStateModuleHelper):
|
||||
_RE_ALIAS_LIST = re.compile(r"^(?P<snap>[\w-]+)\s+(?P<alias>[\w-]+)\s+.*$")
|
||||
|
||||
module = dict(
|
||||
argument_spec={
|
||||
'state': dict(type='str', choices=['absent', 'present'], default='present'),
|
||||
'name': dict(type='str'),
|
||||
'alias': dict(type='list', elements='str', aliases=['aliases']),
|
||||
},
|
||||
required_if=[
|
||||
('state', 'present', ['name', 'alias']),
|
||||
('state', 'absent', ['name', 'alias'], True),
|
||||
],
|
||||
supports_check_mode=True,
|
||||
)
|
||||
command = "snap"
|
||||
command_args_formats = dict(
|
||||
_alias=dict(fmt=lambda v: [v]),
|
||||
state=dict(fmt=lambda v: [_state_map[v]]),
|
||||
)
|
||||
check_rc = False
|
||||
|
||||
def _aliases(self):
|
||||
n = self.vars.name
|
||||
return {n: self._get_aliases_for(n)} if n else self._get_aliases()
|
||||
|
||||
def __init_module__(self):
|
||||
self.vars.set("snap_aliases", self._aliases(), change=True, diff=True)
|
||||
|
||||
def __quit_module__(self):
|
||||
self.vars.snap_aliases = self._aliases()
|
||||
|
||||
def _get_aliases(self):
|
||||
def process_get_aliases(rc, out, err):
|
||||
if err:
|
||||
return {}
|
||||
aliases = [self._RE_ALIAS_LIST.match(a.strip()) for a in out.splitlines()[1:]]
|
||||
snap_alias_list = [(entry.group("snap"), entry.group("alias")) for entry in aliases]
|
||||
results = {}
|
||||
for snap, alias in snap_alias_list:
|
||||
results[snap] = results.get(snap, []) + [alias]
|
||||
return results
|
||||
|
||||
return self.run_command(params=[{'state': 'info'}, 'name'], check_rc=True,
|
||||
publish_rc=False, publish_out=False, publish_err=False, publish_cmd=False,
|
||||
process_output=process_get_aliases)
|
||||
|
||||
def _get_aliases_for(self, name):
|
||||
return self._get_aliases().get(name, [])
|
||||
|
||||
def _has_alias(self, name=None, alias=None):
|
||||
if name:
|
||||
if name not in self.vars.snap_aliases:
|
||||
return False
|
||||
if alias is None:
|
||||
return bool(self.vars.snap_aliases[name])
|
||||
return alias in self.vars.snap_aliases[name]
|
||||
|
||||
return any(alias in aliases for aliases in self.vars.snap_aliases.values())
|
||||
|
||||
def state_present(self):
|
||||
for alias in self.vars.alias:
|
||||
if not self._has_alias(self.vars.name, alias):
|
||||
self.changed = True
|
||||
if not self.module.check_mode:
|
||||
self.run_command(params=['state', 'name', {'_alias': alias}])
|
||||
|
||||
def state_absent(self):
|
||||
if not self.vars.alias:
|
||||
if self._has_alias(self.vars.name):
|
||||
self.changed = True
|
||||
if not self.module.check_mode:
|
||||
self.run_command(params=['state', 'name'])
|
||||
else:
|
||||
for alias in self.vars.alias:
|
||||
if self._has_alias(self.vars.name, alias):
|
||||
self.changed = True
|
||||
if not self.module.check_mode:
|
||||
self.run_command(params=['state', {'_alias': alias}])
|
||||
|
||||
|
||||
def main():
|
||||
SnapAlias.execute()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
Loading…
Add table
Add a link
Reference in a new issue