# SPDX-License-Identifier: AGPL-3.0-or-later """ Test module for component managing system daemons and other systemd units. """ import socket import subprocess from unittest.mock import Mock, call, patch import pytest from plinth.app import App, FollowerComponent, Info from plinth.daemon import (Daemon, RelatedDaemon, SharedDaemon, app_is_running, diagnose_netcat, diagnose_port_listening) from plinth.diagnostic_check import DiagnosticCheck, Result privileged_modules_to_mock = ['plinth.privileged.service'] class AppTest(App): """Test application that contains a daemon.""" app_id = 'test-app' @pytest.fixture(name='daemon') def fixture_daemon(): """Create a test daemon object.""" return Daemon('test-daemon', 'test-unit') @pytest.fixture(name='app_list') def fixture_app_list(daemon): """A list of apps on which tests are to be run.""" app1 = AppTest() app1.add(Info('test-app', 1)) app1.add(daemon) with patch('plinth.app.App.list') as app_list: app_list.return_value = [app1] yield app_list def test_initialization(): """Test that component is initialized properly.""" with pytest.raises(ValueError): Daemon(None, None) daemon = Daemon('test-daemon', 'test-unit') assert daemon.component_id == 'test-daemon' assert daemon.unit == 'test-unit' assert not daemon.strict_check assert daemon.listen_ports == [] assert daemon.alias is None listen_ports = [(345, 'tcp4'), (123, 'udp')] daemon = Daemon('test-daemon', 'test-unit', strict_check=True, listen_ports=listen_ports, alias='test-unit-2') assert daemon.strict_check assert daemon.listen_ports == listen_ports assert daemon.alias == 'test-unit-2' @patch('plinth.action_utils.service_is_enabled') def test_is_enabled(service_is_enabled, daemon): """Test that daemon enabled check works.""" service_is_enabled.return_value = True assert daemon.is_enabled() service_is_enabled.assert_has_calls( [call('test-unit', strict_check=False)]) service_is_enabled.return_value = False assert not daemon.is_enabled() service_is_enabled.reset_mock() daemon.strict_check = True daemon.is_enabled() service_is_enabled.assert_has_calls([call('test-unit', strict_check=True)]) @patch('plinth.app.apps_init') @patch('subprocess.run') def test_enable(subprocess_run, apps_init, app_list, mock_privileged, daemon): """Test that enabling the daemon works.""" common_args = dict(stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=False) daemon.enable() subprocess_run.assert_has_calls( [call(['systemctl', 'enable', 'test-unit'], **common_args)]) subprocess_run.assert_any_call(['systemctl', 'start', 'test-unit'], **common_args) subprocess_run.reset_mock() daemon.alias = 'test-unit-2' daemon.enable() subprocess_run.assert_has_calls([ call(['systemctl', 'enable', 'test-unit'], **common_args), call(['systemctl', 'start', 'test-unit'], **common_args), call(['systemctl', 'enable', 'test-unit-2'], **common_args), call(['systemctl', 'start', 'test-unit-2'], **common_args), ]) subprocess_run.assert_any_call(['systemctl', 'start', 'test-unit'], **common_args) subprocess_run.assert_any_call(['systemctl', 'start', 'test-unit-2'], **common_args) @patch('plinth.app.apps_init') @patch('subprocess.run') def test_disable(subprocess_run, apps_init, app_list, mock_privileged, daemon): """Test that disabling the daemon works.""" common_args = dict(stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=False) daemon.disable() subprocess_run.assert_has_calls( [call(['systemctl', 'disable', 'test-unit'], **common_args)]) subprocess_run.assert_any_call(['systemctl', 'stop', 'test-unit'], **common_args) subprocess_run.reset_mock() daemon.alias = 'test-unit-2' daemon.disable() subprocess_run.assert_has_calls([ call(['systemctl', 'disable', 'test-unit'], **common_args), call(['systemctl', 'stop', 'test-unit'], **common_args), call(['systemctl', 'disable', 'test-unit-2'], **common_args), call(['systemctl', 'stop', 'test-unit-2'], **common_args), ]) subprocess_run.assert_any_call(['systemctl', 'stop', 'test-unit'], **common_args) subprocess_run.assert_any_call(['systemctl', 'stop', 'test-unit-2'], **common_args) @patch('plinth.action_utils.service_is_running') def test_is_running(service_is_running, daemon): """Test that checking that the daemon is running works.""" service_is_running.return_value = True assert daemon.is_running() service_is_running.assert_has_calls([call('test-unit')]) service_is_running.return_value = False assert not daemon.is_running() @patch('plinth.app.apps_init') @patch('plinth.action_utils.service_is_running') @patch('plinth.action_utils.service_show') @patch('subprocess.run') def test_ensure_running(subprocess_run, service_show, service_is_running, apps_init, app_list, mock_privileged, daemon): """Test that checking that the daemon is running works.""" common_args = dict(stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=False) service_show.return_value = {'LoadState': 'not-found'} with daemon.ensure_running() as starting_state: assert not starting_state assert subprocess_run.mock_calls == [] service_show.return_value = {'LoadState': 'loaded'} service_is_running.return_value = True with daemon.ensure_running() as starting_state: assert starting_state assert not subprocess_run.called assert not subprocess_run.called service_is_running.return_value = False with daemon.ensure_running() as starting_state: assert not starting_state assert subprocess_run.mock_calls == [ call(['systemctl', 'enable', 'test-unit'], **common_args), call(['systemctl', 'start', 'test-unit'], **common_args), ] subprocess_run.reset_mock() assert subprocess_run.mock_calls == [ call(['systemctl', 'disable', 'test-unit'], **common_args), call(['systemctl', 'stop', 'test-unit'], **common_args), ] @patch('plinth.action_utils.service_is_running') @patch('plinth.daemon.diagnose_port_listening') def test_diagnose(port_listening, service_is_running, daemon): """Test running diagnostics.""" def side_effect(port, kind, _listen_address, component_id): name = f'test-result-{port}-{kind}' return DiagnosticCheck(name, name, Result.PASSED, {}, component_id) daemon = Daemon('test-daemon', 'test-unit', listen_ports=[(8273, 'tcp4'), (345, 'udp')]) port_listening.side_effect = side_effect service_is_running.return_value = True results = daemon.diagnose() assert results == [ DiagnosticCheck('daemon-running-test-unit', 'Service {service_name} is running', Result.PASSED, {'service_name': 'test-unit'}, 'test-daemon'), DiagnosticCheck('test-result-8273-tcp4', 'test-result-8273-tcp4', Result.PASSED, {}, 'test-daemon'), DiagnosticCheck('test-result-345-udp', 'test-result-345-udp', Result.PASSED, {}, 'test-daemon') ] port_listening.assert_has_calls([ call(8273, 'tcp4', None, 'test-daemon'), call(345, 'udp', None, 'test-daemon') ]) service_is_running.assert_has_calls([call('test-unit')]) service_is_running.return_value = False results = daemon.diagnose() assert results[0].result == Result.FAILED @patch('plinth.action_utils.service_is_running') def test_app_is_running(service_is_running): """Test that checking whether app is running works.""" daemon1 = Daemon('test-daemon-1', 'test-unit-1') daemon2 = FollowerComponent('test-daemon-2', 'test-unit-2') daemon2.is_running = Mock() follower1 = FollowerComponent('test-follower-1') class TestApp(App): """Test app""" app_id = 'test-app' app = TestApp() app.add(daemon1) app.add(daemon2) app.add(follower1) service_is_running.return_value = True daemon2.is_running.return_value = False assert not app_is_running(app) service_is_running.return_value = False daemon2.is_running.return_value = False assert not app_is_running(app) service_is_running.return_value = True daemon2.is_running.return_value = True assert app_is_running(app) @patch('psutil.net_connections') def test_diagnose_port_listening(connections): """Test running port listening diagnostics test.""" connections.return_value = [ Mock(status='LISTEN', laddr=('0.0.0.0', 1234), family=socket.AF_INET), Mock(status='ESTABLISHED', laddr=('0.0.0.0', 2345), family=socket.AF_INET), Mock(raddr=(), laddr=('0.0.0.0', 3456), family=socket.AF_INET), Mock(raddr=('1.1.1.1', 53), laddr=('0.0.0.0', 4567), family=socket.AF_INET), Mock(status='LISTEN', laddr=('::1', 5678), familiy=socket.AF_INET6), Mock(status='LISTEN', laddr=('::', 6789), familiy=socket.AF_INET6), Mock(raddr=(), laddr=('::1', 5678), familiy=socket.AF_INET6), Mock(raddr=(), laddr=('::', 6789), familiy=socket.AF_INET6), ] # Check that message is correct results = diagnose_port_listening(1234) assert results == DiagnosticCheck('daemon-listening-tcp-1234', 'Listening on {kind} port {port}', Result.PASSED, { 'kind': 'tcp', 'port': 1234 }) results = diagnose_port_listening(1234, 'tcp', '0.0.0.0') assert results == DiagnosticCheck( 'daemon-listening-address-tcp-1234-0.0.0.0', 'Listening on {kind} port {listen_address}:{port}', Result.PASSED, { 'kind': 'tcp', 'port': 1234, 'listen_address': '0.0.0.0' }) # Failed results results = diagnose_port_listening(4321) assert results == DiagnosticCheck('daemon-listening-tcp-4321', 'Listening on {kind} port {port}', Result.FAILED, { 'kind': 'tcp', 'port': 4321 }) results = diagnose_port_listening(4321, 'tcp', '0.0.0.0') assert results == DiagnosticCheck( 'daemon-listening-address-tcp-4321-0.0.0.0', 'Listening on {kind} port {listen_address}:{port}', Result.FAILED, { 'kind': 'tcp', 'port': 4321, 'listen_address': '0.0.0.0' }) # Check if psutil call is being made with right argument results = diagnose_port_listening(1234, 'tcp') connections.assert_called_with('tcp') results = diagnose_port_listening(1234, 'tcp4') connections.assert_called_with('tcp') results = diagnose_port_listening(1234, 'tcp6') connections.assert_called_with('tcp6') results = diagnose_port_listening(3456, 'udp') connections.assert_called_with('udp') results = diagnose_port_listening(3456, 'udp4') connections.assert_called_with('udp') results = diagnose_port_listening(3456, 'udp6') connections.assert_called_with('udp6') # TCP assert diagnose_port_listening(1234).result == Result.PASSED assert diagnose_port_listening(1000).result == Result.FAILED assert diagnose_port_listening(2345).result == Result.FAILED assert diagnose_port_listening(1234, 'tcp', '0.0.0.0').result == Result.PASSED assert diagnose_port_listening(1234, 'tcp', '1.1.1.1').result == Result.FAILED assert diagnose_port_listening(1234, 'tcp6').result == Result.PASSED assert diagnose_port_listening(1234, 'tcp4').result == Result.PASSED assert diagnose_port_listening(6789, 'tcp4').result == Result.PASSED assert diagnose_port_listening(5678, 'tcp4').result == Result.FAILED # UDP assert diagnose_port_listening(3456, 'udp').result == Result.PASSED assert diagnose_port_listening(3000, 'udp').result == Result.FAILED assert diagnose_port_listening(4567, 'udp').result == Result.FAILED assert diagnose_port_listening(3456, 'udp', '0.0.0.0').result == Result.PASSED assert diagnose_port_listening(3456, 'udp', '1.1.1.1').result == Result.FAILED assert diagnose_port_listening(3456, 'udp6').result == Result.PASSED assert diagnose_port_listening(3456, 'udp4').result == Result.PASSED assert diagnose_port_listening(6789, 'udp4').result == Result.PASSED assert diagnose_port_listening(5678, 'udp4').result == Result.FAILED @patch('subprocess.Popen') def test_diagnose_netcat(popen): """Test running diagnostic test using netcat.""" popen().returncode = 0 result = diagnose_netcat('test-host', 3300, remote_input='test-input') parameters = {'host': 'test-host', 'port': 3300, 'negate': False} assert result == DiagnosticCheck('daemon-netcat-test-host-3300', 'Connect to {host}:{port}', Result.PASSED, parameters) assert popen.mock_calls[1][1] == (['nc', 'test-host', '3300'], ) assert popen.mock_calls[2] == call().communicate(input=b'test-input') result = diagnose_netcat('test-host', 3300, remote_input='test-input', negate=True, component_id='test-component') parameters2 = parameters.copy() parameters2['negate'] = True assert result == DiagnosticCheck('daemon-netcat-negate-test-host-3300', 'Cannot connect to {host}:{port}', Result.FAILED, parameters2, 'test-component') popen().returncode = 1 result = diagnose_netcat('test-host', 3300, remote_input='test-input') assert result == DiagnosticCheck('daemon-netcat-test-host-3300', 'Connect to {host}:{port}', Result.FAILED, parameters) result = diagnose_netcat('test-host', 3300, remote_input='test-input', negate=True) assert result == DiagnosticCheck('daemon-netcat-negate-test-host-3300', 'Cannot connect to {host}:{port}', Result.PASSED, parameters2) def test_related_daemon_initialization(): """Test that initializing related daemon works.""" component = RelatedDaemon('test-component', 'test-daemon') assert component.component_id == 'test-component' assert component.unit == 'test-daemon' with pytest.raises(ValueError): RelatedDaemon(None, 'test-daemon') def test_shared_daemon_leader(): """Test that shared daemon is not a leader component.""" component1 = SharedDaemon('test-component1', 'test-daemon') assert not component1.is_leader @patch('plinth.action_utils.service_is_enabled') def test_shared_daemon_set_enabled(service_is_enabled): """Test that enabled status is determined by unit status.""" component = SharedDaemon('test-component', 'test-daemon') service_is_enabled.return_value = False component.set_enabled(False) assert not component.is_enabled() component.set_enabled(True) assert not component.is_enabled() service_is_enabled.return_value = True component.set_enabled(False) assert component.is_enabled() component.set_enabled(True) assert component.is_enabled() @patch('plinth.privileged.service.disable') def test_shared_daemon_disable(disable_method): """Test that shared daemon disables service correctly.""" class AppTest2(App): """Test application class.""" app_id = 'test-app-2' component1 = SharedDaemon('test-component1', 'test-daemon') app1 = AppTest() app1.add(component1) app1.is_enabled = Mock() component2 = SharedDaemon('test-component2', 'test-daemon') app2 = AppTest2() app2.add(component2) # When another app is enabled, service should not be disabled app1.is_enabled.return_value = True app2.disable() assert disable_method.mock_calls == [] # When all other apps are disabled, service should be disabled disable_method.reset_mock() app1.is_enabled.return_value = False app2.disable() assert disable_method.mock_calls == [call('test-daemon')]