MAGE-1245 Add integration test for caching with plugin spy

Author: cammonro

Test/Integration/Category/CategoryCacheTest.php

@@ -0,0 +1,140 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Test\Integration\Category;
+
+use Magento\Framework\App\RequestInterface;
+use Magento\Framework\App\Response\Http as ResponseHttp;
+use Magento\Framework\App\ResponseInterface;
+use Magento\Framework\Data\Form\FormKey;
+use Magento\TestFramework\Helper\Bootstrap;
+
+class CategoryCacheTest extends \Magento\TestFramework\TestCase\AbstractController
+{
+    protected $cacheManager;
+
+    protected $url = '/catalog/category/view/id/';
+
+    public static function getCategoryProvider(): array
+    {
+        return [
+            ['categoryId' => 20, 'name' => 'Ladies'],
+            ['categoryId' => 21, 'name' => 'Ladies Tops'],
+        ];
+    }
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->cacheManager = $this->_objectManager->get(\Magento\Framework\App\Cache\Manager::class);
+    }
+
+    /**
+     * @dataProvider getCategoryProvider
+     * @depends      testFullPageCacheAvailable
+     * @magentoConfigFixture default/system/full_page_cache/caching_application 1
+     * @magentoCache full_page enabled
+     * @param int $categoryId
+     * @param string $name
+     * @return void
+     */
+    public function testCategoryPlpMiss(int $categoryId, string $name): void
+    {
+        $this->cacheManager->clean(['full_page']);
+        $this->dispatch($this->url . $categoryId);
+        $response = $this->getResponse();
+        $this->assertEquals(200, $response->getHttpResponseCode(), 'Request failed');
+        $this->assertEquals(
+            'MISS',
+            $response->getHeader('X-Magento-Cache-Debug')->getFieldValue(),
+            "expected MISS on category {$name} id {$categoryId}"
+        );
+    }
+
+    protected function resetResponse(): void
+    {
+        $this->_objectManager->removeSharedInstance(ResponseInterface::class);
+        $this->_response = null;
+    }
+
+    /**
+     * The response object is modified differently by the BuiltinPlugin which prevents anything useful
+     * being returned by AbstractController::getResponse
+     *
+     * Therefore we apply a "spy" on the plugin via a mock to ensure that the proper header is added
+     * when the cache has been warmed (by the first MISS)
+     *
+     * @dataProvider getCategoryProvider
+     * @depends      testCategoryPlpMiss
+     * @magentoConfigFixture default/system/full_page_cache/caching_application 1
+     * @magentoCache full_page enabled
+     * @param int $categoryId
+     * @param string $name
+     * @return void
+     */
+    public function testCategoryPlpHit(int $categoryId, string $name): void
+    {
+        $mockedPluginClass = \Magento\PageCache\Model\App\FrontController\BuiltinPlugin::class;
+        $mockedPluginMethod = 'addDebugHeader';
+        $cachePluginMock = $this->getMockBuilder($mockedPluginClass)
+            ->setConstructorArgs([
+                $this->_objectManager->get(\Magento\PageCache\Model\Config::class),
+                $this->_objectManager->get(\Magento\Framework\App\PageCache\Version::class),
+                $this->_objectManager->get(\Magento\Framework\App\PageCache\Kernel::class),
+                $this->_objectManager->get(\Magento\Framework\App\State::class)
+            ])
+            ->onlyMethods([$mockedPluginMethod])
+            ->getMock();
+        $cachePluginMock
+            ->expects($this->once())
+            ->method($mockedPluginMethod)
+            ->with(
+                $this->isInstanceOf(ResponseHttp::class),
+                $this->equalTo("X-Magento-Cache-Debug"),
+                $this->equalTo("HIT"),
+                $this->isType('boolean')
+            )
+            ->willReturnCallback(
+                function (ResponseHttp $response, $name, $value, $replace)
+                    use ($mockedPluginClass, $mockedPluginMethod, $cachePluginMock)
+                {
+                    $originalMethod = new \ReflectionMethod($mockedPluginClass, $mockedPluginMethod);
+                    return $originalMethod->invoke($cachePluginMock, $response, $name, $value, $replace);
+                }
+            );
+        $this->_objectManager->addSharedInstance(
+            $cachePluginMock,
+            $mockedPluginClass
+        );
+
+        $this->dispatch("catalog/category/view/id/{$categoryId}");
+        $response = $this->getResponse();
+        $this->assertEquals(200, $response->getHttpResponseCode(), 'Request failed');
+    }
+
+    public function xtestCategoryPlpHit(int $categoryId, string $name): void
+    {
+        $this->dispatch("catalog/category/view/id/{$categoryId}");
+        $response = $this->getResponse();
+        $this->assertEquals(
+            'HIT',
+            $response->getHeader('X-Magento-Cache-Debug')->getFieldValue(),
+            "expected HIT on category {$name} id {$categoryId}"
+        );
+    }
+
+    public function testFullPageCacheAvailable(): void
+    {
+        $types = $this->cacheManager->getAvailableTypes();
+        $this->assertContains('full_page', $types);
+    }
+
+    protected function dispatchNew($uri)
+    {
+        $request = $this->_objectManager->get(\Magento\Framework\App\RequestInterface::class);
+
+        $request->setDispatched(false);
+        $request->setRequestUri($uri);
+        $this->_getBootstrap()->runApp();
+    }
+
+}