Spec-Zone.ru › Codeception

Утверждения

Установка

Если вы используете Codeception, установленный с помощью composer, установите этот модуль следующей командой:

composer require --dev codeception/module-asserts

В качестве альтернативы, вы можете включить Asserts модуль в файле конфигурации набора тестов и выполнить

codecept init upgrade4

Этот модуль был включён в Codeception 2 и 3, но с версии 4 его необходимо устанавливать отдельно.
Некоторые модули поставляются с файлами PHAR.
Предупреждение. Использование файла PHAR и composer в одном проекте может привести к непредвиденным ошибкам.

Описание

Специальный модуль для использования утверждений в ваших тестах.

Действия

assertArrayHasKey

Утверждает, что массив содержит указанный ключ.

  • param int|string $key
  • param array|ArrayAccess $array
  • param string $message

assertArrayNotHasKey

Утверждает, что массив не содержит указанный ключ.

  • param int|string $key
  • param array|ArrayAccess $array
  • param string $message

assertClassHasAttribute

Утверждает, что класс имеет указанный атрибут.

  • param string $attributeName
  • param string $className
  • param string $message

assertClassHasStaticAttribute

Утверждает, что класс имеет указанный статический атрибут.

  • param string $attributeName
  • param string $className
  • param string $message

assertClassNotHasAttribute

Утверждает, что класс не имеет указанный атрибут.

  • param string $attributeName
  • param string $className
  • param string $message

assertClassNotHasStaticAttribute

Утверждает, что класс не имеет указанный статический атрибут.

  • param string $attributeName
  • param string $className
  • param string $message

assertContains

Утверждает, что стог содержит иголку.

  • param $needle
  • param $haystack
  • param string $message

assertContainsEquals

  • param $needle
  • param $haystack
  • param string $message

assertContainsOnly

Утверждает, что стог содержит только значения заданного типа.

  • param string $type
  • param $haystack
  • param bool|null $isNativeType
  • param string $message

assertContainsOnlyInstancesOf

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

  • param string $className
  • param $haystack
  • param string $message

assertCount

Утверждает количество элементов массива, Countable или Traversable.

  • param int $expectedCount
  • param Countable|iterable $haystack
  • param string $message

assertDirectoryDoesNotExist

Утверждает, что директория не существует.

  • param string $directory
  • param string $message

assertDirectoryExists

Утверждает, что директория существует.

  • param string $directory
  • param string $message

assertDirectoryIsNotReadable

Утверждает, что директория существует и не читаема.

  • param string $directory
  • param string $message

assertDirectoryIsNotWritable

Утверждает, что директория существует и не записываема.

  • param string $directory
  • param string $message

assertDirectoryIsReadable

Утверждает, что директория существует и читаема.

  • param string $directory
  • param string $message

assertDirectoryIsWritable

Утверждает, что директория существует и записываема.

  • param string $directory
  • param string $message

assertDoesNotMatchRegularExpression

Утверждает, что строка не соответствует заданному регулярному выражению.

  • param string $pattern
  • param string $string
  • param string $message

assertEmpty

Утверждает, что переменная пустая.

  • param $actual
  • param string $message

assertEquals

Утверждает, что две переменные равны.

  • param $expected
  • param $actual
  • param string $message

assertEqualsCanonicalizing

Утверждает, что две переменные равны (канонизируя).

  • param $expected
  • param $actual
  • param string $message

assertEqualsIgnoringCase

Утверждает, что две переменные равны (без учёта регистра).

  • param $expected
  • param $actual
  • param string $message

assertEqualsWithDelta

Утверждает, что две переменные равны (с дельтой).

  • param $expected
  • param $actual
  • param float $delta
  • param string $message

assertFalse

Утверждает, что условие ложно.

  • param $condition
  • param string $message

assertFileDoesNotExist

Утверждает, что файл не существует.

  • param string $filename
  • param string $message

assertFileEquals

Утверждает, что содержимое одного файла равно содержимому другого файла.

  • param string $expected
  • param string $actual
  • param string $message

assertFileEqualsCanonicalizing

Утверждает, что содержимое одного файла равно содержимому другого файла (канонизируя).

  • param $expected
  • param $actual
  • param string $message

assertFileEqualsIgnoringCase

Утверждает, что содержимое одного файла равно содержимому другого файла (без учёта регистра).

  • param $expected
  • param $actual
  • param string $message

assertFileExists

Утверждает, что файл существует.

  • param string $filename
  • param string $message

assertFileIsNotReadable

Утверждает, что файл существует и не читаем.

  • param string $file
  • param string $message

assertFileIsNotWritable

Утверждает, что файл существует и не записываем.

  • param string $file
  • param string $message

assertFileIsReadable

Утверждает, что файл существует и читаем.

  • param string $file
  • param string $message

assertFileIsWritable

Утверждает, что файл существует и записываем.

  • param string $file
  • param string $message

assertFileNotEquals

Утверждает, что содержимое одного файла не равно содержимому другого файла.

  • param $expected
  • param $actual
  • param string $message

assertFileNotEqualsCanonicalizing

Утверждает, что содержимое одного файла не равно содержимому другого файла (канонизируя).

  • param $expected
  • param $actual
  • param string $message

assertFileNotEqualsIgnoringCase

Утверждает, что содержимое одного файла не равно содержимому другого файла (без учёта регистра).

  • param $expected
  • param $actual
  • param string $message

assertFileNotExists

Утверждает, что файл не существует.

  • param string $filename
  • param string $message

assertFinite

Утверждает, что переменная конечна.

  • param $actual
  • param string $message

assertGreaterOrEquals

Утверждает, что значение больше или равно другому значению.

  • param $expected
  • param $actual
  • param string $message

assertGreaterThan

Утверждает, что значение больше другого значения.

  • param $expected
  • param $actual
  • param string $message

assertGreaterThanOrEqual

Утверждает, что значение больше или равно другому значению.

  • param $expected
  • param $actual
  • param string $message

assertInfinite

Утверждает, что переменная бесконечна.

  • param $actual
  • param string $message

assertInstanceOf

Утверждает, что переменная является заданного типа.

  • param $expected
  • param $actual
  • param string $message

assertIsArray

Утверждает, что переменная имеет тип массив.

  • param $actual
  • param string $message

assertIsBool

Утверждает, что переменная имеет тип bool.

  • param $actual
  • param string $message

assertIsCallable

Утверждает, что переменная имеет тип callable.

  • param $actual
  • param string $message

assertIsClosedResource

Проверяет, что переменная имеет тип ресурс и закрыта.

  • param $actual
  • param string $message

assertIsEmpty

Проверяет, что переменная пуста.

  • param $actual
  • param string $message

assertIsFloat

Проверяет, что переменная имеет тип float.

  • param $actual
  • param string $message

assertIsInt

Проверяет, что переменная имеет тип int.

  • param $actual
  • param string $message

assertIsIterable

Проверяет, что переменная имеет тип итерируемый.

  • param $actual
  • param string $message

assertIsNotArray

Проверяет, что переменная не имеет тип массив.

  • param $actual
  • param string $message

assertIsNotBool

Проверяет, что переменная не имеет тип bool.

  • param $actual
  • param string $message

assertIsNotCallable

Проверяет, что переменная не имеет тип вызываемый.

  • param $actual
  • param string $message

assertIsNotClosedResource

Проверяет, что переменная не имеет тип ресурс.

  • param $actual
  • param string $message

assertIsNotFloat

Проверяет, что переменная не имеет тип float.

  • param $actual
  • param string $message

assertIsNotInt

Проверяет, что переменная не имеет тип int.

  • param $actual
  • param string $message

assertIsNotIterable

Проверяет, что переменная не имеет тип итерируемый.

  • param $actual
  • param string $message

assertIsNotNumeric

Проверяет, что переменная не имеет тип числовой.

  • param $actual
  • param string $message

assertIsNotObject

Проверяет, что переменная не имеет тип объект.

  • param $actual
  • param string $message

assertIsNotReadable

Проверяет, что файл/директория существует и не является читаемым.

  • param string $filename
  • param string $message

assertIsNotResource

Проверяет, что переменная не имеет тип ресурс.

  • param $actual
  • param string $message

assertIsNotScalar

Проверяет, что переменная не имеет тип скалярный.

  • param $actual
  • param string $message

assertIsNotString

Проверяет, что переменная не имеет тип строка.

  • param $actual
  • param string $message

assertIsNotWritable

Проверяет, что файл/директория существует и не является записью.

  • param $filename
  • param string $message

assertIsNumeric

Проверяет, что переменная имеет тип числовой.

  • param $actual
  • param string $message

assertIsObject

Проверяет, что переменная имеет тип объект.

  • param $actual
  • param string $message

assertIsReadable

Проверяет, что файл/директория является читаемым.

  • param $filename
  • param string $message

assertIsResource

Проверяет, что переменная имеет тип ресурс.

  • param $actual
  • param string $message

assertIsScalar

Проверяет, что переменная имеет тип скалярный.

  • param $actual
  • param string $message

assertIsString

Проверяет, что переменная имеет тип строка.

  • param $actual
  • param string $message

assertIsWritable

Проверяет, что файл/директория существует и является записью.

  • param $filename
  • param string $message

assertJson

Проверяет, что строка является валидным JSON.

  • param string $actualJson
  • param string $message

assertJsonFileEqualsJsonFile

Проверяет, что два JSON файла равны.

  • param string $expectedFile
  • param string $actualFile
  • param string $message

assertJsonFileNotEqualsJsonFile

Проверяет, что два JSON файла не равны.

  • param string $expectedFile
  • param string $actualFile
  • param string $message

assertJsonStringEqualsJsonFile

Проверяет, что сгенерированный JSON объект и содержимое данного файла равны.

  • param string $expectedFile
  • param string $actualJson
  • param string $message

assertJsonStringEqualsJsonString

Проверяет, что два данных JSON объекта или массива равны.

  • param string $expectedJson
  • param string $actualJson
  • param string $message

assertJsonStringNotEqualsJsonFile

Проверяет, что сгенерированный JSON объект и содержимое данного файла не равны.

  • param string $expectedFile
  • param string $actualJson
  • param string $message

assertJsonStringNotEqualsJsonString

Проверяет, что два данных JSON объекта или массива не равны.

  • param string $expectedJson
  • param string $actualJson
  • param string $message

assertLessOrEquals

Проверяет, что значение меньше или равно другому значению.

  • param $expected
  • param $actual
  • param string $message

assertLessThan

Проверяет, что значение меньше другого значения.

  • param $expected
  • param $actual
  • param string $message

assertLessThanOrEqual

Проверяет, что значение меньше или равно другому значению.

  • param $expected
  • param $actual
  • param string $message

assertMatchesRegularExpression

Проверяет, что строка соответствует заданному регулярному выражению.

  • param string $pattern
  • param string $string
  • param string $message

assertNan

Проверяет, что переменная является nan.

  • param $actual
  • param string $message

assertNotContains

Проверяет, что стог не содержит иглу.

  • param $needle
  • param $haystack
  • param string $message

assertNotContainsEquals

не документировано

assertNotContainsOnly

Проверяет, что стог не содержит только значения заданного типа.

  • param string $type
  • param $haystack
  • param bool|null $isNativeType
  • param string $message

assertNotCount

Проверяет количество элементов массива, Countable или Traversable.

  • param int $expectedCount
  • param Countable|iterable $haystack
  • param string $message

assertNotEmpty

Проверяет, что переменная не пуста.

  • param $actual
  • param string $message

assertNotEquals

Проверяет, что две переменные не равны.

  • param $expected
  • param $actual
  • param string $message

assertNotEqualsCanonicalizing

Проверяет, что две переменные не равны (канонизируя).

  • param $expected
  • param $actual
  • param string $message

assertNotEqualsIgnoringCase

Проверяет, что две переменные не равны (без учёта регистра).

  • param $expected
  • param $actual
  • param string $message

assertNotEqualsWithDelta

Проверяет, что две переменные не равны (с дельтой).

  • param $expected
  • param $actual
  • param float $delta
  • param string $message

assertNotFalse

Проверяет, что условие не ложно.

  • param $condition
  • param string $message

assertNotInstanceOf

Проверяет, что переменная не имеет указанного типа.

  • param $expected
  • param $actual
  • param string $message

assertNotNull

Проверяет, что переменная не равна null.

  • param $actual
  • param string $message

assertNotRegExp

Проверяет, что строка не соответствует заданному регулярному выражению.

  • param string $pattern
  • param string $string
  • param string $message

assertNotSame

Проверяет, что две переменные не имеют одинакового типа и значения.

  • param $expected
  • param $actual
  • param string $message

assertNotSameSize

Утверждает, что размер двух массивов (или Countable или Traversable объектов) не совпадает.

  • param Countable|iterable $expected
  • param Countable|iterable $actual
  • param string $message

assertNotTrue

Утверждает, что условие не истинно.

  • param $condition
  • param string $message

assertNull

Утверждает, что переменная равна null.

  • param $actual
  • param string $message

assertObjectHasAttribute

Утверждает, что объект имеет указанное свойство.

  • param string $attributeName
  • param object $object
  • param string $message

assertObjectNotHasAttribute

Утверждает, что объект не имеет указанного свойства.

  • param string $attributeName
  • param object $object
  • param string $message

assertRegExp

Утверждает, что строка соответствует заданному регулярному выражению.

  • param string $pattern
  • param string $string
  • param string $message

assertSame

Утверждает, что две переменные имеют одинаковый тип и значение.

  • param $expected
  • param $actual
  • param string $message

assertSameSize

Утверждает, что размер двух массивов (или Countable или Traversable объектов) одинаков.

  • param Countable|iterable $expected
  • param Countable|iterable $actual
  • param string $message

assertStringContainsString

  • param string $needle
  • param string $haystack
  • param string $message

assertStringContainsStringIgnoringCase

не документировано

assertStringEndsNotWith

Утверждает, что строка не заканчивается заданным суффиксом.

  • param string $suffix
  • param string $string
  • param string $message

assertStringEndsWith

Утверждает, что строка заканчивается заданным суффиксом.

  • param string $suffix
  • param string $string
  • param string $message

assertStringEqualsFile

Утверждает, что содержимое строки равно содержимому файла.

  • param string $expectedFile
  • param string $actualString
  • param string $message

assertStringEqualsFileCanonicalizing

Утверждает, что содержимое строки равно содержимому файла (канонизируя).

  • param string $expectedFile
  • param string $actualString
  • param string $message

assertStringEqualsFileIgnoringCase

Утверждает, что содержимое строки равно содержимому файла (без учёта регистра).

  • param string $expectedFile
  • param string $actualString
  • param string $message

assertStringMatchesFormat

Утверждает, что строка соответствует заданному формату строки.

  • param string $format
  • param string $string
  • param string $message

assertStringMatchesFormatFile

Утверждает, что строка соответствует заданному формату файла.

  • param string $formatFile
  • param string $string
  • param string $message

assertStringNotContainsString

  • param string $needle
  • param string $haystack
  • param string $message

assertStringNotContainsStringIgnoringCase

  • param string $needle
  • param string $haystack
  • param string $message

assertStringNotEqualsFile

Утверждает, что содержимое строки не равно содержимому файла.

  • param string $expectedFile
  • param string $actualString
  • param string $message

assertStringNotEqualsFileCanonicalizing

Утверждает, что содержимое строки не равно содержимому файла (канонизируя).

  • param string $expectedFile
  • param string $actualString
  • param string $message

assertStringNotEqualsFileIgnoringCase

Утверждает, что содержимое строки не равно содержимому файла (без учёта регистра).

  • param string $expectedFile
  • param string $actualString
  • param string $message

assertStringNotMatchesFormat

Утверждает, что строка не соответствует заданному формату строки.

  • param string $format
  • param string $string
  • param string $message

assertStringNotMatchesFormatFile

Утверждает, что строка не соответствует заданному формату файла.

  • param string $formatFile
  • param string $string
  • param string $message

assertStringStartsNotWith

Утверждает, что строка не начинается с заданного префикса.

  • param string $prefix
  • param string $string
  • param string $message

assertStringStartsWith

Утверждает, что строка начинается с заданного префикса.

  • param string $prefix
  • param string $string
  • param string $message

assertThat

Оценивает объект матчера PHPUnit\Framework\Constraint.

  • param $value
  • param Constraint $constraint
  • param string $message

assertThatItsNot

Оценивает объект матчера PHPUnit\Framework\Constraint.

  • param $value
  • param Constraint $constraint
  • param string $message

assertTrue

Утверждает, что условие истинно.

  • param $condition
  • param string $message

assertXmlFileEqualsXmlFile

Утверждает, что два XML файла равны.

  • param string $expectedFile
  • param string $actualFile
  • param string $message

assertXmlFileNotEqualsXmlFile

Утверждает, что два XML файла не равны.

  • param string $expectedFile
  • param string $actualFile
  • param string $message

assertXmlStringEqualsXmlFile

Утверждает, что два XML документа равны.

  • param string $expectedFile
  • param DOMDocument|string $actualXml
  • param string $message

assertXmlStringEqualsXmlString

Утверждает, что два XML документа равны.

  • param DOMDocument|string $expectedXml
  • param DOMDocument|string $actualXml
  • param string $message

assertXmlStringNotEqualsXmlFile

Утверждает, что два XML документа не равны.

  • param string $expectedFile
  • param DOMDocument|string $actualXml
  • param string $message

assertXmlStringNotEqualsXmlString

Утверждает, что два XML документа не равны.

  • param DOMDocument|string $expectedXml
  • param DOMDocument|string $actualXml
  • param string $message

expectException

Обрабатывает и проверяет исключение, вызываемое внутри функции обратного вызова. Должен быть предоставлен либо имя класса исключения, либо экземпляр исключения.

<?php
$I->expectException(MyException::class, function() {
    $this->doSomethingBad();
});

$I->expectException(new MyException(), function() {
    $this->doSomethingBad();
});

Если нужно проверить сообщение или код исключения, можно передать их с экземпляром исключения:

<?php
// will check that exception MyException is thrown with "Don't do bad things" message
$I->expectException(new MyException("Don't do bad things"), function() {
    $this->doSomethingBad();
});

@deprecated Используйте expectThrowable() вместо этого

  • param \Exception|string $exception
  • param callable $callback

expectThrowable

Обрабатывает и проверяет исключительные ситуации (исключения/ошибки), вызываемые внутри функции обратного вызова. Должен быть предоставлен либо имя класса исключения, либо экземпляр исключения.

<?php
$I->expectThrowable(MyThrowable::class, function() {
    $this->doSomethingBad();
});

$I->expectThrowable(new MyException(), function() {
    $this->doSomethingBad();
});

Если нужно проверить сообщение или код исключения, можно передать их с экземпляром исключения:

<?php
// will check that throwable MyError is thrown with "Don't do bad things" message
$I->expectThrowable(new MyError("Don't do bad things"), function() {
    $this->doSomethingBad();
});
  • param \Throwable|string $throwable
  • param callable $callback

fail

Прерывает тест с указанным сообщением.

  • param string $message

markTestIncomplete

Отметить тест как неполный.

  • param string $message

markTestSkipped

Отметить тест как пропущенный.

  • param string $message

© 2011 Michael Bodnarchuk and contributors
Licensed under the MIT License.
https://codeception.com/docs/modules/Asserts

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API