Skip to content

AuthTest

Test class containing the test for the Hubzilla authentication code.

Since the main authentication code is executed in the global scope on inclusion of the includes/auth.php file, we need to run each test in a separate process to make sure we can excersize the code as we need.

Methods

test_mfa_is_not_checked_for_excluded_modules

Check that mfa status is not checked for certain modules.

public test_mfa_is_not_checked_for_excluded_modules(string $module, array $args): void

This causes issues with things like WebDAV and CardDAV, as there's currently no way for these modules to signal that a TOTP code is needed back to the connecting client.

Parameters:

Parameter Type Description
$module string
$args array

modules_excluded_from_mfa

Data provider for testing modules excluded from mfa

public static modules_excluded_from_mfa(): array
  • This method is static.

create_session_stub

private create_session_stub(): \Zotlabs\Web\Session

Inherited methods

setup_test_db

Connect to the test db, load fixtures and global config.

protected setup_test_db(): void

This function is executed before every test.

The transaction is rolled back in the cleanup_test_db() function that's executed after every test.

init_app

Initialize the global App properties.

protected init_app(): void

cleanup_test_db

Roll back test database to it's original state, cleaning up any changes from the test.

protected cleanup_test_db(): void

This function is executes after evert tests.

connect_to_test_db

Connect to the test database,

protected connect_to_test_db(): void

By default it will connect to a MySQL database with the following settings:

  • HZ_TEST_DB_HOST: db
  • HZ_TEST_DB_PORT: default
  • HZ_TEST_DB_USER: test_user
  • HZ_TEST_DB_PASS: hubzilla
  • HZ_TEST_DB_DATABASE: hubzilla_test_db
  • HZ_TEST_DB_TYPE: mysql (can also be "postgres")
  • HZ_TEST_DB_CHARSET: UTF8

All of these settings can be overridden by the test runner by setting ENV vars named as above with the values you want to override.

dbtype

Return the database type from a string.

private static dbtype(string $type): \Zotlabs\Tests\Unit\The
  • This method is static.

Parameters:

Parameter Type Description
$type string The database type, can be either mysql or postgres.

Return Value:

database type constant matching the passed in type, or DBTYPE_MYSQL if $type is empty or invalid.

loadFixtures

Load database fixtures from the fixture path.

private loadFixtures(): void

loadFixture

Load database fixtures from a specific file.

private loadFixture(string $file): void

The file must be a yaml file named the same as the table in the database it should populate.

The file also need to have a root key with the same name as the table. Under which it contains an array of rows that should be inserted into the db table.

Parameters:

Parameter Type Description
$file string The path and filename of the fixture to load.
The path name is relative to the current working
directory of the process, which should normally
be the Hubzilla root directory.

Automatically generated on 2025-03-18