PHPUnit: стверджують, що два масиви рівні, але порядок елементів не важливий

Який хороший спосіб стверджувати, що два масиви об’єктів рівні, коли порядок елементів у масиві є неважливим або навіть може змінюватися?

Найчистішим способом зробити це було б поширити 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));

Можна використовувати метод assertEqualsCanonicalizing, який був доданий у PHPUnit 7.5. Якщо ви порівнюєте масиви, використовуючи цей метод, ці масиви будуть відсортовані самим компаратором 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 методу 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

Моя проблема полягала в тому, що у мене було 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));

Ще одна можливість:

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

Простий хелперний метод

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

Якщо масив сортується, я б сортував їх обидва, перш ніж перевірити рівність. Якщо ні, я б перетворив їх на деякі набори і порівняв би їх.

Використання 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)));

Хоча ви не дбаєте про замовлення, можливо, це буде простіше врахувати:

Спробуйте:

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

У наших Тестах ми використовуємо такий метод обгортки:

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

Якщо ключі однакові, але вийшли з ладу, це має вирішити.

Вам просто потрібно отримати ключі в тому ж порядку і порівняти результати.

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

Дані рішення не зробили для мене завдання, тому що я хотів вміти обробляти багатовимірний масив і мати чітке повідомлення про те, що відрізняється між двома масивами.

Ось моя функція

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("/"));

Я написав простий код, щоб спочатку отримати всі ключі з багатовимірного масиву:

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

Якщо значення - це лише int або рядки, а масиви декількох рівнів немає ...

Чому б не просто сортувати масиви, перетворити їх у рядок ...

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

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

... а потім порівняйте рядок:

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

Якщо ви хочете перевірити лише значення масиву, що ви можете зробити:

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

Інший варіант, як ніби у вас вже не вистачало, - це поєднати в assertArraySubsetпоєднанні з, assertCountщоб зробити своє твердження. Отже, ваш код виглядав би приблизно так.

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

Таким чином ви замовляєте незалежне, але все одно стверджуєте, що всі ваші елементи присутні.