Merge pull request #82 from bearsunday/coverage

koriym · web-flow · commit 2d04e51ac504 · 2021-01-17T18:00:31.000+09:00
Coverage 100%
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -1,8 +1,6 @@
 filter:
     paths: ["src/*"]
 tools:
-    external_code_coverage:
-        timeout: 1200
     php_code_coverage: true
     php_sim: true
     php_mess_detector: true
diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,12 @@
+codecov:
+  notify:
+    require_ci_to_pass: yes
+
+coverage:
+  status:
+    project:
+      default:
+        target: 100%
+    patch:
+      default:
+        target: 100%
diff --git a/src/CacheInterceptor.php b/src/CacheInterceptor.php
@@ -37,12 +37,10 @@ public function invoke(MethodInvocation $invocation)
         assert($ro instanceof ResourceObject);
         try {
             $stored = $this->repository->get($ro->uri);
-        } catch (LogicException $e) {
-            throw $e;
         } catch (Throwable $e) {
             $this->triggerWarning($e);
 
-            return $invocation->proceed();
+            return $invocation->proceed(); // @codeCoverageIgnore
         }
 
         if ($stored) {
@@ -58,8 +56,8 @@ public function invoke(MethodInvocation $invocation)
             $ro->code === 200 ? $this->repository->put($ro) : $this->repository->purge($ro->uri);
         } catch (LogicException $e) {
             throw $e;
-        } catch (Throwable $e) {
-            $this->triggerWarning($e);
+        } catch (Throwable $e) {  // @codeCoverageIgnore
+            $this->triggerWarning($e); // @codeCoverageIgnore
         }
 
         return $ro;
@@ -74,5 +72,6 @@ private function triggerWarning(Throwable $e): void
     {
         $message = sprintf('%s: %s in %s:%s', get_class($e), $e->getMessage(), $e->getFile(), $e->getLine());
         trigger_error($message, E_USER_WARNING);
+        // @codeCoverageIgnoreStart
     }
 }
diff --git a/src/CliHttpCache.php b/src/CliHttpCache.php
@@ -30,7 +30,7 @@ public function __construct(ResourceStorageInterface $storage)
     public function isNotModified(array $server): bool
     {
         /** @var array{HTTP_IF_NONE_MATCH: string}|array{argc: int, argv: array} $server */
-        $hasRequestHeaderInCli = isset($server['argc']) && $server['argc'] === 4 && isset($server['argv']);
+        $hasRequestHeaderInCli = isset($server['argc']) && $server['argc'] === 4 && isset($server['argv'][3]);
         if ($hasRequestHeaderInCli) {
             $server = $this->setRequestHeaders($server, $server['argv'][3]); // @phpstan-ignore-line
         }
diff --git a/src/CommandInterceptor.php b/src/CommandInterceptor.php
@@ -11,7 +11,9 @@
 use Ray\Aop\MethodInterceptor;
 use Ray\Aop\MethodInvocation;
 
+use function assert;
 use function get_class;
+use function in_array;
 
 class CommandInterceptor implements MethodInterceptor
 {
@@ -35,6 +37,7 @@ public function __construct(array $commands)
      */
     public function invoke(MethodInvocation $invocation)
     {
+        assert(in_array($invocation->getMethod()->name, ['onPut', 'onDelete', 'onPatch']));
         /** @psalm-suppress MixedAssignment */
         $ro = $invocation->proceed();
         if (! $ro instanceof ResourceObject) {
diff --git a/src/QueryRepository.php b/src/QueryRepository.php
@@ -175,10 +175,6 @@ private function setMaxAge(ResourceObject $ro, int $age)
 
     private function saveViewCache(ResourceObject $ro, int $lifeTime): bool
     {
-        if (! $ro->view) {
-            $ro->view = $ro->toString();
-        }
-
         return $this->storage->saveView($ro, $lifeTime);
     }
 }
diff --git a/src/QueryRepositoryModule.php b/src/QueryRepositoryModule.php
@@ -26,7 +26,6 @@ class QueryRepositoryModule extends AbstractModule
      */
     protected function configure()
     {
-        $this->bind(Expiry::class)->toInstance(new Expiry(60, 60 * 60, 60 * 60 * 24));
         $this->bind(QueryRepositoryInterface::class)->to(QueryRepository::class)->in(Scope::SINGLETON);
         $this->bind(Cache::class)->annotatedWith(Storage::class)->toProvider(StorageProvider::class)->in(Scope::SINGLETON);
         $this->bind(CacheProvider::class)->annotatedWith(Storage::class)->to(ArrayCache::class)->in(Scope::SINGLETON);
@@ -37,8 +36,9 @@ protected function configure()
         $this->bind()->annotatedWith(Commands::class)->toProvider(CommandsProvider::class);
         $this->bind()->annotatedWith(CacheVersion::class)->toInstance('');
         $this->bind(RefreshInterceptor::class);
-        $this->install(new QueryRepositoryAopModule());
         $this->bind(ResourceStorageInterface::class)->to(ResourceStorage::class);
+        $this->install(new QueryRepositoryAopModule());
+        $this->install(new StorageExpiryModule(60, 60 * 60, 60 * 60 * 24));
         // BC
         $this->bind(DeprecatedHttpCacheInterface::class)->to(HttpCache::class);
     }
diff --git a/src/RefreshInterceptor.php b/src/RefreshInterceptor.php
@@ -30,7 +30,7 @@ public function invoke(MethodInvocation $invocation)
         /** @psalm-suppress MixedAssignment */
         $ro = $invocation->proceed();
         if (! $ro instanceof ResourceObject) {
-            throw new ReturnValueIsNotResourceObjectException(get_class($invocation->getThis()));
+            throw new ReturnValueIsNotResourceObjectException(get_class($invocation->getThis())); // @codeCoverageIgnore
         }
 
         if ($ro->code < Code::BAD_REQUEST) {
diff --git a/src/RefreshSameCommand.php b/src/RefreshSameCommand.php
@@ -9,8 +9,10 @@
 use ReflectionMethod;
 
 use function array_values;
+use function assert;
 use function call_user_func_array;
 use function get_class;
+use function in_array;
 use function is_callable;
 use function sprintf;
 
@@ -31,11 +33,7 @@ public function __construct(QueryRepositoryInterface $repository)
      */
     public function command(MethodInvocation $invocation, ResourceObject $ro)
     {
-        $method = $invocation->getMethod()->getName();
-        if ($method === 'onGet' || $method === 'onPost') {
-            return;
-        }
-
+        assert(in_array($invocation->getMethod()->name, ['onPut', 'onDelete', 'onPatch']));
         unset($invocation);
         $getQuery = $this->getQuery($ro);
         $delUri = clone $ro->uri;
diff --git a/src/StorageRedisCacheProvider.php b/src/StorageRedisCacheProvider.php
@@ -39,9 +39,11 @@ public function get()
         $redis = new \Redis();
         try {
             $redis->connect($this->host, $this->port);
+            // @codeCoverageIgnoreStart
         } catch (RedisException $e) {
             /** @psalm-suppress UndefinedClass */
             throw new RedisConnectionException(sprintf('%s/%s', $this->host, $this->port), 0, $e);
+            // @codeCoverageIgnoreStart
         }
 
         $redisCache = new RedisCache();
diff --git a/tests/EtagSetterTest.php b/tests/EtagSetterTest.php
@@ -6,6 +6,7 @@
 
 use BEAR\Resource\Module\ResourceModule;
 use BEAR\Resource\ResourceInterface;
+use FakeVendor\HelloWorld\Resource\App\Code;
 use PHPUnit\Framework\TestCase;
 use Ray\Di\Injector;
 
@@ -20,6 +21,16 @@ protected function setUp(): void
         $this->resource = (new Injector(new QueryRepositoryModule(new ResourceModule('FakeVendor\HelloWorld')), $_ENV['TMP_DIR']))->getInstance(ResourceInterface::class);
     }
 
+    public function testStatusNotOk(): void
+    {
+        $setEtag = new EtagSetter();
+        $ro = new Code();
+        $ro->code = 500;
+        $setEtag($ro);
+        // $ro->headers['ETag']
+        $this->assertArrayNotHasKey('Etag', $ro->headers);
+    }
+
     public function testInvoke(): void
     {
         $ro = $this->resource->get('app://self/user', ['id' => 1]);
diff --git a/tests/Fake/fake-app/src/Resource/App/NullView.php b/tests/Fake/fake-app/src/Resource/App/NullView.php
@@ -0,0 +1,21 @@
+<?php
+/**
+ * This file is part of the BEAR.QueryRepository package.
+ *
+ * @license http://opensource.org/licenses/MIT MIT
+ */
+namespace FakeVendor\HelloWorld\Resource\App;
+
+use BEAR\RepositoryModule\Annotation\Cacheable;
+use BEAR\Resource\ResourceObject;
+
+/**
+ * @Cacheable(type="view")
+ */
+class NullView extends ResourceObject
+{
+    public function onGet()
+    {
+        return $this;
+    }
+}
diff --git a/tests/HttpCacheTest.php b/tests/HttpCacheTest.php
@@ -10,13 +10,17 @@
 use PHPUnit\Framework\TestCase;
 use Ray\Di\Injector;
 
+use function http_response_code;
+
 class HttpCacheTest extends TestCase
 {
-    public function testisNotModifiedFale(): void
+    public function testisNotModifiedFale(): CliHttpCache
     {
         $httpCache = new CliHttpCache(new ResourceStorage(new ArrayCache()));
         $server = [];
         $this->assertFalse($httpCache->isNotModified($server));
+
+        return $httpCache;
     }
 
     public function testisNotModifiedTrue(): CliHttpCache
@@ -35,9 +39,38 @@ public function testisNotModifiedTrue(): CliHttpCache
     /**
      * @depends testisNotModifiedTrue
      */
-    public function testTransfer(CliHttpCache $httpCache): void
+    public function testCliHttpCacheTransfer(CliHttpCache $httpCache): void
     {
         $this->expectOutputRegex('/\A304 Not Modified/');
         $httpCache->transfer();
     }
+
+    /**
+     * @depends testisNotModifiedTrue
+     * @covers \BEAR\QueryRepository\HttpCache::transfer
+     */
+    public function testHttpCacheTransfer(): void
+    {
+        $httpCache = new HttpCache(new ResourceStorage(new ArrayCache()));
+        $httpCache->transfer();
+        $this->assertSame(304, http_response_code());
+    }
+
+    /**
+     * @depends testisNotModifiedTrue
+     */
+    public function testHeaderSetInCli(): void
+    {
+        $resource = (new Injector(new QueryRepositoryModule(new ResourceModule('FakeVendor\HelloWorld'))))->getInstance(ResourceInterface::class);
+        $user = $resource->get('app://self/user', ['id' => 1]);
+        $storage = new ResourceStorage(new ArrayCache());
+        $storage->updateEtag($user, 10);
+        $httpCache = new CliHttpCache($storage);
+        $header = 'IF_NONE_MATCH=' . $user->headers['ETag'];
+        $server = [
+            'argc' => 4,
+            'argv' => [3 => $header],
+        ];
+        $this->assertTrue($httpCache->isNotModified($server));
+    }
 }
diff --git a/tests/QueryRepositoryTest.php b/tests/QueryRepositoryTest.php
@@ -10,6 +10,7 @@
 use BEAR\Resource\ResourceObject;
 use BEAR\Resource\Uri;
 use Doctrine\Common\Cache\CacheProvider;
+use FakeVendor\HelloWorld\Resource\App\NullView;
 use FakeVendor\HelloWorld\Resource\App\User\Profile;
 use FakeVendor\HelloWorld\Resource\Page\None;
 use PHPUnit\Framework\TestCase;
@@ -154,4 +155,16 @@ public function testSameResponseButDifferentParameter(): void
         $this->assertFalse($this->httpCache->isNotModified($server1), 'id:1 is modified');
         $this->assertTrue($this->httpCache->isNotModified($server2), 'id:2 is not modified');
     }
+
+    /**
+     * @covers \BEAR\QueryRepository\QueryRepository::saveViewCache
+     */
+    public function testRenderView(): void
+    {
+        $ro = new NullView();
+        $ro->uri = new Uri('app://self/null-view');
+        $ro->body = ['time' => '0'];
+        $this->repository->put($ro);
+        $this->assertIsString($ro->view);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -37,12 +37,10 @@ public function invoke(MethodInvocation $invocation)`
`37`	`37`	`assert($ro instanceof ResourceObject);`
`38`	`38`	`try {`
`39`	`39`	`$stored = $this->repository->get($ro->uri);`
`40`		`- } catch (LogicException $e) {`
`41`		`- throw $e;`
`42`	`40`	`} catch (Throwable $e) {`
`43`	`41`	`$this->triggerWarning($e);`
`44`	`42`
`45`		`- return $invocation->proceed();`
	`43`	`+ return $invocation->proceed(); // @codeCoverageIgnore`
`46`	`44`	`}`
`47`	`45`
`48`	`46`	`if ($stored) {`
`@@ -58,8 +56,8 @@ public function invoke(MethodInvocation $invocation)`
`58`	`56`	`$ro->code === 200 ? $this->repository->put($ro) : $this->repository->purge($ro->uri);`
`59`	`57`	`} catch (LogicException $e) {`
`60`	`58`	`throw $e;`
`61`		`- } catch (Throwable $e) {`
`62`		`- $this->triggerWarning($e);`
	`59`	`+ } catch (Throwable $e) { // @codeCoverageIgnore`
	`60`	`+ $this->triggerWarning($e); // @codeCoverageIgnore`
`63`	`61`	`}`
`64`	`62`
`65`	`63`	`return $ro;`
`@@ -74,5 +72,6 @@ private function triggerWarning(Throwable $e): void`
`74`	`72`	`{`
`75`	`73`	`$message = sprintf('%s: %s in %s:%s', get_class($e), $e->getMessage(), $e->getFile(), $e->getLine());`
`76`	`74`	`trigger_error($message, E_USER_WARNING);`
	`75`	`+ // @codeCoverageIgnoreStart`
`77`	`76`	`}`
`78`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public function __construct(ResourceStorageInterface $storage)`
`30`	`30`	`public function isNotModified(array $server): bool`
`31`	`31`	`{`
`32`	`32`	`/** @var array{HTTP_IF_NONE_MATCH: string}\|array{argc: int, argv: array} $server */`
`33`		`- $hasRequestHeaderInCli = isset($server['argc']) && $server['argc'] === 4 && isset($server['argv']);`
	`33`	`+ $hasRequestHeaderInCli = isset($server['argc']) && $server['argc'] === 4 && isset($server['argv'][3]);`
`34`	`34`	`if ($hasRequestHeaderInCli) {`
`35`	`35`	`$server = $this->setRequestHeaders($server, $server['argv'][3]); // @phpstan-ignore-line`
`36`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -175,10 +175,6 @@ private function setMaxAge(ResourceObject $ro, int $age)`
`175`	`175`
`176`	`176`	`private function saveViewCache(ResourceObject $ro, int $lifeTime): bool`
`177`	`177`	`{`
`178`		`- if (! $ro->view) {`
`179`		`- $ro->view = $ro->toString();`
`180`		`- }`
`181`		`-`
`182`	`178`	`return $this->storage->saveView($ro, $lifeTime);`
`183`	`179`	`}`
`184`	`180`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public function invoke(MethodInvocation $invocation)`
`30`	`30`	`/** @psalm-suppress MixedAssignment */`
`31`	`31`	`$ro = $invocation->proceed();`
`32`	`32`	`if (! $ro instanceof ResourceObject) {`
`33`		`- throw new ReturnValueIsNotResourceObjectException(get_class($invocation->getThis()));`
	`33`	`+ throw new ReturnValueIsNotResourceObjectException(get_class($invocation->getThis())); // @codeCoverageIgnore`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`if ($ro->code < Code::BAD_REQUEST) {`