Merge pull request #135 from findologic/HR-1408_make_reserved_propert…

…y_validation_more_accurate HR-1408_make_reserved_property_validation_more_accurate (FINDO-9622)
findologic · Nov 9, 2022 · aebac7a · aebac7a
2 parents a3649c3 + 35c8418
commit aebac7a
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 19 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -8,7 +8,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: ['7.1', '7.2', '7.3', '7.4', '8.0']
+        php: ['7.1', '7.2', '7.3', '7.4', '8.0', '8.1']
         stability: [prefer-lowest, prefer-stable]
 
     name: PHP ${{ matrix.php }} - ${{ matrix.stability }} Test

diff --git a/composer.json b/composer.json
@@ -9,8 +9,9 @@
         "findologic/xml-export-schema": "^1.4"
     },
     "require-dev": {
-        "phpunit/phpunit": "^7.5|^8.5|^9.0",
-        "squizlabs/php_codesniffer": "^3.5"
+        "phpunit/phpunit": "^7.5|^8.6|^9.0",
+        "squizlabs/php_codesniffer": "^3.5",
+        "nikic/php-parser": "^4.15"
     },
     "scripts": {
         "lint": "phpcs",

diff --git a/src/FINDOLOGIC/Export/Data/Property.php b/src/FINDOLOGIC/Export/Data/Property.php
@@ -11,14 +11,14 @@ class Property
     /**
      * Reserved property keys for internal use which would be overwritten when importing
      *
-     * /image\d+/: Image URLs of type default.
-     * /thumbnail\d+/: Image URLs of type thumbnail.
-     * /ordernumber/: The products first exported ordernumber.
+     * - Image URLs of type default.
+     * - Image URLs of type thumbnail.
+     * - The products first exported ordernumber.
      */
     private const RESERVED_PROPERTY_KEYS = [
-        "/image\d+/",
-        "/thumbnail\d+/",
-        "/ordernumber/"
+        "/^image\d+$/",
+        "/^thumbnail\d+$/",
+        "/^ordernumber$/"
     ];
 
     /** @var string */

diff --git a/tests/FINDOLOGIC/Export/Tests/PropertyTest.php b/tests/FINDOLOGIC/Export/Tests/PropertyTest.php
@@ -37,7 +37,10 @@ public function propertyKeyProvider(): array
             'reserved property "image\d+"' => ['image0', true],
             'reserved property "thumbnail\d+"' => ['thumbnail1', true],
             'reserved property "ordernumber"' => ['ordernumber', true],
-            'non-reserved property key' => ['foobar', false]
+            'non-reserved property key' => ['foobar', false],
+            'non-reserved property key containing "ordernumber"' => ['main_ordernumber', false],
+            'non-reserved property key containing "image0"' => ['main_image0', false],
+            'non-reserved property key containing "thumbnail0"' => ['main_thumbnail0', false],
         ];
     }
 
@@ -58,7 +61,11 @@ public function testReservedPropertyKeysCausesException(string $key, bool $shoul
                 $this->assertNotNull($property);
             }
         } catch (Exception $exception) {
-            $this->assertMatchesRegularExpression('/' . $key . '/', $exception->getMessage());
+            if (!$shouldCauseException) {
+                $this->fail('Using a non-reserved property key should not cause an exception.');
+            } else {
+                $this->assertMatchesRegularExpression('/' . $key . '/', $exception->getMessage());
+            }
         }
     }
 

diff --git a/tests/FINDOLOGIC/Export/Tests/TestCase.php b/tests/FINDOLOGIC/Export/Tests/TestCase.php
@@ -6,12 +6,12 @@
 
 class TestCase extends BaseTestCase
 {
-  public static function assertMatchesRegularExpression(string $pattern, string $string, string $message = ''): void
-  {
-      if (method_exists(BaseTestCase::class, 'assertMatchesRegularExpression')) {
-          parent::assertMatchesRegularExpression($pattern, $string, $message);
-      } else {
-          parent::assertRegExp($pattern, $string, $message);
-      }
-  }
+    public static function assertMatchesRegularExpression(string $pattern, string $string, string $message = ''): void
+    {
+        if (method_exists(BaseTestCase::class, 'assertMatchesRegularExpression')) {
+            parent::assertMatchesRegularExpression($pattern, $string, $message);
+        } else {
+            parent::assertRegExp($pattern, $string, $message);
+        }
+    }
 }