refactoring and finished BloomFilter integration tests from client

averias · averias · commit aa1479144b67 · 2019-11-12T17:05:36.000+01:00
diff --git a/src/RedisBloomClient/Client/BaseRedisBloomClient.php b/src/RedisBloomClient/Client/BaseRedisBloomClient.php
@@ -0,0 +1,43 @@
+<?php
+/**
+ * @project   phpredis-bloom
+ * @author    Rafael Campoy <rafa.campoy@gmail.com>
+ * @copyright 2019 Rafael Campoy <rafa.campoy@gmail.com>
+ * @license   MIT
+ * @link      https://github.com/averias/php-rejson
+ *
+ * Copyright and license information, is included in
+ * the LICENSE file that is distributed with this source code.
+ */
+
+namespace Averias\RedisBloom\Client;
+
+use Averias\RedisBloom\Adapter\RedisClientAdapterInterface;
+use Averias\RedisBloom\Exception\ResponseException;
+use Averias\RedisBloom\Parser\ParserTrait;
+
+class BaseRedisBloomClient
+{
+    use ParserTrait;
+
+    /** @var RedisClientAdapterInterface */
+    protected $redisClientAdapter;
+
+    public function __construct(RedisClientAdapterInterface $redisClientAdapter)
+    {
+        $this->redisClientAdapter = $redisClientAdapter;
+    }
+
+    /**
+     * @param string $command
+     * @param string $key
+     * @param array $params
+     * @return mixed
+     * @throws ResponseException
+     */
+    protected function executeBloomCommand(string $command, string $key, array $params = [])
+    {
+        $response = $this->redisClientAdapter->executeBloomCommand($command, $key, $params);
+        return $this->parseResponse($command, $response);
+    }
+}
diff --git a/src/RedisBloomClient/Client/RedisBloomClient.php b/src/RedisBloomClient/Client/RedisBloomClient.php
@@ -14,23 +14,12 @@
 
 use Averias\RedisBloom\Command\Traits\BloomCommandTrait;
 use Averias\RedisBloom\Exception\ResponseException;
-use Averias\RedisBloom\Adapter\RedisClientAdapterInterface;
-use Averias\RedisBloom\Parser\ParserTrait;
 use Averias\RedisBloom\Validator\InputValidatorTrait;
 
-class RedisBloomClient implements RedisBloomClientInterface
+class RedisBloomClient extends BaseRedisBloomClient implements RedisBloomClientInterface
 {
     use BloomCommandTrait;
     use InputValidatorTrait;
-    use ParserTrait;
-
-    /** @var RedisClientAdapterInterface */
-    protected $redisClientAdapter;
-
-    public function __construct(RedisClientAdapterInterface $redisClientAdapter)
-    {
-        $this->redisClientAdapter = $redisClientAdapter;
-    }
 
     /**
      * @param string $commandName
@@ -53,17 +42,4 @@ public function __call(string $name, array $arguments)
     {
         return $this->redisClientAdapter->executeCommandByName($name, $arguments);
     }
-
-    /**
-     * @param string $command
-     * @param string $key
-     * @param array $params
-     * @return mixed
-     * @throws ResponseException
-     */
-    protected function executeBloomCommand(string $command, string $key, array $params = [])
-    {
-        $response = $this->redisClientAdapter->executeBloomCommand($command, $key, $params);
-        return $this->parseResponse($command, $response);
-    }
 }
diff --git a/src/RedisBloomClient/DataTypes/BaseDataType.php b/src/RedisBloomClient/DataTypes/BaseDataType.php
@@ -13,37 +13,21 @@
 namespace Averias\RedisBloom\DataTypes;
 
 use Averias\RedisBloom\Adapter\RedisClientAdapterInterface;
-use Averias\RedisBloom\Exception\ResponseException;
+use Averias\RedisBloom\Client\BaseRedisBloomClient;
 use Averias\RedisBloom\Parser\ParserTrait;
 use Averias\RedisBloom\Validator\InputValidatorTrait;
 
-class BaseDataType
+class BaseDataType extends BaseRedisBloomClient
 {
     use InputValidatorTrait;
     use ParserTrait;
 
     /** @var string */
     protected $name;
 
-    /** @var RedisClientAdapterInterface */
-    protected $redisClientAdapter;
-
     public function __construct(string $filterName, RedisClientAdapterInterface $redisClientAdapter)
     {
+        parent::__construct($redisClientAdapter);
         $this->name = $filterName;
-        $this->redisClientAdapter = $redisClientAdapter;
-    }
-
-    /**
-     * @param string $command
-     * @param string $key
-     * @param array $params
-     * @return mixed
-     * @throws ResponseException
-     */
-    protected function executeBloomCommand(string $command, string $key, array $params = [])
-    {
-        $response = $this->redisClientAdapter->executeBloomCommand($command, $key, $params);
-        return $this->parseResponse($command, $response);
     }
 }
diff --git a/src/RedisBloomClient/Factory/RedisBloomClientFactoryInterface.php b/src/RedisBloomClient/Factory/RedisBloomClientFactoryInterface.php
@@ -12,9 +12,13 @@
 
 namespace Averias\RedisBloom\Factory;
 
+use Averias\RedisBloom\Adapter\RedisClientAdapterInterface;
 use Averias\RedisBloom\Client\RedisBloomClientInterface;
+use Averias\RedisBloom\DataTypes\BloomFilter;
 
 interface RedisBloomClientFactoryInterface
 {
+    public function getAdapter(array $config = []): RedisClientAdapterInterface;
     public function createClient(array $config): RedisBloomClientInterface;
+    public function createBloomFilter(string $filterName, array $config = []): BloomFilter;
 }
diff --git a/src/RedisBloomClient/Parser/Request/BloomFilterInsertOptionalParams.php b/src/RedisBloomClient/Parser/Request/BloomFilterInsertOptionalParams.php
@@ -23,6 +23,7 @@ class BloomFilterInsertOptionalParams implements ParserInterface
     /**
      * @param $optionalParams
      * @return array
+     * @throws ResponseException
      */
     public function parse($optionalParams)
     {
diff --git a/src/RedisBloomClient/Parser/Response/ArrayOfIntegerToBool.php b/src/RedisBloomClient/Parser/Response/ArrayOfIntegerToBool.php
@@ -16,6 +16,10 @@
 
 class ArrayOfIntegerToBool extends BaseResponseParser implements ParserInterface
 {
+    /**
+     * @param $response
+     * @return mixed
+     */
     public function parse($response)
     {
         foreach ($response as $key => $item) {
diff --git a/src/RedisBloomClient/Parser/Response/BaseResponseParser.php b/src/RedisBloomClient/Parser/Response/BaseResponseParser.php
@@ -14,6 +14,10 @@
 
 class BaseResponseParser
 {
+    /**
+     * @param int $data
+     * @return bool
+     */
     public function convertIntegerToBool(int $data)
     {
         return (bool) $data;
diff --git a/src/RedisBloomClient/Parser/Response/IntegerToBool.php b/src/RedisBloomClient/Parser/Response/IntegerToBool.php
@@ -16,6 +16,10 @@
 
 class IntegerToBool extends BaseResponseParser implements ParserInterface
 {
+    /**
+     * @param $response
+     * @return bool
+     */
     public function parse($response)
     {
         return $this->convertIntegerToBool($response);
diff --git a/src/RedisBloomClient/Parser/Response/OkToTrue.php b/src/RedisBloomClient/Parser/Response/OkToTrue.php
@@ -17,6 +17,11 @@
 
 class OkToTrue implements ParserInterface
 {
+    /**
+     * @param $response
+     * @return bool
+     * @throws ResponseException
+     */
     public function parse($response): bool
     {
         if (!is_string($response)) {
diff --git a/tests/Integration/BaseTestIntegration.php b/tests/Integration/BaseTestIntegration.php
@@ -39,7 +39,10 @@ public static function tearDownAfterClass(): void
         }
     }
 
-    protected static function getReBloomClientConfig()
+    /**
+     * @return array
+     */
+    protected static function getReBloomClientConfig(): array
     {
         return [
             Connection::HOST => REDIS_TEST_SERVER,
diff --git a/tests/Integration/Command/Traits/BloomFilter/BloomFilterAddCommandTest.php b/tests/Integration/Command/Traits/BloomFilter/BloomFilterAddCommandTest.php
@@ -23,7 +23,7 @@ class BloomFilterAddCommandTest extends BaseTestIntegration
      * @param $item
      * @param bool $expectedResult
      */
-    public function testAddItemSuccessfully(string $key, $item, bool $expectedResult)
+    public function testAddItemSuccessfully(string $key, $item, bool $expectedResult): void
     {
         $result = static::$reBloomClient->bloomFilterAdd($key, $item);
         $this->assertSame($expectedResult, $result);
@@ -34,13 +34,13 @@ public function testAddItemSuccessfully(string $key, $item, bool $expectedResult
      * @param string $key
      * @param $item
      */
-    public function testAddItemException(string $key, $item)
+    public function testAddItemException(string $key, $item): void
     {
         $this->expectException(ResponseException::class);
         static::$reBloomClient->bloomFilterAdd($key, $item);
     }
 
-    public function getSuccessDataProvider()
+    public function getSuccessDataProvider(): array
     {
         return [
             ['key-add1', 12, true],
diff --git a/tests/Integration/Command/Traits/BloomFilter/BloomFilterExistsCommandTest.php b/tests/Integration/Command/Traits/BloomFilter/BloomFilterExistsCommandTest.php
@@ -29,19 +29,19 @@ public static function setUpBeforeClass():void
      * @param string $key
      * @param $item
      */
-    public function testExistsItem(string $key, $item)
+    public function testExistsItem(string $key, $item): void
     {
         $result = static::$reBloomClient->bloomFilterExists($key, $item);
         $this->assertTrue($result);
     }
 
-    public function testDoesntExistItem()
+    public function testDoesntExistItem(): void
     {
         $result = static::$reBloomClient->bloomFilterExists(Keys::DEFAULT_KEY, 'bar');
         $this->assertFalse($result);
     }
 
-    public function testNonExistentKey()
+    public function testNonExistentKey(): void
     {
         $result = static::$reBloomClient->bloomFilterExists('nonexistent-key', 'bar');
         $this->assertFalse($result);
@@ -52,13 +52,13 @@ public function testNonExistentKey()
      * @param string $key
      * @param $item
      */
-    public function testExistsItemException(string $key, $item)
+    public function testExistsItemException(string $key, $item): void
     {
         $this->expectException(ResponseException::class);
         static::$reBloomClient->bloomFilterExists($key, $item);
     }
 
-    public function getExistsDataProvider()
+    public function getExistsDataProvider(): array
     {
         return [
             [Keys::DEFAULT_KEY, 'foo'],
@@ -69,7 +69,7 @@ public function getExistsDataProvider()
         ];
     }
 
-    public function getDataProviderForException()
+    public function getDataProviderForException(): array
     {
         return [
             [Keys::DEFAULT_KEY, [[1, 2]]],
diff --git a/tests/Integration/Command/Traits/BloomFilter/BloomFilterInsertCommandTest.php b/tests/Integration/Command/Traits/BloomFilter/BloomFilterInsertCommandTest.php
@@ -25,8 +25,12 @@ class BloomFilterInsertCommandTest extends BaseTestIntegration
      * @param array $options
      * @param array $expectedResult
      */
-    public function testInsertSuccessfullyWithNoOptions(string $key, array $items, array $options, array $expectedResult)
-    {
+    public function testInsertSuccessfullyWithNoOptions(
+        string $key,
+        array $items,
+        array $options,
+        array $expectedResult
+    ): void {
         $result = static::$reBloomClient->bloomFilterInsert($key, $items, $options);
         $this->assertSame($expectedResult, $result);
     }
@@ -38,8 +42,12 @@ public function testInsertSuccessfullyWithNoOptions(string $key, array $items, a
      * @param array $options
      * @param array $expectedResult
      */
-    public function testInsertSuccessfullyWithOptions(string $key, array $items, array $options, array $expectedResult)
-    {
+    public function testInsertSuccessfullyWithOptions(
+        string $key,
+        array $items,
+        array $options,
+        array $expectedResult
+    ): void {
         $result = static::$reBloomClient->bloomFilterInsert($key, $items, $options);
         $this->assertSame($expectedResult, $result);
     }
@@ -50,7 +58,7 @@ public function testInsertSuccessfullyWithOptions(string $key, array $items, arr
      * @param array $items
      * @param array $options
      */
-    public function testInsertException(string $key, array $items, array $options)
+    public function testInsertException(string $key, array $items, array $options): void
     {
         $this->expectException(ResponseException::class);
         static::$reBloomClient->bloomFilterInsert($key, $items, $options);
@@ -112,7 +120,7 @@ public function getSuccessWithOptionsDataProvider(): array
         ];
     }
 
-    public function getDataProviderForException()
+    public function getDataProviderForException(): array
     {
         return [
             [ // fails cause with NOCREATE filter must exist
diff --git a/tests/Integration/Command/Traits/BloomFilter/BloomFilterLoadChunkTest.php b/tests/Integration/Command/Traits/BloomFilter/BloomFilterLoadChunkTest.php
@@ -0,0 +1,55 @@
+<?php
+/**
+ * @project   phpredis-bloom
+ * @author    Rafael Campoy <rafa.campoy@gmail.com>
+ * @copyright 2019 Rafael Campoy <rafa.campoy@gmail.com>
+ * @license   MIT
+ * @link      https://github.com/averias/php-rejson
+ *
+ * Copyright and license information, is included in
+ * the LICENSE file that is distributed with this source code.
+ */
+
+namespace Averias\RedisBloom\Tests\Integration\Command\Traits\BloomFilter;
+
+use Averias\RedisBloom\Enum\Keys;
+use Averias\RedisBloom\Exception\ResponseException;
+use Averias\RedisBloom\Tests\BaseTestIntegration;
+
+class BloomFilterLoadChunkTest extends BaseTestIntegration
+{
+    protected static $data = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
+
+    public static function setUpBeforeClass():void
+    {
+        parent::setUpBeforeClass();
+        static::$reBloomClient->bloomFilterMultiAdd(Keys::DEFAULT_KEY, ...self::$data);
+    }
+
+    public function testLoadChunk(): void
+    {
+        $iterator = 0;
+        while (true) {
+            list ($iterator, $data) = $result = static::$reBloomClient->bloomFilterScanDump(
+                Keys::DEFAULT_KEY,
+                $iterator
+            );
+            if ($iterator == 0) {
+                break;
+            }
+            $result = static::$reBloomClient->bloomFilterLoadChunk('copy-filter', $iterator, $data);
+            $this->assertTrue($result);
+        }
+
+        $copiedData = static::$reBloomClient->bloomFilterMultiExists('copy-filter', ...self::$data);
+        foreach ($copiedData as $item) {
+            $this->assertTrue($item);
+        }
+    }
+
+    public function testLoadChunkException(): void
+    {
+        $this->expectException(ResponseException::class);
+        static::$reBloomClient->bloomFilterLoadChunk('nonexistent', 556, 1);
+    }
+}
diff --git a/tests/Integration/Command/Traits/BloomFilter/BloomFilterMultiAddCommandTest.php b/tests/Integration/Command/Traits/BloomFilter/BloomFilterMultiAddCommandTest.php
diff --git a/tests/Integration/Command/Traits/BloomFilter/BloomFilterMultiExistsCommandTest.php b/tests/Integration/Command/Traits/BloomFilter/BloomFilterMultiExistsCommandTest.php
diff --git a/tests/Integration/Command/Traits/BloomFilter/BloomFilterReserveCommandTest.php b/tests/Integration/Command/Traits/BloomFilter/BloomFilterReserveCommandTest.php
diff --git a/tests/Integration/Command/Traits/BloomFilter/BloomFilterScanDumpTest.php b/tests/Integration/Command/Traits/BloomFilter/BloomFilterScanDumpTest.php

Original file line number	Diff line number	Diff line change
`@@ -12,9 +12,13 @@`
`12`	`12`
`13`	`13`	`namespace Averias\RedisBloom\Factory;`
`14`	`14`
	`15`	`+use Averias\RedisBloom\Adapter\RedisClientAdapterInterface;`
`15`	`16`	`use Averias\RedisBloom\Client\RedisBloomClientInterface;`
	`17`	`+use Averias\RedisBloom\DataTypes\BloomFilter;`
`16`	`18`
`17`	`19`	`interface RedisBloomClientFactoryInterface`
`18`	`20`	`{`
	`21`	`+ public function getAdapter(array $config = []): RedisClientAdapterInterface;`
`19`	`22`	`public function createClient(array $config): RedisBloomClientInterface;`
	`23`	`+ public function createBloomFilter(string $filterName, array $config = []): BloomFilter;`
`20`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ class BloomFilterInsertOptionalParams implements ParserInterface`
`23`	`23`	`/**`
`24`	`24`	`* @param $optionalParams`
`25`	`25`	`* @return array`
	`26`	`+ * @throws ResponseException`
`26`	`27`	`*/`
`27`	`28`	`public function parse($optionalParams)`
`28`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,10 @@`
`16`	`16`
`17`	`17`	`class ArrayOfIntegerToBool extends BaseResponseParser implements ParserInterface`
`18`	`18`	`{`
	`19`	`+ /**`
	`20`	`+ * @param $response`
	`21`	`+ * @return mixed`
	`22`	`+ */`
`19`	`23`	`public function parse($response)`
`20`	`24`	`{`
`21`	`25`	`foreach ($response as $key => $item) {`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,10 @@`
`14`	`14`
`15`	`15`	`class BaseResponseParser`
`16`	`16`	`{`
	`17`	`+ /**`
	`18`	`+ * @param int $data`
	`19`	`+ * @return bool`
	`20`	`+ */`
`17`	`21`	`public function convertIntegerToBool(int $data)`
`18`	`22`	`{`
`19`	`23`	`return (bool) $data;`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,11 @@`
`17`	`17`
`18`	`18`	`class OkToTrue implements ParserInterface`
`19`	`19`	`{`
	`20`	`+ /**`
	`21`	`+ * @param $response`
	`22`	`+ * @return bool`
	`23`	`+ * @throws ResponseException`
	`24`	`+ */`
`20`	`25`	`public function parse($response): bool`
`21`	`26`	`{`
`22`	`27`	`if (!is_string($response)) {`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,10 @@ public static function tearDownAfterClass(): void`
`39`	`39`	`}`
`40`	`40`	`}`
`41`	`41`
`42`		`- protected static function getReBloomClientConfig()`
	`42`	`+ /**`
	`43`	`+ * @return array`
	`44`	`+ */`
	`45`	`+ protected static function getReBloomClientConfig(): array`
`43`	`46`	`{`
`44`	`47`	`return [`
`45`	`48`	`Connection::HOST => REDIS_TEST_SERVER,`