/*
* 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.lucene.index;
import java.io.IOException;
import java.util.Random;
import org.apache.lucene.analysis.MockAnalyzer;
import org.apache.lucene.document.Document;
import org.apache.lucene.document.Field;
import org.apache.lucene.search.*;
import org.apache.lucene.search.BooleanClause.Occur;
import org.apache.lucene.store.AlreadyClosedException;
import org.apache.lucene.store.Directory;
import org.apache.lucene.util.IOUtils;
import org.apache.lucene.util.LuceneTestCase;
import org.apache.lucene.util.TestUtil;
public class TestParallelLeafReader extends LuceneTestCase {
private IndexSearcher parallel, single;
private Directory dir, dir1, dir2;
public void testQueries() throws Exception {
single = single(random());
parallel = parallel(random());
queryTest(new TermQuery(new Term("f1", "v1")));
queryTest(new TermQuery(new Term("f1", "v2")));
queryTest(new TermQuery(new Term("f2", "v1")));
queryTest(new TermQuery(new Term("f2", "v2")));
queryTest(new TermQuery(new Term("f3", "v1")));
queryTest(new TermQuery(new Term("f3", "v2")));
queryTest(new TermQuery(new Term("f4", "v1")));
queryTest(new TermQuery(new Term("f4", "v2")));
BooleanQuery.Builder bq1 = new BooleanQuery.Builder();
bq1.add(new TermQuery(new Term("f1", "v1")), Occur.MUST);
bq1.add(new TermQuery(new Term("f4", "v1")), Occur.MUST);
queryTest(bq1.build());
single.getIndexReader().close(); single = null;
parallel.getIndexReader().close(); parallel = null;
dir.close(); dir = null;
dir1.close(); dir1 = null;
dir2.close(); dir2 = null;
}
public void testFieldNames() throws Exception {
Directory dir1 = getDir1(random());
Directory dir2 = getDir2(random());
ParallelLeafReader pr = new ParallelLeafReader(getOnlyLeafReader(DirectoryReader.open(dir1)),
getOnlyLeafReader(DirectoryReader.open(dir2)));
FieldInfos fieldInfos = pr.getFieldInfos();
assertEquals(4, fieldInfos.size());
assertNotNull(fieldInfos.fieldInfo("f1"));
assertNotNull(fieldInfos.fieldInfo("f2"));
assertNotNull(fieldInfos.fieldInfo("f3"));
assertNotNull(fieldInfos.fieldInfo("f4"));
pr.close();
dir1.close();
dir2.close();
}
public void testRefCounts1() throws IOException {
Directory dir1 = getDir1(random());
Directory dir2 = getDir2(random());
LeafReader ir1, ir2;
// close subreaders, ParallelReader will not change refCounts, but close on its own close
ParallelLeafReader pr = new ParallelLeafReader(ir1 = getOnlyLeafReader(DirectoryReader.open(dir1)),
ir2 = getOnlyLeafReader(DirectoryReader.open(dir2)));
// check RefCounts
assertEquals(1, ir1.getRefCount());
assertEquals(1, ir2.getRefCount());
pr.close();
assertEquals(0, ir1.getRefCount());
assertEquals(0, ir2.getRefCount());
dir1.close();
dir2.close();
}
public void testRefCounts2() throws IOException {
Directory dir1 = getDir1(random());
Directory dir2 = getDir2(random());
LeafReader ir1 = getOnlyLeafReader(DirectoryReader.open(dir1));
LeafReader ir2 = getOnlyLeafReader(DirectoryReader.open(dir2));
// don't close subreaders, so ParallelReader will increment refcounts
ParallelLeafReader pr = new ParallelLeafReader(false, ir1, ir2);
// check RefCounts
assertEquals(2, ir1.getRefCount());
assertEquals(2, ir2.getRefCount());
pr.close();
assertEquals(1, ir1.getRefCount());
assertEquals(1, ir2.getRefCount());
ir1.close();
ir2.close();
assertEquals(0, ir1.getRefCount());
assertEquals(0, ir2.getRefCount());
dir1.close();
dir2.close();
}
public void testCloseInnerReader() throws Exception {
Directory dir1 = getDir1(random());
LeafReader ir1 = getOnlyLeafReader(DirectoryReader.open(dir1));
// with overlapping
ParallelLeafReader pr = new ParallelLeafReader(true,
new LeafReader[] {ir1},
new LeafReader[] {ir1});
ir1.close();
// should already be closed because inner reader is closed!
expectThrows(AlreadyClosedException.class, () -> {
pr.document(0);
});
// noop:
pr.close();
dir1.close();
}
public void testIncompatibleIndexes() throws IOException {
// two documents:
Directory dir1 = getDir1(random());
// one document only:
Directory dir2 = newDirectory();
IndexWriter w2 = new IndexWriter(dir2, newIndexWriterConfig(new MockAnalyzer(random())));
Document d3 = new Document();
d3.add(newTextField("f3", "v1", Field.Store.YES));
w2.addDocument(d3);
w2.close();
LeafReader ir1 = getOnlyLeafReader(DirectoryReader.open(dir1));
LeafReader ir2 = getOnlyLeafReader(DirectoryReader.open(dir2));
// indexes don't have the same number of documents
expectThrows(IllegalArgumentException.class, () -> {
new ParallelLeafReader(ir1, ir2);
});
expectThrows(IllegalArgumentException.class, () -> {
new ParallelLeafReader(random().nextBoolean(),
new LeafReader[] {ir1, ir2},
new LeafReader[] {ir1, ir2});
});
// check RefCounts
assertEquals(1, ir1.getRefCount());
assertEquals(1, ir2.getRefCount());
ir1.close();
ir2.close();
dir1.close();
dir2.close();
}
public void testIgnoreStoredFields() throws IOException {
Directory dir1 = getDir1(random());
Directory dir2 = getDir2(random());
LeafReader ir1 = getOnlyLeafReader(DirectoryReader.open(dir1));
LeafReader ir2 = getOnlyLeafReader(DirectoryReader.open(dir2));
// with overlapping
ParallelLeafReader pr = new ParallelLeafReader(false,
new LeafReader[] {ir1, ir2},
new LeafReader[] {ir1});
assertEquals("v1", pr.document(0).get("f1"));
assertEquals("v1", pr.document(0).get("f2"));
assertNull(pr.document(0).get("f3"));
assertNull(pr.document(0).get("f4"));
// check that fields are there
assertNotNull(pr.terms("f1"));
assertNotNull(pr.terms("f2"));
assertNotNull(pr.terms("f3"));
assertNotNull(pr.terms("f4"));
pr.close();
// no stored fields at all
pr = new ParallelLeafReader(false,
new LeafReader[] {ir2},
new LeafReader[0]);
assertNull(pr.document(0).get("f1"));
assertNull(pr.document(0).get("f2"));
assertNull(pr.document(0).get("f3"));
assertNull(pr.document(0).get("f4"));
// check that fields are there
assertNull(pr.terms("f1"));
assertNull(pr.terms("f2"));
assertNotNull(pr.terms("f3"));
assertNotNull(pr.terms("f4"));
pr.close();
// without overlapping
pr = new ParallelLeafReader(true,
new LeafReader[] {ir2},
new LeafReader[] {ir1});
assertEquals("v1", pr.document(0).get("f1"));
assertEquals("v1", pr.document(0).get("f2"));
assertNull(pr.document(0).get("f3"));
assertNull(pr.document(0).get("f4"));
// check that fields are there
assertNull(pr.terms("f1"));
assertNull(pr.terms("f2"));
assertNotNull(pr.terms("f3"));
assertNotNull(pr.terms("f4"));
pr.close();
// no main readers
expectThrows(IllegalArgumentException.class, () -> {
new ParallelLeafReader(true,
new LeafReader[0],
new LeafReader[] {ir1});
});
dir1.close();
dir2.close();
}
private void queryTest(Query query) throws IOException {
ScoreDoc[] parallelHits = parallel.search(query, 1000).scoreDocs;
ScoreDoc[] singleHits = single.search(query, 1000).scoreDocs;
assertEquals(parallelHits.length, singleHits.length);
for(int i = 0; i < parallelHits.length; i++) {
assertEquals(parallelHits[i].score, singleHits[i].score, 0.001f);
Document docParallel = parallel.doc(parallelHits[i].doc);
Document docSingle = single.doc(singleHits[i].doc);
assertEquals(docParallel.get("f1"), docSingle.get("f1"));
assertEquals(docParallel.get("f2"), docSingle.get("f2"));
assertEquals(docParallel.get("f3"), docSingle.get("f3"));
assertEquals(docParallel.get("f4"), docSingle.get("f4"));
}
}
// Fields 1-4 indexed together:
private IndexSearcher single(Random random) throws IOException {
dir = newDirectory();
IndexWriter w = new IndexWriter(dir, newIndexWriterConfig(new MockAnalyzer(random)));
Document d1 = new Document();
d1.add(newTextField("f1", "v1", Field.Store.YES));
d1.add(newTextField("f2", "v1", Field.Store.YES));
d1.add(newTextField("f3", "v1", Field.Store.YES));
d1.add(newTextField("f4", "v1", Field.Store.YES));
w.addDocument(d1);
Document d2 = new Document();
d2.add(newTextField("f1", "v2", Field.Store.YES));
d2.add(newTextField("f2", "v2", Field.Store.YES));
d2.add(newTextField("f3", "v2", Field.Store.YES));
d2.add(newTextField("f4", "v2", Field.Store.YES));
w.addDocument(d2);
w.close();
DirectoryReader ir = DirectoryReader.open(dir);
return newSearcher(ir);
}
// Fields 1 & 2 in one index, 3 & 4 in other, with ParallelReader:
private IndexSearcher parallel(Random random) throws IOException {
dir1 = getDir1(random);
dir2 = getDir2(random);
ParallelLeafReader pr = new ParallelLeafReader(
getOnlyLeafReader(DirectoryReader.open(dir1)),
getOnlyLeafReader(DirectoryReader.open(dir2)));
TestUtil.checkReader(pr);
return newSearcher(pr);
}
private Directory getDir1(Random random) throws IOException {
Directory dir1 = newDirectory();
IndexWriter w1 = new IndexWriter(dir1, newIndexWriterConfig(new MockAnalyzer(random)));
Document d1 = new Document();
d1.add(newTextField("f1", "v1", Field.Store.YES));
d1.add(newTextField("f2", "v1", Field.Store.YES));
w1.addDocument(d1);
Document d2 = new Document();
d2.add(newTextField("f1", "v2", Field.Store.YES));
d2.add(newTextField("f2", "v2", Field.Store.YES));
w1.addDocument(d2);
w1.forceMerge(1);
w1.close();
return dir1;
}
private Directory getDir2(Random random) throws IOException {
Directory dir2 = newDirectory();
IndexWriter w2 = new IndexWriter(dir2, newIndexWriterConfig(new MockAnalyzer(random)));
Document d3 = new Document();
d3.add(newTextField("f3", "v1", Field.Store.YES));
d3.add(newTextField("f4", "v1", Field.Store.YES));
w2.addDocument(d3);
Document d4 = new Document();
d4.add(newTextField("f3", "v2", Field.Store.YES));
d4.add(newTextField("f4", "v2", Field.Store.YES));
w2.addDocument(d4);
w2.forceMerge(1);
w2.close();
return dir2;
}
// not ok to have one leaf w/ index sort and another with a different index sort
public void testWithIndexSort1() throws Exception {
Directory dir1 = newDirectory();
IndexWriterConfig iwc1 = newIndexWriterConfig(new MockAnalyzer(random()));
iwc1.setIndexSort(new Sort(new SortField("foo", SortField.Type.INT)));
IndexWriter w1 = new IndexWriter(dir1, iwc1);
w1.addDocument(new Document());
w1.commit();
w1.addDocument(new Document());
w1.forceMerge(1);
w1.close();
IndexReader r1 = DirectoryReader.open(dir1);
Directory dir2 = newDirectory();
IndexWriterConfig iwc2 = newIndexWriterConfig(new MockAnalyzer(random()));
iwc2.setIndexSort(new Sort(new SortField("bar", SortField.Type.INT)));
IndexWriter w2 = new IndexWriter(dir2, iwc2);
w2.addDocument(new Document());
w2.commit();
w2.addDocument(new Document());
w2.forceMerge(1);
w2.close();
IndexReader r2 = DirectoryReader.open(dir2);
String message = expectThrows(IllegalArgumentException.class, () -> {
new ParallelLeafReader(getOnlyLeafReader(r1), getOnlyLeafReader(r2));
}).getMessage();
assertEquals("cannot combine LeafReaders that have different index sorts: saw both sort=<int: \"foo\"> and <int: \"bar\">", message);
IOUtils.close(r1, dir1, r2, dir2);
}
// ok to have one leaf w/ index sort and the other with no sort
public void testWithIndexSort2() throws Exception {
Directory dir1 = newDirectory();
IndexWriterConfig iwc1 = newIndexWriterConfig(new MockAnalyzer(random()));
iwc1.setIndexSort(new Sort(new SortField("foo", SortField.Type.INT)));
IndexWriter w1 = new IndexWriter(dir1, iwc1);
w1.addDocument(new Document());
w1.commit();
w1.addDocument(new Document());
w1.forceMerge(1);
w1.close();
IndexReader r1 = DirectoryReader.open(dir1);
Directory dir2 = newDirectory();
IndexWriterConfig iwc2 = newIndexWriterConfig(new MockAnalyzer(random()));
IndexWriter w2 = new IndexWriter(dir2, iwc2);
w2.addDocument(new Document());
w2.addDocument(new Document());
w2.close();
IndexReader r2 = DirectoryReader.open(dir2);
new ParallelLeafReader(false, getOnlyLeafReader(r1), getOnlyLeafReader(r2)).close();
new ParallelLeafReader(false, getOnlyLeafReader(r2), getOnlyLeafReader(r1)).close();
IOUtils.close(r1, dir1, r2, dir2);
}
}