Improve client error message + add missing factory in facade + more tests

MacFJA · MacFJA · commit 8ebffb438b81 · 2021-11-04T19:59:41.000+01:00
diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-.PHONY: analyze fix-code test coverage validation integration-test
+.PHONY: analyze fix-code test test-with-integration coverage coverage-with-integration validation integration-test integration-coverage
 
 analyze: | vendor
 	$(COMPOSER) exec -v parallel-lint -- src
@@ -18,14 +18,25 @@ fix-code: | vendor
 test: | vendor
 	$(COMPOSER) exec -v phpunit
 
+test-with-integration: | vendor
+	$(COMPOSER) exec -v phpunit -- --group default,integration
+
 coverage: | vendor
 	@if [ -z "`php -v | grep -i 'xdebug'`" ]; then echo "You need to install Xdebug in order to do this action"; exit 1; fi
 	$(COMPOSER) exec -v phpunit -- --coverage-text --color
 
+coverage-with-integration: | vendor
+	@if [ -z "`php -v | grep -i 'xdebug'`" ]; then echo "You need to install Xdebug in order to do this action"; exit 1; fi
+	$(COMPOSER) exec -v phpunit -- --group default,integration --coverage-text --color
+
 integration-test: | vendor
 	$(COMPOSER) exec -v phpunit -- --group integration
 
-validation: fix-code analyze test coverage integration-test
+integration-coverage: | vendor
+	@if [ -z "`php -v | grep -i 'xdebug'`" ]; then echo "You need to install Xdebug in order to do this action"; exit 1; fi
+	$(COMPOSER) exec -v phpunit -- --group integration --coverage-text --color
+
+validation: fix-code analyze test-with-integration coverage-with-integration
 
 vendor: composer.json
 	$(COMPOSER) install --optimize-autoloader --no-suggest --prefer-dist
diff --git a/src/Redis/Client/AbstractClient.php b/src/Redis/Client/AbstractClient.php
@@ -24,6 +24,7 @@
 use function count;
 use MacFJA\RediSearch\Redis\Client;
 use MacFJA\RediSearch\Redis\Command;
+use function strlen;
 
 abstract class AbstractClient implements Client
 {
@@ -71,7 +72,7 @@ protected function getMissingMessage(string $name, bool $isExtension, array $cla
         if (true === $isExtension) {
             $message = 'The extension '.$name.' is missing.'.PHP_EOL.'Install the extension';
         }
-        $message .= ' or use a polyfill that provide ';
+        $message .= ' or use a polyfill';
 
         $classesMessage = null;
         if (1 === count($classes)) {
@@ -92,8 +93,11 @@ protected function getMissingMessage(string $name, bool $isExtension, array $cla
             $functionsMessage = 'the functions "'.implode('", "', $functions).'"';
         }
 
-        $message .= implode(' and ', array_filter([$classesMessage, $methodsMessage, $functionsMessage]));
-        $message .= '.';
+        $additional = implode(' and ', array_filter([$classesMessage, $methodsMessage, $functionsMessage]));
+        if (strlen($additional) > 0) {
+            $additional = ' that provide '.$additional;
+        }
+        $message .= $additional.'.';
 
         return $message;
     }
diff --git a/src/Redis/Client/AmpRedisClient.php b/src/Redis/Client/AmpRedisClient.php
@@ -29,9 +29,6 @@
 use MacFJA\RediSearch\Redis\Command;
 use RuntimeException;
 
-/**
- * @codeCoverageIgnore
- */
 class AmpRedisClient extends AbstractClient
 {
     /** @var Redis */
diff --git a/src/Redis/Client/CheprasovRedisClient.php b/src/Redis/Client/CheprasovRedisClient.php
@@ -28,9 +28,6 @@
 use RedisClient\Pipeline\PipelineInterface;
 use RuntimeException;
 
-/**
- * @codeCoverageIgnore
- */
 class CheprasovRedisClient extends AbstractClient
 {
     /** @var AbstractRedisClient */
diff --git a/src/Redis/Client/ClientFacade.php b/src/Redis/Client/ClientFacade.php
@@ -31,9 +31,6 @@
 use Rediska as RediskaRedis;
 use RuntimeException;
 
-/**
- * @codeCoverageIgnore
- */
 class ClientFacade
 {
     /** @var array<string> */
@@ -46,6 +43,7 @@ class ClientFacade
         RedisentClient::class,
         RediskaClient::class,
         AmpRedisClient::class,
+        TinyRedisClient::class,
     ];
 
     /**
diff --git a/src/Redis/Client/CredisClient.php b/src/Redis/Client/CredisClient.php
@@ -27,9 +27,6 @@
 use MacFJA\RediSearch\Redis\Command;
 use RuntimeException;
 
-/**
- * @codeCoverageIgnore
- */
 class CredisClient extends AbstractClient
 {
     /** @var Credis_Client */
diff --git a/src/Redis/Client/PredisClient.php b/src/Redis/Client/PredisClient.php
@@ -29,9 +29,6 @@
 use Predis\Command\RawCommand;
 use RuntimeException;
 
-/**
- * @codeCoverageIgnore
- */
 class PredisClient extends AbstractClient
 {
     /** @var ClientInterface */
diff --git a/src/Redis/Client/RedisentClient.php b/src/Redis/Client/RedisentClient.php
@@ -26,9 +26,6 @@
 use redisent\Redis;
 use RuntimeException;
 
-/**
- * @codeCoverageIgnore
- */
 class RedisentClient extends AbstractClient
 {
     /** @var Redis */
diff --git a/src/Redis/Client/RediskaClient.php b/src/Redis/Client/RediskaClient.php
@@ -31,9 +31,6 @@
 use Rediska_Connection_Exec;
 use RuntimeException;
 
-/**
- * @codeCoverageIgnore
- */
 class RediskaClient extends AbstractClient
 {
     /** @var Rediska */
diff --git a/src/Redis/Client/TinyRedisClient.php b/src/Redis/Client/TinyRedisClient.php
@@ -25,9 +25,6 @@
 use MacFJA\RediSearch\Redis\Command;
 use RuntimeException;
 
-/**
- * @codeCoverageIgnore
- */
 class TinyRedisClient extends AbstractClient
 {
     /** @var \TinyRedisClient */
@@ -80,6 +77,9 @@ public static function make($redis): Client
         return new self($redis);
     }
 
+    /**
+     * @codeCoverageIgnore
+     */
     protected function doPipeline(Command ...$commands): array
     {
         return [];
diff --git a/src/Redis/Response/PaginatedResponse.php b/src/Redis/Response/PaginatedResponse.php
@@ -128,7 +128,7 @@ public function getTotalCount(): int
 
     public function count()
     {
-        return $this->totalCount;
+        return $this->getTotalCount();
     }
 
     private function updateWithLimit(int $offset, int $size): void
diff --git a/tests/Redis/Client/AbstractClientTest.php b/tests/Redis/Client/AbstractClientTest.php
@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Copyright MacFJA
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+namespace MacFJA\RediSearch\tests\Redis\Client;
+
+use MacFJA\RediSearch\tests\fixtures\Redis\Client\FakeAbstractClient;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \MacFJA\RediSearch\Redis\Client\AbstractClient
+ *
+ * @internal
+ */
+class AbstractClientTest extends TestCase
+{
+    public function testGetMissingMessage(): void
+    {
+        $fake = new FakeAbstractClient();
+
+        static::assertSame(
+            'The dependency foo is missing.'.PHP_EOL.'Install the dependency or use a polyfill.',
+            $fake->exposeGetMissingMessage('foo', false, [])
+        );
+
+        static::assertSame(
+            'The dependency bar is missing.'.PHP_EOL.'Install the dependency or use a polyfill that provide the class "baz" and the method "baz::hello".',
+            $fake->exposeGetMissingMessage('bar', false, ['baz' => ['hello']])
+        );
+
+        static::assertSame(
+            'The dependency baz is missing.'.PHP_EOL.'Install the dependency or use a polyfill that provide the function "foobar".',
+            $fake->exposeGetMissingMessage('baz', false, [], ['foobar'])
+        );
+
+        static::assertSame(
+            'The dependency DEP is missing.'.PHP_EOL.'Install the dependency or use a polyfill that provide the classes "C", "CL" and the methods "C::m", "C::e", "CL::t", "CL::h" and the functions "f", "u".',
+            $fake->exposeGetMissingMessage('DEP', false, ['C' => ['m', 'e'], 'CL' => ['t', 'h']], ['f', 'u'])
+        );
+
+        static::assertSame(
+            'The extension foobar is missing.'.PHP_EOL.'Install the extension or use a polyfill.',
+            $fake->exposeGetMissingMessage('foobar', true, [])
+        );
+    }
+}
diff --git a/tests/Redis/Client/ClientFacadeTest.php b/tests/Redis/Client/ClientFacadeTest.php
@@ -0,0 +1,89 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Copyright MacFJA
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+namespace MacFJA\RediSearch\tests\Redis\Client;
+
+use function get_class;
+use MacFJA\RediSearch\Redis\Client;
+use MacFJA\RediSearch\Redis\Client\ClientFacade;
+use MacFJA\RediSearch\Redis\Command;
+use PHPUnit\Framework\TestCase;
+use RuntimeException;
+use stdClass;
+
+/**
+ * @covers \MacFJA\RediSearch\Redis\Client\ClientFacade
+ *
+ * @uses \MacFJA\RediSearch\Redis\Client\AbstractClient
+ * @uses \MacFJA\RediSearch\Redis\Client\AmpRedisClient
+ * @uses \MacFJA\RediSearch\Redis\Client\CheprasovRedisClient
+ * @uses \MacFJA\RediSearch\Redis\Client\PredisClient
+ * @uses \MacFJA\RediSearch\Redis\Client\RedisentClient
+ * @uses \MacFJA\RediSearch\Redis\Client\RediskaClient
+ * @uses \MacFJA\RediSearch\Redis\Client\CredisClient
+ * @uses \MacFJA\RediSearch\Redis\Client\TinyRedisClient
+ *
+ * @internal
+ */
+class ClientFacadeTest extends TestCase
+{
+    public function testGetClientError(): void
+    {
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('Unable to handle the Redis connection');
+
+        $facade = new ClientFacade();
+        $facade->getClient(new stdClass());
+    }
+
+    public function testAddFactory(): void
+    {
+        $facade = new ClientFacade();
+        static::assertFalse($facade->addFactory('Foobar'));
+
+        static::assertTrue($facade->addFactory(get_class(new class() implements Client {
+            public static function make($redis): Client
+            {
+                return new self();
+            }
+
+            public function execute(Command $command): void
+            {
+                // Do nothing
+            }
+
+            public function executeRaw(...$args): void
+            {
+                // Do nothing
+            }
+
+            public function pipeline(Command ...$commands): array
+            {
+                return [];
+            }
+
+            public static function supports($redis): bool
+            {
+                return false;
+            }
+        })));
+    }
+}
diff --git a/tests/fixtures/Redis/Client/FakeAbstractClient.php b/tests/fixtures/Redis/Client/FakeAbstractClient.php
@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Copyright MacFJA
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+namespace MacFJA\RediSearch\tests\fixtures\Redis\Client;
+
+use MacFJA\RediSearch\Redis\Client;
+use MacFJA\RediSearch\Redis\Command;
+
+class FakeAbstractClient extends \MacFJA\RediSearch\Redis\Client\AbstractClient
+{
+    public static function make($redis): Client
+    {
+        return new self();
+    }
+
+    public function execute(Command $command): void
+    {
+        // Do nothing
+    }
+
+    public function executeRaw(...$args): void
+    {
+        // Do nothing
+    }
+
+    public static function supports($redis): bool
+    {
+        return false;
+    }
+
+    /**
+     * @param array<string,array<string>> $classesMethods
+     * @param array<string>               $functions
+     */
+    public function exposeGetMissingMessage(string $name, bool $isExtension, array $classesMethods, array $functions = []): string
+    {
+        return $this->getMissingMessage($name, $isExtension, $classesMethods, $functions);
+    }
+
+    protected function doPipeline(Command ...$commands): array
+    {
+        return [];
+    }
+}
diff --git a/tests/integration/DockerTest.php b/tests/integration/DockerTest.php

Original file line number	Diff line number	Diff line change
`@@ -29,9 +29,6 @@`
`29`	`29`	`use MacFJA\RediSearch\Redis\Command;`
`30`	`30`	`use RuntimeException;`
`31`	`31`
`32`		`-/**`
`33`		`- * @codeCoverageIgnore`
`34`		`- */`
`35`	`32`	`class AmpRedisClient extends AbstractClient`
`36`	`33`	`{`
`37`	`34`	`/** @var Redis */`
Original file line number	Diff line number	Diff line change
`@@ -28,9 +28,6 @@`
`28`	`28`	`use RedisClient\Pipeline\PipelineInterface;`
`29`	`29`	`use RuntimeException;`
`30`	`30`
`31`		`-/**`
`32`		`- * @codeCoverageIgnore`
`33`		`- */`
`34`	`31`	`class CheprasovRedisClient extends AbstractClient`
`35`	`32`	`{`
`36`	`33`	`/** @var AbstractRedisClient */`
Original file line number	Diff line number	Diff line change
`@@ -27,9 +27,6 @@`
`27`	`27`	`use MacFJA\RediSearch\Redis\Command;`
`28`	`28`	`use RuntimeException;`
`29`	`29`
`30`		`-/**`
`31`		`- * @codeCoverageIgnore`
`32`		`- */`
`33`	`30`	`class CredisClient extends AbstractClient`
`34`	`31`	`{`
`35`	`32`	`/** @var Credis_Client */`
Original file line number	Diff line number	Diff line change
`@@ -26,9 +26,6 @@`
`26`	`26`	`use redisent\Redis;`
`27`	`27`	`use RuntimeException;`
`28`	`28`
`29`		`-/**`
`30`		`- * @codeCoverageIgnore`
`31`		`- */`
`32`	`29`	`class RedisentClient extends AbstractClient`
`33`	`30`	`{`
`34`	`31`	`/** @var Redis */`
Original file line number	Diff line number	Diff line change
`@@ -31,9 +31,6 @@`
`31`	`31`	`use Rediska_Connection_Exec;`
`32`	`32`	`use RuntimeException;`
`33`	`33`
`34`		`-/**`
`35`		`- * @codeCoverageIgnore`
`36`		`- */`
`37`	`34`	`class RediskaClient extends AbstractClient`
`38`	`35`	`{`
`39`	`36`	`/** @var Rediska */`
Original file line number	Diff line number	Diff line change
`@@ -25,9 +25,6 @@`
`25`	`25`	`use MacFJA\RediSearch\Redis\Command;`
`26`	`26`	`use RuntimeException;`
`27`	`27`
`28`		`-/**`
`29`		`- * @codeCoverageIgnore`
`30`		`- */`
`31`	`28`	`class TinyRedisClient extends AbstractClient`
`32`	`29`	`{`
`33`	`30`	`/** @var \TinyRedisClient */`
`@@ -80,6 +77,9 @@ public static function make($redis): Client`
`80`	`77`	`return new self($redis);`
`81`	`78`	`}`
`82`	`79`
	`80`	`+ /**`
	`81`	`+ * @codeCoverageIgnore`
	`82`	`+ */`
`83`	`83`	`protected function doPipeline(Command ...$commands): array`
`84`	`84`	`{`
`85`	`85`	`return [];`