#4 Add test for Category views

Author: Willem Wigman

tests/Integration/AbstractFrontendControllerTest.php

@@ -0,0 +1,68 @@
+<?php
+declare(strict_types=1);
+
+namespace IntegerNet\GlobalCustomLayout\Test\Integration;
+
+use IntegerNet\GlobalCustomLayout\Test\Util\CategoryLayoutUpdateManager;
+use Magento\Catalog\Model\Category\Attribute\LayoutUpdateManager;
+use Magento\Catalog\Model\Session;
+use Magento\Framework\ObjectManagerInterface;
+use Magento\Framework\Registry;
+use Magento\Framework\View\LayoutInterface;
+use Magento\TestFramework\Helper\Bootstrap;
+use Magento\TestFramework\TestCase\AbstractController;
+
+/**
+ * @magentoAppIsolation enabled
+ * @magentoAppArea frontend
+ */
+abstract class AbstractFrontendControllerTest extends AbstractController
+{
+    /**
+     * @var ObjectManagerInterface
+     */
+    private $objectManager;
+
+    /**
+     * @var Registry
+     */
+    private $registry;
+
+    /**
+     * @var Session
+     */
+    private $session;
+
+    /**
+     * @var LayoutInterface
+     */
+    private $layout;
+
+    /**
+     * @inheritdoc
+     */
+    protected function setUp()
+    {
+        $this->objectManager = Bootstrap::getObjectManager();
+
+        $this->setUpPreferences();
+
+        parent::setUp();
+
+        $this->registry = $this->objectManager->get(Registry::class);
+        $this->layout = $this->objectManager->get(LayoutInterface::class);
+        $this->session = $this->objectManager->get(Session::class);
+    }
+
+    private function setUpPreferences(): void
+    {
+        $this->objectManager->configure(
+            [
+                'preferences' => [
+                    LayoutUpdateManager::class => CategoryLayoutUpdateManager::class,
+                ]
+            ]
+        );
+        $this->objectManager->removeSharedInstance(LayoutUpdateManager::class);
+    }
+}

tests/Integration/CategoryFrontendControllerTest.php

@@ -0,0 +1,52 @@
+<?php
+declare(strict_types=1);
+
+namespace IntegerNet\GlobalCustomLayout\Test\Integration;
+
+use IntegerNet\GlobalCustomLayout\Test\Util\CategoryLayoutUpdateManager;
+use Magento\Catalog\Api\CategoryRepositoryInterface;
+use Magento\TestFramework\Helper\Bootstrap;
+
+/**
+ * Tests whether global layout handles are correctly saved on categories
+ * and retrieved on the frontend on Category views
+ */
+class CategoryFrontendControllerTest extends AbstractFrontendControllerTest
+{
+    /**
+     * Check that Global Custom Layout Update files work for Category views.
+     *
+     * @return void
+     * @throws \Magento\Framework\Exception\CouldNotSaveException
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     *
+     * @magentoDataFixture Magento/CatalogUrlRewrite/_files/categories_with_product_ids.php
+     */
+    public function testViewWithGlobalCustomUpdate(): void
+    {
+        //Setting a fake file for the category.
+        $file = 'test-file';
+        $categoryId = 5;
+
+        /** @var CategoryLayoutUpdateManager $layoutManager */
+        $layoutManager = Bootstrap::getObjectManager()->get(CategoryLayoutUpdateManager::class);
+        $layoutManager->setCategoryFakeFiles(0, [$file]);
+
+        /** @var CategoryRepositoryInterface $categoryRepo */
+        $categoryRepo = Bootstrap::getObjectManager()->create(CategoryRepositoryInterface::class);
+        $category = $categoryRepo->get($categoryId);
+
+        //Updating the custom attribute.
+        $category->setCustomAttribute('custom_layout_update_file', $file);
+        $categoryRepo->save($category);
+
+        //Viewing the category
+        $this->dispatch("catalog/category/view/id/$categoryId");
+
+        //Layout handles must contain the file.
+        $handles = Bootstrap::getObjectManager()->get(\Magento\Framework\View\LayoutInterface::class)
+            ->getUpdate()
+            ->getHandles();
+        $this->assertContains("catalog_category_view_selectable_0_{$file}", $handles);
+    }
+}

tests/Util/CategoryLayoutUpdateManager.php

@@ -0,0 +1,46 @@
+<?php
+declare(strict_types=1);
+
+namespace IntegerNet\GlobalCustomLayout\Test\Util;
+
+use Magento\Catalog\Api\Data\CategoryInterface;
+
+/**
+ * Easy way to fake available files.
+ */
+class CategoryLayoutUpdateManager extends \Magento\TestFramework\Catalog\Model\CategoryLayoutUpdateManager
+{
+    /**
+     * @var array Keys are category IDs, values - file names.
+     */
+    private $fakeFiles = [];
+
+    /**
+     * Supply fake files for a category.
+     *
+     * @param int $forCategoryId
+     * @param string[]|null $files Pass null to reset.
+     */
+    public function setCategoryFakeFiles(int $forCategoryId, ?array $files): void
+    {
+        if ($files === null) {
+            unset($this->fakeFiles[$forCategoryId]);
+        } else {
+            $this->fakeFiles[$forCategoryId] = $files;
+        }
+    }
+
+    /**
+     * Fetches fake/mock files added through $this->setCategoryFakeFiles()
+     *
+     * @param CategoryInterface $category
+     * @return array
+     */
+    public function fetchAvailableFiles(CategoryInterface $category): array
+    {
+        if (array_key_exists(0, $this->fakeFiles)) {
+            return $this->fakeFiles[0];
+        }
+        return parent::fetchAvailableFiles($category);
+    }
+}