001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.filter;
019
020import static org.junit.Assert.assertFalse;
021import static org.junit.Assert.assertTrue;
022
023import org.apache.hadoop.hbase.HBaseClassTestRule;
024import org.apache.hadoop.hbase.KeyValueUtil;
025import org.apache.hadoop.hbase.testclassification.FilterTests;
026import org.apache.hadoop.hbase.testclassification.SmallTests;
027import org.apache.hadoop.hbase.util.Bytes;
028import org.junit.Before;
029import org.junit.ClassRule;
030import org.junit.Test;
031import org.junit.experimental.categories.Category;
032
033/**
034 * Tests the inclusive stop row filter
035 */
036@Category({ FilterTests.class, SmallTests.class })
037public class TestInclusiveStopFilter {
038
039  @ClassRule
040  public static final HBaseClassTestRule CLASS_RULE =
041    HBaseClassTestRule.forClass(TestInclusiveStopFilter.class);
042
043  private final byte[] STOP_ROW = Bytes.toBytes("stop_row");
044  private final byte[] GOOD_ROW = Bytes.toBytes("good_row");
045  private final byte[] PAST_STOP_ROW = Bytes.toBytes("zzzzzz");
046
047  Filter mainFilter;
048
049  @Before
050  public void setUp() throws Exception {
051    mainFilter = new InclusiveStopFilter(STOP_ROW);
052  }
053
054  /**
055   * Tests identification of the stop row
056   */
057  @Test
058  public void testStopRowIdentification() throws Exception {
059    stopRowTests(mainFilter);
060  }
061
062  /**
063   * Tests serialization
064   */
065  @Test
066  public void testSerialization() throws Exception {
067    // Decompose mainFilter to bytes.
068    byte[] buffer = mainFilter.toByteArray();
069
070    // Recompose mainFilter.
071    Filter newFilter = InclusiveStopFilter.parseFrom(buffer);
072
073    // Ensure the serialization preserved the filter by running a full test.
074    stopRowTests(newFilter);
075  }
076
077  private void stopRowTests(Filter filter) throws Exception {
078    assertFalse("Filtering on " + Bytes.toString(GOOD_ROW),
079      filter.filterRowKey(KeyValueUtil.createFirstOnRow(GOOD_ROW)));
080    assertFalse("Filtering on " + Bytes.toString(STOP_ROW),
081      filter.filterRowKey(KeyValueUtil.createFirstOnRow(STOP_ROW)));
082    assertTrue("Filtering on " + Bytes.toString(PAST_STOP_ROW),
083      filter.filterRowKey(KeyValueUtil.createFirstOnRow(PAST_STOP_ROW)));
084
085    assertTrue("FilterAllRemaining", filter.filterAllRemaining());
086    assertFalse("FilterNotNull", filter.filterRow());
087  }
088
089}