PHPUnit:断言两个数组相等,但元素的顺序并不重要

问题描述 投票:116回答:15

当数组中元素的顺序不重要或甚至可能发生变化时,断言两个对象数组相等的好方法是什么?

php unit-testing phpunit assert
15个回答
33
投票

最简单的方法是使用新的断言方法扩展phpunit。但现在这是一个更简单的方法。未经测试的代码,请验证:

你应用中的某个地方:

 /**
 * Determine if two associative arrays are similar
 *
 * Both arrays must have the same indexes with identical values
 * without respect to key ordering 
 * 
 * @param array $a
 * @param array $b
 * @return bool
 */
function arrays_are_similar($a, $b) {
  // if the indexes don't match, return immediately
  if (count(array_diff_assoc($a, $b))) {
    return false;
  }
  // we know that the indexes, but maybe not values, match.
  // compare the values between the two arrays
  foreach($a as $k => $v) {
    if ($v !== $b[$k]) {
      return false;
    }
  }
  // we have identical indexes, and no unequal values
  return true;
}

在你的测试中:

$this->assertTrue(arrays_are_similar($foo, $bar));

4
投票

即使您不关心订单,也可能更容易将其考虑在内:

尝试:

asort($foo);
asort($bar);
$this->assertEquals($foo, $bar);

2
投票

给定的解决方案对我来说不起作用,因为我希望能够处理多维数组并清楚地了解两个数组之间的不同之处。

这是我的功能

public function assertArrayEquals($array1, $array2, $rootPath = array())
{
    foreach ($array1 as $key => $value)
    {
        $this->assertArrayHasKey($key, $array2);

        if (isset($array2[$key]))
        {
            $keyPath = $rootPath;
            $keyPath[] = $key;

            if (is_array($value))
            {
                $this->assertArrayEquals($value, $array2[$key], $keyPath);
            }
            else
            {
                $this->assertEquals($value, $array2[$key], "Failed asserting that `".$array2[$key]."` matches expected `$value` for path `".implode(" > ", $keyPath)."`.");
            }
        }
    }
}

然后使用它

$this->assertArrayEquals($array1, $array2, array("/"));

1
投票

我写了一些简单的代码来首先从多维数组中获取所有键:

 /**
 * Returns all keys from arrays with any number of levels
 * @param  array
 * @return array
 */
protected function getAllArrayKeys($array)
{
    $keys = array();
    foreach ($array as $key => $element) {
        $keys[] = $key;
        if (is_array($array[$key])) {
            $keys = array_merge($keys, $this->getAllArrayKeys($array[$key]));
        }
    }
    return $keys;
}

然后测试它们的结构是否相同,无论键的顺序如何:

    $expectedKeys = $this->getAllArrayKeys($expectedData);
    $actualKeys = $this->getAllArrayKeys($actualData);
    $this->assertEmpty(array_diff($expectedKeys, $actualKeys));

HTH


0
投票

如果值只是int或字符串,并且没有多级数组....

为什么不只是排序数组,将它们转换为字符串...

    $mapping = implode(',', array_sort($myArray));

    $list = implode(',', array_sort($myExpectedArray));

...然后比较字符串:

    $this->assertEquals($myExpectedArray, $myArray);

-1
投票

如果您只想测试数组的值,您可以执行以下操作:

$this->assertEquals(array_values($arrayOne), array_values($arrayTwo));

-3
投票

另一种选择,就好像你还没有足够的,是将assertArraySubsetassertCount结合起来进行断言。所以,你的代码看起来像。

self::assertCount(EXPECTED_NUM_ELEMENT, $array); self::assertArraySubset(SUBSET, $array);

这样您就可以独立于订单,但仍然断言所有元素都存在。


167
投票

您可以使用在PHPUnit 7.5中添加的assertEqualsCanonicalizing方法。如果使用此方法比较数组,这些数组将按PHPUnit数组比较器本身进行排序。

代码示例:

class ArraysTest extends \PHPUnit\Framework\TestCase
{
    public function testEquality()
    {
        $obj1 = $this->getObject(1);
        $obj2 = $this->getObject(2);
        $obj3 = $this->getObject(3);

        $array1 = [$obj1, $obj2, $obj3];
        $array2 = [$obj2, $obj1, $obj3];

        // Pass
        $this->assertEqualsCanonicalizing($array1, $array2);

        // Fail
        $this->assertEquals($array1, $array2);
    }

    private function getObject($value)
    {
        $result = new \stdClass();
        $result->property = $value;
        return $result;
    }
}

在旧版本的PHPUnit中,您可以使用未记录的param $ canonicalize of assertEquals方法。如果你传递$ canonicalize = true,你将获得相同的效果:

class ArraysTest extends PHPUnit_Framework_TestCase
{
    public function testEquality()
    {
        $obj1 = $this->getObject(1);
        $obj2 = $this->getObject(2);
        $obj3 = $this->getObject(3);

        $array1 = [$obj1, $obj2, $obj3];
        $array2 = [$obj2, $obj1, $obj3];

        // Pass
        $this->assertEquals($array1, $array2, "\$canonicalize = true", 0.0, 10, true);

        // Fail
        $this->assertEquals($array1, $array2, "Default behaviour");
    }

    private function getObject($value)
    {
        $result = new stdclass();
        $result->property = $value;
        return $result;
    }
}

在最新版本的PHPUnit中使用比较器源代码:https://github.com/sebastianbergmann/comparator/blob/master/src/ArrayComparator.php#L46


34
投票

我的问题是我有2个数组(数组键与我无关,只是值)。

例如,我想测试是否

$expected = array("0" => "green", "2" => "red", "5" => "blue", "9" => "pink");

有相同的内容(与我无关的顺序)

$actual = array("0" => "pink", "1" => "green", "3" => "yellow", "red", "blue");

所以我用过array_diff

最终结果是(如果数组相等,差异将导致空数组)。请注意,差异是双向计算的(谢谢@beret,@ GordonM)

$this->assertEmpty(array_merge(array_diff($expected, $actual), array_diff($actual, $expected)));

有关更详细的错误消息(在调试时),您也可以像这样测试(感谢@DenilsonSá):

$this->assertSame(array_diff($expected, $actual), array_diff($actual, $expected));

里面有bug的旧版本:

$ this-> assertEmpty(array_diff($ array2,$ array1));


20
投票

另一种可能性:

  1. 对两个数组排序
  2. 将它们转换为字符串
  3. 断言两个字符串是相等的

$arr = array(23, 42, 108);
$exp = array(42, 23, 108);

sort($arr);
sort($exp);

$this->assertEquals(json_encode($exp), json_encode($arr));

14
投票

简单的帮助方法

protected function assertEqualsArrays($expected, $actual, $message) {
    $this->assertTrue(count($expected) == count(array_intersect($expected, $actual)), $message);
}

或者,如果在数组不相等时需要更多调试信息

protected function assertEqualsArrays($expected, $actual, $message) {
    sort($expected);
    sort($actual);

    $this->assertEquals($expected, $actual, $message);
}

7
投票

如果数组是可排序的,我会在检查相等性之前对它们进行排序。如果没有,我会将它们转换为某种类型的集合并进行比较。


6
投票

使用array_diff()

$a1 = array(1, 2, 3);
$a2 = array(3, 2, 1);

// error when arrays don't have the same elements (order doesn't matter):
$this->assertEquals(0, count(array_diff($a1, $a2)) + count(array_diff($a2, $a1)));

或者有2个断言(更容易阅读):

// error when arrays don't have the same elements (order doesn't matter):
$this->assertEquals(0, count(array_diff($a1, $a2)));
$this->assertEquals(0, count(array_diff($a2, $a1)));

5
投票

我们在测试中使用以下包装器方法:

/**
 * Assert that two arrays are equal. This helper method will sort the two arrays before comparing them if
 * necessary. This only works for one-dimensional arrays, if you need multi-dimension support, you will
 * have to iterate through the dimensions yourself.
 * @param array $expected the expected array
 * @param array $actual the actual array
 * @param bool $regard_order whether or not array elements may appear in any order, default is false
 * @param bool $check_keys whether or not to check the keys in an associative array
 */
protected function assertArraysEqual(array $expected, array $actual, $regard_order = false, $check_keys = true) {
    // check length first
    $this->assertEquals(count($expected), count($actual), 'Failed to assert that two arrays have the same length.');

    // sort arrays if order is irrelevant
    if (!$regard_order) {
        if ($check_keys) {
            $this->assertTrue(ksort($expected), 'Failed to sort array.');
            $this->assertTrue(ksort($actual), 'Failed to sort array.');
        } else {
            $this->assertTrue(sort($expected), 'Failed to sort array.');
            $this->assertTrue(sort($actual), 'Failed to sort array.');
        }
    }

    $this->assertEquals($expected, $actual);
}

5
投票

如果键是相同但不按顺序,这应该解决它。

您只需按相同顺序获取密钥并比较结果即可。

 /**
 * Assert Array structures are the same
 *
 * @param array       $expected Expected Array
 * @param array       $actual   Actual Array
 * @param string|null $msg      Message to output on failure
 *
 * @return bool
 */
public function assertArrayStructure($expected, $actual, $msg = '') {
    ksort($expected);
    ksort($actual);
    $this->assertSame($expected, $actual, $msg);
}
© www.soinside.com 2019 - 2024. All rights reserved.