Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Use standalone EmbeddedSolrServer for Solr integration tests #1368

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@
import io.anserini.search.SearchSolr;

public class AclAnthologyEndToEndTest extends SolrEndToEndTest {
@Override
protected String getCollectionName() {
return "AclAnthology";
}

@Override
protected String getSchemaAdjustmentFile() {
return "solr/schemas/acl-anthology.json";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@
import io.anserini.search.SearchSolr;

public class CoreEndToEndTest extends SolrEndToEndTest {
@Override
protected String getCollectionName() {
return "Core";
}

@Override
protected String getSchemaAdjustmentFile() {
return "solr/schemas/core.json";
Expand Down
128 changes: 88 additions & 40 deletions src/test/java/io/anserini/integration/solr/SolrEndToEndTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,29 +26,98 @@
import org.apache.commons.pool2.impl.DefaultPooledObject;
import org.apache.commons.pool2.impl.GenericObjectPool;
import org.apache.commons.pool2.impl.GenericObjectPoolConfig;
import org.apache.solr.EmbeddedSolrServerTestBase;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.lucene.util.LuceneTestCase;
import org.apache.solr.client.solrj.SolrClient;
import org.apache.solr.client.solrj.embedded.EmbeddedSolrServer;
import org.apache.solr.client.solrj.request.CoreAdminRequest;
import org.apache.solr.client.solrj.request.json.DirectJsonQueryRequest;
import org.apache.solr.client.solrj.response.QueryResponse;
import org.apache.solr.common.params.CommonParams;
import org.apache.solr.core.NodeConfig;
import org.apache.solr.core.SolrResourceLoader;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;

import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.lang.reflect.Field;
import java.net.URL;
import java.nio.file.Files;

public abstract class SolrEndToEndTest extends EmbeddedSolrServerTestBase {
import static org.apache.solr.SolrTestCaseJ4.params;

@LuceneTestCase.SuppressSysoutChecks(bugUrl = "None")
public abstract class SolrEndToEndTest extends LuceneTestCase {
private static final Logger LOG = LogManager.getLogger(SolrEndToEndTest.class);

protected ObjectPool<SolrClient> stubSolrPool;
protected final String searchOutputPrefix = "e2eTestSearch";

protected EmbeddedSolrServer client;

protected static File getFile(String path) {
final URL url = SolrEndToEndTest.class.getClassLoader().getResource(path);
if (url != null) {
try {
return new File(url.toURI());
} catch (Exception e) {
throw new RuntimeException("Resource was found on classpath, but cannot be resolved to a normal file: " + path);
}
}
final File file = new File(path);
if (file.exists()) {
return file;
}
throw new RuntimeException("Cannot find resource in classpath or in file-system (relative to CWD): " + path);
}

@Before
@Override
public void setUp() throws Exception {
super.setUp();

final File solrHome = createTempDir().toFile();
final File configSetBaseDir = new File(solrHome.toPath() + File.separator + "configsets");
FileUtils.copyDirectory(getFile("solr/anserini"), new File(configSetBaseDir + File.separator + "anserini"));

SolrResourceLoader loader = new SolrResourceLoader(solrHome.toPath());
NodeConfig config = new NodeConfig.NodeConfigBuilder("embeddedSolrServerNode", loader)
.setConfigSetBaseDirectory(configSetBaseDir.getAbsolutePath()).build();
client = new EmbeddedSolrServer(config, getCollectionName());
LOG.info("Created Embedded Solr Server");

CoreAdminRequest.Create createRequest = new CoreAdminRequest.Create();
createRequest.setCoreName(getCollectionName());
createRequest.setConfigSet("anserini");
createRequest.process(client);
client.commit();
LOG.info("Created Solr Core: " + getCollectionName());

GenericObjectPoolConfig<SolrClient> poolConfig = new GenericObjectPoolConfig<>();
poolConfig.setMaxTotal(1); // only 1 EmbeddedSolrServer instance will be created by getSolrClient
poolConfig.setMinIdle(1);
stubSolrPool = new GenericObjectPool<>(new StubSolrClientFactory(client), poolConfig);
}

@After
@Override
public void tearDown() throws Exception {
super.tearDown();

client.deleteByQuery("*:*");
client.commit();
client.close();
stubSolrPool.close();
}

protected IndexArgs createDefaultIndexArgs() {
IndexArgs args = new IndexArgs();

args.solrIndex = DEFAULT_CORE_NAME;
args.solrIndex = getCollectionName();
args.threads = 1;
args.storePositions = true;
args.storeDocvectors = true;
Expand All @@ -64,60 +133,38 @@ protected IndexArgs createDefaultIndexArgs() {
protected SearchSolr.Args createSearchArgs(String topicReader, String topicFile) {
SearchSolr.Args args = new SearchSolr.Args();

args.solrIndex = DEFAULT_CORE_NAME;
args.output = this.searchOutputPrefix + topicReader;
args.solrIndex = getCollectionName();
args.output = searchOutputPrefix + topicReader;
args.topicReader = topicReader;
args.topics = new String[]{topicFile};
args.zkUrl = "localhost"; // SearchSolr initialization workaround

return args;
}

protected class StubSolrClientFactory extends BasePooledObjectFactory<SolrClient> {
protected static class StubSolrClientFactory extends BasePooledObjectFactory<SolrClient> {
final SolrClient client;

public StubSolrClientFactory(SolrClient client) {
this.client = client;
}

@Override
public SolrClient create() {
return getSolrClient();
return this.client;
}

@Override
public PooledObject<SolrClient> wrap(SolrClient solrClient) {
return new DefaultPooledObject<>(solrClient);
}

@Override
public void destroyObject(PooledObject<SolrClient> pooled) throws Exception {
pooled.getObject().close();
}
}

@BeforeClass
public static void beforeClass() throws Exception {
File testHome = createTempDir().toFile();
String collectionPath = testHome.getAbsolutePath() + File.separator + DEFAULT_CORE_NAME;
FileUtils.copyDirectory(getFile("solr/anserini"), new File(collectionPath));
initCore("solrconfig.xml", "managed-schema", testHome.getAbsolutePath(), DEFAULT_CORE_NAME);
}

@Before
@Override
public void setUp() throws Exception {
super.setUp();

clearIndex();
assertU(commit());
assertU(optimize());

GenericObjectPoolConfig<SolrClient> config = new GenericObjectPoolConfig<>();
config.setMaxTotal(1); // only 1 EmbeddedSolrServer instance will be created by getSolrClient
config.setMinIdle(1);
this.stubSolrPool = new GenericObjectPool<>(new StubSolrClientFactory(), config);
}

protected IndexCollection getIndexRunner(IndexArgs args) throws Exception {
IndexCollection runner = new IndexCollection(args);
Field f = runner.getClass().getDeclaredField("solrPool");
f.setAccessible(true);
f.set(runner, this.stubSolrPool);
f.set(runner, stubSolrPool);
return runner;
}

Expand All @@ -126,10 +173,12 @@ protected SearchSolr getSearchRunner(SearchSolr.Args args) throws Exception {
Field f = runner.getClass().getDeclaredField("client");
f.setAccessible(true);
((SolrClient) f.get(runner)).close(); // close the old client
f.set(runner, getSolrClient());
f.set(runner, client);
return runner;
}

protected abstract String getCollectionName();

protected abstract String getSchemaAdjustmentFile();

protected abstract IndexArgs getIndexArgs();
Expand All @@ -145,14 +194,13 @@ public void testIndexAndSearch() throws Exception {
// update schema, much like curl -X POST -H 'Content-type:application/json' --data-binary SCHEMA_NAME.json http://localhost:8983/solr/COLLECTION_NAME/schema
String schemaJson = Files.readString(getFile(schemaAdjustmentFile).toPath());
DirectJsonQueryRequest schemaRequest = new DirectJsonQueryRequest(schemaJson, params(CommonParams.QT, "/schema"));
QueryResponse response = schemaRequest.process(getSolrClient(), DEFAULT_CORE_NAME);
QueryResponse response = schemaRequest.process(client, getCollectionName());
assertEquals(0, response.getStatus());
}

IndexArgs indexArgs = getIndexArgs();
IndexCollection indexRunner = getIndexRunner(indexArgs);
indexRunner.run();
this.stubSolrPool.close();

SearchSolr.Args searchArgs = getSearchArgs();
SearchSolr searchRunner = getSearchRunner(searchArgs);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@
import io.anserini.search.SearchSolr;

public class TrecEndToEndTest extends SolrEndToEndTest {
@Override
protected String getCollectionName() {
return "Trec";
}

@Override
protected String getSchemaAdjustmentFile() {
return null; // no need to adjust schema
Expand Down