PHPUnit | assertDirectoryExists() Function

The assertDirectoryExists() function is a builtin function in PHPUnit and is used to assert whether an directory path exists or not. This assertion will return true in the case if given directory path exists else return false. In case of true the asserted test case got passed else test case got failed.

Syntax:

assertDirectoryExists( integer $directory, string $message = '' )

Parameters: This function accepts two parameters as shown in the above syntax. The parameters are described below:

• $directory: This parameter is a string which denotes the directory path.
• $message: This parameter takes string value. When the testcase got failed this string message got displayed as error message.

Below programs illustrate the assertDirectoryExists() function in PHPUnit:

Program 1:

<?php
use PHPUnit\Framework\TestCase;

class GeeksPhpunitTestCase extends TestCase
{
    public function testNegativeTestcaseForAssertDirectoryExists()
    {
        $directoryPath = "/home/shivam/Documents/geeksDoesNotExist/";

        // Assert function to test whether given
        // directory path exists or not
        $this->assertDirectoryExists(
            $directoryPath,
            "directoryPath doesn't exists"
        );
    }
}

?>

Output:

PHPUnit 8.2.5 by Sebastian Bergmann and contributors.

F                                                                   1 / 1 (100%)

Time: 68 ms, Memory: 10.00 MB

There was 1 failure:

1) GeeksPhpunitTestCase::testNegativeTestcaseForAssertDirectoryExists
directoryPath doesn't exists
Failed asserting that directory "/home/shivam/Documents/geeksDoesNotExist/" exists.

/home/shivam/Documents/geeks/phpunit/abc.php:13

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

Program 2:

<?php
use PHPUnit\Framework\TestCase;

class GeeksPhpunitTestCase extends TestCase
{
    public function testPositiveTestcaseForAssertDirectoryExists()
    {
        $directoryPath = "/home/shivam/Documents/geeks/";

        // Assert function to test whether given
        // directory path exists or not
        $this->assertDirectoryExists(
            $directoryPath,
            "directoryPath exists"
        );
    }
}

?>

Output:

PHPUnit 8.2.5 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 67 ms, Memory: 10.00 MB

OK (1 test, 1 assertion)

Note: To run testcases with phpunit follow steps from here. Also, assertDirectoryExists() is supported by phpunit 7 and above.