#!/usr/bin/python # # Copyright (c) 2015, Brian Coca # 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 annotations DOCUMENTATION = r""" module: svc author: - Brian Coca (@bcoca) short_description: Manage C(daemontools) services description: - Controls C(daemontools) services on remote hosts using the C(svc) utility. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: name: description: - Name of the service to manage. type: str required: true state: description: - V(started)/V(stopped) are idempotent actions that do not run commands unless necessary. - V(restarted) always bounces the svc (svc -t) and V(killed) always bounces the svc (svc -k). - V(reloaded) sends a sigusr1 (svc -1). - V(once) runs a normally downed svc once (svc -o), not really an idempotent operation. type: str choices: [killed, once, reloaded, restarted, started, stopped] downed: description: - Should a C(down) file exist or not, if it exists it disables auto startup. Defaults to V(false). Downed does not imply stopped. type: bool enabled: description: - Whether the service is enabled or not, if disabled it also implies O(state=stopped). Take note that a service can be enabled and downed (no auto restart). type: bool service_dir: description: - Directory C(svscan) watches for services. type: str default: /service service_src: description: - Directory where services are defined, the source of symlinks to O(service_dir). type: str default: /etc/service """ EXAMPLES = r""" - name: Start svc dnscache, if not running community.general.svc: name: dnscache state: started - name: Stop svc dnscache, if running community.general.svc: name: dnscache state: stopped - name: Kill svc dnscache, in all cases community.general.svc: name: dnscache state: killed - name: Restart svc dnscache, in all cases community.general.svc: name: dnscache state: restarted - name: Reload svc dnscache, in all cases community.general.svc: name: dnscache state: reloaded - name: Using alternative svc directory location community.general.svc: name: dnscache state: reloaded service_dir: /var/service """ import os import re import traceback from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_native def _load_dist_subclass(cls, *args, **kwargs): """ Used for derivative implementations """ subclass = None distro = kwargs["module"].params["distro"] # get the most specific superclass for this platform if distro is not None: for sc in cls.__subclasses__(): if sc.distro is not None and sc.distro == distro: subclass = sc if subclass is None: subclass = cls return super(cls, subclass).__new__(subclass) class Svc: """ Main class that handles daemontools, can be subclassed and overridden in case we want to use a 'derivative' like encore, s6, etc """ # def __new__(cls, *args, **kwargs): # return _load_dist_subclass(cls, args, kwargs) def __init__(self, module): self.extra_paths = ["/command", "/usr/local/bin"] self.report_vars = ["state", "enabled", "downed", "svc_full", "src_full", "pid", "duration", "full_state"] self.module = module self.name = module.params["name"] self.service_dir = module.params["service_dir"] self.service_src = module.params["service_src"] self.enabled = None self.downed = None self.full_state = None self.state = None self.pid = None self.duration = None self.svc_cmd = module.get_bin_path("svc", opt_dirs=self.extra_paths) self.svstat_cmd = module.get_bin_path("svstat", opt_dirs=self.extra_paths) self.svc_full = f"{self.service_dir}/{self.name}" self.src_full = f"{self.service_src}/{self.name}" self.enabled = os.path.lexists(self.svc_full) if self.enabled: self.downed = os.path.lexists(f"{self.svc_full}/down") self.get_status() else: self.downed = os.path.lexists(f"{self.src_full}/down") self.state = "stopped" def enable(self): if os.path.exists(self.src_full): try: os.symlink(self.src_full, self.svc_full) except OSError as e: self.module.fail_json(path=self.src_full, msg=f"Error while linking: {to_native(e)}") else: self.module.fail_json(msg=f"Could not find source for service to enable ({self.src_full}).") def disable(self): try: os.unlink(self.svc_full) except OSError as e: self.module.fail_json(path=self.svc_full, msg=f"Error while unlinking: {e}") self.execute_command([self.svc_cmd, "-dx", self.src_full]) src_log = f"{self.src_full}/log" if os.path.exists(src_log): self.execute_command([self.svc_cmd, "-dx", src_log]) def get_status(self): rc, out, err = self.execute_command([self.svstat_cmd, self.svc_full]) if err is not None and err: self.full_state = self.state = err else: self.full_state = out m = re.search(r"\(pid (\d+)\)", out) if m: self.pid = m.group(1) m = re.search(r"(\d+) seconds", out) if m: self.duration = m.group(1) if re.search(" up ", out): self.state = "start" elif re.search(" down ", out): self.state = "stopp" else: self.state = "unknown" return if re.search(" want ", out): self.state += "ing" else: self.state += "ed" def start(self): return self.execute_command([self.svc_cmd, "-u", self.svc_full]) def stopp(self): return self.stop() def stop(self): return self.execute_command([self.svc_cmd, "-d", self.svc_full]) def once(self): return self.execute_command([self.svc_cmd, "-o", self.svc_full]) def reload(self): return self.execute_command([self.svc_cmd, "-1", self.svc_full]) def restart(self): return self.execute_command([self.svc_cmd, "-t", self.svc_full]) def kill(self): return self.execute_command([self.svc_cmd, "-k", self.svc_full]) def execute_command(self, cmd): try: rc, out, err = self.module.run_command(cmd) except Exception as e: self.module.fail_json(msg=f"failed to execute: {e}", exception=traceback.format_exc()) return (rc, out, err) def report(self): self.get_status() states = {} for k in self.report_vars: states[k] = self.__dict__[k] return states # =========================================== # Main control flow def main(): module = AnsibleModule( argument_spec=dict( name=dict(type="str", required=True), state=dict(type="str", choices=["killed", "once", "reloaded", "restarted", "started", "stopped"]), enabled=dict(type="bool"), downed=dict(type="bool"), service_dir=dict(type="str", default="/service"), service_src=dict(type="str", default="/etc/service"), ), supports_check_mode=True, ) module.run_command_environ_update = dict(LANG="C", LC_ALL="C", LC_MESSAGES="C", LC_CTYPE="C") state = module.params["state"] enabled = module.params["enabled"] downed = module.params["downed"] svc = Svc(module) changed = False dummy_orig_state = svc.report() # TODO - is this not needed? if enabled is not None and enabled != svc.enabled: changed = True if not module.check_mode: try: if enabled: svc.enable() else: svc.disable() except (OSError, IOError) as e: module.fail_json(msg=f"Could not change service link: {e}") if state is not None and state != svc.state: changed = True if not module.check_mode: getattr(svc, state[:-2])() if downed is not None and downed != svc.downed: changed = True if not module.check_mode: d_file = f"{svc.svc_full}/down" try: if downed: open(d_file, "a").close() else: os.unlink(d_file) except (OSError, IOError) as e: module.fail_json(msg=f"Could not change downed file: {e} ") module.exit_json(changed=changed, svc=svc.report()) if __name__ == "__main__": main()