Open In App

PHPUnit assertStringEndsWith() Function

Improve
Improve
Like Article
Like
Save
Share
Report

The assertStringEndsWith() function is a builtin function in PHPUnit and is used to assert whether the actual string ends with expected suffix string or not. This assertion will return true in the case if the expected suffix string ends with actual string else returns false. In case of true the asserted test case got passed else test case got failed.

Syntax:

assertStringEndsWith(string $suffix, string $string
[, string $message = ''])

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

  • $expectedsuffix: This parameter is of any type which represents the expected suffix string.
  • $actualstring: This parameter is of any type which represents the actual string.
  • $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 assertStringEndsWith() function in PHPUnit:

Example 1:

PHP




<?php 
use PHPUnit\Framework\TestCase; 
    
class GeeksPhpunitTestCase extends TestCase 
    public function testNegativeTestcaseForassertStringEndsWith()
    
        $expectedsuffix = ('thh');
        $actualstring = ('4th');
    
        // Assert function to test whether 
        // expected suffix string ends with
        // actual string content
        $this->assertStringEndsWith(
            $expectedsuffix,
            $actualstring
            "actual string content ends with expected 
             suffix content"
        ); 
    
    
?>


Output:

PHPUnit 8.5.8 by Sebastian Bergmann and contributors.

F                                                             1 / 1 (100%)

Time: 90 ms, Memory: 10.00 MB

There was 1 failure:

1) GeeksPhpunitTestCase::testPositiveTestcaseForassertStringNotEqualsFile
actual string content ends with expected suffix content
Failed asserting that '4th' ends with "thh".

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

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

Example 2:

PHP




<?php 
use PHPUnit\Framework\TestCase; 
    
class GeeksPhpunitTestCase extends TestCase 
    public function testPositiveTestcaseForassertStringEndsWith()
    
        $expectedsuffix = ('th');
        $actualstring = ('4th');
    
        // Assert function to test whether 
        // expected suffix
        // string ends with actual string content
        $this->assertStringEndsWith(
            $expectedsuffix,
            $actualstring
            "actual string content ends with 
             expected suffix content"
        ); 
    
    
?>


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/9.2/assertions.html#assertstringendswith



Last Updated : 07 Aug, 2020
Like Article
Save Article
Previous
Next
Share your thoughts in the comments
Similar Reads