1
0
Fork 0

migrated the module_utils to an indipendent repository

Dieser Commit ist enthalten in:
Sebastian Tobie 2023-11-26 10:53:45 +01:00
Ursprung affe76fbcf
Commit 283e551204
15 geänderte Dateien mit 60 neuen und 579 gelöschten Zeilen

Datei anzeigen

@ -1,10 +1,18 @@
===================================== =====================================
sebastian.systemd 0.3.3 Release Notes sebastian.systemd 0.3.4 Release Notes
===================================== =====================================
.. contents:: Topics .. contents:: Topics
v0.3.4
======
Changelog
---------
moved the module_utils to an indipendent repository
v0.3.3 v0.3.3
====== ======

Datei anzeigen

@ -2,53 +2,48 @@ ancestor: null
releases: releases:
0.1.0: 0.1.0:
changes: changes:
release_date: '2023-04-15'
release_summary: Erstes Release
major_changes: major_changes:
- added systemd_link module - added systemd_link module
- added systemd_mount module - added systemd_mount module
- added systemd_network module - added systemd_network module
modules: release_summary: Erstes Release
- name: systemd_link release_date: '2023-04-15'
description: Erstellt eine Systemd Link Unit
- name: systemd_mount
description: Erstellt eine Systemd mount Unit
- name: systemd_network
description: Erstellt eine Systemd Network Unit
0.1.1: 0.1.1:
changes: changes:
release_date: '2023-04-15'
release_summary: kleines feature update
minor_changes: minor_changes:
- update_doc hinzugefügt. um Dokumentation automatisch zu aktualisieren - "update_doc hinzugef\xFCgt. um Dokumentation automatisch zu aktualisieren"
release_summary: kleines feature update
release_date: '2023-04-15'
0.1.2: 0.1.2:
changes: changes:
release_date: '2023-04-15' release_summary: "Pfad der aufl\xF6sung f\xFCr Tests und autodoc ge\xE4ndert,
release_summary: Pfad der auflösung für Tests und autodoc geändert, weil Mitogen sonst blockiert weil Mitogen sonst blockiert"
release_date: '2023-04-15'
0.1.3: 0.1.3:
changes: changes:
release_date: "2023-04-20" release_summary: renamed all modules to names without systemd_ prefix
release_summary: "renamed all modules to names without systemd_ prefix" release_date: '2023-04-20'
0.2.0: 0.2.0:
changes: changes:
release_date: "2023-04-21" release_summary: added an rudimentary system_service module
release_summary: "added an rudimentary system_service module" release_date: '2023-04-21'
modules:
- name: system_service
description: erstellt ein einfachen systemd system service
0.3.0: 0.3.0:
changes: changes:
release_date: "2023-04-23" release_summary: added socket module and some small fixes
release_summary: "added socket module and some small fixes" release_date: '2023-04-23'
0.3.1: 0.3.1:
changes: changes:
release_date: "2023-04-23" release_summary: fixed runtime.yml
release_summary: "fixed runtime.yml" release_date: '2023-04-23'
0.3.2: 0.3.2:
changes: changes:
release_date: "2023-07-15" release_summary: added virtualization and negative matches to link and network
release_summary: "added virtualization and negative matches to link and network" release_date: '2023-07-15'
0.3.3: 0.3.3:
changes: changes:
release_date: "2023-07-16" release_summary: added netdev module
release_summary: "added netdev module" release_date: '2023-07-16'
0.3.4:
release_date: '2023-11-26'
changes:
release_summary: moved the module_utils to an indipendent repository

Datei anzeigen

@ -1,7 +1,7 @@
--- ---
namespace: sebastian namespace: sebastian
name: systemd name: systemd
version: 0.3.3 version: 0.3.4
readme: README.md readme: README.md

Datei anzeigen

@ -1,126 +0,0 @@
import pathlib
import warnings
from typing import Any, Callable, Dict, Optional, Sequence, Tuple, Type, Union
__all__ = (
"Types",
"SYSTEMD_SERVICE_CONFIG",
"SYSTEMD_NETWORK_CONFIG",
"SYSTEMD_CONFIG_ROOT",
"systemdbool",
"AnsibleParameter",
)
SYSTEMD_CONFIG_ROOT = pathlib.Path("/etc/systemd")
SYSTEMD_NETWORK_CONFIG = SYSTEMD_CONFIG_ROOT / "network"
SYSTEMD_SERVICE_CONFIG = SYSTEMD_CONFIG_ROOT / "system"
AnsibleParameter = Dict[str, Any]
class _Type:
def __dir__(self) -> tuple:
return (
"str",
"bool",
"int",
"float",
"path",
"raw",
"jsonarg",
"json",
"bytes",
"dict",
"list",
"bits",
"__doc__",
)
def list(
self,
elements: Union[Type[object], str, AnsibleParameter],
required: bool = False,
help: Optional[str] = None,
) -> AnsibleParameter:
option: AnsibleParameter = dict(type="list", required=required)
if not isinstance(elements, (str, dict)):
option["elements"] = elements.__name__
elif isinstance(elements, dict):
option["elements"] = elements["type"]
if elements["type"] == "dict":
option["options"] = dict()
for name, value in elements["option"].items():
option["options"][name] = value
if "description" not in option["options"][name]:
warnings.warn(
"helptext of option {} is unset. Ansible requires suboptions to have an documentation".format(name),
)
if help is not None:
option["description"] = help.split("\n")
return option
def dict(self, required: bool = False, help: Optional[str] = None, **options: dict) -> AnsibleParameter:
option: AnsibleParameter = dict(type="dict", required=required)
option["option"] = options
if help is not None:
option["description"] = help.split("\n")
return option
def __getattr__(self, name: str):
def argument(
required: bool = False,
help: Optional[str] = None,
choices: Optional[Sequence] = None,
default: Optional[Any] = None,
) -> AnsibleParameter:
"""Simple wrapper for Ansible {0} argument dict"""
option: AnsibleParameter = dict(type=name, required=required)
if choices is not None:
option["choices"] = choices
if default is not None:
option["default"] = default
if help is not None:
option["description"] = help.split("\n")
return option
argument.__name__ = name
argument.__doc__ = argument.__doc__.format(name) # type: ignore
return argument
Types = _Type()
def systemdbool(b: Union[bool, str]) -> str:
if b is True:
return "yes"
elif b is False:
return "no"
return b
def modspec(
argument_spec: Dict[str, Dict[str, Any]],
mutually_exclusive: Sequence[Tuple[str, ...]] = (),
required_together: Sequence[Tuple[str, ...]] = (),
required_one_of: Sequence[Tuple[str, ...]] = (),
required_if: Sequence[Union[Tuple[str, Any, Tuple[str, ...]], Tuple[str, Any, Tuple[str, ...], bool]]] = (),
required_by: Dict[str, Union[str, Tuple[str, ...]]] = {},
) -> Dict[str, Any]:
return dict(
argument_spec=argument_spec,
mutually_exclusive=mutually_exclusive,
required_together=required_together,
required_one_of=required_one_of,
required_if=required_if,
required_by=required_by,
)
def joindict(*items: dict) -> dict:
odict = dict()
for item in items:
for key, value in item.items():
odict[key] = value
return odict

Datei anzeigen

@ -1,365 +0,0 @@
import pathlib
from copy import deepcopy
from typing import Any, Callable, ClassVar, Dict, NoReturn, Optional, Type, TypeVar, Union, overload
import ansible.module_utils.basic as basic
try:
from ansible_collections.sebastian.systemd.plugins.module_utils.generic import AnsibleParameter, Types,systemdbool
except ImportError:
from plugins.module_utils.generic import AnsibleParameter, Types,systemdbool
__all__ = (
"AnsibleModule",
"SystemdUnitModule",
"installable",
"SystemdReloadMixin",
)
T = TypeVar("T")
def docify(input: Union[dict, AnsibleParameter]) -> dict:
options = dict()
for name, help in input.items():
options[name] = dict(type=help["type"])
if "description" in help:
if isinstance(help["description"], str):
help["description"] = help["description"].split("\n")
options[name]["description"] = help["description"]
if "required" in help and help["required"]:
options[name]["required"] = True
else:
options[name]["required"] = False
if help["type"] == "list":
options[name]["elements"] = help["elements"]
if not options[name]["required"]:
options[name]["default"] = []
if "default" in help:
options[name]["default"] = help["default"]
if "options" in help:
options[name]["options"] = docify(help["options"])
if "choices" in help:
options[name]["choices"] = tuple(help["choices"])
return options
class AnsibleModule(object):
"""Simple wrapper for the basic.AnsibleModule"""
#: name of the module. This is required for the generation of the Ansible documentation
name: ClassVar[str]
#: The AnsibleModule for this Module
module: basic.AnsibleModule
#: The result of this Module call. It always contains the changed key, so in any case an Module can report if it changed anything
result: dict
#: the specification of the arguments. Subclasses that are usable Modules must set this value.
module_spec: ClassVar[dict]
#: This is set by classes that define common things for their subclasses, like behaviour of the run and check methods. This is used by `SystemdUnitModule`
_common_args = dict()
@property
def params(self) -> Dict[str, Any]:
"""params is an wrapper for the module.params"""
return self.module.params # type: ignore
def __init__(self):
self.result = dict(changed=False)
specs = dict()
specs.update(deepcopy(self._common_args))
modspec = self.module_spec
if "argument_spec" in modspec and "argument_spec" in self._common_args:
specs["argument_spec"].update(modspec["argument_spec"])
del modspec["argument_spec"]
specs.update(modspec)
self.module = basic.AnsibleModule(**specs)
self.tmpdir = pathlib.Path(self.module.tmpdir)
def set(self, key: str, value):
"""sets an value for the result"""
self.result[key] = value
@overload
def diff(self, diff: Dict[str, str]):
pass
@overload
def diff(
self,
before: Optional[str] = None,
after: Optional[str] = None,
before_header: Optional[str] = None,
after_header: Optional[str] = None,
):
pass
def diff( # type: ignore
self,
diff=None,
*,
before=None,
after=None,
before_header=None,
after_header=None,
):
"""adds the special return value "diff". This allows Modules to present the changes of files to the caller. it takes care of the special semantics of the return value"""
if "diff" not in self.result:
self.result["diff"] = list()
if diff is not None and not any((before is not None, after is not None)):
pass
elif all((before is not None, after is not None, diff is None)):
diff = dict(
before=before,
after=after,
)
if before_header is not None:
diff["before_header"] = before_header
if after_header is not None:
diff["after_header"] = after_header
else:
raise TypeError("only diff or before and after can be set, not both of them")
self.result["diff"].append(diff)
def get(self, key: str, default: T = None) -> T:
"""returns an Parameter of the Module."""
if self.params[key] is None and default is not None:
return default
elif self.params[key] is None and default is None:
raise KeyError()
return self.params[key]
def changed_get(self):
"""value that shows if changes were detected/made"""
return self.result["changed"]
def changed_set(self, value):
self.result["changed"] = not not value
changed = property(changed_get, changed_set, None, changed_get.__doc__)
def prepare(self):
raise NotImplementedError()
def check(self):
raise NotImplementedError()
def run(self):
raise NotImplementedError()
def __call__(self) -> NoReturn:
"""This calls the module. first prepare is called and then check or run, depending on the check mode.
If an exception is raised this is catched and the module automatically fails with an traceback
"""
self.prepare()
try:
if self.module.check_mode:
self.check()
else:
self.run()
except Exception as exc:
import traceback
self.module.fail_json(
"".join(traceback.format_exception(type(exc), exc, exc.__traceback__)),
**self.result,
)
self.module.exit_json(**self.result)
@classmethod
def doc(cls) -> str:
"""this returns the documentation string of the module. If the help arguments of an Types method was given, it adds this as an helptext of this parameter"""
try:
import yaml
except ImportError:
return "---\n"
doc = cls.__doc__
if doc is None:
doc = ""
help: _sdict
specs = dict()
if "argument_spec" in cls._common_args:
specs.update(cls._common_args["argument_spec"])
if "argument_spec" in cls.module_spec:
specs.update(cls.module_spec["argument_spec"])
options = docify(specs)
docu = doc.split("\n")
return str(
yaml.safe_dump(
dict(
module=cls.name,
short_description=docu[0],
description=docu,
options=options,
),
stream=None,
explicit_start="---",
)
)
class SystemdUnitModule(AnsibleModule):
#: path of the unitfile managed by this module
unitfile: pathlib.Path
#: subclasses of this always support the file common args and the check mode
_common_args = dict(
supports_check_mode=True,
add_file_common_args=True,
argument_spec=dict(
description=Types.str(help="An description for programs that access systemd"),
documentation=Types.list(str, help="Paths where documentation can be found"),
requires=Types.list(
str,
help="list of units that this unit requires. If it fails or can't be started this unit fails. without before/after this is started at the same time",
),
wants=Types.list(str, help="list of units that this unit wants. If it fails or can't be started it does not affect this unit"),
partof=Types.list(
str,
help="list of units that this unit is part of.\nIf the restart this unit does it too, but if this restarts it does not affect the other units.",
),
before=Types.list(str, help="list of units that this unit needs to be started before this unit."),
after=Types.list(str, help="list of units that this unit wants to be started after this unit"),
),
)
#: if defined it will be called after run has changed the unitfile
post: Optional[Callable[[], None]]
def unit(self) -> str:
raise NotImplementedError()
def header(self) -> str:
header = "[Unit]\n"
header += "".join(
self.map_param(
description="Description",
documentation="Documentation",
requires="Requires",
wants="Wants",
partof="PartOf",
before="Before",
after="After",
)
)
return header
def map_param(self, **parammap: str):
"""maps an dict with keys for an section with given params. The key of the dictionary is the parameter and the value is the key in the unitfile. If an parameter has multiple values it adds multiple entries"""
output: list[str] = []
for param, key in parammap.items():
if self.params[param] is not None:
params = self.params[param]
if isinstance(params, list):
output.extend((f"{key}={systemdbool(p)}\n" for p in params))
else:
output.append(f"{key}={systemdbool(params)}\n")
return output
def unitfile_gen(self):
path = self.tmpdir / "newunit"
with open(path, "w") as unit:
unit.write(self.unit())
self.module.set_owner_if_different(path.as_posix(), "root", False)
self.module.set_group_if_different(path.as_posix(), "root", False)
self.module.set_mode_if_different(path.as_posix(), "0644", False)
if self.unitfile.exists():
diff = dict()
self.changed = self.changed | self.module.set_owner_if_different(
self.unitfile.as_posix(),
"root",
self.result["changed"],
diff,
)
self.diff(diff)
diff = dict()
self.changed = self.changed | self.module.set_group_if_different(
self.unitfile.as_posix(),
"root",
self.result["changed"],
diff,
)
self.diff(diff)
diff = dict()
self.changed = self.changed | self.module.set_mode_if_different(
self.unitfile.as_posix(),
"0644",
self.result["changed"],
diff,
)
self.diff(diff)
def check(self):
self.set("unitfile", self.unitfile.as_posix())
self.unitfile_gen()
if not self.unitfile.exists():
self.diff(before="", after=self.unit(), before_header=self.unitfile.as_posix())
self.changed = True
else:
if self.module.sha256(self.unitfile.as_posix()) != self.module.sha256((self.tmpdir / "newunit").as_posix()):
self.changed = True
self.diff(
before=self.unitfile.read_text(),
after=self.unit(),
before_header=self.unitfile.as_posix(),
)
def run(self):
self.check()
if not self.changed:
return
self.module.atomic_move(
src=(self.tmpdir / "newunit").as_posix(),
dest=self.unitfile.as_posix(),
)
if hasattr(self, "post") and self.post is not None:
self.post()
_INSTALL_MAPPING = dict(
required_by="RequiredBy",
wanted_by="WantedBy",
)
def installable(_class: Type[SystemdUnitModule]):
"""adds the required arguments to the spec and adds the install method for the unit method"""
specs = _class.module_spec
arguments = dict(
required_by=Types.list(elements=str, help="systemd units that require this mount"),
wanted_by=Types.list(
elements=str,
help="systemd units that want the mount, but not explicitly require it. Commonly used for target if not service explicitly require it.",
),
)
specs["argument_spec"].update(arguments)
def install(self: SystemdUnitModule) -> str:
output = "[Install]\n"
for argument, key in _INSTALL_MAPPING.items():
if self.get(argument, False):
for unit in self.get(argument):
output += "{}={}\n".format(key, unit)
return output
_class.install = install
_class.module_spec = specs
return _class
class SystemdReloadMixin:
module: basic.AnsibleModule
unitfile: pathlib.Path
restartable: bool = True
changed: bool
def post(self):
if not self.changed:
return
systemctl = self.module.get_bin_path("systemctl", required=True)
self.module.run_command([systemctl, "daemon-reload"], check_rc=True)
if self.unitfile.stem.endswith("@") or not self.restartable:
return
(rc, _, _) = self.module.run_command([systemctl, "is-enabled", self.unitfile.name], check_rc=False)
if rc == 0:
self.module.run_command([systemctl, "restart", self.unitfile.name], check_rc=True)

Datei anzeigen

@ -2,12 +2,8 @@
import pathlib import pathlib
from typing import List from typing import List
try: from ansible_module.generic import SYSTEMD_NETWORK_CONFIG, Types, modspec
from ansible_collections.sebastian.systemd.plugins.module_utils.generic import SYSTEMD_NETWORK_CONFIG, Types, modspec from ansible_module.module import SystemdUnitModule
from ansible_collections.sebastian.systemd.plugins.module_utils.module import SystemdUnitModule
except ImportError:
from plugins.module_utils.generic import SYSTEMD_NETWORK_CONFIG, Types, modspec
from plugins.module_utils.module import SystemdUnitModule
class Module(SystemdUnitModule): # type: ignore class Module(SystemdUnitModule): # type: ignore

Datei anzeigen

@ -2,12 +2,8 @@
import pathlib import pathlib
from typing import List, Optional from typing import List, Optional
try: from ansible_module.generic import SYSTEMD_SERVICE_CONFIG, Types, modspec
from ansible_collections.sebastian.systemd.plugins.module_utils.generic import SYSTEMD_SERVICE_CONFIG, Types, modspec from ansible_module.module import SystemdReloadMixin, SystemdUnitModule, installable
from ansible_collections.sebastian.systemd.plugins.module_utils.module import SystemdReloadMixin, SystemdUnitModule, installable
except ImportError:
from plugins.module_utils.generic import SYSTEMD_SERVICE_CONFIG, Types, modspec
from plugins.module_utils.module import SystemdReloadMixin, SystemdUnitModule, installable
SYSTEMD_SERVICE_CONFIG = pathlib.Path("/etc/systemd/system") SYSTEMD_SERVICE_CONFIG = pathlib.Path("/etc/systemd/system")

Datei anzeigen

@ -2,18 +2,14 @@
import pathlib import pathlib
from typing import List, Optional from typing import List, Optional
try: from ansible_module.generic import (
from ansible_collections.sebastian.systemd.plugins.module_utils.generic import ( SYSTEMD_NETWORK_CONFIG,
SYSTEMD_NETWORK_CONFIG, Types,
Types, joindict,
joindict, modspec,
modspec, systemdbool,
systemdbool, )
) from ansible_module.module import SystemdUnitModule
from ansible_collections.sebastian.systemd.plugins.module_utils.module import SystemdUnitModule
except ImportError:
from plugins.module_utils.generic import SYSTEMD_NETWORK_CONFIG, Types, joindict, modspec, systemdbool
from plugins.module_utils.module import SystemdUnitModule
kinds = ( kinds = (

Datei anzeigen

@ -2,12 +2,8 @@
import pathlib import pathlib
from typing import List, Union from typing import List, Union
try: from ansible_module.generic import SYSTEMD_NETWORK_CONFIG, Types, modspec, systemdbool
from ansible_collections.sebastian.systemd.plugins.module_utils.generic import SYSTEMD_NETWORK_CONFIG, Types, modspec, systemdbool from ansible_module.module import SystemdUnitModule
from ansible_collections.sebastian.systemd.plugins.module_utils.module import SystemdUnitModule
except ImportError:
from plugins.module_utils.generic import SYSTEMD_NETWORK_CONFIG, Types, modspec, systemdbool
from plugins.module_utils.module import SystemdUnitModule
class Module(SystemdUnitModule): # type: ignore class Module(SystemdUnitModule): # type: ignore

Datei anzeigen

@ -2,12 +2,8 @@
import pathlib import pathlib
from typing import List, Union from typing import List, Union
try: from ansible_module.generic import SYSTEMD_SERVICE_CONFIG, Types, modspec
from ansible_collections.sebastian.systemd.plugins.module_utils.generic import SYSTEMD_SERVICE_CONFIG, Types, modspec from ansible_module.module import SystemdReloadMixin, SystemdUnitModule, installable
from ansible_collections.sebastian.systemd.plugins.module_utils.module import SystemdReloadMixin, SystemdUnitModule, installable
except ImportError:
from plugins.module_utils.generic import SYSTEMD_SERVICE_CONFIG, Types, modspec
from plugins.module_utils.module import SystemdReloadMixin, SystemdUnitModule, installable
@installable @installable

Datei anzeigen

@ -2,12 +2,8 @@
import pathlib import pathlib
from typing import List, Union from typing import List, Union
try: from ansible_module.generic import SYSTEMD_SERVICE_CONFIG, Types
from ansible_collections.sebastian.systemd.plugins.module_utils.generic import SYSTEMD_SERVICE_CONFIG, Types from ansible_module.module import SystemdReloadMixin, SystemdUnitModule, installable
from ansible_collections.sebastian.systemd.plugins.module_utils.module import SystemdReloadMixin, SystemdUnitModule, installable
except ImportError:
from plugins.module_utils.generic import SYSTEMD_SERVICE_CONFIG, Types
from plugins.module_utils.module import SystemdReloadMixin, SystemdUnitModule, installable
@installable @installable

Datei anzeigen

@ -2,12 +2,8 @@
import pathlib import pathlib
from typing import List, Union from typing import List, Union
try: from ansible_module.generic import SYSTEMD_SERVICE_CONFIG, Types, systemdbool
from ansible_collections.sebastian.systemd.plugins.module_utils.generic import SYSTEMD_SERVICE_CONFIG, Types, systemdbool from ansible_module.module import SystemdReloadMixin, SystemdUnitModule, installable
from ansible_collections.sebastian.systemd.plugins.module_utils.module import SystemdReloadMixin, SystemdUnitModule, installable
except ImportError:
from plugins.module_utils.generic import SYSTEMD_SERVICE_CONFIG, Types, systemdbool
from plugins.module_utils.module import SystemdReloadMixin, SystemdUnitModule, installable
__module_name__ = "TargetModule" __module_name__ = "TargetModule"

Datei anzeigen

@ -2,12 +2,8 @@
import pathlib import pathlib
from typing import List, Union from typing import List, Union
try: from ansible_module.generic import SYSTEMD_SERVICE_CONFIG, Types, modpec
from ansible_collections.sebastian.systemd.plugins.module_utils.generic import SYSTEMD_SERVICE_CONFIG, Types, modpec from ansible_module.module import SystemdReloadMixin, SystemdUnitModule, installable
from ansible_collections.sebastian.systemd.plugins.module_utils.module import SystemdReloadMixin, SystemdUnitModule, installable
except ImportError:
from plugins.module_utils.generic import SYSTEMD_SERVICE_CONFIG, Types, modspec
from plugins.module_utils.module import SystemdReloadMixin, SystemdUnitModule, installable
@installable @installable

1
requirements.txt Normale Datei
Datei anzeigen

@ -0,0 +1 @@
ansible-module>0.1.3