univention.testing package

univention.testing package#

Subpackages#

Submodules#

univention.testing.active_directory module#

Library for AD/Samba connections.

Includes objects and functionality for: * Users * Shares * Domain password settings

The library uses the CLI tools samba-tool and smbclient as backend.

exception univention.testing.active_directory.ActiveDirectoryException[source]#: Bases: Exception

exception univention.testing.active_directory.SambaToolException[source]#: Bases: ActiveDirectoryException

exception univention.testing.active_directory.SmbClientException[source]#: Bases: ActiveDirectoryException

exception univention.testing.active_directory.LogonFailureException[source]#: Bases: ActiveDirectoryException

exception univention.testing.active_directory.AccountLockedOutException[source]#: Bases: ActiveDirectoryException

exception univention.testing.active_directory.NotLockedOutException[source]#: Bases: ActiveDirectoryException

class univention.testing.active_directory.ActiveDirectorySettings(*, host: str | None = None, admin_username: str | None = None, admin_password: str | None = None, is_local_connect: bool = False)[source]#

Bases: BaseModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

host: str | None#

admin_username: str | None#

admin_password: str | None#

is_local_connect: bool#

class univention.testing.active_directory.DomainPasswordsettingsData(*, password_complexity: str | None = None, store_plaintext_passwords: str | None = None, password_history_length: int | None = None, minimum_password_length: int | None = None, minimum_password_age: int | None = None, maximum_password_age: int | None = None, account_lockout_duration: int | None = None, account_lockout_threshold: int | None = None, reset_account_lockout_after: int | None = None)[source]#

Bases: BaseModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

password_complexity: str | None#

store_plaintext_passwords: str | None#

password_history_length: int | None#

minimum_password_length: int | None#

minimum_password_age: int | None#

maximum_password_age: int | None#

account_lockout_duration: int | None#

account_lockout_threshold: int | None#

reset_account_lockout_after: int | None#

class univention.testing.active_directory.SharesData(*, share_name: str | None = None, type: str | None = None, comment: str | None = None)[source]#

Bases: BaseModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

share_name: str | None#

type: str | None#

comment: str | None#

Bases: BaseModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

dn: str | None#

name: str | None#

password: str | None#

bad_pwd_count: int | None#

bad_password_time: int | None#

lockout_time: int | None#

class univention.testing.active_directory.ActiveDirectory(settings: ActiveDirectorySettings)[source]#

Bases: object

parse_text(pattern: str, text: str, result_type: type[int | str], default: int | str | None = None) → int | str | None[source]#

class univention.testing.active_directory.SambaTool(settings: ActiveDirectorySettings)[source]#

Bases: ActiveDirectory

Abstract base class for samba tool calls.

execute(arguments: list[str]) → str[source]#

class univention.testing.active_directory.SmbClient(settings: ActiveDirectorySettings)[source]#

Bases: ActiveDirectory

Abstract base class for SMB client calls.

execute(arguments: list[str]) → str[source]#

class univention.testing.active_directory.DomainPasswordSettings(settings: ActiveDirectorySettings)[source]#

Bases: SambaTool

get() → DomainPasswordsettingsData[source]#

set(domain_passwordsettings: DomainPasswordsettingsData)[source]#

class univention.testing.active_directory.User(settings: ActiveDirectorySettings)[source]#

Bases: SambaTool

create(username: str, password: str, use_username_as_cn: bool = True) → UserData[source]#

delete(username: str)[source]#

unlock(username: str)[source]#

get(username: str) → UserData[source]#

set_password(username: str, password: str)[source]#

class univention.testing.active_directory.Shares(settings: ActiveDirectorySettings)[source]#

Bases: SmbClient

list(username: str, password) → list[SharesData][source]#

univention.testing.apptest module#

univention.testing.apptest.run_test_file(fname: str) → None[source]#

univention.testing.apptest.pip_modules(modules: list[str]) → Iterator[None][source]#

univention.testing.apptest.xserver() → Iterator[str][source]#

univention.testing.apptest.ffmpeg_start(capture_video: str, display: str) → int[source]#

univention.testing.apptest.ffmpeg_stop(pid: int) → None[source]#

univention.testing.apptest.is_local() → bool[source]#

class univention.testing.apptest.Session(display_num: str, base_url: str, screenshot_path: str, driver)[source]#

Bases: object

add_ucs_root_ca_to_chrome_cert_store() → None[source]#

capture(name: str) → Iterator[None][source]#

wait_until_clickable(css: str) → None[source]#

wait_until_clickable_and_click(css: str) → None[source]#

wait_until_gone(css: str) → None[source]#

goto_portal() → None[source]#

portal_login(username: str, password: str) → None[source]#

click_portal_tile(name: str) → None[source]#

switched_frame(css: str) → Iterator[None][source]#

get(url: str) → None[source]#

get_current_url() → str[source]#

reload() → None[source]#

find_all(css: str) → list[source]#

find_all_below(element, css: str) → list[source]#

find_first(css: str)[source]#

assert_one(css: str)[source]#

assert_one_below(element, css)[source]#

click_element(css: str) → None[source]#

click_element_below(element, css: str) → None[source]#

change_tab(idx: int) → None[source]#

close_tab() → None[source]#

enter_input(input_name: str, value: str) → None[source]#

enter_input_element(css: str, value: str) → None[source]#

enter_return(css: str | None = None) → None[source]#

enter_shift_tab() → None[source]#

enter_tab() → None[source]#

drag_and_drop(source, target) → None[source]#

send_keys(keys) → None[source]#

save_screenshot(name: str) → str[source]#

classmethod chrome(display_num: str, base_url: str, screenshot_path: str) → Self[source]#

classmethod running_chrome(base_url: str, screenshot_path: str) → Iterator[Self][source]#

univention.testing.apptest.config() → dict[str, str][source]#: Test wide Configuration aka UCR Used to get some defaults if not environment variables are given. But if UCR is not avaiable, returns an empty dict…

univention.testing.apptest.hostname(config) → str | None[source]#: Hostname to test against

univention.testing.apptest.fqdn(config) → str[source]#: fqdn to test against

univention.testing.apptest.admin_username(config) → str[source]#: Username of the Admin account

univention.testing.apptest.admin_password(config) → str[source]#: Password of the Admin account

univention.testing.apptest.umc(hostname: str, admin_username: str, admin_password: str)[source]#

univention.testing.apptest.ucs_call(fqdn: str) → Callable[[Sequence[str]], None][source]#

univention.testing.apptest.ucr(umc)[source]#

univention.testing.apptest.ucr_module()[source]#: Per module auto-reverting UCR instance.

univention.testing.apptest.appcenter(umc, fqdn)[source]#

univention.testing.apptest.udm(hostname: str, config, admin_username: str, admin_password: str)[source]#: A UDM instance (REST client)

univention.testing.apptest.users(udm) → Iterator[source]#

univention.testing.apptest.new_user(users)[source]#: Creates a new user and cleans up

univention.testing.apptest.db_conn()[source]#: A database connection object (sqlalchemy)

univention.testing.apptest.selenium_base_url(hostname: str) → str[source]#: Base URL for selenium

univention.testing.apptest.selenium_screenshot_path() → str[source]#: Path where selenium should save screenshots

univention.testing.apptest.test_logger() → Logger[source]#: Our logger instance so you can print some info for pytest

univention.testing.apptest.chrome(selenium_base_url: str, selenium_screenshot_path: str) → Iterator[source]#: A running chrome instance, controllable by selenium

univention.testing.codes module#

Public interface for test resultes.

class univention.testing.codes.Reason(value)[source]#

Bases: Enum

UNKNOWN = (-1, 'E', 'Test failed', 'RED')#

SKIP = (77, 'S', 'Test skipped', 'BLUE')#

OKAY = (100, 'O', 'Test passed', 'GREEN')#

FIXED_EXPECTED = (101, 'O', 'Test passed', 'GREEN')#

FIXED_UNEXPECTED = (102, 'O', 'Test passed', 'GREEN')#

FAIL = (110, 'F', 'Test failed', 'RED')#

FAIL_UNEXPECTED = (111, 'F', 'Test failed', 'RED')#

FAIL_TRANSIENT = (120, 'F', 'Test failed', 'RED')#

FAIL_EXPECTED = (121, 'F', 'Test failed', 'RED')#

UNAVAILABLE = (122, 'E', 'Test failed', 'RED')#

IMMATURE = (130, 'S', 'Test failed', 'RED')#

VERSION_MISMATCH = (131, 'S', 'Test skipped (wrong version)', 'BLUE')#

VERSION_TOO_OLD = (132, 'S', 'Test skipped (version too old)', 'BLUE')#

VERSION_TOO_NEW = (133, 'S', 'Test skipped (version too new)', 'BLUE')#

ROLE_MISMATCH = (134, 'S', 'Test skipped (role mismatch)', 'BLUE')#

JOIN = (135, 'S', 'Test skipped (system not joined)', 'BLUE')#

JOINED = (136, 'S', 'Test skipped (system is joined)', 'BLUE')#

INSTALL = (137, 'S', 'Test skipped (missing software)', 'BLUE')#

INSTALLED = (138, 'S', 'Test skipped (conflicting software)', 'BLUE')#

DANGER = (139, 'S', 'Test skipped (too dangerous)', 'BLUE')#

INTERNAL = (140, 'E', 'Test failed', 'RED')#

ABORT = (141, 'S', 'Test aborted', 'RED')#

APP_MISMATCH = (142, 'S', 'Test skipped (app mismatch)', 'BLUE')#

property eofs: str#

property color#

classmethod lookup(code: int) → Self[source]#

univention.testing.conftest module#

conftest plugin for pytest runner in ucs-test

univention.testing.conftest.pytest_addoption(parser: Parser) → None[source]#

univention.testing.conftest.pytest_configure(config: Config) → None[source]#

univention.testing.conftest.pytest_runtest_setup(item: Item) → None[source]#

univention.testing.conftest.check_tags(item: Item) → None[source]#

univention.testing.conftest.check_roles(item: Item) → None[source]#

univention.testing.conftest.check_exposure(item: Item) → None[source]#

univention.testing.conftest.locale_available(*locales: str) → Callable[[Callable[[...], _RT]], Callable[[...], _RT]][source]#

univention.testing.connector_common module#

univention.testing.connector_common.random_string(length: int = 10, alpha: bool = False, numeric: bool = False, charset: str = '', encoding: str = 'utf-8') → str[source]#

univention.testing.connector_common.random_bytestring(length: int = 10, alpha: bool = False, numeric: bool = False, charset: str = '') → bytes[source]#

univention.testing.connector_common.normalize_dn(dn: str) → str[source]#

Normalize a given dn. This removes some escaping of special chars in the DNs. Note: The CON-LDAP returns DNs with escaping chars, OpenLDAP does not.

>>> normalize_dn(r"cn=peter\#,cn=groups")
'cn=peter#,cn=groups'

univention.testing.connector_common.to_unicode(string: bytes | str) → str[source]#

univention.testing.connector_common.restart_univention_cli_server() → None[source]#

class univention.testing.connector_common.TestUser(user, rename={}, container=None, selection=None)[source]#

Bases: object

classmethod to_unicode(dictionary)[source]#

class univention.testing.connector_common.NormalUser(selection=None)[source]#: Bases: TestUser

class univention.testing.connector_common.Utf8User(selection=None)[source]#: Bases: TestUser

class univention.testing.connector_common.SpecialUser(selection=None)[source]#: Bases: TestUser

class univention.testing.connector_common.TestGroup(group, rename={}, container=None)[source]#

Bases: object

classmethod to_unicode(dictionary)[source]#

class univention.testing.connector_common.NormalGroup[source]#: Bases: TestGroup

class univention.testing.connector_common.Utf8Group[source]#: Bases: TestGroup

class univention.testing.connector_common.SpecialGroup[source]#: Bases: TestGroup

class univention.testing.connector_common.TestObject(obj, rename={}, container=None)[source]#

Bases: object

classmethod to_unicode(dictionary)[source]#

class univention.testing.connector_common.NormalWindows[source]#: Bases: TestObject

class univention.testing.connector_common.NormalContainer[source]#: Bases: TestObject

class univention.testing.connector_common.NormalOU[source]#: Bases: TestObject

univention.testing.connector_common.map_udm_user_to_con(user)[source]#: Map a UDM user given as a dictionary of property:values mappings to a dictionary of attributes:values mappings as required by the CON-LDAP. Note: This expects the properties from the UDM users/user module and not OpenLDAP-attributes!.

univention.testing.connector_common.map_udm_group_to_con(group)[source]#: Map a UDM group given as a dictionary of property:values mappings to a dictionary of attributes:values mappings as required by the CON-LDAP. Note: This expects the properties from the UDM groups/group module and not OpenLDAP-attributes!.

univention.testing.connector_common.map_udm_windows_to_con(windows)[source]#: Map a UDM computers/windows given as a dictionary of property:values mappings to a dictionary of attributes:values mappings as required by the CON-LDAP. Note: This expects the properties from the UDM computers/windows module and not OpenLDAP-attributes!.

univention.testing.connector_common.map_udm_container_to_con(container)[source]#: Map a UDM container/* given as a dictionary of property:values mappings to a dictionary of attributes:values mappings as required by the CON-LDAP. Note: This expects the properties from the UDM container/* module and not OpenLDAP-attributes!.

univention.testing.connector_common.map_udm_ou_to_con(container)[source]#: Map a UDM container/* given as a dictionary of property:values mappings to a dictionary of attributes:values mappings as required by the CON-LDAP. Note: This expects the properties from the UDM container/* module and not OpenLDAP-attributes!.

univention.testing.connector_common.create_udm_user(udm, con, user, wait_for_sync, verify=True)[source]#

univention.testing.connector_common.delete_udm_user(udm, con, udm_user_dn, con_user_dn, wait_for_sync)[source]#

univention.testing.connector_common.create_con_user(con, udm_user, wait_for_sync, basic_con_user=None)[source]#

univention.testing.connector_common.delete_con_user(con, con_user_dn, udm_user_dn, wait_for_sync)[source]#

univention.testing.connector_common.create_udm_group(udm, con, group, wait_for_sync)[source]#

univention.testing.connector_common.delete_udm_group(udm, con, udm_group_dn, con_group_dn, wait_for_sync)[source]#

univention.testing.connector_common.create_con_group(con, udm_group, wait_for_sync)[source]#

univention.testing.connector_common.delete_con_group(con, con_group_dn, udm_group_dn, wait_for_sync)[source]#

univention.testing.coverage module#

Code coverage measurement for ucs-test

exception univention.testing.coverage.MissingCoverage[source]#: Bases: Exception

class univention.testing.coverage.Coverage(options: Namespace)[source]#

Bases: object

COVERAGE_PTH = '/usr/lib/python3/dist-packages/ucstest-coverage.pth'#

COVERAGE_PTH_CONTENT = 'import univention.testing.coverage; univention.testing.coverage.Coverage.startup()'#

COVERAGE_DEBUG_PATH = '/tmp/ucs-test-coverage'#

coverage = None#

COVERAGE_DEBUG = False#

start() → None[source]#: Start measuring of coverage. Only called by ucs-test-framework once. Sets up the configuration.

write_config_file() → None[source]#: Write a Python .pth file which is invoked before any Python process

restart_python_services() → None[source]#: Restart currently running Python services, so that they start/stop measuring code

stop() → None[source]#: Stop coverage measuring. Only called by ucs-test-framework once. Stores the results.

classmethod get_argument_group(parser: ArgumentParser) → _ArgumentGroup[source]#: The option group for ucs-test-framework

classmethod is_candidate(argv: list[str]) → bool[source]#

classmethod startup() → None[source]#: Startup function which is invoked by every(!) Python process during coverage measurement. If the process is relevant we start measuring coverage.

classmethod stop_measurement(start: bool = False) → None[source]#

classmethod debug_message(*messages: Any) → None[source]#

class univention.testing.coverage.StopCoverageDecorator(method: Callable[[...], Any])[source]#

Bases: object

inDecorator = False#

univention.testing.data module#

Test case, environment, result and related classes.

class univention.testing.data.TestCase(filename: str)[source]#

Bases: object

Test case.

logger = <Logger test.case (DEBUG)>#

RE_NL = re.compile(b'[\\r\\n]+')#

load() → Self[source]#: Load test case from stream.

load_meta() → dict[str, Any][source]#

parse_meta(header: dict[str, Any]) → None[source]#

check(environment: TestEnvironment) → list[Verdict][source]#: Check if the test case should run.

pytest_check(environment: TestEnvironment) → list[str][source]#

run(result: TestResult) → None[source]#: Run the test case and fill in result.

class univention.testing.data.TestEnvironment(interactive: bool = True, logfile: str | None = None)[source]#

Bases: object

Test environment for running test cases.

Handels system data, requirements checks, test output.

logger = <Logger test.env (DEBUG)>#

property local_apps: list[str]#: Lazy load locally installed apps.

dump(stream: ~typing.IO[str] = <colorama.ansitowin32.StreamWrapper object>) → None[source]#: Dump environment information.

tag(require: set[str] = {}, ignore: set[str] = {}, prohibit: set[str] = {}) → None[source]#: Update required, ignored, prohibited tags.

set_exposure(exposure: str) → None[source]#: Set maximum allowed exposure level.

set_timeout(timeout: int) → None[source]#: Set maximum allowed time for single test.

class univention.testing.data.TestFormatInterface(stream: ~typing.IO[str] = <colorama.ansitowin32.StreamWrapper object>)[source]#

Bases: object

Format UCS Test result.

begin_run(environment: TestEnvironment, count: int = 1) → None[source]#: Called before first test.

begin_section(section: str) → None[source]#: Called before each section.

begin_test(case: TestCase, prefix: str = '') → None[source]#: Called before each test.

end_test(result: TestResult) → None[source]#: Called after each test.

end_section() → None[source]#: Called after each section.

end_run() → None[source]#: Called after all test.

format(result: TestResult) → None[source]#: Format single test.

class univention.testing.data.TestResult(case: TestCase, environment: TestEnvironment)[source]#

Bases: object

Test result from running a test case.

dump(stream: ~typing.IO[str] = <colorama.ansitowin32.StreamWrapper object>) → None[source]#: Dump test result data.

attach(key: str, mime: str, content: Any) → None[source]#: Attach artifact ‘content’ of mime-type ‘mime’.

check() → bool[source]#: Test conditions to run test.

run() → Self[source]#: Return test.

univention.testing.debian_package module#

exception univention.testing.debian_package.BuildRuntimeError[source]#: Bases: RuntimeError

exception univention.testing.debian_package.InstallRuntimeError[source]#: Bases: RuntimeError

exception univention.testing.debian_package.UninstallRuntimeError[source]#: Bases: RuntimeError

class univention.testing.debian_package.DebianPackage(name: str = 'testdeb', version: str = '1.0')[source]#

Bases: object

Class to build simple debian packages

get_package_name() → str[source]#

get_temp_dir() → str[source]#

get_binary_name() → str[source]#

create_join_script_from_buffer(joinscript_name: str, joinscript_buffer: str) → None[source]#

create_unjoin_script_from_buffer(unjoinscript_name: str, unjoinscript_buffer: str) → None[source]#

create_usr_share_file_from_buffer(share_filename: str, schema_buffer: str, write_mode: str = 'w') → None[source]#

create_debian_file_from_buffer(debian_filename: str, debian_buffer: str) → None[source]#

build() → None[source]#

install() → None[source]#

uninstall(purge: bool = False) → None[source]#

remove() → None[source]#

univention.testing.decorators module#

class univention.testing.decorators.WaitForNonzeroResultOrTimeout(func: Callable[[...], Any], timeout: int = 90)[source]#: Bases: object

class univention.testing.decorators.SetTimeout(func: Callable[[...], None], timeout: int = 90)[source]#: Bases: object

univention.testing.decorators.setTimeout(timeout: int = 90) → Callable[[F], F][source]#

univention.testing.errors module#

UCS Test errors.

exception univention.testing.errors.TestConditionError[source]#

Bases: Exception

Error during prepaation for test.

property tests#: Return failed tests.

exception univention.testing.errors.TestError[source]#

Bases: Exception

General test error.

univention.testing.fixtures_recyclebin module#

Common functions/fixtures for recyclebin tests.

univention.testing.fixtures_recyclebin.recyclebin_policy_session(udm_session, ldap_base)[source]#

univention.testing.fixtures_recyclebin.recyclebin_policy(udm, ldap_base)[source]#

univention.testing.fixtures_recyclebin.deleted_user_object(recyclebin_policy, udm)[source]#

univention.testing.fixtures_recyclebin.share_for_testing_session(udm_session, ldap_base)[source]#: Create a share for testing homeShare attributes

univention.testing.fixtures_recyclebin.deleted_object_user_properties(ldap_base) → SimpleNamespace[source]#

univention.testing.internal module#

Internal functions for test finding and setup.

class univention.testing.internal.UCSVersion(ver: str | tuple[int, int, int, int])[source]#

Bases: object

UCS version.

>>> UCSVersion("1.0") < UCSVersion("2.0")
True
>>> UCSVersion("1.0") < UCSVersion("1.0")
False
>>> UCSVersion("1.0") <= UCSVersion("1.0")
True
>>> UCSVersion("2.0") <= UCSVersion("1.0")
False
>>> UCSVersion("1.0") == UCSVersion("1.0")
True
>>> UCSVersion("1.0") == UCSVersion("2.0")
False
>>> UCSVersion("1.0") != UCSVersion("2.0")
True
>>> UCSVersion("1.0") != UCSVersion("1.0")
False
>>> UCSVersion("1.0") >= UCSVersion("1.0")
True
>>> UCSVersion("1.0") >= UCSVersion("2.0")
False
>>> UCSVersion("2.0") > UCSVersion("1.0")
True
>>> UCSVersion("1.0") > UCSVersion("1.0")
False
>>> UCSVersion("1.0") == UCSVersion((1, 0, INF, INF))
True
>>> UCSVersion("1.0-0-0") == UCSVersion((1, 0, 0, 0))
True
>>> UCSVersion("")
Traceback (most recent call last):
    ...
ValueError: Version does not match: ""
>>> UCSVersion("0")
Traceback (most recent call last):
    ...
ValueError: Version does not match: "0"
>>> UCSVersion("1")
Traceback (most recent call last):
    ...
ValueError: Version does not match: "1"
>>> UCSVersion("1.2")
UCSVersion('=1.2')
>>> UCSVersion("1.2-3")
UCSVersion('=1.2-3')
>>> UCSVersion("1.2-3-4")
UCSVersion('=1.2-3-4')
>>> UCSVersion("1.2-3-4-5")
Traceback (most recent call last):
    ...
ValueError: Version does not match: "1.2-3-4-5"
>>> UCSVersion(None)
Traceback (most recent call last):
    ...
TypeError: None
>>> UCSVersion(1)
Traceback (most recent call last):
    ...
TypeError: 1
>>> UCSVersion(1.5)
Traceback (most recent call last):
    ...
TypeError: 1.5

RE_VERSION = re.compile('^(<|<<|<=|=|==|>=|>|>>)?([1-9][0-9]*)\\.([0-9]+)(?:-([0-9]*)(?:-([0-9]+))?)?$')#

match(other: Self) → bool[source]#: Check if other matches the criterion. >>> UCSVersion(‘>1.2-3’).match(UCSVersion(‘1.2-4’)) True >>> UCSVersion(‘>1.2-3’).match(UCSVersion(‘1.2-3-4’)) False >>> UCSVersion(‘>1.2-3-5’).match(UCSVersion(‘1.2-3-4’)) False >>> UCSVersion(‘>=1.2-3’).match(UCSVersion(‘1.2-3-4’)) True

univention.testing.internal.get_sections() → dict[str, str][source]#: Return dictionary section-name -> section-directory.

univention.testing.internal.get_tests(sections: Iterable[str]) → dict[str, list[str]][source]#: Return dictionary of section -> [filenames].

univention.testing.internal.setup_debug(level: int) → None[source]#: Setup Python logging.

univention.testing.internal.setup_environment() → None[source]#: Setup runtime environment.

univention.testing.internal.strip_indent(text: str) → str[source]#: Strip common indent.

univention.testing.ldap_glue module#

univention.testing.ldap_glue.get_rdn(dn)[source]#

>>> get_rdn(r'a=b\,c+d=e,f=g+h=i\,j')
'a=b\\,c+d=e'
>>> get_rdn(r'a=b')
'a=b'

univention.testing.ldap_glue.get_parent_dn(dn)[source]#

>>> get_parent_dn(r'a=b\,c+d=e,f=g+h=i\,j')
'f=g+h=i\\,j'
>>> get_parent_dn(r'a=b')

univention.testing.ldap_glue.to_bytes(value)[source]#

univention.testing.ldap_glue.get_first(value)[source]#

class univention.testing.ldap_glue.LDAPConnection(no_starttls=False)[source]#

Bases: object

helper functions to modify LDAP-objects intended as glue for shell-scripts

connect(no_starttls=False)[source]#

get_kerberos_ticket()[source]#

exists(dn)[source]#

get_attribute(dn, attribute)[source]#: Get attributes ‘key’ of LDAP object at ‘dn’.

get(dn, attr=[], required=False)[source]#: returns ldap object

create(dn, attrs)[source]#: Create LDAP object at ‘dn’ with attributes ‘attrs’.

delete(dn)[source]#: Delete LDAP object at ‘dn’.

move(dn, newdn)[source]#: Move LDAP object from ‘dn’ to ‘newdn’.

set_attribute(dn, key, value)[source]#: Set attribute ‘key’ of LDAP object at ‘dn’ to ‘value’.

set_attributes(dn, **attributes)[source]#

set_attribute_with_provision_ctrl(dn, key, value)[source]#

delete_attribute(dn, key)[source]#: Delete attribute ‘key’ of LDAP object at ‘dn’.

append_to_attribute(dn, key, value)[source]#: Add ‘value’ to attribute ‘key’ of LDAP object at ‘dn’.

remove_from_attribute(dn, key, value)[source]#: Remove ‘value’ from attribute ‘key’ of LDAP object at ‘dn’.

class univention.testing.ldap_glue.ADConnection(configbase='connector')[source]#

Bases: LDAPConnection

helper functions to modify AD-objects

delete(dn)[source]#: Delete LDAP object at ‘dn’.

search(ldap_filter, attr=[], required=False)[source]#

get(dn, attr=[], required=False)[source]#: returns ldap object

set_attributes(dn, **attributes)[source]#

add_to_group(group_dn, member_dn)[source]#

remove_from_group(group_dn, member_dn)[source]#

getdn(filter)[source]#

createuser(username, position=None, **attributes)[source]#

Create a AD user with attributes as given by the keyword-args attributes. The created user will be populated with some defaults if not otherwise set.

Returns the dn of the created user.

rename_or_move_user_or_group(dn, name=None, position=None)[source]#

group_create(groupname, position=None, **attributes)[source]#

Create a AD group with attributes as given by the keyword-args attributes. The created group will be populated with some defaults if not otherwise set.

Returns the dn of the created group.

windows_create(name, position=None, **attributes)[source]#

Create a AD windows with attributes as given by the keyword-args attributes. The created windows will be populated with some defaults if not otherwise set.

Returns the dn of the created windows.

getprimarygroup(user_dn)[source]#

setprimarygroup(user_dn, group_dn)[source]#

container_create(name, position=None, description=None)[source]#

createou(name, position=None, description=None)[source]#

verify_object(dn, expected_attributes)[source]#

Verify an object exists with the given dn and attributes in the AD-LDAP. Setting expected_attributes to None requires the object to not exist. expected_attributes is a dictionary of attribute:list-of-values.

This will throw an AssertionError in case of a mismatch.

univention.testing.ldif module#

This program compares LDAP host entries with a local comparative ldif file. All differences will be displayed at the console.

exception univention.testing.ldif.LdifError[source]#

Bases: Exception

Error in input processing.

exception univention.testing.ldif.SlapError[source]#

Bases: Exception

Error in slapcat processing.

class univention.testing.ldif.Ldif(src: Iterable[bytes], exclude: set[str] = {'createTimestamp', 'creatorsName', 'entryCSN', 'entryUUID', 'modifiersName', 'modifyTimestamp', 'structuralObjectClass'})[source]#

Bases: object

Abstract class for LDIF source.

RE = re.compile('\n ^\n (?:\n ([0-9]+(?:\\.[0-9]+)*) # ldap-oid\n |([A-Za-z][\\-0-9A-Za-z]*) # AttributeType\n ) # AttributeDescription\n (;[\\-0-9A-Za-z]+)* # OP, re.VERBOSE)#

OPERATIONAL = {'createTimestamp', 'creatorsName', 'entryCSN', 'entryUUID', 'modifiersName', 'modifyTimestamp', 'structuralObjectClass'}#

next_line() → Iterator[str][source]#: Return line iterator.

split(line: str) → tuple[str, str][source]#

Split attribute and value. Options are stripped. Base64 encoded values are decoded.

Parameters:: line (str) – The line to split.
Returns:: A tuple (name, value).

>>> Ldif(b'').split('a:') == ('a', u'')
True
>>> Ldif(b'').split('a: b') == ('a', u'b')
True
>>> Ldif(b'').split('a:: YWFh') == ('a', u'aaa')
True
>>> Ldif(b'').split('a;b:c') == ('a', u'c')
True
>>> Ldif(b'').split('a;b;c::YWFh') == ('a', u'aaa')
True
>>> Ldif(b'').split('a:: ACB/') == ('a', u'\\u0000 \\u007f')
True

static printable(value: str) → str[source]#: Convert binary data to printable string.

class univention.testing.ldif.LdifSource[source]#

Bases: object

classmethod create(arg: str, options: Values) → LdifFile[source]#

start_reading() → Ldif[source]#: Start reading the LDIF data.

class univention.testing.ldif.LdifFile(filename: str)[source]#

Bases: object

LDIF source from local file.

classmethod create(arg: str, options: Values) → Self[source]#

start_reading() → Ldif[source]#: Start reading the LDIF data.

class univention.testing.ldif.LdifSlapcat[source]#

Bases: object

LDIF source from local LDAP.

classmethod create(arg: Any, options: Values) → Self[source]#

start_reading() → Ldif[source]#: Start reading the LDIF data.

wait_for_data(proc: Popen) → None[source]#

Wait for the remote process to send data.

>>> LdifSlapcat().wait_for_data(subprocess.Popen(('echo',), stdout=subprocess.PIPE))
>>> LdifSlapcat().wait_for_data(subprocess.Popen(('false',), stdout=subprocess.PIPE))
Traceback (most recent call last):
...
SlapError: ('Error executing', ['slapcat', '-d0'], 1)

class univention.testing.ldif.LdifSsh(hostname: str, ssh: str = 'ssh')[source]#

Bases: LdifSlapcat

LDIF source from remote LDAP.

classmethod create(hostname: str, options: Values) → Self[source]#

univention.testing.ldif.stream2object(ldif: Ldif) → dict[str, dict[str, list[str]]][source]#

Convert LDIF stream to dictionary of objects.

Parameters:: ldif (Ldif) – A LDIF stream.
Returns:: A dictionary mapping distinguished names to a dictionary of key-values.

>>> stream2object([{'dn': ['dc=test']}])
{'dc=test': {}}

univention.testing.ldif.sort_dn(dname: str) → tuple[tuple[str, ...], ...][source]#

Sort by reversed dn.

Parameters:: dname (str) – distinguished name.
Returns:: tuple of relative distinguised names.

>>> sort_dn('a=1')
(('a=1',),)
>>> sort_dn('b=1,a=1')
(('a=1',), ('b=1',))
>>> sort_dn('b=2+a=1')
(('a=1', 'b=2'),)

univention.testing.ldif.compare_ldif(lldif: Ldif, rldif: Ldif, options: Values) → int[source]#

Compare two LDIF files.

Parameters:

ldif1 – first LDIF to compare.
ldif2 – second LDIF to compare.
options – command line options.

univention.testing.ldif.compare_keys(ldata: dict[str, list[str]], rdata: dict[str, list[str]]) → Iterator[tuple[Literal[-1, 0, 1], str, str]][source]#

Compare and return attributes of two LDAP objects.

Parameters:

ldata (dict) – the first LDAP object.
rdata (dict) – the second LDAP object.

Returns:

an iterator of differences as 3-tuples (comparison, key, value).

>>> list(compare_keys({}, {}))
[]
>>> list(compare_keys({'a': ['1']}, {}))
[(-1, 'a', '1')]
>>> list(compare_keys({}, {'a': ['1']}))
[(1, 'a', '1')]
>>> list(compare_keys({'a': ['1']}, {'a': ['1']}))
[(0, 'a', '1')]
>>> list(compare_keys({'a': ['1']}, {'a': ['2']}))
[(1, 'a', '2'), (-1, 'a', '1')]

univention.testing.ldif.compare_values(attr: str, lvalues: list[str], rvalues: list[str]) → Iterator[tuple[Literal[-1, 0, 1], str, str]][source]#

Compare and return values of two multi-valued LDAP attributes.

Parameters:

lvalues (list) – the first values.
rvalues (list) – the second values.

Returns:

an iterator of differences as 3-tuples (comparison, key, value), where comparison<0 if key is missing in lvalues, comparison>0 if key is missing in rvalues, otherwise 0.

>>> list(compare_values('attr', [], []))
[]
>>> list(compare_values('attr', ['1', '2'], ['2', '3']))
[(1, 'attr', '3'), (0, 'attr', '2'), (-1, 'attr', '1')]

univention.testing.ldif.parse_args() → tuple[LdifSource, LdifSource, Values][source]#: Parse command line arguments.

univention.testing.ldif.main() → None[source]#: A main()-method with options.

univention.testing.ldif.run_compare(ldif1: Ldif, ldif2: Ldif, options: Values) → NoReturn[source]#

UNIX correct error handling. Termination by signal is propagaed as signal.

Parameters:

ldif1 – first LDIF to compare.
ldif2 – second LDIF to compare.
options – command line options.

univention.testing.license_client module#

A tool to obtain licenses for the UCS test environments.

exception univention.testing.license_client.CredentialsMissing[source]#

Bases: Exception

A custom exception to be raised when a ‘license.secret’ file is not found

class univention.testing.license_client.ShopParser(log: Logger)[source]#

Bases: HTMLParser

Initialize and reset this instance.

If convert_charrefs is True (the default), all character references are automatically converted to the corresponding Unicode characters.

error(message)[source]#

handle_starttag(tag: str, attrs: Iterable[tuple[str, str | None]]) → None[source]#: Method is called every time a new start tag is found in the html feed. When the link tag with ‘orders/’ attribute is found, the attribute is saved to ‘self.link_to_license’

class univention.testing.license_client.TestLicenseClient(parser: ArgumentParser | None = None)[source]#

Bases: object

Class constructor for the test license client and HTMLParser

setup_logging() → None[source]#: Creates and configures the logger with an INFO level

create_connection() → None[source]#: Creates a HTTPS connection instance on a default port (443) to the ‘self.license_server_url’

close_connection() → None[source]#: Closes the license server connection if the connection instance was created

get_server_password(secret_file: str = '/etc/license.secret') → None[source]#: Opens and reads the ‘secret_file’. Saves the result to a ‘self.server_password’

get_cookie() → None[source]#: Makes a POST request with ‘self.server_username’ and ‘self.server_password’ into login forms and saves the cookie from the response received.

make_post_request(url: str, body: str, headers: dict[str, str]) → HTTPResponse[source]#: Makes a POST request with the given ‘url’, ‘body’, ‘headers’ and returns the response

make_get_request(url: str, headers: dict[str, str]) → HTTPResponse[source]#: Makes a GET request with the given ‘url’, ‘headers’ and returns the response

get_the_license(body: str) → None[source]#: Processes the given ‘body’ with HTMLParser to find the link to a created license file and downloads the license after.

order_a_license() → str[source]#: Makes a POST request with encoded ‘self.license_params’ as a body to order a new license. Returns the response body.

get_body(response: HTTPResponse) → str[source]#

download_license_file(link_to_license: str) → None[source]#: Downloads the license located at filename and saves it to the file ‘self.license_filename’

check_date_format() → None[source]#: Checks if the ‘EndDate’ format is correct.

update_with_parsed_args(args: dict[str, Any]) → None[source]#: Updates the loglevel and license filename settings if given among the parsed arguments. Merges parsed data with default license parameters.

process_cmd_arguments() → None[source]#: Populates self.parser class with positional and optional arguments and processes the user input, checks the date format and than merges it with the default values in the ‘self.license_params’ dictionary

main(base_dn: str = '', end_date: str = '', server_url: str = '', license_file: str = '') → None[source]#: A method to order and download a test license from the license server. ‘base_dn’ and ‘end_date’ should be provided if argument parser is not used. ‘server_url’ is an optional argument for the license shop server. ‘license_file’ is an optional argument for the license filename.

univention.testing.mail module#

class univention.testing.mail.MailSinkGuard[source]#

Bases: object

This class is a simple context manager that stops all attached mail sinks if the context is left.

with MaiLSinkGuard() as msg:: sink = MailSink(……) msg.add(sink) ….use sink….

add(sink: MailSink) → None[source]#

class univention.testing.mail.MailSink(address: str, port: int, filename: str | None = None, target_dir: str | None = None, fqdn: str | None = None)[source]#

Bases: object

This class starts an SMTP sink on the specified address/port. Each incoming mail will be written to a single file if target_dir is used. To write all incoming mails into one file, use filename.

>>> ms = MailSink('127.0.0.1', 12345, target_dir='/tmp/')
>>> ms.start()
<do some stuff>
>>> ms.stop()

>>> ms = MailSink('127.0.0.1', 12345, filename='/tmp/sinkfile.eml')
>>> ms.start()
<do some stuff>
>>> ms.stop()

>>> with MailSink('127.0.0.1', 12345, filename='/tmp/sinkfile.eml') as ms:
>>>     <do some stuff>

start() → None[source]#

stop() → None[source]#

univention.testing.network module#

Networking helper that may establish connection redirection for testing network connections/configuration of different programs (e.g. postfix).

WARNING: The networking helper will install special iptables rules that may completely break routing from/to the test system. Especially if the test script does not clean up in error cases!

exception univention.testing.network.UCSTestNetwork[source]#: Bases: Exception

exception univention.testing.network.UCSTestNetworkCannotDetermineExternalAddress[source]#: Bases: UCSTestNetwork

exception univention.testing.network.UCSTestNetworkCmdFailed[source]#: Bases: UCSTestNetwork

exception univention.testing.network.UCSTestNetworkUnknownLoop[source]#: Bases: UCSTestNetwork

exception univention.testing.network.UCSTestNetworkUnknownRedirection[source]#: Bases: UCSTestNetwork

exception univention.testing.network.UCSTestNetworkNoWithStatement[source]#

Bases: UCSTestNetwork

message = 'NetworkRedirector has to be used via with statement!'#

exception univention.testing.network.UCSTestNetworkOnlyOneLoopSupported[source]#

Bases: UCSTestNetwork

message = 'NetworkRedirector does support only ONE loop at a time!'#

class univention.testing.network.NetworkRedirector[source]#

Bases: object

The NetworkRedirector is able to establish port/connection redirections via iptables. It has to be used via the with-statement.

>>> with NetworkRedirector() as nethelper:
>>> nethelper.add_loop('1.2.3.4', '4.3.2.1')
>>> nethelper.add_redirection('1.1.1.1', 25, 60025)
>>> ...
>>> # the following lines are optional! NetworkRedirector does automatic cleanup!
>>> nethelper.remove_loop('1.2.3.4', '4.3.2.1')
>>> nethelper.remove_redirection('1.1.1.1', 25, 60025)

It is also possible to redirect all traffic to a specific port. The trailing “/0” is important, otherwise the redirection won’t work!

>>> nethelper.add_redirection('0.0.0.0/0', 25, 60025)

BIN_IPTABLES = '/sbin/iptables'#

CMD_LIST_LOOP = [['/sbin/iptables', '-t', 'mangle', '%(action)s', 'OUTPUT', '-d', '%(addr1)s', '-j', 'TOS', '--set-tos', '0x04'], ['/sbin/iptables', '-t', 'nat', '%(action)s', 'OUTPUT', '-d', '%(addr1)s', '-j', 'DNAT', '--to-destination', '%(local_external_addr)s'], ['/sbin/iptables', '-t', 'nat', '%(action)s', 'POSTROUTING', '-m', 'tos', '--tos', '0x04', '-j', 'SNAT', '--to-source', '%(addr2)s'], ['/sbin/iptables', '-t', 'mangle', '%(action)s', 'OUTPUT', '-d', '%(addr2)s', '-j', 'TOS', '--set-tos', '0x08'], ['/sbin/iptables', '-t', 'nat', '%(action)s', 'OUTPUT', '-d', '%(addr2)s', '-j', 'DNAT', '--to-destination', '%(local_external_addr)s'], ['/sbin/iptables', '-t', 'nat', '%(action)s', 'POSTROUTING', '-m', 'tos', '--tos', '0x08', '-j', 'SNAT', '--to-source', '%(addr1)s']]#

CMD_LIST_REDIRECTION = [['/sbin/iptables', '-t', 'nat', '%(action)s', 'OUTPUT', '-p', '%(family)s', '-d', '%(remote_addr)s', '--dport', '%(remote_port)s', '-j', 'DNAT', '--to-destination', '127.0.0.1:%(local_port)s']]#

revert_network_settings() → None[source]#

run_commands(cmdlist: list[list[str]], argdict: Mapping[str, Any], ignore_errors: bool = False) → None[source]#

Start all commands in cmdlist and replace formatstrings with arguments in argdict.

>>> run_commands([['/bin/echo', '%(msg)s'], ['/bin/echo', 'World']], {'msg': 'Hello'})

add_loop(addr1: str, addr2: str) → None[source]#

Add connection loop for addr1 and addr2. Outgoing connections to addr1 will be redirected back to localhost. The redirected connection will appear as it comes from addr2. All outgoing traffic to addr2 will be also redirected back to localhost and will appear as it comes from addr1.

HINT: only one loop may be established at a time!

remove_loop(addr1: str, addr2: str, ignore_errors: bool = False) → None[source]#: Remove previously defined connection loop.

add_redirection(remote_addr: str, remote_port: int, local_port: int, family: str = 'tcp') → None[source]#

Add new connection redirection.

Outgoing connections to <remote_addr>:<remote_port> will be redirected back to localhost:<local_port>.

remove_redirection(remote_addr: str, remote_port: int, local_port: int, family: str = 'tcp', ignore_errors: bool = False) → None[source]#: Remove previously defined connection redirection.

univention.testing.pytest module#

pytest runner for ucs-test

class univention.testing.pytest.PytestRunner[source]#

Bases: object

options = Namespace(inside=True)#

classmethod extend_command(testcase, cmd)[source]#: Add junit and other arguments to pytest

classmethod set_arguments(options)[source]#: store singleton CLI arguments globally

classmethod is_pytest(test_case)[source]#: indicates that the test case is a pytest test

classmethod get_argument_group(parser)[source]#: The option group for ucs-test-framework

univention.testing.strings module#

univention.testing.strings.random_string(length: int = 10, alpha: bool = True, numeric: bool = True, charset: str = '', encoding: str = 'utf-8') → str[source]#: Get specified number of random characters (ALPHA, NUMERIC or ALPHANUMERIC). Default is an alphanumeric string of 10 characters length. A custom character set may be defined via “charset” as string. The default encoding is UTF-8. If length is 0 or negative, an empty string is returned.

univention.testing.strings.random_name(length: int = 10) → str[source]#: create random name (1 ALPHA, 8 ALPHANUM, 1 ALPHA)

univention.testing.strings.random_name_special_characters(length: int = 10) → str[source]#: create random name (1 UMLAUT, 2 ALPHA, 6 SPECIAL_CHARACTERS + UMLAUT, 1 UMLAUTNUM)

univention.testing.strings.random_username(length: int = 10) → str#: create random name (1 ALPHA, 8 ALPHANUM, 1 ALPHA)

univention.testing.strings.random_groupname(length: int = 10) → str#: create random name (1 ALPHA, 8 ALPHANUM, 1 ALPHA)

univention.testing.strings.random_int(bottom_end: int = 0, top_end: int = 9) → str[source]#

univention.testing.strings.random_version(elements: int = 3) → str[source]#

univention.testing.strings.random_ucs_version(min_major: int = 1, max_major: int = 9, min_minor: int = 0, max_minor: int = 99, min_patchlevel: int = 0, max_patchlevel: int = 99) → str[source]#

univention.testing.strings.random_mac() → str[source]#

univention.testing.strings.random_ip(ip_iter: ~collections.abc.Iterator[int] = <range_iterator object>) → str[source]#: Returns 110 different ip addresses in the range 11.x.x.x-120.x.x.x

univention.testing.strings.random_subnet(ip_iter: ~collections.abc.Iterator[int] = <range_iterator object>) → str[source]#: Returns 110 different ip addresses in the range 11.x.x.x-120.x.x.x

univention.testing.strings.random_ipv6_subnet() → str[source]#: Returns random six blocks of an ipv6 address

univention.testing.strings.random_domain_name(length: int = 10) → str[source]#

univention.testing.strings.random_dns_record() → str[source]#

univention.testing.strings.random_date() → str[source]#

univention.testing.strings.random_time(range_hour: tuple[int, int] = (0, 23)) → str[source]#

univention.testing.strings.random_email() → str[source]#

univention.testing.ucr module#

BETA VERSION

Wrapper around Univention Configuration Registry that is able to revert the UCR status after usage. For usage examples look at the end of this file.

Warning

changes to the ConfigRegistry object will also trigger the evaluation of templates and therefore changes in configuration files created by UCR!

Warning

The API is currently under development and may change before next UCS release!

class univention.testing.ucr.UCSTestConfigRegistry(*args: Any, **kwargs: Any)[source]#

Bases: ConfigRegistry

Extension to ConfigRegistry to be able to clean up after several changes to UCR variables have been done.

initialise object

ucr_update(*args)[source]#

handler_set(*args)[source]#

handler_unset(*args)[source]#

load() → None[source]#: call load() of superclass and save original registry values

revert_to_original_registry() → None[source]#: revert UCR values back to original state

univention.testing.ucs_samba module#

exception univention.testing.ucs_samba.DRSReplicationFailed[source]#: Bases: Exception

exception univention.testing.ucs_samba.WaitForS4ConnectorTimeout[source]#: Bases: Exception

univention.testing.ucs_samba.password_policy(complexity: bool = False, minimum_password_age: int = 0, maximum_password_age: int = 3) → Iterator[None][source]#

univention.testing.ucs_samba.wait_for_drs_replication(ldap_filter: str, attrs: list[str] | str | None = None, base: str | None = None, scope: int = 2, lp: LoadParm | None = None, timeout: int = 360, delta_t: int = 1, verbose: bool = True, should_exist: bool = True, controls: list[str] | None = None) → None[source]#

univention.testing.ucs_samba.get_available_s4connector_dc() → str[source]#

univention.testing.ucs_samba.force_drs_replication(source_dc: str | None = None, destination_dc: str | None = None, partition_dn: str | None = None, direction: str = 'in') → int[source]#

univention.testing.ucs_samba.wait_for_s4connector(timeout: int = 360, delta_t: int = 1, s4cooldown_t: int = 5) → int[source]#

univention.testing.ucs_samba.append_dot(verify_list: list[str]) → list[str][source]#: The S4-Connector appends dots to various dns records. Helper function to adjust a list.

univention.testing.udm module#

ALPHA VERSION

Wrapper around Univention Directory Manager CLI to simplify creation/modification of UDM objects in python. The wrapper automatically removed created objects during wrapper destruction. For usage examples look at the end of this file.

WARNING: The API currently allows only modifications to objects created by the wrapper itself. Also the deletion of objects is currently unsupported. Also not all UDM object types are currently supported.

WARNING2: The API is currently under heavy development and may/will change before next UCS release!

exception univention.testing.udm.UCSTestUDM_Exception[source]#: Bases: Exception

exception univention.testing.udm.UCSTestUDM_MissingModulename[source]#: Bases: UCSTestUDM_Exception

exception univention.testing.udm.UCSTestUDM_MissingDn[source]#: Bases: UCSTestUDM_Exception

exception univention.testing.udm.UCSTestUDM_CreateUDMObjectFailed[source]#: Bases: UCSTestUDM_Exception

exception univention.testing.udm.UCSTestUDM_CreateUDMUnknownDN[source]#: Bases: UCSTestUDM_Exception

exception univention.testing.udm.UCSTestUDM_ModifyUDMObjectFailed[source]#: Bases: UCSTestUDM_Exception

exception univention.testing.udm.UCSTestUDM_RestoreUDMObjectFailed[source]#: Bases: UCSTestUDM_Exception

exception univention.testing.udm.UCSTestUDM_MoveUDMObjectFailed[source]#: Bases: UCSTestUDM_Exception

exception univention.testing.udm.UCSTestUDM_NoModification[source]#: Bases: UCSTestUDM_Exception

exception univention.testing.udm.UCSTestUDM_ModifyUDMUnknownDN[source]#: Bases: UCSTestUDM_Exception

exception univention.testing.udm.UCSTestUDM_RestoreUDMUnknownDN[source]#: Bases: UCSTestUDM_Exception

exception univention.testing.udm.UCSTestUDM_RemoveUDMObjectFailed[source]#: Bases: UCSTestUDM_Exception

exception univention.testing.udm.UCSTestUDM_CleanupFailed[source]#: Bases: UCSTestUDM_Exception

exception univention.testing.udm.UCSTestUDM_CannotModifyExistingObject[source]#: Bases: UCSTestUDM_Exception

exception univention.testing.udm.UCSTestUDM_ListUDMObjectFailed[source]#: Bases: UCSTestUDM_Exception

exception univention.testing.udm.UCSTestUDM_GetUDMObjectFailed[source]#: Bases: UCSTestUDM_Exception

class univention.testing.udm.UCSTestUDM(language=None)[source]#

Bases: object

PATH_UDM_CLI_SERVER = '/usr/share/univention-directory-manager-tools/univention-cli-server'#

PATH_UDM_CLI_CLIENT = '/usr/sbin/udm'#

PATH_UDM_CLI_CLIENT_WRAPPED = '/usr/sbin/udm-test'#

COMPUTER_MODULES = ('computers/ubuntu', 'computers/linux', 'computers/windows', 'computers/windows_domaincontroller', 'computers/domaincontroller_master', 'computers/domaincontroller_backup', 'computers/domaincontroller_slave', 'computers/memberserver', 'computers/macos', 'computers/ipmanagedclient')#

ad_object_identifying_filter(modulename: str, dn: str) → dict[str, str] | None[source]#

property LDAP_BASE: str#

property FQHN: str#

property UNIVENTION_CONTAINER: str#

property UNIVENTION_TEMPORARY_CONTAINER: str#

create_object(modulename: str, wait_for_replication: bool = True, check_for_drs_replication: bool = False, wait_for: bool = False, **kwargs: Any) → str[source]#

Creates a LDAP object via UDM. Values for UDM properties can be passed via keyword arguments only and have to exactly match UDM property names (case-sensitive!).

Parameters:

modulename (str) – name of UDM module (e.g. ‘users/user’)
wait_for_replication (bool) – delay return until Listener has settled.
check_for_drs_replication (bool) – delay return until Samab4 has settled.
**kwargs

create_with_defaults(modulename: str, **kwargs: Any) → tuple[str, dict][source]#: Create any object with as maximum as possible prefilled random default values

modify_object(modulename: str, wait_for_replication: bool = True, check_for_drs_replication: bool = False, wait_for: bool = False, **kwargs: Any) → str[source]#

Modifies a LDAP object via UDM. Values for UDM properties can be passed via keyword arguments only and have to exactly match UDM property names (case-sensitive!). Please note: the object has to be created by create_object otherwise this call will raise an exception!

Parameters:: modulename (str) – name of UDM module (e.g. ‘users/user’)

restore_object(modulename: str, wait_for_replication: bool = True, check_for_drs_replication: bool = False, wait_for: bool = False, **kwargs: Any) → str[source]#

move_object(modulename: str, wait_for_replication: bool = True, check_for_drs_replication: bool = False, wait_for: bool = False, **kwargs: Any) → str[source]#

remove_object(modulename: str, wait_for_replication: bool = True, wait_for: bool = False, **kwargs: Any) → None[source]#

wait_for(modulename: str, dn: str, wait_for_replication: bool = True, wait_for_drs_replication: bool = False, wait_for_s4connector: bool = False, everything: bool = False) → None[source]#

create_user(wait_for_replication: bool = True, check_for_drs_replication: bool = True, wait_for: bool = True, **kwargs: Any) → tuple[str, str][source]#

Creates a user via UDM CLI. Values for UDM properties can be passed via keyword arguments only and have to exactly match UDM property names (case-sensitive!). Some properties have default values:

Parameters:

position (str) – ‘cn=users,$ldap_base’
password (str) – ‘univention’
firstname (str) – ‘Foo Bar’
lastname (str) – <random string>
username (str) – <random string> If username is missing, a random user name will be used.

Returns:

(dn, username)

create_ldap_user(wait_for_replication: bool = True, check_for_drs_replication: bool = False, **kwargs: Any) → tuple[str, str][source]#

remove_user(username: str, wait_for_replication: bool = True) → None[source]#: Removes a user object from the ldap given it’s username.

create_group(wait_for_replication: bool = True, check_for_drs_replication: bool = True, **kwargs: Any) → tuple[str, str][source]#

Creates a group via UDM CLI. Values for UDM properties can be passed via keyword arguments only and have to exactly match UDM property names (case-sensitive!). Some properties have default values:

Parameters:

position (str) – cn=users,$ldap_base
name (str) – <random value>

Returns:

(dn, groupname)

If “groupname” is missing, a random group name will be used.

addCleanupLock(lockType, lockValue)[source]#

get_object(modulename: str, dn: str, **kwargs: Any) → dict[str, Any][source]#

list_objects(modulename: str, **kwargs: Any) → list[tuple[str, dict[str, Any]]][source]#

cleanup() → None[source]#: Automatically removes LDAP objects via UDM CLI that have been created before.

stop_cli_server() → None[source]#: restart UDM CLI server

verify_udm_object(*args, **kwargs)[source]#

verify_ldap_object(*args, **kwargs)[source]#

class univention.testing.udm.UDM(language=None)[source]#

Bases: UCSTestUDM

UDM interface using the REST API

PATH_UDM_CLI_CLIENT_WRAPPED = '/usr/sbin/udm-test-rest'#

list_objects_json(modulename: str, **kwargs: Any) → list[tuple[str, dict[str, Any]]][source]#

stop_cli_server() → None[source]#: restart UDM CLI server

univention.testing.udm.verify_udm_object(module: Any, dn: str, expected_properties: Mapping[str, bytes | str | Sequence[str]] | None) → None[source]#

Verify an object exists with the given dn in the given UDM module with some properties. Setting expected_properties to None requires the object to not exist. :param dict expected_properties: is a dictionary of (property,value) pairs.

Raises:: AssertionError – in case of a mismatch.

univention.testing.udm_extensions module#

univention.testing.udm_extensions.get_package_name() → str[source]#: returns a valid package name

univention.testing.udm_extensions.get_package_version() → str[source]#

univention.testing.udm_extensions.get_extension_name(extension_type: str) → str[source]#: Returns a valid extension name for the given extension type. >>> get_extension_name(‘hook’) ‘jcvuardfqx’ >>> get_extension_name(‘syntax’) ‘hwvkm29tde’ >>> get_extension_name(‘module’) ‘ucstest/r3jkljngcp’

univention.testing.udm_extensions.get_extension_filename(extension_type: str, extension_name: str) → str[source]#

univention.testing.udm_extensions.call_cmd(cmd: Sequence[str], fail_on_error: bool = True) → int[source]#: Calls the given cmd (list of strings).

univention.testing.udm_extensions.call_join_script(name: str, fail_on_error: bool = True) → int[source]#: Calls the given join script (e.g. name=’66foobar.inst’). If fail is true, then the function fail() is called if the exitcode is not zero.

univention.testing.udm_extensions.call_unjoin_script(name: str, fail_on_error: bool = True) → int[source]#: Calls the given unjoin script (e.g. name=’66foobar-uninstall.uinst’). If fail is true, then the function fail() is called if the exitcode is not zero.

univention.testing.udm_extensions.get_syntax_buffer(name: str | None = None, identifier: str | None = None) → str[source]#: Returns a UDM syntax with given name (e.g. ‘MySimpleHook’). If name is omitted, a randomly generated name is used.

univention.testing.udm_extensions.get_hook_buffer(name: str | None = None, identifier: str | None = None) → str[source]#: Returns a UDM hook with given name (e.g. ‘MySimpleHook’). If name is omitted, a randomly generated name is used.

univention.testing.udm_extensions.get_module_buffer(name: str | None = None, identifier: str | None = None) → str[source]#: Returns a UDM module with given name (e.g. ‘testing/mytest’). If name is omitted, a randomly generated name is used (‘ucstest/%(randomstring)s’).

univention.testing.udm_extensions.get_extension_buffer(extension_type: str, name: str | None = None, identifier: str | None = None) → str[source]#: Get UDM extension of specified type with specified name. In case the name is omitted, a random name will be used.

univention.testing.udm_extensions.get_postinst_script_buffer(extension_type: str, filename: str, app_id: str | None = None, version_start: str | None = None, version_end: str | None = None, options: Mapping[str, str | Iterable[str]] | None = None) → str[source]#: Returns a postinst script that registers the given file as UDM extension with extension type (‘hook’, ‘syntax’ or ‘module’). Optionally UNIVENTION_APP_ID, UCS version start and UCS version end may be specified.

univention.testing.udm_extensions.get_postrm_script_buffer(extension_type: str, extension_name: str, package_name: str) → str[source]#: Returns an postrm script that deregisters the given UDM extension. The type of the extension has to be specified (‘hook’, ‘syntax’ or ‘module’).

univention.testing.udm_extensions.get_join_script_buffer(extension_type: str, filename: str, app_id: str | None = None, joinscript_version: int = 1, version_start: str | None = None, version_end: str | None = None, options: Mapping[str, str | Iterable[str]] | None = None) → str[source]#: Returns a join script that registers the given file as UDM extension with extension type (‘hook’, ‘syntax’ or ‘module’). Optionally a joinscript version, UNIVENTION_APP_ID, UCS version start and UCS version end may be specified.

univention.testing.udm_extensions.get_unjoin_script_buffer(extension_type: str, extension_name: str, package_name: str) → str[source]#: Returns an unjoin script that deregisters the given UDM extension. The type of the extension has to be specified (‘hook’, ‘syntax’ or ‘module’).

univention.testing.udm_extensions.get_absolute_extension_filename(extension_type: str, filename: str) → str[source]#: Returns the absolute path to an extentension of the given type and filename.

univention.testing.udm_extensions.get_dn_of_extension_by_name(extension_type: str, name: str) → str[source]#: Returns a list of DNs of UDM extension objects with given type an name, or [] if no object has been found.

univention.testing.udm_extensions.remove_extension_by_name(extension_type: str, extension_name: str, fail_on_error: bool = True) → None[source]#: Remove all extensions of given type and name from LDAP.

univention.testing.umc module#

Bases: Client

print_response = True#

print_request_data = True#

classmethod get_test_connection(hostname: str | None = None, *args: Any, **kwargs: Any) → Self[source]#

umc_command(*args: Any, **kwargs: Any) → Self[source]#

Perform generic UMC command.

Parameters:

path (str) – The URL path of the command after the command/ prefix.
options (dict) – The argument for the UMC command.
flavor (str) – Optional name of the UMC module flavor, e.g. users/user for UDM modules.
headers (dict) – Optional HTTP headers.

Returns:

The UMC response.

Return type:

univention.lib.umc.Response

request(method: str, path: str, data: Any = None, headers: Any = None) → Any[source]#

Send request to UMC server handling re-authentication.

Parameters:

method (str) – The HTTP method for the request.
path (str) – The URL of the request.
data – The message body.
headers (dict) – Optional HTTP headers.

:raises univention.lib.umc.Unauthorized: if the session expired and re-authentication was disabled.

Returns:: The UMC response.
Return type:: univention.lib.umc.Response

exception univention.testing.umc.SamlLoginError[source]#: Bases: Exception

class univention.testing.umc.GetHtmlTagValue(tag: str, condition: tuple[str, str], value_name: str)[source]#

Bases: HTMLParser

Initialize and reset this instance.

If convert_charrefs is True (the default), all character references are automatically converted to the corresponding Unicode characters.

handle_starttag(tag: str, attrs: Iterable[tuple[str, str | None]]) → None[source]#

univention.testing.umc.get_html_tag_value(page: str, tag: str, condition: tuple[str, str], value_name: str) → str[source]#

Bases: Client

authenticate(*args: Any) → None[source]#

Authenticate against the host and preserves the cookie. Has to be done only once (but keep in mind that the session probably expires after 10 minutes of inactivity)

Parameters:

username (str) – A user name.
password (str) – The password of the user.

authenticate_saml(*args: Any) → None[source]#

Setup authentication using SAML.

Parameters:

username (str) – A user name.
password (str) – The password of the user.

Warning

not implemented.

Bases: Client

authenticate(username: str, password: str, portal_fqdn: str | None = None, kc_idp_hint: str | None = None) → None[source]#

Authenticate against the host and preserves the cookie. Has to be done only once (but keep in mind that the session probably expires after 10 minutes of inactivity)

Parameters:

username (str) – A user name.
password (str) – The password of the user.

logout() → None[source]#

get_session_code(text)[source]#

get_kerberos_redirect(text)[source]#

get_login_link(req)[source]#

univention.testing.utils module#

Common functions used by tests.

exception univention.testing.utils.LDAPError[source]#: Bases: Exception

exception univention.testing.utils.LDAPReplicationFailed[source]#: Bases: LDAPError

exception univention.testing.utils.LDAPObjectNotFound[source]#: Bases: LDAPError

exception univention.testing.utils.LDAPUnexpectedObjectFound[source]#: Bases: LDAPError

exception univention.testing.utils.LDAPObjectValueMissing[source]#: Bases: LDAPError

exception univention.testing.utils.LDAPObjectUnexpectedValue[source]#: Bases: LDAPError

class univention.testing.utils.UCSTestDomainAdminCredentials(ucr: ConfigRegistry | None = None)[source]#

Bases: object

This class fetches the username, the LDAP bind DN and the password for a domain admin user account from UCR. The account may be used for testing.

>>> dummy_ucr = {'ldap/base': 'dc=example,dc=com', 'tests/domainadmin/pwdfile': '/dev/null'}
>>> account = UCSTestDomainAdminCredentials(ucr=dummy_ucr)
>>> account.username
'Administrator'
>>> account.binddn
'uid=Administrator,cn=users,dc=example,dc=com'
>>> account.bindpw
''

univention.testing.utils.get_ldap_connection(admin_uldap: bool = False, primary: bool = False) → access[source]#

univention.testing.utils.retry_on_error(func: ~collections.abc.Callable[[...], ~univention.testing.utils._T], exceptions: tuple[type[Exception], ...] = (<class 'Exception'>,), retry_count: int = 20, delay: float = 10) → _T[source]#

This function calls the given function func. If one of the specified exceptions is caught, func is called again until the retry count is reached or any unspecified exception is caught. Between two calls of func retry_on_error waits for delay seconds.

Parameters:

func – function to be called
exceptions – tuple of exception classes, that cause a rerun of func
retry_count – retry the execution of func max retry_count times
delay – waiting time in seconds between two calls of func

Returns:

return value of func

univention.testing.utils.verify_ldap_object(baseDn: str, expected_attr: Mapping[str, Sequence[bytes | str]] | None = None, strict: bool = True, should_exist: bool = True, retry_count: int = 20, delay: float = 10, primary: bool = False, pre_check: Callable[[...], None] | None = None, pre_check_kwargs: dict[str, Any] | None = None, not_expected_attr: dict[str, str] | None = None) → None[source]#

Verify [non]existence and attributes of LDAP object.

Parameters:

baseDn (str) – DN of object to check
expected_attr (dict) – attributes and their values that the LDAP object is expected to have
strict (bool) – value lists of multi-value attributes must be complete
should_exist (bool) – whether the object is expected to exist
retry_count (int) – how often to retry the verification if it fails before raising an exception
delay (float) – waiting time in seconds between retries on verification failures
primary (bool) – whether to connect to the primary (DC master) instead of local LDAP (to be exact: ucr[ldap/server/name], ucr[‘ldap/server/addition’])
pre_check – function to execute before starting verification. Value should be a function object like utils.wait_for_replication.
pre_check_kwargs (dict) – dict with kwargs to pass to pre_check() call
not_expected_attr (dict) – attributes and their values that the LDAP object is NOT expected to have

Returns:

None

Raises:

LDAPObjectNotFound – when no object was found at baseDn
LDAPUnexpectedObjectFound – when an object was found at baseDn, but should_exist=False
LDAPObjectValueMissing – when a value listed in expected_attr is missing in the LDAP object
LDAPObjectUnexpectedValue – if strict=True and a multi-value attribute of the LDAP object has more values than were listed in expected_attr or an not_expected_attr was found

univention.testing.utils.s4connector_present() → bool[source]#

univention.testing.utils.stop_s4connector() → None[source]#

univention.testing.utils.start_s4connector() → None[source]#

univention.testing.utils.restart_s4connector() → None[source]#

univention.testing.utils.stop_slapd() → None[source]#

univention.testing.utils.start_slapd() → None[source]#

univention.testing.utils.restart_slapd() → None[source]#

univention.testing.utils.stop_listener() → None[source]#

univention.testing.utils.start_listener() → None[source]#

univention.testing.utils.restart_listener() → None[source]#

univention.testing.utils.restart_firewall() → None[source]#

class univention.testing.utils.AutomaticListenerRestart[source]#

Bases: object

Automatically restart Univention Directory Listener when leaving the “with” block:

with AutomaticListenerRestart() as alr:
    with ucr_test.UCSTestConfigRegistry() as ucr:
        # set some ucr variables, that influence the Univention Directory Listener
        univention.config_registry.handler_set(['foo/bar=ding/dong'])

class univention.testing.utils.AutoCallCommand(enter_cmd: Sequence[str] | None = None, exit_cmd: Sequence[str] | None = None, stdout: IO[str] | None = None, stderr: IO[str] | None = None)[source]#

Bases: object

Automatically call the given commands when entering/leaving the “with” block. The keyword arguments enter_cmd and exit_cmd are optional:

with AutoCallCommand(
    enter_cmd=['/etc/init.d/dovecot', 'reload'],
    exit_cmd=['/etc/init.d/dovecot', 'restart']
) as acc:
    with ucr_test.UCSTestConfigRegistry() as ucr:
        # set some ucr variables, that influence the Univention Directory Listener
        univention.config_registry.handler_set(['foo/bar=ding/dong'])

In case some filedescriptors for stdout/stderr have to be passed to the executed command, they may be passed as kwarg:

with AutoCallCommand(
    enter_cmd=['/etc/init.d/dovecot', 'reload'],
    exit_cmd=['/etc/init.d/dovecot', 'restart'],
    stderr=open('/dev/zero', 'w')
) as acc:
    pass

class univention.testing.utils.FollowLogfile(logfiles: Iterable[str], always: bool = False)[source]#

Bases: object

Prints the contents of the listed files on exit of the with block if an exception occurred. Set always=True to also print them without exception. You may wish to make the server flush its logs before existing the with block. Use AutoCallCommand inside the block for that:

cmd = ('doveadm', 'log', 'reopen')
with FollowLogfile(logfiles=['/var/log/syslog', '/var/log/mail.log']):
    with utils.AutoCallCommand(enter_cmd=cmd, exit_cmd=cmd):
        pass

with FollowLogfile(logfiles=['/var/log/syslog'], always=True):
    with utils.AutoCallCommand(enter_cmd=cmd, exit_cmd=cmd):
        pass

Parameters:

logfiles – list of absolute filenames to read from
always – bool, if True: print logfile change also if no error occurred (default=False)

class univention.testing.utils.ReplicationType(value)[source]#

Bases: IntEnum

LISTENER = 1#

POSTRUN = 2#

S4C_FROM_UCS = 3#

S4C_TO_UCS = 4#

DRS = 5#

univention.testing.utils.wait_for_replication_from_master_openldap_to_local_samba(replication_postrun: bool = False, ldap_filter: str | None = None, verbose: bool = True) → None[source]#: Wait for all kind of replications

univention.testing.utils.wait_for_replication_from_local_samba_to_local_openldap(replication_postrun: bool = False, ldap_filter: str | None = None, verbose: bool = True) → None[source]#: Wait for all kind of replications

univention.testing.utils.wait_for(conditions: list[tuple[ReplicationType, Any]] | None = None, verbose: bool = True) → None[source]#: Wait for all kind of replications

univention.testing.utils.wait_for_drs_replication(*args: Any, **kwargs: Any) → None[source]#

univention.testing.utils.wait_for_listener_replication(verbose: bool = True) → None[source]#

univention.testing.utils.get_lid() → int[source]#: get_lid() returns the last processed notifier ID of univention-directory-listener.

univention.testing.utils.wait_for_listener_replication_and_postrun(verbose: bool = True) → None[source]#

univention.testing.utils.wait_for_s4connector_replication(verbose: bool = True) → None[source]#

univention.testing.utils.wait_for_replication(verbose: bool = True) → None#

univention.testing.utils.wait_for_replication_and_postrun(verbose: bool = True) → None#

univention.testing.utils.wait_for_connector_replication(verbose: bool = True) → None#

univention.testing.utils.package_installed(package: str) → bool[source]#

univention.testing.utils.fail(log_message: str | None = None, returncode: int = 1) → NoReturn[source]#

univention.testing.utils.uppercase_in_ldap_base() → bool[source]#

univention.testing.utils.is_udp_port_open(port: int, ip: str | None = None) → bool[source]#

univention.testing.utils.is_port_open(port: int, hosts: Iterable[str] | None = None, timeout: float = 60) → bool[source]#

check if port is open, if host == None check hostname and 127.0.0.1

Parameters:

port (int) – TCP port number
hosts (list[str] or None) – list of hostnames or localhost if hosts is None.

Returns:

True if at least on host is reachable, False otherwise.

Return type:

boolean

univention.testing.utils.no_change_in_file(no_change_for: int, log_file: str) → bool[source]#

univention.testing.utils.wait_for_s4_connector_to_be_inactive(no_change_for: int = 10) → None[source]#

Univention Corporate Server Python API 5.2 documentation

univention.testing package

Contents

univention.testing package#

Subpackages#

Submodules#

univention.testing.active_directory module#

univention.testing.apptest module#

univention.testing.codes module#

univention.testing.conftest module#

univention.testing.connector_common module#

univention.testing.coverage module#

univention.testing.data module#

univention.testing.debian_package module#

univention.testing.decorators module#

univention.testing.errors module#

univention.testing.fixtures_recyclebin module#

univention.testing.internal module#

univention.testing.ldap_glue module#

univention.testing.ldif module#

univention.testing.license_client module#

univention.testing.mail module#

univention.testing.network module#

univention.testing.pytest module#

univention.testing.strings module#

univention.testing.ucr module#

univention.testing.ucs_samba module#

univention.testing.udm module#

univention.testing.udm_extensions module#

univention.testing.umc module#

univention.testing.utils module#