/*
* 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.store;
import java.io.EOFException;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.List;
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.index.DirectoryReader;
import org.apache.lucene.index.IndexReader;
import org.apache.lucene.index.IndexWriter;
import org.apache.lucene.index.IndexWriterConfig.OpenMode;
import org.apache.lucene.index.IndexWriterConfig;
import org.apache.lucene.search.IndexSearcher;
import org.apache.lucene.util.English;
import org.apache.lucene.util.IOUtils;
/**
* JUnit testcase to test RAMDirectory. RAMDirectory itself is used in many testcases,
* but not one of them uses an different constructor other than the default constructor.
*/
public class TestRAMDirectory extends BaseDirectoryTestCase {
@Override
protected Directory getDirectory(Path path) {
return new RAMDirectory();
}
// add enough document so that the index will be larger than RAMDirectory.READ_BUFFER_SIZE
private static final int DOCS_TO_ADD = 500;
private Path buildIndex() throws IOException {
Path path = createTempDir("buildIndex");
Directory dir = newFSDirectory(path);
IndexWriter writer = new IndexWriter(dir, new IndexWriterConfig(
new MockAnalyzer(random())).setOpenMode(OpenMode.CREATE));
// add some documents
Document doc = null;
for (int i = 0; i < DOCS_TO_ADD; i++) {
doc = new Document();
doc.add(newStringField("content", English.intToEnglish(i).trim(), Field.Store.YES));
writer.addDocument(doc);
}
assertEquals(DOCS_TO_ADD, writer.maxDoc());
writer.close();
dir.close();
return path;
}
// LUCENE-1468
public void testCopySubdir() throws Throwable {
Path path = createTempDir("testsubdir");
FSDirectory fsDir = null;
try {
Files.createDirectory(path.resolve("subdir"));
fsDir = new SimpleFSDirectory(path);
RAMDirectory ramDir = new RAMDirectory(fsDir, newIOContext(random()));
List<String> files = Arrays.asList(ramDir.listAll());
assertFalse(files.contains("subdir"));
} finally {
IOUtils.close(fsDir);
}
}
public void testRAMDirectory () throws IOException {
Path indexDir = buildIndex();
FSDirectory dir = new SimpleFSDirectory(indexDir);
MockDirectoryWrapper ramDir = new MockDirectoryWrapper(random(), new RAMDirectory(dir, newIOContext(random())));
// close the underlaying directory
dir.close();
// Check size
assertEquals(ramDir.sizeInBytes(), ramDir.getRecomputedSizeInBytes());
// open reader to test document count
IndexReader reader = DirectoryReader.open(ramDir);
assertEquals(DOCS_TO_ADD, reader.numDocs());
// open search zo check if all doc's are there
IndexSearcher searcher = newSearcher(reader);
// search for all documents
for (int i = 0; i < DOCS_TO_ADD; i++) {
Document doc = searcher.doc(i);
assertTrue(doc.getField("content") != null);
}
// cleanup
reader.close();
}
private static final int NUM_THREADS = 10;
private static final int DOCS_PER_THREAD = 40;
public void testRAMDirectorySize() throws IOException, InterruptedException {
Path indexDir = buildIndex();
FSDirectory dir = new SimpleFSDirectory(indexDir);
final MockDirectoryWrapper ramDir = new MockDirectoryWrapper(random(), new RAMDirectory(dir, newIOContext(random())));
dir.close();
final IndexWriter writer = new IndexWriter(ramDir, new IndexWriterConfig(
new MockAnalyzer(random())).setOpenMode(OpenMode.APPEND));
writer.forceMerge(1);
assertEquals(ramDir.sizeInBytes(), ramDir.getRecomputedSizeInBytes());
Thread[] threads = new Thread[NUM_THREADS];
for (int i = 0; i< NUM_THREADS; i++) {
final int num = i;
threads[i] = new Thread(){
@Override
public void run() {
for (int j = 1; j< DOCS_PER_THREAD; j++) {
Document doc = new Document();
doc.add(newStringField("sizeContent", English.intToEnglish(num* DOCS_PER_THREAD +j).trim(), Field.Store.YES));
try {
writer.addDocument(doc);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
}
};
}
for (int i = 0; i< NUM_THREADS; i++) {
threads[i].start();
}
for (int i = 0; i< NUM_THREADS; i++) {
threads[i].join();
}
writer.forceMerge(1);
assertEquals(ramDir.sizeInBytes(), ramDir.getRecomputedSizeInBytes());
writer.close();
}
public void testShouldThrowEOFException() throws Exception {
final Random random = random();
try (Directory dir = newDirectory()) {
final int len = 16 + random().nextInt(2048) / 16 * 16;
final byte[] bytes = new byte[len];
try (IndexOutput os = dir.createOutput("foo", newIOContext(random))) {
os.writeBytes(bytes, bytes.length);
}
try (IndexInput is = dir.openInput("foo", newIOContext(random))) {
expectThrows(EOFException.class, () -> {
is.seek(0);
// Here, I go past EOF.
is.seek(len + random().nextInt(2048));
// since EOF is not enforced by the previous call in RAMInputStream
// this call to readBytes should throw the exception.
is.readBytes(bytes, 0, 16);
});
}
}
}
}