PHPUnit | assertArraySubset() function

The assertArraySubset() function is a builtin function in PHPUnit and is used to assert an array having a subset.This assertion will return true in the case if the array contains the provided subset else return false and in case of true the asserted test case got passed else test case got failed.

Syntax:

assertArraySubset(array $subset, array $array[, bool $strict = false, string $message = ''])

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



  1. $subset: This parameter represents the subset to be contained in array.
  2. $array: This parameter is a array for which the assert function will check whether it contains subset or not.
  3. $strict: This parameter is a flag used to compare the identity of objects within arrays.
  4. $message: This parameter takes string value. When the testcase got failed this string message got displayed as error message.

Below programs illustrate the assertArraySubset() function:

Program 1:

filter_none

edit
close

play_arrow

link
brightness_4
code

<?php
use PHPUnit\Framework\TestCase;
  
class GeeksPhpunitTestCase extends TestCase
{
    public function testNegativeTestcaseForArraySubset()
    {
        $testArray = array("a"=>"value b", "b" =>" value b");
        $subset = array("a"=> "value a"); 
        // assert function to test whether 'subset' is a subset of array
        $this->assertArraySubset($subset, $testArray, false, "testArray doesn't contains subset as subset") ;
    }
}
  
?>

chevron_right


Output:

PHPUnit 6.5.5 by Sebastian Bergmann and contributors.

F                                                                   1 / 1 (100%)

Time: 29 ms, Memory: 4.00MB

There was 1 failure:

1) GeeksPhpunitTestCase::testNegativeTestcaseForArraySubset
testArray doesn't contains subset as subset
Failed asserting that an array has the subset Array &0 (
    'a' => 'value a'
).
--- Expected
+++ Actual
@@ @@
 Array
 (
-    [a] => value a
+    [a] => value b

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

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

Program 2:

filter_none

edit
close

play_arrow

link
brightness_4
code

<?php
use PHPUnit\Framework\TestCase;
  
class GeeksPhpunitTestCase extends TestCase
{
    public function testPositiveTestcaseForArraySubset()
    {
        $testArray = array("a"=>"value a", "b" =>" value b");
        $subset = array("a"=> "value a"); 
        // assert function to test whether 'subset' is a subset of array
        $this->assertArraySubset($subset, $testArray, false, "testArray doesn't contains subset as subset") ;
    }
}
?>

chevron_right


Output:

PHPUnit 6.5.5 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 21 ms, Memory: 4.00MB

OK (1 test, 1 assertion)

Note : To run testcases with phpunit follow steps from here.



My Personal Notes arrow_drop_up

Discovering ways to develop a plane for soaring career goals

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.




Article Tags :
Practice Tags :


Be the First to upvote.


Please write to us at contribute@geeksforgeeks.org to report any issue with the above content.