PHPUnit assertFileExists() Function

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

Syntax:

assertFileExists(string $filename[, string $message = ''])

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

• $filename: This parameter is a string that denotes the File path.
• $message: This parameter takes a string value. When the test case got failed this string message got displayed as an error message.

Below programs illustrate the assertFileExists() function in PHPUnit:

Example 1:

<?php 
use PHPUnit\Framework\TestCase; 
  
class GeeksPhpunitTestCase extends TestCase 
{ 
    public function testNegativeTestcaseForAssertFileExists() 
    { 
        $filename = "/home/Documents/geeksDoesNotExist/"; 
  
        // Assert function to test whether given 
        // file path exists or not 
        $this->assertFileExists( 
            $filename, 
            "given filename doesn't exists"
        ); 
    } 
} 
  
?> 

Output:

PHPUnit 8.5.8 by Sebastian Bergmann and contributors.

F                                             1 / 1 (100%)

Time: 391 ms, Memory: 10.00 MB

There was 1 failure:

1) GeeksPhpunitTestCase::testNegativeTestcaseForAssertFileExists
given filename doesn't exists
Failed asserting that file "/home/Documents/geeksDoesNotExist/" exists.

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

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

Example 2:

<?php 
use PHPUnit\Framework\TestCase; 
  
class GeeksPhpunitTestCase extends TestCase 
{ 
    public function testPositiveTestcaseForAssertFileExists() 
    { 
        $filename = "/home/bittu/Documents/php/"; 
  
        // Assert function to test whether given 
        // file name exists or not 
        $this->assertFileExists( 
            $filename, 
            "filename doesn't exists"
        ); 
    } 
} 
  
?> 

Output:

PHPUnit 8.5.8 by Sebastian Bergmann and contributors.

.                                             1 / 1 (100%)

Time: 88 ms, Memory: 10.00 MB

OK (1 test, 1 assertion)

Reference: https://phpunit.readthedocs.io/en/8.2/assertions.html#assertfileexists