/**
* (c) Copyright 2013 WibiData, Inc.
*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* Licensed 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.kiji.schema;
import static org.junit.Assert.assertArrayEquals;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import java.io.IOException;
import java.util.List;
import java.util.NoSuchElementException;
import com.google.common.collect.Lists;
import org.apache.hadoop.hbase.HConstants;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.kiji.schema.KijiDataRequestBuilder.ColumnsDef;
import org.kiji.schema.filter.KijiColumnRangeFilter;
import org.kiji.schema.impl.hbase.HBaseKijiTable;
import org.kiji.schema.impl.hbase.HBaseQualifierPager;
import org.kiji.schema.layout.KijiTableLayouts;
public class TestHBaseQualifierPager extends KijiClientTest {
private static final Logger LOG = LoggerFactory.getLogger(TestHBaseQualifierPager.class);
private KijiTableReader mReader;
private KijiTable mTable;
private static final int NJOBS = 5;
private static final long NTIMESTAMPS = 5;
@Before
public final void setupTestHBaseQualifierPager() throws Exception {
final Kiji kiji = getKiji();
kiji.createTable(KijiTableLayouts.getLayout(KijiTableLayouts.PAGING_TEST));
mTable = kiji.openTable("user");
final EntityId eid = mTable.getEntityId("me");
final KijiTableWriter writer = mTable.openTableWriter();
try {
for (int job = 0; job < NJOBS; ++job) {
for (long ts = 1; ts <= NTIMESTAMPS; ++ts) {
writer.put(eid, "jobs", String.format("j%d", job), ts, String.format("j%d-t%d", job, ts));
}
}
} finally {
writer.close();
}
mReader = mTable.openTableReader();
}
@After
public final void teardownTestHBaseQualifierPager() throws IOException {
mReader.close();
mTable.release();
}
/** Test a qualifier pager on a map-type family with no user filter. */
@Test
public void testQualifiersPager() throws IOException {
final EntityId eid = mTable.getEntityId("me");
final int pageSize = 2;
final KijiDataRequest dataRequest = KijiDataRequest.builder()
.addColumns(ColumnsDef.create()
.withMaxVersions(HConstants.ALL_VERSIONS).withPageSize(pageSize).addFamily("jobs"))
.build();
final HBaseQualifierPager pager =
new HBaseQualifierPager(
eid, dataRequest, (HBaseKijiTable) mTable, KijiColumnName.create("jobs"));
try {
assertTrue(pager.hasNext());
final List<String> qualifiers = Lists.newArrayList();
int npage = 0;
while (pager.hasNext()) {
// Note: we cannot validate individual pages as their boundaries depend on HBase version.
final List<String> page = Lists.newArrayList(pager.next());
LOG.info("Page #{}: {}", npage, page);
assertTrue(page.size() <= pageSize);
qualifiers.addAll(page);
npage++;
}
final List<String> expected = Lists.newArrayList("j0", "j1", "j2", "j3", "j4");
assertTrue(npage >= 3); // at least 3 pages
assertEquals(expected, qualifiers);
assertFalse(pager.hasNext());
try {
pager.next();
Assert.fail("next() should throw NoSuchElementException");
} catch (NoSuchElementException nsee) {
// Expected
}
} finally {
pager.close();
}
}
/** Test a qualifier pager on a map-type family with a user filter that discards everything. */
@Test
public void testQualifiersPagerWithUserFilterEmpty() throws IOException {
final EntityId eid = mTable.getEntityId("me");
final int pageSize = 2;
final KijiDataRequest dataRequest = KijiDataRequest.builder()
.addColumns(ColumnsDef.create()
.withPageSize(pageSize)
.withFilter(new KijiColumnRangeFilter("j12", true, "j13", true))
.addFamily("jobs"))
.build();
final HBaseQualifierPager pager =
new HBaseQualifierPager(
eid, dataRequest, (HBaseKijiTable) mTable, KijiColumnName.create("jobs"));
try {
assertTrue(pager.hasNext());
assertArrayEquals(new String[]{}, pager.next());
assertFalse(pager.hasNext());
try {
pager.next();
Assert.fail("next() should throw NoSuchElementException");
} catch (NoSuchElementException nsee) {
// Expected
}
} finally {
pager.close();
}
}
/** Test a qualifier pager on a map-type family with a user filter. */
@Test
public void testQualifiersPagerWithUserFilter() throws IOException {
final EntityId eid = mTable.getEntityId("me");
final int pageSize = 2;
final KijiDataRequest dataRequest = KijiDataRequest.builder()
.addColumns(ColumnsDef.create()
.withPageSize(pageSize)
.withFilter(new KijiColumnRangeFilter("j1", true, "j2", true))
.addFamily("jobs"))
.build();
final HBaseQualifierPager pager =
new HBaseQualifierPager(
eid, dataRequest, (HBaseKijiTable) mTable, KijiColumnName.create("jobs"));
try {
assertTrue(pager.hasNext());
final List<String> qualifiers = Lists.newArrayList();
int npage = 0;
while (pager.hasNext()) {
// Note: we cannot validate individual pages as their boundaries depend on HBase version.
final List<String> page = Lists.newArrayList(pager.next());
LOG.info("Page #{}: {}", npage, page);
assertTrue(page.size() <= pageSize);
qualifiers.addAll(page);
npage++;
}
final List<String> expected = Lists.newArrayList("j1", "j2");
assertTrue(npage >= 1); // at least 1 page
assertEquals(expected, qualifiers);
assertFalse(pager.hasNext());
try {
pager.next();
Assert.fail("next() should throw NoSuchElementException");
} catch (NoSuchElementException nsee) {
// Expected
}
} finally {
pager.close();
}
}
/** Test a qualifier pager on a map-type family with a user filter and several pages. */
@Test
public void testQualifiersPagerWithUserFilter2() throws IOException {
final EntityId eid = mTable.getEntityId("me");
final int pageSize = 2;
final KijiDataRequest dataRequest = KijiDataRequest.builder()
.addColumns(ColumnsDef.create()
.withPageSize(pageSize)
.withFilter(new KijiColumnRangeFilter("j1", true, null, true))
.addFamily("jobs"))
.build();
final HBaseQualifierPager pager =
new HBaseQualifierPager(
eid, dataRequest, (HBaseKijiTable) mTable, KijiColumnName.create("jobs"));
try {
assertTrue(pager.hasNext());
final List<String> qualifiers = Lists.newArrayList();
int npage = 0;
while (pager.hasNext()) {
// Note: we cannot validate individual pages as their boundaries depend on HBase version.
final List<String> page = Lists.newArrayList(pager.next());
LOG.info("Page #{}: {}", npage, page);
assertTrue(page.size() <= pageSize);
qualifiers.addAll(page);
npage++;
}
final List<String> expected = Lists.newArrayList("j1", "j2", "j3", "j4");
assertTrue(npage >= 2); // at least 2 pages
assertEquals(expected, qualifiers);
assertFalse(pager.hasNext());
try {
pager.next();
Assert.fail("next() should throw NoSuchElementException");
} catch (NoSuchElementException nsee) {
// Expected
}
} finally {
pager.close();
}
}
}