svn commit: r1566386 - in /hbase/branches/0.98: hbase-client/src/main/java/org/apache/hadoop/hbase/filter/PrefixFilter.java hbase-server/src/test/java/org/apache/hadoop/hbase/filter/TestFilterListAdditional.java

[te...@apache.org]

Author: tedyu
Date: Sun Feb  9 20:00:49 2014
New Revision: 1566386

URL: http://svn.apache.org/r1566386
Log:
HBASE-10485 PrefixFilter#filterKeyValue() should perform filtering on row key


Added:
    hbase/branches/0.98/hbase-server/src/test/java/org/apache/hadoop/hbase/filter/TestFilterListAdditional.java
Modified:
    hbase/branches/0.98/hbase-client/src/main/java/org/apache/hadoop/hbase/filter/PrefixFilter.java

Modified: hbase/branches/0.98/hbase-client/src/main/java/org/apache/hadoop/hbase/filter/PrefixFilter.java
URL: http://svn.apache.org/viewvc/hbase/branches/0.98/hbase-client/src/main/java/org/apache/hadoop/hbase/filter/PrefixFilter.java?rev=1566386&r1=1566385&r2=1566386&view=diff
==============================================================================
--- hbase/branches/0.98/hbase-client/src/main/java/org/apache/hadoop/hbase/filter/PrefixFilter.java (original)
+++ hbase/branches/0.98/hbase-client/src/main/java/org/apache/hadoop/hbase/filter/PrefixFilter.java Sun Feb  9 20:00:49 2014
@@ -25,6 +25,7 @@ import com.google.protobuf.InvalidProtoc
 
 import org.apache.hadoop.classification.InterfaceAudience;
 import org.apache.hadoop.classification.InterfaceStability;
+import org.apache.hadoop.hbase.Cell;
 import org.apache.hadoop.hbase.exceptions.DeserializationException;
 import org.apache.hadoop.hbase.protobuf.generated.FilterProtos;
 import org.apache.hadoop.hbase.util.Bytes;
@@ -66,6 +67,12 @@ public class PrefixFilter extends Filter
     return filterRow;
   }
 
+  @Override
+  public ReturnCode filterKeyValue(Cell v) {
+    if (filterRowKey(v.getRowArray(), v.getRowOffset(), v.getRowLength())) return ReturnCode.SKIP;
+    return ReturnCode.INCLUDE;
+  }
+
   public boolean filterRow() {
     return filterRow;
   }

Added: hbase/branches/0.98/hbase-server/src/test/java/org/apache/hadoop/hbase/filter/TestFilterListAdditional.java
URL: http://svn.apache.org/viewvc/hbase/branches/0.98/hbase-server/src/test/java/org/apache/hadoop/hbase/filter/TestFilterListAdditional.java?rev=1566386&view=auto
==============================================================================
--- hbase/branches/0.98/hbase-server/src/test/java/org/apache/hadoop/hbase/filter/TestFilterListAdditional.java (added)
+++ hbase/branches/0.98/hbase-server/src/test/java/org/apache/hadoop/hbase/filter/TestFilterListAdditional.java Sun Feb  9 20:00:49 2014
@@ -0,0 +1,228 @@
+/**
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.hadoop.hbase.filter;
+
+import static org.junit.Assert.*;
+
+import java.io.IOException;
+
+import org.apache.hadoop.conf.Configuration;
+import org.apache.hadoop.hbase.Cell;
+import org.apache.hadoop.hbase.HBaseConfiguration;
+import org.apache.hadoop.hbase.HBaseTestingUtility;
+import org.apache.hadoop.hbase.HColumnDescriptor;
+import org.apache.hadoop.hbase.HConstants;
+import org.apache.hadoop.hbase.HTableDescriptor;
+import org.apache.hadoop.hbase.MasterNotRunningException;
+import org.apache.hadoop.hbase.SmallTests;
+import org.apache.hadoop.hbase.ZooKeeperConnectionException;
+import org.apache.hadoop.hbase.client.HBaseAdmin;
+import org.apache.hadoop.hbase.client.HTable;
+import org.apache.hadoop.hbase.client.Put;
+import org.apache.hadoop.hbase.client.Result;
+import org.apache.hadoop.hbase.client.ResultScanner;
+import org.apache.hadoop.hbase.client.Scan;
+import org.apache.hadoop.hbase.exceptions.DeserializationException;
+import org.apache.hadoop.hbase.filter.FilterList;
+import org.apache.hadoop.hbase.filter.PrefixFilter;
+import org.apache.hadoop.hbase.util.Bytes;
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.junit.experimental.categories.Category;
+
+/* 
+ * Tests FilterList composed of PrefixFilter and custom filter whose filterKeyValue() returns
+ *  ReturnCode.NEXT_COL with FilterList.Operator.MUST_PASS_ONE
+ */
+@Category(SmallTests.class)
+public class TestFilterListAdditional {
+  private static final HBaseTestingUtility TEST_UTIL = new HBaseTestingUtility();
+  private static Configuration conf = null;
+  private static HBaseAdmin admin = null;
+  private static byte[] tableName = Bytes.toBytes("test");
+
+  @BeforeClass
+  public static void setUp() throws Exception {
+    TEST_UTIL.startMiniCluster(1);
+    initialize(TEST_UTIL.getConfiguration());
+  }
+
+  @AfterClass
+  public static void tearDown() throws Exception {
+    deleteTable();
+    TEST_UTIL.shutdownMiniCluster();
+  }
+
+  /*
+   * The result using this prefix filter must be only rows that have a rowid that start
+   * with this string.
+   */
+  @Test
+  public void testFilterListPrefixOnly() throws IOException {
+    String prefix = "Row C";
+
+    HTable table = new HTable(TestFilterListAdditional.conf, tableName);
+    assertTrue("Fail to create the table", admin.tableExists(tableName));
+
+    FilterList flist = new FilterList(FilterList.Operator.MUST_PASS_ONE);
+    flist.addFilter(new PrefixFilter(prefix.getBytes()));
+
+    Scan scan = new Scan();
+    scan.setFilter(flist);
+
+    ResultScanner scanner = table.getScanner(scan);
+
+    for (Result r: scanner){
+      assertTrue("The rowid of this row does not start with \""+prefix+"\": "+r.toString(),
+          Bytes.toStringBinary(r.getRow()).startsWith(prefix));
+    }
+    scanner.close();
+    table.close();
+  }
+
+  public static  class AlwaysNextColFilter extends FilterBase {
+    public AlwaysNextColFilter() {
+        super();
+    }
+
+    @Override
+    public ReturnCode filterKeyValue(Cell v) {
+        return ReturnCode.NEXT_COL;
+    }
+    public static AlwaysNextColFilter parseFrom(final byte [] pbBytes)
+        throws DeserializationException {
+      return new AlwaysNextColFilter();
+    }
+  }
+
+  /*
+   * The result using this 'always next col' filter is an empty result set.
+   * No records are in here.
+   */
+  @Test
+  public void testFilterListAlwaysNextColOnly() throws IOException {
+    HTable table = new HTable(TestFilterListAdditional.conf, tableName);
+    assertTrue("Fail to create the table", admin.tableExists(tableName));
+
+    FilterList flist = new FilterList(FilterList.Operator.MUST_PASS_ONE);
+    flist.addFilter(new AlwaysNextColFilter());
+
+    Scan scan = new Scan();
+    scan.setFilter(flist);
+
+    ResultScanner scanner = table.getScanner(scan);
+
+    for (Result r: scanner){
+      fail("The result set MUST be empty, instead we got "+r.toString());
+    }
+    scanner.close();
+    table.close();
+  }
+
+
+  /*
+   * When we do a "MUST_PASS_ONE" (a logical 'OR') of the above two filters
+   * we expect to get the same result as the 'prefix' only result.
+   */
+  @Test
+  public void testFilterListTwoFiltersMustPassOne() throws IOException {
+    String prefix = "Row C";
+
+    HTable table = new HTable(TestFilterListAdditional.conf, tableName);
+    assertTrue("Fail to create the table", admin.tableExists(tableName));
+
+    FilterList flist = new FilterList(FilterList.Operator.MUST_PASS_ONE);
+    flist.addFilter(new AlwaysNextColFilter());
+    flist.addFilter(new PrefixFilter(prefix.getBytes()));
+
+    Scan scan = new Scan();
+    scan.setFilter(flist);
+
+    ResultScanner scanner = table.getScanner(scan);
+
+    for (Result r: scanner){
+      assertTrue("The rowid of this row does not start with \""+prefix+"\": "+r.toString(),
+                 Bytes.toStringBinary(r.getRow()).startsWith(prefix));
+    }
+    scanner.close();
+    table.close();
+  }
+
+  private static void prepareData() throws IOException {
+    HTable table = new HTable(TestFilterListAdditional.conf, tableName);
+    assertTrue("Fail to create the table", admin.tableExists(tableName));
+
+    Put put = new Put("Row AA".getBytes());
+    put.add("F".getBytes(), "Col A1".getBytes(), "Foo".getBytes());
+    put.add("F".getBytes(), "Col A2".getBytes(), "Foo".getBytes());
+    table.put(put);
+
+    put = new Put("Row BB".getBytes());
+    put.add("F".getBytes(), "Col B1".getBytes(), "Foo".getBytes());
+    put.add("F".getBytes(), "Col B2".getBytes(), "Foo".getBytes());
+    table.put(put);
+
+    put = new Put("Row CC".getBytes());
+    put.add("F".getBytes(), "Col C1".getBytes(), "Foo".getBytes());
+    put.add("F".getBytes(), "Col C2".getBytes(), "Foo".getBytes());
+    table.put(put);
+
+    put = new Put("Row DD".getBytes());
+    put.add("F".getBytes(), "Col D1".getBytes(), "Foo".getBytes());
+    put.add("F".getBytes(), "Col D2".getBytes(), "Foo".getBytes());
+    table.put(put);
+
+    table.close();
+  }
+
+  private static void createTable() throws IOException {
+    assertNotNull("HBaseAdmin is not initialized successfully.", admin);
+    if (admin != null) {
+      HTableDescriptor desc = new HTableDescriptor(tableName);
+      HColumnDescriptor coldef = new HColumnDescriptor(Bytes.toBytes("F"));
+      desc.addFamily(coldef);
+
+      admin.createTable(desc);
+      assertTrue("Fail to create the table", admin.tableExists(tableName));
+    }
+  }
+
+  private static void deleteTable() throws IOException {
+    if (admin != null) {
+      admin.disableTable(tableName);
+      admin.deleteTable(tableName);
+    }
+  }
+
+  private static void initialize(Configuration conf) throws IOException {
+    TestFilterListAdditional.conf = HBaseConfiguration.create(conf);
+    TestFilterListAdditional.conf.setInt(
+        HConstants.HBASE_CLIENT_RETRIES_NUMBER, 1);
+    try {
+      admin = new HBaseAdmin(conf);
+    } catch (MasterNotRunningException e) {
+      assertNull("Master is not running", e);
+    } catch (ZooKeeperConnectionException e) {
+      assertNull("Cannot connect to Zookeeper", e);
+    }
+    createTable();
+    prepareData();
+  }
+}