Veiko Aasa 7d77a26761
datetime: Handle timesyncd service runs conditionally
systemd-timesyncd service does not run if we have another NTP daemon installed
or FreedomBox runs inside a container where the host manages the time. In this
case, make the application as unmanaged - app can't be disabled, no app
diagnostics is shown and enable/disable functional tests are skipped.

Closes #1616

Tests performed:
- Run FreedomBox inside a KVM virtualization module, check that
  systemd-timesyncd is running, datetime app can be disabled and all
  diagnostics and date_and_time functional tests pass.
- Run FreedomBox inside a systemd-nspawn container, check that
  systemd-timesyncd is not running, datetime app can't be disabled,
  the diagnostics button is not shown and two date_and_time functional tests
  are skipped.

Signed-off-by: Veiko Aasa <veiko17@disroot.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2020-04-25 09:56:00 -04:00

117 lines
3.1 KiB
Python

# SPDX-License-Identifier: AGPL-3.0-or-later
"""
FreedomBox app to configure system date and time.
"""
import subprocess
from django.utils.translation import ugettext_lazy as _
from plinth import app as app_module
from plinth import menu
from plinth.daemon import Daemon
from .manifest import backup # noqa, pylint: disable=unused-import
version = 2
is_essential = True
managed_services = ['systemd-timesyncd']
managed_packages = []
_description = [
_('Network time server is a program that maintains the system time '
'in synchronization with servers on the Internet.')
]
app = None
class UnmanagedDateTimeApp(app_module.App):
"""FreedomBox app for date and time if time syncronization is unmanaged."""
app_id = 'datetime'
can_be_disabled = False
def __init__(self):
"""Create components for the app."""
super().__init__()
info = app_module.Info(app_id=self.app_id, version=version,
is_essential=is_essential,
name=_('Date & Time'), icon='fa-clock-o',
description=_description,
manual_page='DateTime')
self.add(info)
menu_item = menu.Menu('menu-datetime', info.name, None, info.icon,
'datetime:index', parent_url_name='system')
self.add(menu_item)
class ManagedDateTimeApp(UnmanagedDateTimeApp):
"""FreedomBox app for date and time if time syncronization is managed."""
can_be_disabled = True
def __init__(self):
"""Create components for the app."""
super().__init__()
daemon = Daemon('daemon-datetime', managed_services[0])
self.add(daemon)
def diagnose(self):
"""Run diagnostics and return the results."""
results = super().diagnose()
results.append(_diagnose_time_synchronized())
return results
def init():
"""Initialize the date/time module."""
global app
if _is_time_managed():
app = ManagedDateTimeApp()
else:
app = UnmanagedDateTimeApp()
if app.is_enabled():
app.set_enabled(True)
def setup(helper, old_version=None):
"""Install and configure the module."""
helper.call('post', app.enable)
def _diagnose_time_synchronized():
"""Check whether time is synchronized to NTP server."""
result = 'failed'
try:
output = subprocess.check_output(
['timedatectl', 'show', '--property=NTPSynchronized', '--value'])
if 'yes' in output.decode():
result = 'passed'
except subprocess.CalledProcessError:
pass
return [_('Time synchronized to NTP server'), result]
def _is_time_managed():
"""Check whether time should be syncronized by the systemd-timesyncd.
systemd-timesyncd does not run if we have another NTP daemon installed or
FreedomBox runs inside a container where the host manages the time.
"""
output = subprocess.check_output([
'systemctl', 'show', '--property=ConditionResult', '--value',
'systemd-timesyncd'
])
return 'yes' in output.decode()