Adding better tests for path resolving

Author: lachiebol

tests/Unit/APITest.php

@@ -17,6 +17,7 @@
 use Piwik\Access;
 use Piwik\Container\StaticContainer;
 use Piwik\Plugins\OpenApiDocs\API;
+use Piwik\Plugins\OpenApiDocs\Specs\PathResolver;
 use Piwik\Tests\Framework\Mock\FakeAccess;
 
 /**
@@ -100,12 +101,21 @@ public function testGetOpenApiSpecThrowsExceptionWhenSpecIsNotAValidPlugin()
         $api->getOpenApiSpec('DefinitelyNotARealPlugin');
     }
 
-    public function testGetSpecFilePathUsesPluginSpecificFileName()
+    public function testGetSpecFilePathDelegatesToPathResolver()
     {
-        $api = new API();
+        $pathResolver = $this->createMock(PathResolver::class);
+        $pathResolver->expects($this->once())
+            ->method('getSpecFilePath')
+            ->with('CustomAlerts')
+            ->willReturn('/shared/specs/CustomAlerts_openapi_spec_v1.0.0.json');
+
+        $api = $this->getMockBuilder(API::class)
+            ->onlyMethods(['getSpecPathResolver'])
+            ->getMock();
+        $api->method('getSpecPathResolver')->willReturn($pathResolver);
 
         $this->assertSame(
-            PIWIK_INCLUDE_PATH . '/plugins/OpenApiDocs/tmp/specs/CustomAlerts_openapi_spec_v1.0.0.json',
+            '/shared/specs/CustomAlerts_openapi_spec_v1.0.0.json',
             $this->callProtectedMethod($api, 'getSpecFilePath', ['CustomAlerts'])
         );
     }

tests/Unit/Specs/PathResolverTest.php

@@ -0,0 +1,104 @@
+<?php
+
+/**
+ * Matomo - free/libre analytics platform
+ *
+ * @link    https://matomo.org
+ * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+declare(strict_types=1);
+
+namespace Piwik\Plugins\OpenApiDocs\tests\Unit\Specs;
+
+require_once PIWIK_INCLUDE_PATH . '/plugins/OpenApiDocs/vendor/autoload.php';
+
+use PHPUnit\Framework\TestCase;
+use Piwik\Container\Container;
+use Piwik\Plugins\OpenApiDocs\Specs\PathResolver;
+
+/**
+ * @group OpenApiDocs
+ * @group OpenApiDocs_Unit
+ * @group OpenApiDocs_PathResolverTest
+ */
+class PathResolverTest extends TestCase
+{
+    public function testReturnsPluginLocalPathsWhenCloudIsDisabled(): void
+    {
+        $resolver = new PathResolver('/plugins/OpenApiDocs', false);
+
+        $this->assertSame('/plugins/OpenApiDocs/tmp/specs/', $resolver->getSpecDirectory());
+        $this->assertSame('/plugins/OpenApiDocs/tmp/annotations/', $resolver->getAnnotationsDirectory());
+        $this->assertSame('/plugins/OpenApiDocs/tmp/responses/', $resolver->getResponsesDirectory());
+    }
+
+    public function testReturnsSharedPathsWhenCloudIsEnabledAndDistributedCachePathExists(): void
+    {
+        $resolver = new PathResolver('/plugins/OpenApiDocs', true, $this->buildContainerStub(true, '/cache/distributed'));
+
+        $this->assertSame('/cache/distributed/OpenApiDocs/specs/', $resolver->getSpecDirectory());
+        $this->assertSame('/cache/distributed/OpenApiDocs/annotations/', $resolver->getAnnotationsDirectory());
+        $this->assertSame('/cache/distributed/OpenApiDocs/responses/', $resolver->getResponsesDirectory());
+    }
+
+    public function testFallsBackToPluginLocalPathsWhenCloudCachePathIsMissing(): void
+    {
+        $resolver = new PathResolver('/plugins/OpenApiDocs', true, $this->buildContainerStub(false));
+
+        $this->assertSame('/plugins/OpenApiDocs/tmp/specs/', $resolver->getSpecDirectory());
+        $this->assertSame('/plugins/OpenApiDocs/tmp/annotations/', $resolver->getAnnotationsDirectory());
+        $this->assertSame('/plugins/OpenApiDocs/tmp/responses/', $resolver->getResponsesDirectory());
+    }
+
+    public function testFallsBackToPluginLocalPathsWhenCloudCachePathIsEmpty(): void
+    {
+        $resolver = new PathResolver('/plugins/OpenApiDocs', true, $this->buildContainerStub(true, '   '));
+
+        $this->assertSame('/plugins/OpenApiDocs/tmp/specs/', $resolver->getSpecDirectory());
+        $this->assertSame('/plugins/OpenApiDocs/tmp/annotations/', $resolver->getAnnotationsDirectory());
+        $this->assertSame('/plugins/OpenApiDocs/tmp/responses/', $resolver->getResponsesDirectory());
+    }
+
+    public function testBuildsFilePathsUsingExpectedNamingConventions(): void
+    {
+        $resolver = new PathResolver('/plugins/OpenApiDocs', true, $this->buildContainerStub(true, '/cache/distributed/'));
+
+        $this->assertSame(
+            '/cache/distributed/OpenApiDocs/specs/CustomAlerts_openapi_spec_v2.0.0.yaml',
+            $resolver->getSpecFilePath('CustomAlerts', '2.0.0', 'YAML')
+        );
+        $this->assertSame(
+            '/cache/distributed/OpenApiDocs/annotations/CustomAlertsGeneratedAnnotations.php',
+            $resolver->getAnnotationFilePath('CustomAlerts')
+        );
+        $this->assertSame(
+            '/cache/distributed/OpenApiDocs/annotations/matomo_api_method_info.json',
+            $resolver->getApiMethodInfoFilePath('matomo')
+        );
+        $this->assertSame(
+            '/cache/distributed/OpenApiDocs/responses/CustomAlerts.getAlerts.json',
+            $resolver->getExampleResponseFilePath('CustomAlerts', 'getAlerts', 'JSON')
+        );
+    }
+
+    private function buildContainerStub(bool $hasDistributedCachePath, string $distributedCachePath = ''): Container
+    {
+        $container = $this->getMockBuilder(Container::class)
+            ->disableOriginalConstructor()
+            ->onlyMethods(['has', 'get'])
+            ->getMock();
+
+        $container->method('has')
+            ->with('CloudDistributedCachePath')
+            ->willReturn($hasDistributedCachePath);
+
+        if ($hasDistributedCachePath) {
+            $container->method('get')
+                ->with('CloudDistributedCachePath')
+                ->willReturn($distributedCachePath);
+        }
+
+        return $container;
+    }
+}