/*
* 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.solr;
import org.apache.commons.io.FileUtils;
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.embedded.JettyConfig;
import org.apache.solr.client.solrj.embedded.JettySolrRunner;
import org.apache.solr.client.solrj.impl.HttpSolrClient;
import org.apache.solr.util.ExternalPaths;
import org.eclipse.jetty.servlet.ServletHolder;
import org.junit.After;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.File;
import java.io.OutputStreamWriter;
import java.lang.invoke.MethodHandles;
import java.nio.file.Path;
import java.util.Properties;
import java.util.SortedMap;
abstract public class SolrJettyTestBase extends SolrTestCaseJ4
{
private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
@BeforeClass
public static void beforeSolrJettyTestBase() throws Exception {
}
public static JettySolrRunner jetty;
public static int port;
public static SolrClient client = null;
public static String context;
public static JettySolrRunner createJetty(String solrHome, String configFile, String schemaFile, String context,
boolean stopAtShutdown, SortedMap<ServletHolder,String> extraServlets)
throws Exception {
// creates the data dir
context = context==null ? "/solr" : context;
SolrJettyTestBase.context = context;
JettyConfig jettyConfig = JettyConfig.builder()
.setContext(context)
.stopAtShutdown(stopAtShutdown)
.withServlets(extraServlets)
.withSSLConfig(sslConfig)
.build();
Properties nodeProps = new Properties();
if (configFile != null)
nodeProps.setProperty("solrconfig", configFile);
if (schemaFile != null)
nodeProps.setProperty("schema", schemaFile);
if (System.getProperty("solr.data.dir") == null && System.getProperty("solr.hdfs.home") == null) {
nodeProps.setProperty("solr.data.dir", createTempDir().toFile().getCanonicalPath());
}
return createJetty(solrHome, nodeProps, jettyConfig);
}
public static JettySolrRunner createJetty(String solrHome, String configFile, String context) throws Exception {
return createJetty(solrHome, configFile, null, context, true, null);
}
public static JettySolrRunner createJetty(String solrHome, JettyConfig jettyConfig) throws Exception {
return createJetty(solrHome, new Properties(), jettyConfig);
}
public static JettySolrRunner createJetty(String solrHome) throws Exception {
return createJetty(solrHome, new Properties(), JettyConfig.builder().withSSLConfig(sslConfig).build());
}
public static JettySolrRunner createJetty(String solrHome, Properties nodeProperties, JettyConfig jettyConfig) throws Exception {
initCore(null, null, solrHome);
Path coresDir = createTempDir().resolve("cores");
Properties props = new Properties();
props.setProperty("name", DEFAULT_TEST_CORENAME);
props.setProperty("configSet", "collection1");
props.setProperty("config", "${solrconfig:solrconfig.xml}");
props.setProperty("schema", "${schema:schema.xml}");
writeCoreProperties(coresDir.resolve("core"), props, "RestTestBase");
Properties nodeProps = new Properties(nodeProperties);
nodeProps.setProperty("coreRootDirectory", coresDir.toString());
nodeProps.setProperty("configSetBaseDir", solrHome);
jetty = new JettySolrRunner(solrHome, nodeProps, jettyConfig);
jetty.start();
port = jetty.getLocalPort();
log.info("Jetty Assigned Port#" + port);
return jetty;
}
@After
public void afterClass() throws Exception {
if (client != null) client.close();
client = null;
}
@AfterClass
public static void afterSolrJettyTestBase() throws Exception {
if (jetty != null) {
jetty.stop();
jetty = null;
}
}
public SolrClient getSolrClient() {
{
if (client == null) {
client = createNewSolrClient();
}
return client;
}
}
/**
* Create a new solr client.
* If createJetty was called, an http implementation will be created,
* otherwise an embedded implementation will be created.
* Subclasses should override for other options.
*/
public SolrClient createNewSolrClient() {
if (jetty != null) {
try {
// setup the client...
String url = jetty.getBaseUrl().toString() + "/" + "collection1";
HttpSolrClient client = getHttpSolrClient(url);
client.setConnectionTimeout(DEFAULT_CONNECTION_TIMEOUT);
return client;
}
catch( Exception ex ) {
throw new RuntimeException( ex );
}
} else {
return new EmbeddedSolrServer( h.getCoreContainer(), "collection1" ) {
@Override
public void close() {
// do not close core container
}
};
}
}
// Sets up the necessary config files for Jetty. At least some tests require that the solrconfig from the test
// file directory are used, but some also require that the solr.xml file be explicitly there as of SOLR-4817
public static void setupJettyTestHome(File solrHome, String collection) throws Exception {
copySolrHomeToTemp(solrHome, collection);
}
public static void cleanUpJettyHome(File solrHome) throws Exception {
if (solrHome.exists()) {
FileUtils.deleteDirectory(solrHome);
}
}
public static void initCore() throws Exception {
String exampleHome = legacyExampleCollection1SolrHome();
String exampleConfig = exampleHome+"/collection1/conf/solrconfig.xml";
String exampleSchema = exampleHome+"/collection1/conf/schema.xml";
initCore(exampleConfig, exampleSchema, exampleHome);
}
public static String legacyExampleCollection1SolrHome() {
String sourceHome = ExternalPaths.SOURCE_HOME;
if (sourceHome == null)
throw new IllegalStateException("No source home! Cannot create the legacy example solr home directory.");
String legacyExampleSolrHome = null;
try {
File tempSolrHome = LuceneTestCase.createTempDir().toFile();
org.apache.commons.io.FileUtils.copyFileToDirectory(new File(sourceHome, "server/solr/solr.xml"), tempSolrHome);
File collection1Dir = new File(tempSolrHome, "collection1");
org.apache.commons.io.FileUtils.forceMkdir(collection1Dir);
File configSetDir = new File(sourceHome, "server/solr/configsets/sample_techproducts_configs/conf");
org.apache.commons.io.FileUtils.copyDirectoryToDirectory(configSetDir, collection1Dir);
Properties props = new Properties();
props.setProperty("name", "collection1");
OutputStreamWriter writer = null;
try {
writer = new OutputStreamWriter(FileUtils.openOutputStream(new File(collection1Dir, "core.properties")), "UTF-8");
props.store(writer, null);
} finally {
if (writer != null) {
try {
writer.close();
} catch (Exception ignore){}
}
}
legacyExampleSolrHome = tempSolrHome.getAbsolutePath();
} catch (Exception exc) {
if (exc instanceof RuntimeException) {
throw (RuntimeException)exc;
} else {
throw new RuntimeException(exc);
}
}
return legacyExampleSolrHome;
}
}