web-dev-qa-db-ja.com

PHPUnit：2つの配列が等しいと主張するが、要素の順序は重要ではない

配列内の要素の順序が重要でない場合、または変更される可能性がある場合でも、オブジェクトの2つの配列が等しいと主張する良い方法は何ですか？

phpunit-testingphpunitassert
119
koen

これを行う最もクリーンな方法は、新しいアサーションメソッドで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));
34
Craig

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の古いバージョンでは、ドキュメント化されていないパラメーター$ canonicalize ofassertEqualsメソッドを使用できます。 $ 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

170
pryazhnikov

私の問題は、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));

内部にバグがある古いバージョン：

$ this-> assertEmpty（array_diff（$ array2、$ array1））;

34
Valentin Despa

もう1つの可能性：

  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));
20
rodrigo-silveira

シンプルなヘルパーメソッド

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);
}
14
ksimka

配列がソート可能な場合、等価性をチェックする前に両方をソートします。そうでない場合は、それらをある種のセットに変換して比較します。

7
Rodney Gitzel

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)));
6
caligari

キーが同じであるが、故障している場合、これは解決するはずです。

キーを同じ順序で取得し、結果を比較するだけです。

 /**
 * 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);
}
5
Cris

テストでは、次のラッパーメソッドを使用します。

/**
 * 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
t.heintz

順序を気にしなくても、それを考慮する方が簡単な場合があります。

試してください：

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

多次元配列を処理し、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("/"));
2
moins52

最初に多次元配列からすべてのキーを取得するための簡単なコードをいくつか作成しました。

 /**
 * 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

1
sturrockad

値が単なる整数または文字列であり、複数レベルの配列がない場合...

配列を並べ替えるだけでなく、文字列に変換してください...

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

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

...そして文字列を比較します：

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