ENGCOM-8009: magento/web-api-test-recursive-array-comparison #29458

 - Merge Pull Request #29458 from bricht/magento2:web-api-test-recursive-array-comparison
 - Merged commits:
   1. 9cf55e5
   2. 289af76

Author: magento-engcom-team

dev/tests/api-functional/framework/Magento/TestFramework/Helper/CompareArraysRecursively.php

@@ -0,0 +1,70 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\TestFramework\Helper;
+
+/**
+ * Class for comparing arrays recursively
+ */
+class CompareArraysRecursively
+{
+    /**
+     * Compare arrays recursively regardless of nesting.
+     * Can compare arrays that have both one level and n-level nesting.
+     * ```
+     *  [
+     * 'products' => [
+     *      'items' => [
+     *      [
+     *          'sku'       => 'bundle-product',
+     *          'type_id'   => 'bundle',
+     *          'items'     => [
+     *          [
+     *              'title'     => 'Bundle Product Items',
+     *              'sku'       => 'bundle-product',
+     *              'options'   => [
+     *              [
+     *                  'price' => 2.75,
+     *                  'label' => 'Simple Product',
+     *                  'product' => [
+     *                      'name'    => 'Simple Product',
+     *                      'sku'     => 'simple',
+     *                  ]
+     *              ]
+     *          ]
+     *      ]
+     *  ];
+     * ```
+     *
+     * @param array $expected
+     * @param array $actual
+     * @return array
+     */
+    public function execute(array $expected, array $actual): array
+    {
+        $diffResult = [];
+
+        foreach ($expected as $key => $value) {
+            if (array_key_exists($key, $actual)) {
+                if (is_array($value)) {
+                    $recursiveDiff = $this->execute($value, $actual[$key]);
+                    if (!empty($recursiveDiff)) {
+                        $diffResult[$key] = $recursiveDiff;
+                    }
+                } else {
+                    if (!in_array($value, $actual, true)) {
+                        $diffResult[$key] = $value;
+                    }
+                }
+            } else {
+                $diffResult[$key] = $value;
+            }
+        }
+
+        return $diffResult;
+    }
+}

dev/tests/api-functional/testsuite/Magento/Catalog/Api/CategoryManagementTest.php

@@ -9,6 +9,7 @@
 
 use Magento\TestFramework\TestCase\WebapiAbstract;
 use Magento\TestFramework\Helper\Bootstrap;
+use Magento\TestFramework\Helper\CompareArraysRecursively;
 
 /**
  * Tests CategoryManagement
@@ -19,6 +20,20 @@ class CategoryManagementTest extends WebapiAbstract
 
     const SERVICE_NAME = 'catalogCategoryManagementV1';
 
+    /**
+     * @var CompareArraysRecursively
+     */
+    private $compareArraysRecursively;
+
+    /**
+     * @inheritDoc
+     */
+    protected function setUp(): void
+    {
+        $objectManager = Bootstrap::getObjectManager();
+        $this->compareArraysRecursively = $objectManager->create(CompareArraysRecursively::class);
+    }
+
     /**
      * Tests getTree operation
      *
@@ -40,8 +55,8 @@ public function testTree($rootCategoryId, $depth, $expected)
             ]
         ];
         $result = $this->_webApiCall($serviceInfo, $requestData);
-        $expected = array_replace_recursive($result, $expected);
-        $this->assertEquals($expected, $result);
+        $diff = $this->compareArraysRecursively->execute($expected, $result);
+        self::assertEquals([], $diff, "Actual categories response doesn't equal expected data");
     }
 
     /**