MCLOUD-13312: Segregated PatchApplierCest based on PHP & Magento versions

Author: prateek-karanpuria-adobe

src/Test/Functional/Acceptance/PatchApplier83Cest.php

@@ -0,0 +1,24 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CloudPatches\Test\Functional\Acceptance;
+
+/**
+ * @group php83
+ */
+class PatchApplier83Cest extends PatchApplierCest
+{
+    /**
+     * @return array
+     */
+    protected function patchesDataProvider(): array
+    {
+        return [
+            ['templateVersion' => '2.4.7', 'magentoVersion' => '2.4.7'],
+        ];
+    }
+}

src/Test/Functional/Acceptance/PatchApplier84Cest.php

@@ -0,0 +1,24 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CloudPatches\Test\Functional\Acceptance;
+
+/**
+ * @group php84
+ */
+class PatchApplier84Cest extends PatchApplierCest
+{
+    /**
+     * @return array
+     */
+    protected function patchesDataProvider(): array
+    {
+        return [
+            ['templateVersion' => '2.4.8', 'magentoVersion' => '2.4.8'],
+        ];
+    }
+}

src/Test/Functional/Acceptance/PatchApplierCest.php

@@ -10,28 +10,43 @@
 use Magento\CloudDocker\Test\Functional\Codeception\Docker;
 
 /**
- * @group php84
+ * Abstract PatchApplierCest
+ *
+ * @abstract
  */
-class PatchApplierCest extends AbstractCest
+abstract class PatchApplierCest extends AbstractCest
 {
     /**
-     * @param \CliTester $I
+     * Prepares the test environment before each test.
+     *
+     * @param \CliTester $I The CLI tester instance.
+     * @throws \Robo\Exception\TaskException
      */
     public function _before(\CliTester $I): void
     {
         parent::_before($I);
-
-        $this->prepareTemplate($I, '2.4.8');
-        $I->copyFileToWorkDir('files/debug_logging/.magento.env.yaml', '.magento.env.yaml');
     }
 
     /**
+     * Tests applying an existing patch to a target file.
+     *
      * @param \CliTester $I
+     * @param \Codeception\Example $data The example data for the test.
+     *        Expected structure:
+     *        [
+     *            'templateVersion' => string,
+     *            'magentoVersion' => string|null (optional)
+     *        ]
      * @throws \Robo\Exception\TaskException
+     * @dataProvider patchesDataProvider
      */
-    public function testApplyingPatch(\CliTester $I): void
+    public function testApplyingPatch(\CliTester $I, \Codeception\Example $data): void
     {
+        $this->prepareTemplate($I, $data['templateVersion'], $data['magentoVersion'] ?? null);
+
         $I->generateDockerCompose('--mode=production');
+
+        $I->copyFileToWorkDir('files/debug_logging/.magento.env.yaml', '.magento.env.yaml');
         $I->copyFileToWorkDir('files/patches/target_file.md', 'target_file.md');
         $I->copyFileToWorkDir('files/patches/patch.patch', 'm2-hotfixes/patch.patch');
 
@@ -47,12 +62,25 @@ public function testApplyingPatch(\CliTester $I): void
     }
 
     /**
+     * Tests that an existing patch is not applied again.
+     *
      * @param \CliTester $I
+     * @param \Codeception\Example $data The example data for the test.
+     *        Expected structure:
+     *        [
+     *            'templateVersion' => string,
+     *            'magentoVersion' => string|null (optional)
+     *        ]
      * @throws \Robo\Exception\TaskException
+     * @dataProvider patchesDataProvider
      */
-    public function testApplyingExistingPatch(\CliTester $I): void
+    public function testApplyingExistingPatch(\CliTester $I, \Codeception\Example $data): void
     {
+        $this->prepareTemplate($I, $data['templateVersion'], $data['magentoVersion'] ?? null);
+
         $I->generateDockerCompose('--mode=production');
+
+        $I->copyFileToWorkDir('files/debug_logging/.magento.env.yaml', '.magento.env.yaml');
         $I->copyFileToWorkDir('files/patches/target_file_applied_patch.md', 'target_file.md');
         $I->copyFileToWorkDir('files/patches/patch.patch', 'm2-hotfixes/patch.patch');
 
@@ -68,4 +96,10 @@ public function testApplyingExistingPatch(\CliTester $I): void
             $I->grabFileContent('/init/var/log/cloud.log', Docker::BUILD_CONTAINER)
         );
     }
+
+    /**
+     * Returns the data provider for patches.
+     * @return array
+     */
+    abstract protected function patchesDataProvider(): array;
 }