Помощники

DomQuery

Tester\DomQuery Расширяет SimpleXMLElement, позволяя легко запрашивать HTML или XML с помощью CSS-селекторов.

# create DomQuery from HTML string
$dom = Tester\DomQuery::fromHtml('
	<article class="post">
		<h1>Title</h1>
		<div class="content">Text</div>
	</article>
');

# test element existence using CSS selectors
Assert::true($dom->has('article.post'));
Assert::true($dom->has('h1'));

# find elements as DomQuery array
$headings = $dom->find('h1');
Assert::same('Title', (string) $headings[0]);

# test if element matches selector (since version 2.5.3)
$content = $dom->find('.content')[0];
Assert::true($content->matches('div'));
Assert::false($content->matches('p'));

# find closest ancestor matching selector (since 2.5.5)
$article = $content->closest('.post');
Assert::true($article->matches('article'));

FileMock

Tester\FileMock эмулирует файлы в памяти, чтобы помочь вам протестировать код, который использует функции типа fopen(), file_get_contents() или parse_ini_file(). Например:

# Tested class
class Logger
{
	public function __construct(
		private string $logFile,
	) {
	}

	public function log(string $message): void
	{
		file_put_contents($this->logFile, $message . "\n", FILE_APPEND);
	}
}

# New empty file
$file = Tester\FileMock::create('');

$logger = new Logger($file);
$logger->log('Login');
$logger->log('Logout');

# Created content testing
Assert::same("Login\nLogout\n", file_get_contents($file));

Assert::with()

Это не утверждение, а помощник для тестирования приватных методов и свойств объектов.

class Entity
{
	private $enabled;
	// ...
}

$ent = new Entity;

Assert::with($ent, function () {
	Assert::true($this->enabled); // accessible private $ent->enabled
});

Helpers::purge()

Метод purge() создает указанный каталог и, если он уже существует, удаляет все его содержимое. Он удобен для создания временных каталогов. Например, в tests/bootstrap.php:

@mkdir(__DIR__ . '/tmp');  # @ - directory may already exist

define('TempDir', __DIR__ . '/tmp/' . getmypid());
Tester\Helpers::purge(TempDir);

Environment::lock()

Тесты запускаются параллельно. Иногда нам не нужно перекрывать время выполнения тестов. Обычно тесты баз данных нуждаются в подготовке содержимого базы данных, и им нужно, чтобы ничто не мешало им во время выполнения теста. В этих случаях мы используем Tester\Environment::lock($name, $dir):

Tester\Environment::lock('database', __DIR__ . '/tmp');

Первый аргумент – имя блокировки. Второй – путь к каталогу для сохранения блокировки. Сначала запускается тест, который получает блокировку. Остальные тесты должны подождать, пока он завершится.

Environment::bypassFinals()

Классы или методы, помеченные как final, трудно тестировать. Вызов Tester\Environment::bypassFinals() в начале тестирования приводит к тому, что ключевые слова final удаляются при загрузке кода.

require __DIR__ . '/bootstrap.php';

Tester\Environment::bypassFinals();

class MyClass extends NormallyFinalClass  # <-- NormallyFinalClass is not final anymore
{
	// ...
}

Environment::setup()

• улучшает читабельность дампа ошибок (включена раскраска), иначе выводится стандартная трассировка стека PHP
• позволяет проверить, что утверждения были вызваны в тесте, иначе тесты без (например, забытых) утверждений тоже пройдут
• автоматически запускает сборщик покрытия кода при использовании --coverage (описано позже)
• печатает статус OK или FAILURE в конце скрипта

Environment::setupFunctions()

Создает глобальные функции test(), testException(), setUp() и tearDown(), на которые можно разбить тесты.

test('описание теста', function () {
	Assert::same(123, foo());
	Assert::false(bar());
	// ...
});

Environment::VariableRunner

Позволяет узнать, был ли тест запущен напрямую или через Tester.

if (getenv(Tester\Environment::VariableRunner)) {
	# run by Tester
} else {
	# another way
}

Environment::VariableThread

Tester запускает тесты параллельно в заданном количестве потоков. Мы найдем номер потока в переменной окружения, когда нас это заинтересует:

echo "I'm running in a thread number " . getenv(Tester\Environment::VariableThread);