def ensure_is_systemd():
"""
Ensure if current system is systemd system. Raises Library error if not.
"""
if not is_systemctl():
raise LibraryError(
reports.unsupported_operation_on_non_systemd_systems())
def ensure_is_systemd():
"""
Raise a LibraryError if the current system is not a systemd system
"""
if not is_systemctl():
raise LibraryError(
reports.unsupported_operation_on_non_systemd_systems())
def ensure_is_systemd():
"""
Ensure if current system is systemd system. Raises Library error if not.
"""
if not is_systemctl():
raise LibraryError(
reports.unsupported_operation_on_non_systemd_systems()
)
def ensure_is_systemd():
"""
Raise a LibraryError if the current system is not a systemd system
"""
if not is_systemctl():
raise LibraryError(
ReportItem.error(
reports.messages.UnsupportedOperationOnNonSystemdSystems()))
def is_service_installed(runner, service, instance=None):
"""
Check if specified service is installed on local system.
runner -- CommandRunner
service -- name of service
instance -- systemd service instance
"""
if not is_systemctl():
return service in get_non_systemd_services(runner)
service_name = "{0}{1}".format(service, "" if instance is None else "@")
return service_name in get_systemd_services(runner)
def is_service_installed(runner, service, instance=None):
"""
Check if specified service is installed on local system.
runner -- CommandRunner
service -- name of service
instance -- systemd service instance
"""
if not is_systemctl():
return service in get_non_systemd_services(runner)
service_name = "{0}{1}".format(service, "" if instance is None else "@")
return service_name in get_systemd_services(runner)
def is_service_enabled(runner, service, instance=None):
"""
Check if specified service is enabled in local system.
runner -- CommandRunner
service -- name of service
"""
if is_systemctl():
dummy_stdout, dummy_stderr, retval = runner.run(
[_systemctl, "is-enabled", _get_service_name(service, instance)]
)
else:
dummy_stdout, dummy_stderr, retval = runner.run([_chkconfig, service])
return retval == 0
def is_service_enabled(runner, service, instance=None):
"""
Check if specified service is enabled in local system.
runner -- CommandRunner
service -- name of service
"""
if is_systemctl():
dummy_stdout, dummy_stderr, retval = runner.run(
[_systemctl, "is-enabled",
_get_service_name(service, instance)])
else:
dummy_stdout, dummy_stderr, retval = runner.run([_chkconfig, service])
return retval == 0
def is_service_running(runner, service, instance=None):
"""
Check if specified service is currently running on local system.
runner -- CommandRunner
service -- name of service
"""
if is_systemctl():
dummy_stdout, dummy_stderr, retval = runner.run(
[_systemctl, "is-active",
_get_service_name(service, instance)])
else:
dummy_stdout, dummy_stderr, retval = runner.run(
[_service, service, "status"])
return retval == 0
def stop_service(runner, service, instance=None):
"""
Stop specified service in local system
CommandRunner runner
string service service name
string instance instance name, it ha no effect on not systemd systems.
If None no instance name will be used.
"""
if is_systemctl():
stdout, stderr, retval = runner.run(
[_systemctl, "stop",
_get_service_name(service, instance)])
else:
stdout, stderr, retval = runner.run([_service, service, "stop"])
if retval != 0:
raise StopServiceError(service, join_multilines([stderr, stdout]),
instance)
def is_service_enabled(runner: CommandRunner,
service: str,
instance: Optional[str] = None) -> bool:
"""
Check if the specified service is enabled in the local system.
runner -- CommandRunner
service -- name of the service
instance -- optional name of the services's instance
"""
if is_systemctl():
dummy_stdout, dummy_stderr, retval = runner.run(
[_systemctl, "is-enabled",
_get_service_name(service, instance)])
else:
dummy_stdout, dummy_stderr, retval = runner.run([_chkconfig, service])
return retval == 0
def enable_service(runner, service, instance=None):
"""
Enable specified service in local system.
Raise EnableServiceError or LibraryError on failure.
runner -- CommandRunner
service -- name of service
instance -- instance name, it ha no effect on not systemd systems.
If None no instance name will be used.
"""
if is_systemctl():
stdout, stderr, retval = runner.run(
[_systemctl, "enable",
_get_service_name(service, instance)])
else:
stdout, stderr, retval = runner.run([_chkconfig, service, "on"])
if retval != 0:
raise EnableServiceError(service, join_multilines([stderr, stdout]),
instance)
def get_non_systemd_services(runner):
"""
Returns list of all installed services on non systemd system.
runner -- CommandRunner
"""
if is_systemctl():
return []
stdout, dummy_stderr, return_code = runner.run([_chkconfig])
if return_code != 0:
return []
service_list = []
for service in stdout.splitlines():
service = service.split(" ", 1)[0]
if service:
service_list.append(service)
return service_list
def get_non_systemd_services(runner):
"""
Returns list of all installed services on non systemd system.
runner -- CommandRunner
"""
if is_systemctl():
return []
stdout, dummy_stderr, return_code = runner.run([_chkconfig])
if return_code != 0:
return []
service_list = []
for service in stdout.splitlines():
service = service.split(" ", 1)[0]
if service:
service_list.append(service)
return service_list
def is_service_running(runner, service, instance=None):
"""
Check if specified service is currently running on local system.
runner -- CommandRunner
service -- name of service
"""
if is_systemctl():
dummy_stdout, dummy_stderr, retval = runner.run([
_systemctl,
"is-active",
_get_service_name(service, instance)
])
else:
dummy_stdout, dummy_stderr, retval = runner.run(
[_service, service, "status"]
)
return retval == 0
def is_service_running(runner: CommandRunner,
service: str,
instance: Optional[str] = None) -> bool:
"""
Check if the specified service is currently running on the local system.
runner -- CommandRunner
service -- name of the service
instance -- optional name of the services's instance
"""
if is_systemctl():
dummy_stdout, dummy_stderr, retval = runner.run(
[_systemctl, "is-active",
_get_service_name(service, instance)])
else:
dummy_stdout, dummy_stderr, retval = runner.run(
[_service, service, "status"])
return retval == 0
def get_systemd_services(runner):
"""
Returns list of all systemd services installed on local system.
runner -- CommandRunner
"""
if not is_systemctl():
return []
stdout, dummy_stderr, return_code = runner.run(
[_systemctl, "list-unit-files", "--full"])
if return_code != 0:
return []
service_list = []
for service in stdout.splitlines():
match = re.search(r'^([\S]*)\.service', service)
if match:
service_list.append(match.group(1))
return service_list
def stop_service(runner, service, instance=None):
"""
Stop specified service in local system
CommandRunner runner
string service service name
string instance instance name, it ha no effect on not systemd systems.
If None no instance name will be used.
"""
if is_systemctl():
stdout, stderr, retval = runner.run([
_systemctl, "stop", _get_service_name(service, instance)
])
else:
stdout, stderr, retval = runner.run([_service, service, "stop"])
if retval != 0:
raise StopServiceError(
service,
join_multilines([stderr, stdout]),
instance
)
def get_systemd_services(runner):
"""
Returns list of all systemd services installed on local system.
runner -- CommandRunner
"""
if not is_systemctl():
return []
stdout, dummy_stderr, return_code = runner.run([
_systemctl, "list-unit-files", "--full"
])
if return_code != 0:
return []
service_list = []
for service in stdout.splitlines():
match = re.search(r'^([\S]*)\.service', service)
if match:
service_list.append(match.group(1))
return service_list
def enable_service(runner, service, instance=None):
"""
Enable specified service in local system.
Raise EnableServiceError or LibraryError on failure.
runner -- CommandRunner
service -- name of service
instance -- instance name, it ha no effect on not systemd systems.
If None no instance name will be used.
"""
if is_systemctl():
stdout, stderr, retval = runner.run([
_systemctl, "enable", _get_service_name(service, instance)
])
else:
stdout, stderr, retval = runner.run([_chkconfig, service, "on"])
if retval != 0:
raise EnableServiceError(
service,
join_multilines([stderr, stdout]),
instance
)