mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
On user deletion, user's home folder is also deleted. Admins have an
option to avoid deleting user's home by inactivating the user instead.
This commit also removes user deletion buttons from the user's list
page and adds this option to the user edit page. The user's edit form
asks for a confirmation if the user deletion is requested. This change
also means that the confirmation password is now required to delete a user.
Also:
- Add a simple username validation to the privileged actions.
- Functional tests: Create a fixture to login as an admin before every test.
- Functional tests: Add a test to check that SSH passwordless login works
after user is renamed to validate correct SSH related path permissions.
- Privileged tests: Add `test_` prefix to the generated random string which
makes easier to check and cleanup created home folders.
- Minor quote fixes.
Tests performed in stable and testing containers:
- Run all the users module tests twice, no failures in tests.
- When user is the last admin, both "Active" and "Delete user"
checkboxes are disabled.
Closes #2451.
[sunil]
- Refactor the JS code:
- Ensure that DOM elements are lookup after DOM content is loaded.
- Styling changes. Reduce the number of globals, name the global names
somewhat more unique.
- Click the button instead of submitting the form to disable the button.
- Template changes:
- Add a body for the confirmation dialog to talk about disabling the user and
deleting the home directory.
- Change the label of the confirm button to make it more
explicit (recommendation from many UX guides).
- Styling.
- Functional tests:
- Fix visibility checking of an element to use the correct splinter API.
- Simplify clicking the edit user link.
- Minor update to form checkbox help text.
Signed-off-by: Veiko Aasa <veiko17@disroot.org>
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
793 lines
27 KiB
Python
793 lines
27 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""
|
|
Utilities for functional testing.
|
|
"""
|
|
|
|
import configparser
|
|
import logging
|
|
import os
|
|
import pathlib
|
|
import subprocess
|
|
import tempfile
|
|
import time
|
|
import warnings
|
|
from contextlib import contextmanager
|
|
|
|
import pytest
|
|
import requests
|
|
from selenium.common.exceptions import (ElementClickInterceptedException,
|
|
NoSuchElementException,
|
|
StaleElementReferenceException,
|
|
WebDriverException)
|
|
from selenium.webdriver.support.ui import WebDriverWait
|
|
|
|
config = configparser.ConfigParser()
|
|
config.read(pathlib.Path(__file__).with_name('config.ini'))
|
|
|
|
# Configuration to allow each pytest-xdist worker to hit a dedicated
|
|
# app server. See .ci/functional-tests.yml for usage.
|
|
worker = os.environ.get('PYTEST_XDIST_WORKER', 'master')
|
|
if worker == 'master':
|
|
config['DEFAULT']['url'] = os.environ.get(
|
|
'FREEDOMBOX_URL', config['DEFAULT']['url']).rstrip('/')
|
|
else:
|
|
# worker_ids are like gw0, gw1, ...
|
|
worker_number = int(worker.lstrip('gw')) + 1
|
|
config['DEFAULT']['url'] = os.environ[f'APP_SERVER_URL_{worker_number}']
|
|
|
|
config['DEFAULT']['ssh_port'] = os.environ.get('FREEDOMBOX_SSH_PORT',
|
|
config['DEFAULT']['ssh_port'])
|
|
config['DEFAULT']['samba_port'] = os.environ.get(
|
|
'FREEDOMBOX_SAMBA_PORT', config['DEFAULT']['samba_port'])
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
base_url = config['DEFAULT']['url']
|
|
|
|
# unlisted sites just use '/' + site_name as url
|
|
_site_url = {
|
|
'wiki': '/ikiwiki',
|
|
'jsxc': '/plinth/apps/jsxc/jsxc/',
|
|
'cockpit': '/_cockpit/',
|
|
'syncthing': '/syncthing/',
|
|
'rssbridge': '/rss-bridge/',
|
|
'ttrss': '/tt-rss/',
|
|
}
|
|
|
|
_sys_modules = [
|
|
'avahi', 'backups', 'bind', 'cockpit', 'config', 'datetime', 'diagnostics',
|
|
'dynamicdns', 'firewall', 'letsencrypt', 'names', 'networks', 'pagekite',
|
|
'performance', 'power', 'privacy', 'security', 'snapshot', 'ssh',
|
|
'storage', 'upgrades', 'users'
|
|
]
|
|
|
|
|
|
######################
|
|
# Browser Extensions #
|
|
######################
|
|
def visit(browser, path):
|
|
"""Visit a path assuming the base URL as configured."""
|
|
browser.visit(config['DEFAULT']['url'] + path)
|
|
|
|
|
|
def eventually(function, args=[], timeout=30):
|
|
"""Execute a function returning a boolean expression till it returns
|
|
True or a timeout is reached"""
|
|
end_time = time.time() + timeout
|
|
current_time = time.time()
|
|
while current_time < end_time:
|
|
try:
|
|
if function(*args):
|
|
return True
|
|
except Exception:
|
|
pass
|
|
|
|
time.sleep(0.1)
|
|
current_time = time.time()
|
|
|
|
return False
|
|
|
|
|
|
class _PageLoaded():
|
|
"""
|
|
Wait until a page (re)loaded.
|
|
|
|
- element: Wait until this element gets stale
|
|
- expected_url (optional): Wait for the URL to become <expected_url>.
|
|
This can be necessary to wait for a redirect to finish.
|
|
"""
|
|
|
|
def __init__(self, element, expected_url=None):
|
|
self.element = element
|
|
self.expected_url = expected_url
|
|
self.loaded_new_page = False
|
|
|
|
def __call__(self, driver):
|
|
is_stale = False
|
|
try:
|
|
self.element.has_class('whatever_class')
|
|
# XXX: There is still another unhandled case where the webserver
|
|
# restarts after submission of a form and the browser does not switch
|
|
# to error page. It continues to wait for a response from the server
|
|
# indefinitely until timeout.
|
|
except NoSuchElementException:
|
|
# This is still the old page, wait for it to change.
|
|
if not self.loaded_new_page:
|
|
return False
|
|
|
|
# This is the new page and we are not waiting for a specific URL.
|
|
# Stop waiting.
|
|
if not self.expected_url:
|
|
return True
|
|
|
|
# This is the new page and expected URL has not reached, wait for
|
|
# the page to spontaneously change.
|
|
if not driver.url.endswith(self.expected_url):
|
|
return False
|
|
|
|
# This is the new page and we have reached the expected URL. Stop
|
|
# waiting.
|
|
return True
|
|
except (StaleElementReferenceException, TypeError):
|
|
# After a domain name change, Let's Encrypt will restart the web
|
|
# server and could cause a connection failure.
|
|
if driver.find_by_id('netErrorButtonContainer'):
|
|
try:
|
|
driver.visit(driver.url)
|
|
# After this for some unknown reason,
|
|
# StaleElementReferenceException is no longer thrown.
|
|
self.loaded_new_page = True
|
|
except WebDriverException:
|
|
# Web server is not yet available.
|
|
pass
|
|
|
|
return False
|
|
|
|
is_fully_loaded = driver.execute_script(
|
|
'return document.readyState;') == 'complete'
|
|
if not is_fully_loaded:
|
|
is_stale = False
|
|
elif self.expected_url is None:
|
|
is_stale = True
|
|
else:
|
|
if driver.url.endswith(self.expected_url):
|
|
is_stale = True
|
|
|
|
return is_stale
|
|
|
|
|
|
@contextmanager
|
|
def wait_for_page_update(browser, timeout=300, expected_url=None):
|
|
page_body = browser.find_by_tag('body').first
|
|
try:
|
|
yield
|
|
except ElementClickInterceptedException:
|
|
# When a element that is not visible is clicked, the click is ignored
|
|
# and we can't expect a page update.
|
|
raise
|
|
except WebDriverException:
|
|
# ignore a connection failure which may happen after web server restart
|
|
pass
|
|
|
|
WebDriverWait(browser, timeout).until(_PageLoaded(page_body, expected_url))
|
|
|
|
|
|
def _get_site_url(site_name):
|
|
if site_name.startswith('share'):
|
|
site_name = site_name.replace('_', '/')
|
|
url = '/' + site_name
|
|
url = _site_url.get(site_name, url)
|
|
return url
|
|
|
|
|
|
def access_url(browser, site_name):
|
|
browser.visit(config['DEFAULT']['url'] + _get_site_url(site_name))
|
|
|
|
|
|
def get_password(username):
|
|
"""Get a user password."""
|
|
if username == config['DEFAULT']['username']:
|
|
return config['DEFAULT']['password']
|
|
return 'password@&123_{}'.format(username)
|
|
|
|
|
|
def is_available(browser, site_name):
|
|
"""Check if the given site_name is available."""
|
|
url_to_visit = config['DEFAULT']['url'] + _get_site_url(site_name)
|
|
browser.visit(url_to_visit)
|
|
time.sleep(3)
|
|
browser.reload()
|
|
if '404' in browser.title or 'Page not found' in browser.title:
|
|
return False
|
|
|
|
# The site might have a default path after the sitename,
|
|
# e.g /mediawiki/Main_Page
|
|
print('URL =', browser.url, url_to_visit, browser.title)
|
|
browser_url = browser.url.partition('://')[2]
|
|
url_to_visit_without_proto = url_to_visit.strip('/').partition('://')[2]
|
|
return browser_url.startswith(url_to_visit_without_proto) # not a redirect
|
|
|
|
|
|
def download_file(browser, url):
|
|
"""Return file contents after downloading a URL."""
|
|
cookies = browser.cookies.all()
|
|
response = requests.get(url, cookies=cookies, verify=False)
|
|
if response.status_code != 200:
|
|
raise Exception('URL download failed')
|
|
|
|
return response.content
|
|
|
|
|
|
def download_file_outside_browser(url):
|
|
"""Download a file to disk given a URL."""
|
|
with tempfile.NamedTemporaryFile(delete=False) as temp_file:
|
|
logging.captureWarnings(True)
|
|
request = requests.get(url, verify=False)
|
|
logging.captureWarnings(False)
|
|
temp_file.write(request.content)
|
|
|
|
return temp_file.name
|
|
|
|
|
|
###########################
|
|
# Form handling utilities #
|
|
###########################
|
|
def click(browser, element):
|
|
"""Click an element after scrolling it into view considering header."""
|
|
try:
|
|
element.click()
|
|
except ElementClickInterceptedException:
|
|
script = 'arguments[0].style.scrollMarginTop = "4.3125rem";' \
|
|
'arguments[0].scrollIntoView(true);'
|
|
browser.execute_script(script, element._element)
|
|
element.click()
|
|
|
|
|
|
def submit(browser, element=None, form_class=None, expected_url=None):
|
|
"""Submit a specific form in the current page and wait for page change."""
|
|
if not (element or form_class):
|
|
raise AssertionError('Either element or form_class must be sent')
|
|
|
|
with wait_for_page_update(browser, expected_url=expected_url):
|
|
if element:
|
|
click(browser, element)
|
|
elif form_class:
|
|
browser.find_by_css(f'.{form_class} input[type=submit], '
|
|
f'.{form_class} button[type=submit]').click()
|
|
else:
|
|
browser.find_by_css(
|
|
'input[type=submit] button[type=submit]').click()
|
|
|
|
|
|
def set_app_form_value(browser, app_id, element_id, value):
|
|
"""Change a value in the form and submit."""
|
|
nav_to_module(browser, app_id)
|
|
original_url = browser.url
|
|
browser.find_by_id(element_id).fill(value)
|
|
submit(browser, form_class='form-configuration')
|
|
# Check that there are no errors
|
|
assert browser.url == original_url
|
|
assert not browser.find_by_css('.alert-danger')
|
|
|
|
|
|
def change_checkbox_status(browser, app_name, checkbox_id,
|
|
change_status_to='enabled'):
|
|
"""Change checkbox status."""
|
|
checkbox = browser.find_by_id(checkbox_id)
|
|
if change_status_to == 'enabled':
|
|
checkbox.check()
|
|
else:
|
|
checkbox.uncheck()
|
|
|
|
submit(browser, form_class='form-configuration')
|
|
|
|
|
|
def wait_for_config_update(browser, app_name):
|
|
"""Wait until the configuration update progress goes away.
|
|
|
|
Perform an atomic check that page is fully loaded and that progress icon is
|
|
not present at the same time to avoid race conditions due to automatic page
|
|
reloads.
|
|
|
|
"""
|
|
script = 'return (document.readyState == "complete") && ' \
|
|
'(!Boolean(document.querySelector(".app-operation")));'
|
|
while not browser.execute_script(script):
|
|
time.sleep(0.1)
|
|
|
|
|
|
############################
|
|
# Login handling utilities #
|
|
############################
|
|
def is_login_prompt(browser):
|
|
return all(
|
|
[browser.find_by_id('id_username'),
|
|
browser.find_by_id('id_password')])
|
|
|
|
|
|
def _create_admin_account(browser, username, password):
|
|
browser.find_by_id('id_username').fill(username)
|
|
browser.find_by_id('id_password1').fill(password)
|
|
browser.find_by_id('id_password2').fill(password)
|
|
submit(browser, form_class='form-create')
|
|
|
|
|
|
def login(browser):
|
|
"""Login to the FreedomBox interface with default test account."""
|
|
login_with_account(browser, base_url, config['DEFAULT']['username'],
|
|
config['DEFAULT']['password'])
|
|
|
|
|
|
def login_with_account(browser, url, username, password=None):
|
|
"""Login to the FreedomBox interface with provided account."""
|
|
if password is None:
|
|
password = get_password(username)
|
|
# XXX: Find a way to remove the hardcoded jsxc URL
|
|
if '/plinth/' not in browser.url or '/jsxc/jsxc' in browser.url:
|
|
browser.visit(url)
|
|
|
|
user_menu = browser.find_by_id('id_user_menu')
|
|
|
|
if len(user_menu):
|
|
if user_menu.text == username:
|
|
return
|
|
|
|
logout(browser)
|
|
|
|
login_button = browser.links.find_by_href('/plinth/accounts/login/')
|
|
if login_button:
|
|
login_button.first.click()
|
|
if login_button:
|
|
browser.fill('username', username)
|
|
browser.fill('password', password)
|
|
submit(browser, form_class='form-login')
|
|
else:
|
|
browser.visit(base_url + '/plinth/firstboot/welcome')
|
|
submit(browser, form_class='form-start') # "Start Setup" button
|
|
_create_admin_account(browser, username, password)
|
|
if '/firstboot/backports' in browser.url:
|
|
submit(browser, element=browser.find_by_name('next')[0])
|
|
|
|
|
|
def logout(browser):
|
|
"""Log out of the FreedomBox interface."""
|
|
# Navigate to the home page if logout form is not found
|
|
if not browser.find_by_css('.form-logout'):
|
|
visit(browser, '/plinth/')
|
|
|
|
# We are not logged in if the home page does not contain logout form
|
|
if browser.find_by_css('.form-logout'):
|
|
browser.find_by_id('id_user_menu').click()
|
|
submit(browser, form_class='form-logout')
|
|
|
|
|
|
#################
|
|
# App utilities #
|
|
#################
|
|
def nav_to_module(browser, module):
|
|
sys_or_apps = 'sys' if module in _sys_modules else 'apps'
|
|
required_url = base_url + f'/plinth/{sys_or_apps}/{module}/'
|
|
if browser.url != required_url:
|
|
browser.visit(required_url)
|
|
|
|
|
|
def app_select_domain_name(browser, app_name, domain_name):
|
|
browser.visit('{}/plinth/apps/{}/setup/'.format(base_url, app_name))
|
|
drop_down = browser.find_by_id('id_domain_name')
|
|
drop_down.select(domain_name)
|
|
submit(browser, form_class='form-configuration')
|
|
|
|
|
|
#########################
|
|
# App install utilities #
|
|
#########################
|
|
def is_installed(browser, app_name):
|
|
nav_to_module(browser, app_name)
|
|
return not bool(browser.find_by_css('.form-install input[type=submit]'))
|
|
|
|
|
|
def install(browser, app_name):
|
|
nav_to_module(browser, app_name)
|
|
install_button_css = '.form-install input[type=submit]'
|
|
while True:
|
|
script = 'return (document.readyState == "complete") && ' \
|
|
'(!Boolean(document.querySelector(".app-operation"))) &&' \
|
|
'(!Boolean(document.querySelector(".app-just-installed")));'
|
|
if not browser.execute_script(script):
|
|
time.sleep(0.1)
|
|
elif browser.is_element_present_by_css('.neterror'):
|
|
browser.visit(browser.url)
|
|
elif browser.is_element_present_by_css('.alert-danger'):
|
|
break
|
|
elif browser.is_element_present_by_css(install_button_css):
|
|
install_button = browser.find_by_css(install_button_css).first
|
|
if install_button['disabled']:
|
|
# This app is not available in this distribution
|
|
warnings.warn(
|
|
f'App {app_name} is not available in distribution')
|
|
pytest.skip('App not available in distribution')
|
|
else:
|
|
install_button.click()
|
|
else:
|
|
break
|
|
|
|
|
|
def uninstall(browser, app_name):
|
|
"""Uninstall the app if possible."""
|
|
nav_to_module(browser, app_name)
|
|
actions_button = browser.find_by_id('id_extra_actions_button')
|
|
if not actions_button:
|
|
pytest.skip('App cannot be uninstalled')
|
|
|
|
actions_button.click()
|
|
uninstall_item = browser.find_by_css('.uninstall-item')
|
|
if not uninstall_item:
|
|
pytest.skip('App cannot be uninstalled')
|
|
|
|
uninstall_item[0].click()
|
|
submit(browser, form_class='form-uninstall')
|
|
|
|
while True:
|
|
script = 'return (document.readyState == "complete") && ' \
|
|
'(!Boolean(document.querySelector(".app-operation")));'
|
|
if not browser.execute_script(script):
|
|
time.sleep(0.1)
|
|
elif browser.is_element_present_by_css('.neterror'):
|
|
browser.visit(browser.url)
|
|
elif browser.is_element_present_by_css('.alert-danger'):
|
|
raise RuntimeError('Uninstall failed')
|
|
else:
|
|
break
|
|
|
|
|
|
################################
|
|
# App enable/disable utilities #
|
|
################################
|
|
def _change_app_status(browser, app_name, change_status_to='enabled'):
|
|
"""Enable or disable application."""
|
|
button = browser.find_by_css('button[name="app_enable_disable_button"]')
|
|
if not button:
|
|
raise RuntimeError('App enable/disable button not found')
|
|
|
|
should_enable_field = browser.find_by_id('id_should_enable')
|
|
if (should_enable_field.value == 'False' and change_status_to
|
|
== 'disabled') or (should_enable_field.value == 'True'
|
|
and change_status_to == 'enabled'):
|
|
submit(browser, element=button)
|
|
|
|
|
|
def app_enable(browser, app_name):
|
|
nav_to_module(browser, app_name)
|
|
_change_app_status(browser, app_name, 'enabled')
|
|
|
|
|
|
def app_disable(browser, app_name):
|
|
nav_to_module(browser, app_name)
|
|
_change_app_status(browser, app_name, 'disabled')
|
|
|
|
|
|
def app_is_enabled(browser, app_name):
|
|
"""Return whether the app is enabled."""
|
|
nav_to_module(browser, app_name)
|
|
should_enable_field = browser.find_by_id('id_should_enable')
|
|
return should_enable_field.value == 'False'
|
|
|
|
|
|
def app_can_be_disabled(browser, app_name):
|
|
"""Return whether the application can be disabled."""
|
|
nav_to_module(browser, app_name)
|
|
button = browser.find_by_css('button[name="app_enable_disable_button"]')
|
|
return bool(button)
|
|
|
|
|
|
########################
|
|
# Front page utilities #
|
|
########################
|
|
def find_on_front_page(browser, app_name):
|
|
browser.visit(base_url)
|
|
shortcuts = browser.links.find_by_href(f'/{app_name}/')
|
|
return shortcuts
|
|
|
|
|
|
def is_visible_on_front_page(browser, app_name):
|
|
shortcuts = find_on_front_page(browser, app_name)
|
|
return len(shortcuts) == 1
|
|
|
|
|
|
####################
|
|
# Daemon utilities #
|
|
####################
|
|
def service_is_running(browser, app_name):
|
|
nav_to_module(browser, app_name)
|
|
return len(browser.find_by_id('service-not-running')) == 0
|
|
|
|
|
|
def service_is_not_running(browser, app_name):
|
|
nav_to_module(browser, app_name)
|
|
return len(browser.find_by_id('service-not-running')) != 0
|
|
|
|
|
|
def running_inside_container():
|
|
"""Check if freedombox is running inside a container"""
|
|
# If the URL to connect to was overridden then assume that we are running
|
|
# tests on a different machine than the machine running freedombox. Assume
|
|
# running inside container to be conservative about tests.
|
|
if config['DEFAULT']['url'] != 'https://localhost':
|
|
return True
|
|
|
|
# If URL is not overridden then testing code and freedombox are running on
|
|
# the same machine. Proceed with a proper test.
|
|
result = subprocess.run(['systemd-detect-virt', '--container'],
|
|
stdout=subprocess.PIPE, check=False)
|
|
return result.stdout.decode('utf-8').strip().lower() != 'none'
|
|
|
|
|
|
#############################
|
|
# System -> Names utilities #
|
|
#############################
|
|
def set_hostname(browser, hostname):
|
|
visit(browser, '/plinth/sys/names/hostname/')
|
|
browser.find_by_id('id_hostname-hostname').fill(hostname)
|
|
submit(browser, form_class='form-hostname')
|
|
|
|
|
|
def set_domain_name(browser, domain_name):
|
|
visit(browser, '/plinth/sys/names/domains/')
|
|
browser.find_by_id('id_domain-name-domain_name').fill(domain_name)
|
|
submit(browser, form_class='form-domain-name')
|
|
|
|
|
|
##############################
|
|
# System -> Config utilities #
|
|
##############################
|
|
def set_advanced_mode(browser, mode):
|
|
nav_to_module(browser, 'config')
|
|
advanced_mode = browser.find_by_id('id_advanced_mode')
|
|
if mode:
|
|
advanced_mode.check()
|
|
else:
|
|
advanced_mode.uncheck()
|
|
|
|
submit(browser, form_class='form-configuration')
|
|
|
|
|
|
####################
|
|
# Backup utilities #
|
|
####################
|
|
def _click_button_and_confirm(browser, href, form_class):
|
|
buttons = browser.links.find_by_href(href)
|
|
if buttons:
|
|
submit(browser, element=buttons.first)
|
|
submit(browser, form_class=form_class,
|
|
expected_url='/plinth/sys/backups/')
|
|
|
|
|
|
def _backup_delete_archive_by_name(browser, archive_name):
|
|
nav_to_module(browser, 'backups')
|
|
href = f'/plinth/sys/backups/root/delete/{archive_name}/'
|
|
_click_button_and_confirm(browser, href, 'form-delete')
|
|
|
|
|
|
def backup_create(browser, app_name, archive_name=None):
|
|
"""Create a new backup for a given app."""
|
|
install(browser, 'backups')
|
|
if archive_name:
|
|
_backup_delete_archive_by_name(browser, archive_name)
|
|
|
|
buttons = browser.links.find_by_href('/plinth/sys/backups/create/')
|
|
submit(browser, element=buttons.first)
|
|
eventually(browser.find_by_css, args=['.select-all'])
|
|
browser.find_by_css('.select-all').first.uncheck()
|
|
if archive_name:
|
|
browser.find_by_id('id_backups-name').fill(archive_name)
|
|
|
|
# ensure the checkbox is scrolled into view
|
|
browser.execute_script('window.scrollTo(0, 0)')
|
|
browser.find_by_value(app_name).first.check()
|
|
submit(browser, form_class='form-backups')
|
|
|
|
|
|
def backup_restore(browser, app_name, archive_name=None):
|
|
"""Restore a given app from a backup archive."""
|
|
nav_to_module(browser, 'backups')
|
|
href = f'/plinth/sys/backups/root/restore-archive/{archive_name}/'
|
|
_click_button_and_confirm(browser, href, 'form-restore')
|
|
|
|
|
|
######################
|
|
# Networks utilities #
|
|
######################
|
|
def networks_set_firewall_zone(browser, zone):
|
|
""""Set the network device firewall zone as internal or external."""
|
|
nav_to_module(browser, 'networks')
|
|
# First active Ethernet connection
|
|
device = browser.find_by_xpath(
|
|
'//span[contains(@class, "connection-type-label") and '
|
|
'contains(., "Ethernet") ]/../..'
|
|
'//span[contains(@class, "badge-success") '
|
|
'and contains(@class, "connection-status-label")]/following::a').first
|
|
network_id = device['href'].split('/')[-3]
|
|
device.click()
|
|
edit_url = '/plinth/sys/networks/{}/edit/'.format(network_id)
|
|
browser.links.find_by_href(edit_url).first.click()
|
|
browser.select('zone', zone)
|
|
submit(browser, form_class='form-connection-edit')
|
|
|
|
|
|
##################
|
|
# Bind utilities #
|
|
##################
|
|
def set_forwarders(browser, forwarders):
|
|
"""Set the forwarders list (space separated) in bind configuration."""
|
|
nav_to_module(browser, 'bind')
|
|
browser.fill('forwarders', forwarders)
|
|
submit(browser, form_class='form-configuration')
|
|
|
|
|
|
def get_forwarders(browser):
|
|
"""Return the forwarders list (space separated) in bind configuration."""
|
|
nav_to_module(browser, 'bind')
|
|
return browser.find_by_name('forwarders').first.value
|
|
|
|
|
|
##############################
|
|
# Users and Groups utilities #
|
|
##############################
|
|
|
|
|
|
def create_user(browser, name, password=None, groups=[], email=None):
|
|
"""Create a user with password and user groups."""
|
|
nav_to_module(browser, 'users')
|
|
|
|
if password is None:
|
|
password = get_password(name)
|
|
|
|
with wait_for_page_update(browser):
|
|
browser.links.find_by_href('/plinth/sys/users/create/').first.click()
|
|
|
|
browser.find_by_id('id_username').fill(name)
|
|
browser.find_by_id('id_password1').fill(password)
|
|
browser.find_by_id('id_password2').fill(password)
|
|
if email:
|
|
browser.find_by_id('id_email').fill(email)
|
|
|
|
for group in groups:
|
|
browser.find_by_xpath(
|
|
f'//label[contains(text(), "({group})")]/input').check()
|
|
|
|
browser.find_by_id('id_confirm_password').fill(
|
|
config['DEFAULT']['password'])
|
|
|
|
submit(browser, form_class='form-create')
|
|
|
|
|
|
def delete_user(browser, name):
|
|
"""Delete a user."""
|
|
nav_to_module(browser, 'users')
|
|
browser.links.find_by_href(f'/plinth/sys/users/{name}/edit/').first.click()
|
|
|
|
browser.find_by_id('id_delete').check()
|
|
browser.find_by_id('id_confirm_password').fill(
|
|
config['DEFAULT']['password'])
|
|
|
|
browser.find_by_css('.form-update input[type=submit]').first.click()
|
|
|
|
confirm_button = browser.find_by_css(
|
|
'#user-delete-confirm-dialog button.confirm').first
|
|
eventually(lambda: confirm_button.visible)
|
|
assert confirm_button.visible
|
|
with wait_for_page_update(browser, expected_url='/plinth/sys/users/'):
|
|
confirm_button.click()
|
|
|
|
|
|
def user_exists(browser, name):
|
|
"""Check if a user with a given name exists."""
|
|
nav_to_module(browser, 'users')
|
|
links = browser.links.find_by_href(f'/plinth/sys/users/{name}/edit/')
|
|
return len(links) == 1
|
|
|
|
|
|
def user_set_language(browser, language_code):
|
|
"""Change user's preferred UI language."""
|
|
username = config['DEFAULT']['username']
|
|
admin_password = config['DEFAULT']['password']
|
|
visit(browser, '/plinth/sys/users/{}/edit/'.format(username))
|
|
browser.find_by_xpath('//select[@id="id_language"]//option[@value="' +
|
|
language_code + '"]').first.click()
|
|
browser.find_by_id('id_confirm_password').fill(admin_password)
|
|
submit(browser, form_class='form-update')
|
|
|
|
|
|
class BaseAppTests:
|
|
"""Base class for common functional tests.
|
|
|
|
To run these tests on an app, the app should subclass this class with a
|
|
class name starting with 'Test'. This allows the app tests to be
|
|
automatically discovered while the base class tests to stay undiscovered.
|
|
Tests will apply to the app without the need not override each test.
|
|
"""
|
|
|
|
app_name = ''
|
|
# TODO: Check the components of the app instead of configuring here.
|
|
has_service = False
|
|
has_web = True
|
|
can_uninstall = True
|
|
check_diagnostics = True
|
|
diagnostics_delay = 0
|
|
disable_after_tests = True
|
|
|
|
def assert_app_running(self, session_browser):
|
|
"""Assert that the app is running."""
|
|
if self.has_service:
|
|
assert service_is_running(session_browser, self.app_name)
|
|
|
|
if self.has_web:
|
|
assert is_available(session_browser, self.app_name)
|
|
|
|
def assert_app_not_running(self, session_browser):
|
|
"""Assert that the app is not running."""
|
|
if self.has_service:
|
|
assert service_is_not_running(session_browser, self.app_name)
|
|
|
|
if self.has_web:
|
|
assert not is_available(session_browser, self.app_name)
|
|
|
|
def install_and_setup(self, session_browser):
|
|
"""Install the app and set it up if needed."""
|
|
install(session_browser, self.app_name)
|
|
|
|
@pytest.fixture(autouse=True, name='background')
|
|
def fixture_background(self, session_browser):
|
|
"""Login, install, and enable the app."""
|
|
login(session_browser)
|
|
self.install_and_setup(session_browser)
|
|
app_enable(session_browser, self.app_name)
|
|
yield
|
|
login(session_browser)
|
|
if self.disable_after_tests:
|
|
app_disable(session_browser, self.app_name)
|
|
|
|
def test_enable_disable(self, session_browser):
|
|
"""Test enabling and disabling the app."""
|
|
app_disable(session_browser, self.app_name)
|
|
self.assert_app_not_running(session_browser)
|
|
|
|
app_enable(session_browser, self.app_name)
|
|
self.assert_app_running(session_browser)
|
|
|
|
def test_run_diagnostics(self, session_browser):
|
|
"""Test that all app diagnostics are passing."""
|
|
if not self.check_diagnostics:
|
|
pytest.skip(f'Skipping diagnostics check for {self.app_name}.')
|
|
|
|
time.sleep(self.diagnostics_delay)
|
|
session_browser.find_by_id('id_extra_actions_button').click()
|
|
submit(session_browser, form_class='form-diagnostics-button')
|
|
|
|
warning_results = session_browser.find_by_css('.badge-warning')
|
|
if warning_results:
|
|
warnings.warn(
|
|
f'Diagnostics warnings for {self.app_name}: {warning_results}')
|
|
|
|
failure_results = session_browser.find_by_css('.badge-danger')
|
|
assert not failure_results
|
|
|
|
@pytest.mark.backups
|
|
def test_backup_restore(self, session_browser):
|
|
"""Test that backup and restore operations work on the app."""
|
|
backup_create(session_browser, self.app_name, 'test_' + self.app_name)
|
|
if self.can_uninstall:
|
|
uninstall(session_browser, self.app_name)
|
|
|
|
backup_restore(session_browser, self.app_name, 'test_' + self.app_name)
|
|
self.assert_app_running(session_browser)
|
|
|
|
def test_uninstall(self, session_browser):
|
|
"""Test that app can be uninstalled and installed back again."""
|
|
if not self.can_uninstall:
|
|
pytest.skip(f'Skipping uninstall test for {self.app_name}.')
|
|
|
|
uninstall(session_browser, self.app_name)
|
|
assert not is_installed(session_browser, self.app_name)
|
|
self.install_and_setup(session_browser)
|