PHPUnit assertIsIterable() Function

The assertIsIterable() function is a builtin function in PHPUnit and is used to assert whether the given variable is Iterable or not. This assertion will return true in the case if the given variable is Iterable else returns false. In case of true the asserted test case got passed else test case got failed.

Syntax:

assertIsIterable($actual[, $message = ''])

Parameters: This function accepts two parameters as mentioned above and described below:

• $variable: This parameter is of any type of variable which represents the actual data.
• $message: This parameter takes a string value. When the test case got failed this string message got displayed as an error message.

Below examples illustrate the assertIsIterable() function in PHPUnit:

Example 1: 

PHP

<?php
use PHPUnit\Framework\TestCase;

class GeeksPhpunitTestCase extends TestCase
{
    public function testNegativeTestcaseForassertIsIterable()
    {
       $variable = "[1, 2, 3]";
        // Assert function to test whether assert
        //  variable is Iterable or not
        $this->assertIsIterable(
            $variable,
            "assert variable is Iterable or not"
        );

    }

 }
?>

Output:

PHPUnit 8.5.8 by Sebastian Bergmann and contributors.

F                                                   1 / 1 (100%)

Time: 89 ms, Memory: 10.00 MB

There was 1 failure:

1) GeeksPhpunitTestCase::testPositiveTestcaseForassertIsIterable
assert variable is Iterable or not
Failed asserting that '[1, 2, 3]' is of type "iterable".

/home/lovely/Documents/php/test.php:14

FAILURES!
Tests: 1, Assertions: 1, Failures: 1.

Example 2:

PHP

<?php
use PHPUnit\Framework\TestCase;

class GeeksPhpunitTestCase extends TestCase
{
    public function testPositiveTestcaseForassertIsIterable()
    {
       $variable = [1, 2, 3];
         // Assert function to test whether assert
        //  variable is Iterable or not
        $this->assertIsIterable(
            $variable,
            "assert variable is Iterable or not"
        );

    }

 }
?>

Output:

PHPUnit 8.5.8 by Sebastian Bergmann and contributors.

.                                                  1 / 1 (100%)

Time: 89 ms, Memory: 10.00 MB

OK (1 test, 1 assertion)

Reference: https://phpunit.readthedocs.io/en/9.2/assertions.html#assertisiterable