Readrows Filter and system test (#1322)

* System test for filter * update doc * throw exception if rowKeys is not array in readRows * Simplified some fitler test * use dataprovider for filter system test * formatting * address feedback
googleapis · Oct 2, 2018 · 874f5af · 874f5af
1 parent 750a20b
commit 874f5af
Show file tree

Hide file tree

Showing 9 changed files with 536 additions and 11 deletions.
diff --git a/Bigtable/src/DataClient.php b/Bigtable/src/DataClient.php
@@ -20,6 +20,7 @@
 use Google\ApiCore\ApiException;
 use Google\ApiCore\Serializer;
 use Google\Cloud\Bigtable\Exception\BigtableDataOperationException;
+use Google\Cloud\Bigtable\Filter\FilterInterface;
 use Google\Cloud\Bigtable\V2\BigtableClient as TableClient;
 use Google\Cloud\Bigtable\V2\RowRange;
 use Google\Cloud\Bigtable\V2\RowSet;
@@ -241,6 +242,10 @@ public function upsert(array $rows, array $options = [])
      *           associative array which may contain a start key
      *           (`startKeyClosed` or `startKeyOpen`) and/or an end key
      *           (`endKeyOpen` or `endKeyClosed`).
+     *     @type FilterInterface $filter A filter used to take an input row and
+     *           produce an alternate view of the row based on the specified rules.
+     *           To learn more please see {@see Google\Cloud\Bigtable\Filter} which
+     *           provides static factory methods for the various filter types.
      *     @type int $rowsLimit The number of rows to scan.
      * }
      * @return ChunkFormatter
@@ -249,14 +254,22 @@ public function readRows(array $options = [])
     {
         $rowKeys = $this->pluck('rowKeys', $options, false) ?: [];
         $ranges = $this->pluck('rowRanges', $options, false) ?: [];
+        $filter = $this->pluck('filter', $options, false) ?: null;
 
         array_walk($ranges, function (&$range) {
             $range = $this->serializer->decodeMessage(
                 new RowRange(),
                 $range
             );
         });
-
+        if (!is_array($rowKeys)) {
+            throw new \InvalidArgumentException(
+                sprintf(
+                    'Expected rowKeys to be of type array, instead got \'%s\'.',
+                    gettype($rowKeys)
+                )
+            );
+        }
         if ($ranges || $rowKeys) {
             $options['rows'] = $this->serializer->decodeMessage(
                 new RowSet,
@@ -266,6 +279,18 @@ public function readRows(array $options = [])
                 ]
             );
         }
+        if ($filter !== null) {
+            if (!$filter instanceof FilterInterface) {
+                throw new \InvalidArgumentException(
+                    sprintf(
+                        'Expected filter to be of type \'%s\', instead got \'%s\'.',
+                        FilterInterface::class,
+                        gettype($filter)
+                    )
+                );
+            }
+            $options['filter'] = $filter->toProto();
+        }
 
         $serverStream = $this->bigtableClient->readRows(
             $this->tableName,

diff --git a/Bigtable/tests/System/DataClientMutateRowsTest.php b/Bigtable/tests/System/DataClientMutateRowsTest.php
@@ -50,7 +50,7 @@ public function testBasicWriteAndReadDataOperation()
                 ]
             ]
         ];
-        $rows = iterator_to_array(self::$dataClient->readRows(['rowKeys' => 'rk1'])->readAll());
+        $rows = iterator_to_array(self::$dataClient->readRows(['rowKeys' => ['rk1']])->readAll());
         $this->assertEquals($readRows, $rows);
     }
 
@@ -70,7 +70,7 @@ public function testDeleteRow()
         $rowMutation = new RowMutation('rk2');
         $rowMutation->deleteRow();
         self::$dataClient->mutateRows([$rowMutation]);
-        $rows = iterator_to_array(self::$dataClient->readRows(['rowKeys' => 'rk2'])->readAll());
+        $rows = iterator_to_array(self::$dataClient->readRows(['rowKeys' => ['rk2']])->readAll());
         $this->assertEquals([], $rows);
     }
 
@@ -96,7 +96,7 @@ public function testDeleteFromFamily()
         $rowMutation = new RowMutation('rk3');
         $rowMutation->deleteFromFamily('cf2');
         self::$dataClient->mutateRows([$rowMutation]);
-        $rows = iterator_to_array(self::$dataClient->readRows(['rowKeys' => 'rk3'])->readAll());
+        $rows = iterator_to_array(self::$dataClient->readRows(['rowKeys' => ['rk3']])->readAll());
         $expectedRows = [
             'rk3' => [
                 'cf1' => [
@@ -131,7 +131,7 @@ public function testDeleteFromColumn()
         $rowMutation = new RowMutation('rk4');
         $rowMutation->deleteFromColumn('cf1', 'cq2');
         self::$dataClient->mutateRows([$rowMutation]);
-        $rows = iterator_to_array(self::$dataClient->readRows(['rowKeys' => 'rk4'])->readAll());
+        $rows = iterator_to_array(self::$dataClient->readRows(['rowKeys' => ['rk4']])->readAll());
         $expectedRows = [
             'rk4' => [
                 'cf1' => [
@@ -188,7 +188,7 @@ public function testDeleteFromColumnWithRange()
         $rowMutation = new RowMutation('rk5');
         $rowMutation->deleteFromColumn('cf1', 'cq2', ['start' => 21000, 'end' => 40000]);
         self::$dataClient->mutateRows([$rowMutation]);
-        $rows = iterator_to_array(self::$dataClient->readRows(['rowKeys' => 'rk5'])->readAll());
+        $rows = iterator_to_array(self::$dataClient->readRows(['rowKeys' => ['rk5']])->readAll());
         $expectedRows = [
             'rk5' => [
                 'cf1' => [

diff --git a/Bigtable/tests/System/DataClientReadRowsTest.php b/Bigtable/tests/System/DataClientReadRowsTest.php
@@ -115,7 +115,7 @@ public function testReadRowsSingleKey()
         $rows = iterator_to_array(
             self::$dataClient->readRows(
                 [
-                    'rowKeys' => 'rk2'
+                    'rowKeys' => ['rk2']
                 ]
             )->readAll()
         );

diff --git a/Bigtable/tests/System/DataClientTest.php b/Bigtable/tests/System/DataClientTest.php
@@ -122,8 +122,16 @@ private static function createTable()
         $table = new Table();
         $columnFamily = new ColumnFamily();
         $table->setColumnFamilies([
+            'cf0' => $columnFamily,
             'cf1' => $columnFamily,
-            'cf2' => $columnFamily
+            'cf2' => $columnFamily,
+            'cf3' => $columnFamily,
+            'cf4' => $columnFamily,
+            'cf5' => $columnFamily,
+            'cf6' => $columnFamily,
+            'cf7' => $columnFamily,
+            'cf8' => $columnFamily,
+            'cf9' => $columnFamily
         ]);
         self::$tableAdminClient->createTable(
             $formattedParent,