0.90/src/test/java/org/apache/hadoop/hbase/filter/TestDependentColumnFilter.java - hbase - Git at Google

 /*
  * Copyright 2010 The Apache Software Foundation
  *
  * 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 java.io.IOException;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;

 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.apache.hadoop.hbase.HBaseTestingUtility;
 import org.apache.hadoop.hbase.HColumnDescriptor;
 import org.apache.hadoop.hbase.HRegionInfo;
 import org.apache.hadoop.hbase.HTableDescriptor;
 import org.apache.hadoop.hbase.KeyValue;
 import org.apache.hadoop.hbase.client.Put;
 import org.apache.hadoop.hbase.client.Scan;
 import org.apache.hadoop.hbase.filter.CompareFilter.CompareOp;
 import org.apache.hadoop.hbase.filter.Filter.ReturnCode;
 import org.apache.hadoop.hbase.regionserver.HRegion;
 import org.apache.hadoop.hbase.regionserver.InternalScanner;
 import org.apache.hadoop.hbase.util.Bytes;

 import junit.framework.TestCase;

 public class TestDependentColumnFilter extends TestCase {
   private final Log LOG = LogFactory.getLog(this.getClass());
   private static final byte[][] ROWS = {
 	  Bytes.toBytes("test1"),Bytes.toBytes("test2")
   };
   private static final byte[][] FAMILIES = {
 	  Bytes.toBytes("familyOne"),Bytes.toBytes("familyTwo")
   };
   private static final long STAMP_BASE = System.currentTimeMillis();
   private static final long[] STAMPS = {
 	  STAMP_BASE-100, STAMP_BASE-200, STAMP_BASE-300
   };
   private static final byte[] QUALIFIER = Bytes.toBytes("qualifier");
   private static final byte[][] BAD_VALS = {
 	  Bytes.toBytes("bad1"), Bytes.toBytes("bad2"), Bytes.toBytes("bad3")
   };
   private static final byte[] MATCH_VAL = Bytes.toBytes("match");
   private HBaseTestingUtility testUtil;

   List<KeyValue> testVals;
   private HRegion region;

   @Override
   protected void setUp() throws Exception {
     super.setUp();

     testUtil = new HBaseTestingUtility();

     testVals = makeTestVals();

     HTableDescriptor htd = new HTableDescriptor(getName());
     htd.addFamily(new HColumnDescriptor(FAMILIES[0]));
     htd.addFamily(new HColumnDescriptor(FAMILIES[1]));
     HRegionInfo info = new HRegionInfo(htd, null, null, false);
     this.region = HRegion.createHRegion(info, testUtil.getTestDir(), testUtil.getConfiguration());
     addData();
   }

   @Override
   protected void tearDown() throws Exception {
     super.tearDown();
     this.region.close();
   }

   private void addData() throws IOException {
     Put put = new Put(ROWS[0]);
     // add in an entry for each stamp, with 2 as a "good" value
     put.add(FAMILIES[0], QUALIFIER, STAMPS[0], BAD_VALS[0]);
     put.add(FAMILIES[0], QUALIFIER, STAMPS[1], BAD_VALS[1]);
     put.add(FAMILIES[0], QUALIFIER, STAMPS[2], MATCH_VAL);
     // add in entries for stamps 0 and 2.
     // without a value check both will be "accepted"
     // with one 2 will be accepted(since the corresponding ts entry
     // has a matching value
     put.add(FAMILIES[1], QUALIFIER, STAMPS[0], BAD_VALS[0]);
     put.add(FAMILIES[1], QUALIFIER, STAMPS[2], BAD_VALS[2]);

     this.region.put(put);

     put = new Put(ROWS[1]);
     put.add(FAMILIES[0], QUALIFIER, STAMPS[0], BAD_VALS[0]);
     // there is no corresponding timestamp for this so it should never pass
     put.add(FAMILIES[0], QUALIFIER, STAMPS[2], MATCH_VAL);
     // if we reverse the qualifiers this one should pass
     put.add(FAMILIES[1], QUALIFIER, STAMPS[0], MATCH_VAL);
     // should pass
     put.add(FAMILIES[1], QUALIFIER, STAMPS[1], BAD_VALS[2]);

     this.region.put(put);
   }

   private List<KeyValue> makeTestVals() {
 	List<KeyValue> testVals = new ArrayList<KeyValue>();
 	testVals.add(new KeyValue(ROWS[0], FAMILIES[0], QUALIFIER, STAMPS[0], BAD_VALS[0]));
 	testVals.add(new KeyValue(ROWS[0], FAMILIES[0], QUALIFIER, STAMPS[1], BAD_VALS[1]));
 	testVals.add(new KeyValue(ROWS[0], FAMILIES[1], QUALIFIER, STAMPS[1], BAD_VALS[2]));
 	testVals.add(new KeyValue(ROWS[0], FAMILIES[1], QUALIFIER, STAMPS[0], MATCH_VAL));
 	testVals.add(new KeyValue(ROWS[0], FAMILIES[1], QUALIFIER, STAMPS[2], BAD_VALS[2]));

 	return testVals;
   }

   /**
    * This shouldn't be confused with TestFilter#verifyScan
    * as expectedKeys is not the per row total, but the scan total
    *
    * @param s
    * @param expectedRows
    * @param expectedCells
    * @throws IOException
    */
   private void verifyScan(Scan s, long expectedRows, long expectedCells)
   throws IOException {
     InternalScanner scanner = this.region.getScanner(s);
     List<KeyValue> results = new ArrayList<KeyValue>();
     int i = 0;
     int cells = 0;
     for (boolean done = true; done; i++) {
       done = scanner.next(results);
       Arrays.sort(results.toArray(new KeyValue[results.size()]),
           KeyValue.COMPARATOR);
       LOG.info("counter=" + i + ", " + results);
       if (results.isEmpty()) break;
       cells += results.size();
       assertTrue("Scanned too many rows! Only expected " + expectedRows +
           " total but already scanned " + (i+1), expectedRows > i);
       assertTrue("Expected " + expectedCells + " cells total but " +
           "already scanned " + cells, expectedCells >= cells);
       results.clear();
     }
     assertEquals("Expected " + expectedRows + " rows but scanned " + i +
         " rows", expectedRows, i);
     assertEquals("Expected " + expectedCells + " cells but scanned " + cells +
             " cells", expectedCells, cells);
   }

   /**
    * Test scans using a DependentColumnFilter
    */
   public void testScans() throws Exception {
     Filter filter = new DependentColumnFilter(FAMILIES[0], QUALIFIER);

     Scan scan = new Scan();
     scan.setFilter(filter);
     scan.setMaxVersions(Integer.MAX_VALUE);

     verifyScan(scan, 2, 8);

     // drop the filtering cells
     filter = new DependentColumnFilter(FAMILIES[0], QUALIFIER, true);
     scan = new Scan();
     scan.setFilter(filter);
     scan.setMaxVersions(Integer.MAX_VALUE);

     verifyScan(scan, 2, 3);

     // include a comparator operation
     filter = new DependentColumnFilter(FAMILIES[0], QUALIFIER, false,
         CompareOp.EQUAL, new BinaryComparator(MATCH_VAL));
     scan = new Scan();
     scan.setFilter(filter);
     scan.setMaxVersions(Integer.MAX_VALUE);

     /*
      * expecting to get the following 3 cells
      * row 0
      *   put.add(FAMILIES[0], QUALIFIER, STAMPS[2], MATCH_VAL);
      *   put.add(FAMILIES[1], QUALIFIER, STAMPS[2], BAD_VALS[2]);
      * row 1
      *   put.add(FAMILIES[0], QUALIFIER, STAMPS[2], MATCH_VAL);
      */
     verifyScan(scan, 2, 3);

     // include a comparator operation and drop comparator
     filter = new DependentColumnFilter(FAMILIES[0], QUALIFIER, true,
         CompareOp.EQUAL, new BinaryComparator(MATCH_VAL));
     scan = new Scan();
     scan.setFilter(filter);
     scan.setMaxVersions(Integer.MAX_VALUE);

     /*
      * expecting to get the following 1 cell
      * row 0
      *   put.add(FAMILIES[1], QUALIFIER, STAMPS[2], BAD_VALS[2]);
      */
     verifyScan(scan, 1, 1);

   }

   /**
    * Test that the filter correctly drops rows without a corresponding timestamp
    *
    * @throws Exception
    */
   public void testFilterDropping() throws Exception {
     Filter filter = new DependentColumnFilter(FAMILIES[0], QUALIFIER);
     List<KeyValue> accepted = new ArrayList<KeyValue>();
     for(KeyValue val : testVals) {
       if(filter.filterKeyValue(val) == ReturnCode.INCLUDE) {
         accepted.add(val);
       }
     }
     assertEquals("check all values accepted from filterKeyValue", 5, accepted.size());

     filter.filterRow(accepted);
     assertEquals("check filterRow(List<KeyValue>) dropped cell without corresponding column entry", 4, accepted.size());

     // start do it again with dependent column dropping on
     filter = new DependentColumnFilter(FAMILIES[1], QUALIFIER, true);
     accepted.clear();
     for(KeyValue val : testVals) {
         if(filter.filterKeyValue(val) == ReturnCode.INCLUDE) {
           accepted.add(val);
         }
       }
       assertEquals("check the filtering column cells got dropped", 2, accepted.size());

       filter.filterRow(accepted);
       assertEquals("check cell retention", 2, accepted.size());
   }
 }
	/*
	* Copyright 2010 The Apache Software Foundation
	*
	* 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 java.io.IOException;
	import java.util.ArrayList;
	import java.util.Arrays;
	import java.util.List;

	import org.apache.commons.logging.Log;
	import org.apache.commons.logging.LogFactory;
	import org.apache.hadoop.hbase.HBaseTestingUtility;
	import org.apache.hadoop.hbase.HColumnDescriptor;
	import org.apache.hadoop.hbase.HRegionInfo;
	import org.apache.hadoop.hbase.HTableDescriptor;
	import org.apache.hadoop.hbase.KeyValue;
	import org.apache.hadoop.hbase.client.Put;
	import org.apache.hadoop.hbase.client.Scan;
	import org.apache.hadoop.hbase.filter.CompareFilter.CompareOp;
	import org.apache.hadoop.hbase.filter.Filter.ReturnCode;
	import org.apache.hadoop.hbase.regionserver.HRegion;
	import org.apache.hadoop.hbase.regionserver.InternalScanner;
	import org.apache.hadoop.hbase.util.Bytes;

	import junit.framework.TestCase;

	public class TestDependentColumnFilter extends TestCase {
	private final Log LOG = LogFactory.getLog(this.getClass());
	private static final byte[][] ROWS = {
	Bytes.toBytes("test1"),Bytes.toBytes("test2")
	};
	private static final byte[][] FAMILIES = {
	Bytes.toBytes("familyOne"),Bytes.toBytes("familyTwo")
	};
	private static final long STAMP_BASE = System.currentTimeMillis();
	private static final long[] STAMPS = {
	STAMP_BASE-100, STAMP_BASE-200, STAMP_BASE-300
	};
	private static final byte[] QUALIFIER = Bytes.toBytes("qualifier");
	private static final byte[][] BAD_VALS = {
	Bytes.toBytes("bad1"), Bytes.toBytes("bad2"), Bytes.toBytes("bad3")
	};
	private static final byte[] MATCH_VAL = Bytes.toBytes("match");
	private HBaseTestingUtility testUtil;

	List<KeyValue> testVals;
	private HRegion region;

	@Override
	protected void setUp() throws Exception {
	super.setUp();

	testUtil = new HBaseTestingUtility();

	testVals = makeTestVals();

	HTableDescriptor htd = new HTableDescriptor(getName());
	htd.addFamily(new HColumnDescriptor(FAMILIES[0]));
	htd.addFamily(new HColumnDescriptor(FAMILIES[1]));
	HRegionInfo info = new HRegionInfo(htd, null, null, false);
	this.region = HRegion.createHRegion(info, testUtil.getTestDir(), testUtil.getConfiguration());
	addData();
	}

	@Override
	protected void tearDown() throws Exception {
	super.tearDown();
	this.region.close();
	}

	private void addData() throws IOException {
	Put put = new Put(ROWS[0]);
	// add in an entry for each stamp, with 2 as a "good" value
	put.add(FAMILIES[0], QUALIFIER, STAMPS[0], BAD_VALS[0]);
	put.add(FAMILIES[0], QUALIFIER, STAMPS[1], BAD_VALS[1]);
	put.add(FAMILIES[0], QUALIFIER, STAMPS[2], MATCH_VAL);
	// add in entries for stamps 0 and 2.
	// without a value check both will be "accepted"
	// with one 2 will be accepted(since the corresponding ts entry
	// has a matching value
	put.add(FAMILIES[1], QUALIFIER, STAMPS[0], BAD_VALS[0]);
	put.add(FAMILIES[1], QUALIFIER, STAMPS[2], BAD_VALS[2]);

	this.region.put(put);

	put = new Put(ROWS[1]);
	put.add(FAMILIES[0], QUALIFIER, STAMPS[0], BAD_VALS[0]);
	// there is no corresponding timestamp for this so it should never pass
	put.add(FAMILIES[0], QUALIFIER, STAMPS[2], MATCH_VAL);
	// if we reverse the qualifiers this one should pass
	put.add(FAMILIES[1], QUALIFIER, STAMPS[0], MATCH_VAL);
	// should pass
	put.add(FAMILIES[1], QUALIFIER, STAMPS[1], BAD_VALS[2]);

	this.region.put(put);
	}

	private List<KeyValue> makeTestVals() {
	List<KeyValue> testVals = new ArrayList<KeyValue>();
	testVals.add(new KeyValue(ROWS[0], FAMILIES[0], QUALIFIER, STAMPS[0], BAD_VALS[0]));
	testVals.add(new KeyValue(ROWS[0], FAMILIES[0], QUALIFIER, STAMPS[1], BAD_VALS[1]));
	testVals.add(new KeyValue(ROWS[0], FAMILIES[1], QUALIFIER, STAMPS[1], BAD_VALS[2]));
	testVals.add(new KeyValue(ROWS[0], FAMILIES[1], QUALIFIER, STAMPS[0], MATCH_VAL));
	testVals.add(new KeyValue(ROWS[0], FAMILIES[1], QUALIFIER, STAMPS[2], BAD_VALS[2]));

	return testVals;
	}

	/**
	* This shouldn't be confused with TestFilter#verifyScan
	* as expectedKeys is not the per row total, but the scan total
	*
	* @param s
	* @param expectedRows
	* @param expectedCells
	* @throws IOException
	*/
	private void verifyScan(Scan s, long expectedRows, long expectedCells)
	throws IOException {
	InternalScanner scanner = this.region.getScanner(s);
	List<KeyValue> results = new ArrayList<KeyValue>();
	int i = 0;
	int cells = 0;
	for (boolean done = true; done; i++) {
	done = scanner.next(results);
	Arrays.sort(results.toArray(new KeyValue[results.size()]),
	KeyValue.COMPARATOR);
	LOG.info("counter=" + i + ", " + results);
	if (results.isEmpty()) break;
	cells += results.size();
	assertTrue("Scanned too many rows! Only expected " + expectedRows +
	" total but already scanned " + (i+1), expectedRows > i);
	assertTrue("Expected " + expectedCells + " cells total but " +
	"already scanned " + cells, expectedCells >= cells);
	results.clear();
	}
	assertEquals("Expected " + expectedRows + " rows but scanned " + i +
	" rows", expectedRows, i);
	assertEquals("Expected " + expectedCells + " cells but scanned " + cells +
	" cells", expectedCells, cells);
	}

	/**
	* Test scans using a DependentColumnFilter
	*/
	public void testScans() throws Exception {
	Filter filter = new DependentColumnFilter(FAMILIES[0], QUALIFIER);

	Scan scan = new Scan();
	scan.setFilter(filter);
	scan.setMaxVersions(Integer.MAX_VALUE);

	verifyScan(scan, 2, 8);

	// drop the filtering cells
	filter = new DependentColumnFilter(FAMILIES[0], QUALIFIER, true);
	scan = new Scan();
	scan.setFilter(filter);
	scan.setMaxVersions(Integer.MAX_VALUE);

	verifyScan(scan, 2, 3);

	// include a comparator operation
	filter = new DependentColumnFilter(FAMILIES[0], QUALIFIER, false,
	CompareOp.EQUAL, new BinaryComparator(MATCH_VAL));
	scan = new Scan();
	scan.setFilter(filter);
	scan.setMaxVersions(Integer.MAX_VALUE);

	/*
	* expecting to get the following 3 cells
	* row 0
	* put.add(FAMILIES[0], QUALIFIER, STAMPS[2], MATCH_VAL);
	* put.add(FAMILIES[1], QUALIFIER, STAMPS[2], BAD_VALS[2]);
	* row 1
	* put.add(FAMILIES[0], QUALIFIER, STAMPS[2], MATCH_VAL);
	*/
	verifyScan(scan, 2, 3);

	// include a comparator operation and drop comparator
	filter = new DependentColumnFilter(FAMILIES[0], QUALIFIER, true,
	CompareOp.EQUAL, new BinaryComparator(MATCH_VAL));
	scan = new Scan();
	scan.setFilter(filter);
	scan.setMaxVersions(Integer.MAX_VALUE);

	/*
	* expecting to get the following 1 cell
	* row 0
	* put.add(FAMILIES[1], QUALIFIER, STAMPS[2], BAD_VALS[2]);
	*/
	verifyScan(scan, 1, 1);

	}

	/**
	* Test that the filter correctly drops rows without a corresponding timestamp
	*
	* @throws Exception
	*/
	public void testFilterDropping() throws Exception {
	Filter filter = new DependentColumnFilter(FAMILIES[0], QUALIFIER);
	List<KeyValue> accepted = new ArrayList<KeyValue>();
	for(KeyValue val : testVals) {
	if(filter.filterKeyValue(val) == ReturnCode.INCLUDE) {
	accepted.add(val);
	}
	}
	assertEquals("check all values accepted from filterKeyValue", 5, accepted.size());

	filter.filterRow(accepted);
	assertEquals("check filterRow(List<KeyValue>) dropped cell without corresponding column entry", 4, accepted.size());

	// start do it again with dependent column dropping on
	filter = new DependentColumnFilter(FAMILIES[1], QUALIFIER, true);
	accepted.clear();
	for(KeyValue val : testVals) {
	if(filter.filterKeyValue(val) == ReturnCode.INCLUDE) {
	accepted.add(val);
	}
	}
	assertEquals("check the filtering column cells got dropped", 2, accepted.size());

	filter.filterRow(accepted);
	assertEquals("check cell retention", 2, accepted.size());
	}
	}