ACP2E-4148: Investigate if AC-9296 can be automated

Author: dhorytskyi

dev/tests/integration/testsuite/Magento/PageBuilder/Plugin/Filter/TemplatePluginTest.php

@@ -3,72 +3,83 @@
  * Copyright 2019 Adobe
  * All Rights Reserved.
  */
-
 declare(strict_types=1);
 
 namespace Magento\PageBuilder\Plugin\Filter;
 
+use Magento\Framework\App\Area;
+use Magento\Framework\Filter\Template as FrameworkTemplateFilter;
 use Magento\Store\Model\Store;
-use Magento\Widget\Model\Template\Filter as TemplateFilter;
+use Magento\TestFramework\Fixture\AppArea;
+use Magento\TestFramework\Fixture\DataFixture;
 use Magento\TestFramework\Helper\Bootstrap;
+use Magento\Widget\Model\Template\Filter as WidgetTemplateFilter;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
 
-/**
- * @magentoAppArea frontend
- */
-class TemplatePluginTest extends \PHPUnit\Framework\TestCase
+#[
+    CoversClass(TemplatePlugin::class),
+    DataFixture('Magento/PageBuilder/_files/custom_variable_xss.php'),
+]
+class TemplatePluginTest extends TestCase
 {
     /**
-     * @var \Magento\Framework\ObjectManagerInterface
-     */
-    private $objectManager;
-
-    /**
-     * @var TemplateFilter
+     * @param string $preFiltered
+     * @param string $postFiltered
+     * @param string $preFilteredBasename
      */
-    private $templateFilter;
-
-    protected function setUp(): void
+    #[
+        AppArea(Area::AREA_GLOBAL),
+        DataProvider('filterDataProvider'),
+    ]
+    public function testFilter(string $preFiltered, string $postFiltered, string $preFilteredBasename): void
     {
-        $this->objectManager = Bootstrap::getObjectManager();
-        $this->templateFilter = $this->objectManager->get(TemplateFilter::class);
-
-        // set store id to 0 to recognize that escaping is required in custom variable
-        $this->templateFilter->setStoreId(Store::DEFAULT_STORE_ID);
+        $templateFilter = Bootstrap::getObjectManager()->create(FrameworkTemplateFilter::class);
+        $filtered = $templateFilter->filter($preFiltered);
+        $this->assertEquals(
+            $this->formatHtml($postFiltered),
+            $this->formatHtml($filtered),
+            "Failed asserting that two strings are equal after filtering $preFilteredBasename"
+        );
     }
 
     /**
      * @param string $preFiltered
      * @param string $postFiltered
      * @param string $preFilteredBasename
-     * @dataProvider filterDataProvider
-     * @magentoDataFixture Magento/PageBuilder/_files/custom_variable_xss.php
-     * @magentoDbIsolation enabled
      */
-    public function testFiltering(string $preFiltered, string $postFiltered, string $preFilteredBasename)
+    #[
+        AppArea(Area::AREA_FRONTEND),
+        DataProvider('filterFrontendDataProvider'),
+    ]
+    public function testFilterFrontend(string $preFiltered, string $postFiltered, string $preFilteredBasename): void
     {
+        $templateFilter = Bootstrap::getObjectManager()->create(WidgetTemplateFilter::class);
+        // set store id to 0 to recognize that escaping is required in custom variable
+        $templateFilter->setStoreId(Store::DEFAULT_STORE_ID);
+        $filtered = $templateFilter->filter($preFiltered);
         $this->assertEquals(
             $this->formatHtml($postFiltered),
-            $this->formatHtml($this->templateFilter->filter($preFiltered)),
+            $this->formatHtml($filtered),
             "Failed asserting that two strings are equal after filtering $preFilteredBasename"
         );
     }
 
     /**
-     * @return array
+     * @param array $preFilteredFiles
+     * @return array[]
      */
-    public static function filterDataProvider(): array
+    private static function loadFiles(array $preFilteredFiles): array
     {
-        $preFilteredFiles = glob(__DIR__ . '/../../_files/template_plugin/*pre_filter*');
-
         $dataProviderArgs = [];
-
         foreach ($preFilteredFiles as $preFilteredFile) {
             $preFilteredBasename = basename($preFilteredFile);
             $postFilteredFile = pathinfo($preFilteredFile, PATHINFO_DIRNAME) . '/' . str_replace(
-                'pre_filter',
-                'post_filter',
-                $preFilteredBasename
-            );
+                    'pre_filter',
+                    'post_filter',
+                    $preFilteredBasename
+                );
 
             $dataProviderArgs[] = [
                 file_get_contents($preFilteredFile),
@@ -80,11 +91,34 @@ public static function filterDataProvider(): array
         return $dataProviderArgs;
     }
 
+    /**
+     * @return array
+     */
+    public static function filterDataProvider(): array
+    {
+        $preFilteredFiles = glob(__DIR__ . '/../../_files/template_plugin/*pre_filter*');
+        $dataProviderArgs = self::loadFiles($preFilteredFiles);
+
+        return $dataProviderArgs;
+    }
+
+    /**
+     * @return array
+     */
+    public static function filterFrontendDataProvider(): array
+    {
+        $dataProviderArgs = self::filterDataProvider();
+        $preFilteredFiles = glob(__DIR__ . '/../../_files/template_plugin/frontend/*pre_filter*');
+        $dataProviderArgs = array_merge($dataProviderArgs, self::loadFiles($preFilteredFiles));
+
+        return $dataProviderArgs;
+    }
+
     /**
      * Strip whitespace from the HTML to conduct a fairer comparison
      *
      * @param string $html
-     * @return string|string[]|null
+     * @return string
      */
     private function formatHtml(string $html): string
     {