Skip to content

Latest commit

 

History

History
292 lines (160 loc) · 5.26 KB

Asserts.md

File metadata and controls

292 lines (160 loc) · 5.26 KB
layout title
doc
Asserts - Codeception - Documentation

Special module for using asserts in your tests.

assertArrayHasKey

  • param $key
  • param $actual
  • param $description

assertArrayNotHasKey

  • param $key
  • param $actual
  • param $description

assertContains

Checks that haystack contains needle

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

assertEmpty

Checks that variable is empty.

  • param $actual
  • param string $message

assertEquals

Checks that two variables are equal.

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

assertFalse

Checks that condition is negative.

  • param $condition
  • param string $message

assertFileExists

Checks if file exists

  • param string $filename
  • param string $message

assertFileNotExists

Checks if file doesn't exist

  • param string $filename
  • param string $message

assertGreaterOrEquals

  • param $expected
  • param $actual
  • param $description

assertGreaterThan

Checks that actual is greater than expected

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

assertGreaterThanOrEqual

Checks that actual is greater or equal than expected

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

assertGreaterThen

  • deprecated

assertGreaterThenOrEqual

  • deprecated

assertInstanceOf

  • param $class
  • param $actual
  • param $description

assertInternalType

  • param $type
  • param $actual
  • param $description

assertIsEmpty

  • param $actual
  • param $description

assertLessOrEquals

  • param $expected
  • param $actual
  • param $description

assertLessThan

Checks that actual is less than expected

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

assertLessThanOrEqual

Checks that actual is less or equal than expected

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

assertNotContains

Checks that haystack doesn't contain needle.

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

assertNotEmpty

Checks that variable is not empty.

  • param $actual
  • param string $message

assertNotEquals

Checks that two variables are not equal

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

assertNotInstanceOf

  • param $class
  • param $actual
  • param $description

assertNotNull

Checks that variable is not NULL

  • param $actual
  • param string $message

assertNotRegExp

Checks that string not match with pattern

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

assertNotSame

Checks that two variables are not same

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

assertNull

Checks that variable is NULL

  • param $actual
  • param string $message

assertRegExp

Checks that string match with pattern

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

assertSame

Checks that two variables are same

  • param $expected
  • param $actual
  • param string $message
  • return mixed|void

assertTrue

Checks that condition is positive.

  • param $condition
  • param string $message

expectException

Handles and checks exception called inside callback function. Either exception class name or exception instance should be provided.

{% highlight php %}

expectException(MyException::class, function() { $this->doSomethingBad(); }); $I->expectException(new MyException(), function() { $this->doSomethingBad(); }); {% endhighlight %} If you want to check message or exception code, you can pass them with exception instance: {% highlight php %} expectException(new MyException("Don't do bad things"), function() { $this->doSomethingBad(); }); {% endhighlight %} * `param` $exception string or \Exception * `param` $callback #### fail Fails the test with message. * `param` $message

 

Module reference is taken from the source code. Help us to improve documentation. Edit module reference