FreedomBox/plinth/modules/tor/tests/test_functional.py
James Valleroy 1bc42a7647
tor: Convert functional tests to non-BDD python format
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
[sunil: Remove use of text constants for bool values (artifact of bdd)]
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
2021-10-05 15:28:47 -07:00

137 lines
5.1 KiB
Python

# SPDX-License-Identifier: AGPL-3.0-or-later
"""
Functional, browser based tests for tor app.
"""
import pytest
from plinth.tests import functional
_TOR_FEATURE_TO_ELEMENT = {
'relay': 'tor-relay_enabled',
'bridge-relay': 'tor-bridge_relay_enabled',
'hidden-services': 'tor-hs_enabled',
'software': 'tor-apt_transport_tor_enabled'
}
pytestmark = [pytest.mark.apps, pytest.mark.tor]
@pytest.fixture(scope='module', autouse=True)
def fixture_background(session_browser):
"""Login and install the app."""
functional.login(session_browser)
functional.install(session_browser, 'tor')
yield
functional.app_disable(session_browser, 'tor')
def test_enable_disable(session_browser):
"""Test enabling the app."""
functional.app_disable(session_browser, 'tor')
functional.app_enable(session_browser, 'tor')
assert functional.service_is_running(session_browser, 'tor')
functional.app_disable(session_browser, 'tor')
assert functional.service_is_not_running(session_browser, 'tor')
def test_set_tor_relay_configuration(session_browser):
"""Test setting Tor relay configuration."""
functional.app_enable(session_browser, 'tor')
_feature_enable(session_browser, 'relay', should_enable=False)
_feature_enable(session_browser, 'relay', should_enable=True)
_assert_feature_enabled(session_browser, 'relay', enabled=True)
assert 'orport' in _get_relay_ports(session_browser)
def test_set_tor_bridge_relay_configuration(session_browser):
"""Test setting Tor bridge relay configuration."""
functional.app_enable(session_browser, 'tor')
_feature_enable(session_browser, 'bridge-relay', should_enable=False)
_feature_enable(session_browser, 'bridge-relay', should_enable=True)
_assert_feature_enabled(session_browser, 'bridge-relay', enabled=True)
assert 'obfs3' in _get_relay_ports(session_browser)
assert 'obfs4' in _get_relay_ports(session_browser)
def test_set_tor_hidden_services_configuration(session_browser):
"""Test setting Tor hidden services configuration."""
functional.app_enable(session_browser, 'tor')
_feature_enable(session_browser, 'hidden-services', should_enable=False)
_feature_enable(session_browser, 'hidden-services', should_enable=True)
_assert_feature_enabled(session_browser, 'hidden-services', enabled=True)
_assert_hidden_services(session_browser)
def test_set_download_software_packages_over_tor(session_browser):
"""Test setting download software packages over Tor."""
functional.app_enable(session_browser, 'tor')
_feature_enable(session_browser, 'software', should_enable=True)
_feature_enable(session_browser, 'software', should_enable=False)
_assert_feature_enabled(session_browser, 'software', enabled=False)
# TODO: Test more thoroughly by checking same hidden service is restored and by
# actually connecting using Tor.
@pytest.mark.backups
def test_backup_restore(session_browser):
"""Test backup and restore of configuration."""
functional.app_enable(session_browser, 'tor')
_feature_enable(session_browser, 'relay', should_enable=True)
_feature_enable(session_browser, 'bridge-relay', should_enable=True)
_feature_enable(session_browser, 'hidden-services', should_enable=True)
functional.backup_create(session_browser, 'tor', 'test_tor')
_feature_enable(session_browser, 'relay', should_enable=False)
_feature_enable(session_browser, 'hidden-services', should_enable=False)
functional.backup_restore(session_browser, 'tor', 'test_tor')
assert functional.service_is_running(session_browser, 'tor')
_assert_feature_enabled(session_browser, 'relay', enabled=True)
_assert_feature_enabled(session_browser, 'bridge-relay', enabled=True)
_assert_feature_enabled(session_browser, 'hidden-services', enabled=True)
def _feature_enable(browser, feature, should_enable):
"""Enable/disable a Tor feature."""
element_name = _TOR_FEATURE_TO_ELEMENT[feature]
functional.nav_to_module(browser, 'tor')
checkbox_element = browser.find_by_name(element_name).first
if should_enable == checkbox_element.checked:
return
if should_enable:
if feature == 'bridge-relay':
browser.find_by_name('tor-relay_enabled').first.check()
checkbox_element.check()
else:
checkbox_element.uncheck()
functional.submit(browser, form_class='form-configuration')
functional.wait_for_config_update(browser, 'tor')
def _assert_feature_enabled(browser, feature, enabled):
"""Assert whether Tor relay is enabled or disabled."""
element_name = _TOR_FEATURE_TO_ELEMENT[feature]
functional.nav_to_module(browser, 'tor')
assert browser.find_by_name(element_name).first.checked == enabled
def _get_relay_ports(browser):
"""Return the list of ports shown in the relay table."""
functional.nav_to_module(browser, 'tor')
return [
port_name.text
for port_name in browser.find_by_css('.tor-relay-port-name')
]
def _assert_hidden_services(browser):
"""Assert that hidden service information is shown."""
functional.nav_to_module(browser, 'tor')
assert browser.find_by_css('.tor-hs .tor-hs-hostname')