/*
* 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.directory.server.xdbm.search.impl;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import org.apache.commons.io.FileUtils;
import org.apache.directory.server.core.partition.Partition;
import org.apache.directory.server.core.partition.impl.avl.AvlPartition;
import org.apache.directory.server.xdbm.ForwardIndexEntry;
import org.apache.directory.server.xdbm.IndexCursor;
import org.apache.directory.server.xdbm.IndexEntry;
import org.apache.directory.server.xdbm.Store;
import org.apache.directory.server.xdbm.StoreUtils;
import org.apache.directory.server.xdbm.impl.avl.AvlIndex;
import org.apache.directory.server.xdbm.search.Evaluator;
import org.apache.directory.shared.ldap.model.constants.SchemaConstants;
import org.apache.directory.shared.ldap.model.cursor.Cursor;
import org.apache.directory.shared.ldap.model.cursor.InvalidCursorPositionException;
import org.apache.directory.shared.ldap.model.entry.Entry;
import org.apache.directory.shared.ldap.model.filter.ExprNode;
import org.apache.directory.shared.ldap.model.filter.FilterParser;
import org.apache.directory.shared.ldap.model.filter.OrNode;
import org.apache.directory.shared.ldap.model.filter.SubstringNode;
import org.apache.directory.shared.ldap.model.name.Dn;
import org.apache.directory.shared.ldap.model.schema.SchemaManager;
import org.apache.directory.shared.ldap.schemaextractor.SchemaLdifExtractor;
import org.apache.directory.shared.ldap.schemaextractor.impl.DefaultSchemaLdifExtractor;
import org.apache.directory.shared.ldap.schemaloader.LdifSchemaLoader;
import org.apache.directory.shared.ldap.schemamanager.impl.DefaultSchemaManager;
import org.apache.directory.shared.util.exception.Exceptions;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
*
* Test class for OrCursor.
*
* Note: The results of OrCursor need not be symmetric, in the sense that the results obtained<br>
* in a particular order (say first to last ) need not be same as the results obtained in the<br>
* order last to first, cause each underlying cursor of OrCursor will have elements in their own order.<br>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class OrCursorTest
{
private static final Logger LOG = LoggerFactory.getLogger( OrCursorTest.class.getSimpleName() );
File wkdir;
Store<Entry, Long> store;
static SchemaManager schemaManager = null;
EvaluatorBuilder evaluatorBuilder;
CursorBuilder cursorBuilder;
@BeforeClass
public static void setup() throws Exception
{
String workingDirectory = System.getProperty( "workingDirectory" );
if ( workingDirectory == null )
{
String path = OrCursorTest.class.getResource( "" ).getPath();
int targetPos = path.indexOf( "target" );
workingDirectory = path.substring( 0, targetPos + 6 );
}
File schemaRepository = new File( workingDirectory, "schema" );
SchemaLdifExtractor extractor = new DefaultSchemaLdifExtractor( new File( workingDirectory ) );
extractor.extractOrCopy( true );
LdifSchemaLoader loader = new LdifSchemaLoader( schemaRepository );
schemaManager = new DefaultSchemaManager( loader );
boolean loaded = schemaManager.loadAllEnabled();
if ( !loaded )
{
fail( "Schema load failed : " + Exceptions.printErrors(schemaManager.getErrors()) );
}
loaded = schemaManager.loadWithDeps( loader.getSchema( "collective" ) );
if ( !loaded )
{
fail( "Schema load failed : " + Exceptions.printErrors(schemaManager.getErrors()) );
}
}
@Before
public void createStore() throws Exception
{
// setup the working directory for the store
wkdir = File.createTempFile( getClass().getSimpleName(), "db" );
wkdir.delete();
wkdir = new File( wkdir.getParentFile(), getClass().getSimpleName() );
wkdir.mkdirs();
// initialize the store
store = new AvlPartition( schemaManager );
((Partition)store).setId( "example" );
store.setCacheSize( 10 );
store.setPartitionPath( wkdir.toURI() );
store.setSyncOnWrite( false );
store.addIndex( new AvlIndex( SchemaConstants.OU_AT_OID ) );
store.addIndex( new AvlIndex( SchemaConstants.CN_AT_OID ) );
((Partition)store).setSuffixDn( new Dn( schemaManager, "o=Good Times Co." ) );
((Partition)store).initialize();
((Partition)store).initialize();
StoreUtils.loadExampleData( store, schemaManager );
evaluatorBuilder = new EvaluatorBuilder( store, schemaManager );
cursorBuilder = new CursorBuilder( store, evaluatorBuilder );
LOG.debug( "Created new store" );
}
@After
public void destroyStore() throws Exception
{
if ( store != null )
{
((Partition)store).destroy();
}
store = null;
if ( wkdir != null )
{
FileUtils.deleteDirectory( wkdir );
}
wkdir = null;
}
@Test
public void testOrCursorUsingCursorBuilder() throws Exception
{
String filter = "(|(cn=J*)(sn=W*))";
ExprNode exprNode = FilterParser.parse( schemaManager, filter );
IndexCursor<?, Entry, Long> cursor = cursorBuilder.build( exprNode );
cursor.afterLast();
assertTrue( cursor.previous() );
assertTrue( cursor.available() );
assertEquals( 5, ( long ) cursor.get().getId() );
assertEquals( "walker", cursor.get().getValue() );
assertTrue( cursor.previous() );
assertTrue( cursor.available() );
assertEquals( 11, ( long ) cursor.get().getId() );
assertEquals( "johnny walker", cursor.get().getValue() );
assertTrue( cursor.previous() );
assertTrue( cursor.available() );
assertEquals( 10, ( long ) cursor.get().getId() );
assertEquals( "jim bean", cursor.get().getValue() );
assertTrue( cursor.previous() );
assertTrue( cursor.available() );
assertEquals( 9, ( long ) cursor.get().getId() );
assertEquals( "jim bean", cursor.get().getValue() );
assertTrue( cursor.previous() );
assertTrue( cursor.available() );
assertEquals( 6, ( long ) cursor.get().getId() );
assertEquals( "jim bean", cursor.get().getValue() );
assertTrue( cursor.previous() );
assertTrue( cursor.available() );
assertEquals( 8, ( long ) cursor.get().getId() );
assertEquals( "jack daniels", cursor.get().getValue() );
assertFalse( cursor.previous() );
assertFalse( cursor.available() );
cursor.beforeFirst();
assertTrue( cursor.next() );
assertTrue( cursor.available() );
assertEquals( 8, ( long ) cursor.get().getId() );
assertEquals( "jack daniels", cursor.get().getValue() );
assertTrue( cursor.next() );
assertTrue( cursor.available() );
assertEquals( 6, ( long ) cursor.get().getId() );
assertEquals( "jim bean", cursor.get().getValue() );
assertTrue( cursor.next() );
assertTrue( cursor.available() );
assertEquals( 9, ( long ) cursor.get().getId() );
assertEquals( "jim bean", cursor.get().getValue() );
assertTrue( cursor.next() );
assertTrue( cursor.available() );
assertEquals( 10, ( long ) cursor.get().getId() );
assertEquals( "jim bean", cursor.get().getValue() );
assertTrue( cursor.next() );
assertTrue( cursor.available() );
assertEquals( 11, ( long ) cursor.get().getId() );
assertEquals( "johnny walker", cursor.get().getValue() );
assertTrue( cursor.next() );
assertTrue( cursor.available() );
assertEquals( 5, ( long ) cursor.get().getId() );
assertEquals( "walker", cursor.get().getValue() );
assertFalse( cursor.next() );
assertFalse( cursor.available() );
cursor.close();
assertTrue( cursor.isClosed() );
}
@Test(expected = InvalidCursorPositionException.class)
@SuppressWarnings("unchecked")
public void testOrCursor() throws Exception
{
List<Evaluator<? extends ExprNode, Entry, Long>> evaluators = new ArrayList<Evaluator<? extends ExprNode, Entry, Long>>();
List<Cursor<IndexEntry<?, Entry, Long>>> cursors = new ArrayList<Cursor<IndexEntry<?, Entry, Long>>>();
Evaluator<? extends ExprNode, Entry, Long> eval;
Cursor<IndexEntry<?, Entry, Long>> cursor;
OrNode orNode = new OrNode();
ExprNode exprNode = new SubstringNode( schemaManager.getAttributeType( "cn" ), "J", null );
eval = new SubstringEvaluator( ( SubstringNode ) exprNode, store, schemaManager );
Cursor subStrCursor1 = new SubstringCursor( store, ( SubstringEvaluator ) eval );
cursors.add( subStrCursor1 );
evaluators.add( eval );
orNode.addNode( exprNode );
// try
// {
// new OrCursor( cursors, evaluators );
// fail( "should throw IllegalArgumentException" );
// }
// catch( IllegalArgumentException ie ){ }
exprNode = new SubstringNode( schemaManager.getAttributeType( "sn" ), "W", null );
eval = new SubstringEvaluator( ( SubstringNode ) exprNode, store, schemaManager );
evaluators.add( eval );
Cursor subStrCursor2 = new SubstringCursor( store, ( SubstringEvaluator ) eval );
cursors.add( subStrCursor2 );
orNode.addNode( exprNode );
cursor = new OrCursor( cursors, evaluators );
cursor.beforeFirst();
assertFalse( cursor.available() );
// from first
assertTrue( cursor.first() );
assertTrue( cursor.available() );
assertEquals( 8, ( long ) cursor.get().getId() );
assertEquals( "jack daniels", cursor.get().getValue() );
assertTrue( cursor.next() );
assertTrue( cursor.available() );
assertEquals( 6, ( long ) cursor.get().getId() );
assertEquals( "jim bean", cursor.get().getValue() );
assertTrue( cursor.next() );
assertTrue( cursor.available() );
assertEquals( 9, ( long ) cursor.get().getId() );
assertEquals( "jim bean", cursor.get().getValue() );
assertTrue( cursor.next() );
assertTrue( cursor.available() );
assertEquals( 10, ( long ) cursor.get().getId() );
assertEquals( "jim bean", cursor.get().getValue() );
assertTrue( cursor.next() );
assertTrue( cursor.available() );
assertEquals( 5, ( long ) cursor.get().getId() );
assertEquals( "walker", cursor.get().getValue() );
assertTrue( cursor.next() );
assertTrue( cursor.available() );
assertEquals( 11, ( long ) cursor.get().getId() );
assertEquals( "johnny walker", cursor.get().getValue() );
assertFalse( cursor.next() );
assertFalse( cursor.available() );
// from last
cursor.afterLast();
assertFalse( cursor.available() );
assertTrue( cursor.last() );
assertTrue( cursor.available() );
assertEquals( 11, ( long ) cursor.get().getId() );
assertEquals( "johnny walker", cursor.get().getValue() );
assertTrue( cursor.previous() );
assertTrue( cursor.available() );
assertEquals( 5, ( long ) cursor.get().getId() );
assertEquals( "walker", cursor.get().getValue() );
assertTrue( cursor.previous() );
assertTrue( cursor.available() );
assertEquals( 10, ( long ) cursor.get().getId() );
assertEquals( "jim bean", cursor.get().getValue() );
assertTrue( cursor.previous() );
assertTrue( cursor.available() );
assertEquals( 9, ( long ) cursor.get().getId() );
assertEquals( "jim bean", cursor.get().getValue() );
assertTrue( cursor.previous() );
assertTrue( cursor.available() );
assertEquals( 6, ( long ) cursor.get().getId() );
assertEquals( "jim bean", cursor.get().getValue() );
assertTrue( cursor.previous() );
assertTrue( cursor.available() );
assertEquals( 8, ( long ) cursor.get().getId() );
assertEquals( "jack daniels", cursor.get().getValue() );
assertFalse( cursor.previous() );
assertFalse( cursor.available() );
try
{
cursor.after( new ForwardIndexEntry() );
fail( "should fail with UnsupportedOperationException " );
}
catch ( UnsupportedOperationException uoe )
{
}
try
{
cursor.before( new ForwardIndexEntry() );
fail( "should fail with UnsupportedOperationException " );
}
catch ( UnsupportedOperationException uoe )
{
}
cursor.get();
}
}