Package org.apache.solr.cloud

Class MiniSolrCloudCluster

java.lang.Object

org.apache.solr.cloud.MiniSolrCloudCluster

public class MiniSolrCloudCluster
extends Object

"Mini" SolrCloud cluster to be used for testing

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MiniSolrCloudCluster.Builder	Builder class for a MiniSolrCloudCluster
static class	MiniSolrCloudCluster.JettySolrRunnerWithMetrics

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_CLOUD_SOLR_XML
static int	DEFAULT_TIMEOUT
static String	TEST_URL_ALLOW_LIST

Constructor Summary

Constructors

Constructor	Description
MiniSolrCloudCluster(int numServers, String hostContext, Path baseDir, String solrXml, SortedMap<org.eclipse.jetty.servlet.ServletHolder,String> extraServlets, SortedMap<Class<? extends javax.servlet.Filter>,String> extraRequestFilters)	Create a MiniSolrCloudCluster
MiniSolrCloudCluster(int numServers, String hostContext, Path baseDir, String solrXml, SortedMap<org.eclipse.jetty.servlet.ServletHolder,String> extraServlets, SortedMap<Class<? extends javax.servlet.Filter>,String> extraRequestFilters, org.apache.solr.client.solrj.embedded.SSLConfig sslConfig)	Create a MiniSolrCloudCluster
MiniSolrCloudCluster(int numServers, Path baseDir, String solrXml, JettyConfig jettyConfig)	Create a MiniSolrCloudCluster
MiniSolrCloudCluster(int numServers, Path baseDir, String solrXml, JettyConfig jettyConfig, ZkTestServer zkTestServer, boolean formatZkServer)	Create a MiniSolrCloudCluster
MiniSolrCloudCluster(int numServers, Path baseDir, JettyConfig jettyConfig)	Create a MiniSolrCloudCluster with default solr.xml

Method Summary

Modifier and Type	Method	Description
protected org.apache.solr.client.solrj.impl.CloudSolrClient	buildSolrClient()
void	deleteAllCollections()	Delete all collections (and aliases)
void	deleteAllConfigSets()
void	dumpCoreInfo(PrintStream pw)
void	dumpMetrics(File outputDirectory, String fileName)
static org.apache.solr.common.cloud.CollectionStatePredicate	expectedActive()
static org.apache.solr.common.cloud.CollectionStatePredicate	expectedShardsAndActiveReplicas(int expectedShards, int expectedReplicas)
void	expireZkSession(JettySolrRunner jetty)	Make the zookeeper session on a particular jetty lose connection and expire
Path	getBaseDir()
JettySolrRunner	getJettySolrRunner(int index)
List<JettySolrRunner>	getJettySolrRunners()
org.apache.solr.cloud.Overseer	getOpenOverseer()
static org.apache.solr.cloud.Overseer	getOpenOverseer(List<org.apache.solr.cloud.Overseer> overseers)
JettySolrRunner	getRandomJetty(Random random)
JettySolrRunner	getReplicaJetty(org.apache.solr.common.cloud.Replica replica)	Return the jetty that a particular replica resides on
org.apache.solr.client.solrj.impl.CloudSolrClient	getSolrClient()
org.apache.solr.common.cloud.SolrZkClient	getZkClient()
ZkTestServer	getZkServer()
org.apache.solr.common.cloud.ZkStateReader	getZkStateReader()	The ZkStateReader inside getSolrClient().
void	injectChaos(Random random)
void	shutdown()	Shut down the cluster, including all Solr nodes and ZooKeeper
JettySolrRunner	startJettySolrRunner()	Start a new Solr instance, using the default config
JettySolrRunner	startJettySolrRunner(String name, String hostContext, SortedMap<org.eclipse.jetty.servlet.ServletHolder,String> extraServlets, SortedMap<Class<? extends javax.servlet.Filter>,String> extraRequestFilters)	Start a new Solr instance
JettySolrRunner	startJettySolrRunner(String name, String hostContext, SortedMap<org.eclipse.jetty.servlet.ServletHolder,String> extraServlets, SortedMap<Class<? extends javax.servlet.Filter>,String> extraRequestFilters, org.apache.solr.client.solrj.embedded.SSLConfig sslConfig)	Start a new Solr instance
JettySolrRunner	startJettySolrRunner(String name, String hostContext, JettyConfig config)	Start a new Solr instance on a particular servlet context
JettySolrRunner	startJettySolrRunner(JettySolrRunner jetty)	Add a previously stopped node back to the cluster
JettySolrRunner	stopJettySolrRunner(int index)	Stop a Solr instance
JettySolrRunner	stopJettySolrRunner(JettySolrRunner jetty)	Stop the given Solr instance.
void	uploadConfigSet(Path configDir, String configName)	Upload a config set
void	waitForActiveCollection(String collection, int shards, int totalReplicas)
void	waitForActiveCollection(String collection, long wait, TimeUnit unit)
void	waitForActiveCollection(String collection, long wait, TimeUnit unit, int shards, int totalReplicas)
void	waitForAllNodes(int timeout)	This method wait till all Solr JVMs ( Jettys ) are running .
void	waitForJettyToStop(JettySolrRunner runner)
void	waitForNode(JettySolrRunner jetty, int timeoutSeconds)
void	zkSetData(String path, byte[] data, boolean retryOnConnLoss)	Set data in zk without exposing caller to the ZK API, i.e.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TEST_URL_ALLOW_LIST

public static final String TEST_URL_ALLOW_LIST

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_CLOUD_SOLR_XML

public static final String DEFAULT_CLOUD_SOLR_XML

Constructor Detail

MiniSolrCloudCluster

public MiniSolrCloudCluster(int numServers,
                            Path baseDir,
                            JettyConfig jettyConfig)
                     throws Exception

Create a MiniSolrCloudCluster with default solr.xml

Parameters:

numServers - number of Solr servers to start

baseDir - base directory that the mini cluster should be run from

jettyConfig - Jetty configuration

Throws:

Exception - if there was an error starting the cluster

MiniSolrCloudCluster

public MiniSolrCloudCluster(int numServers,
                            String hostContext,
                            Path baseDir,
                            String solrXml,
                            SortedMap<org.eclipse.jetty.servlet.ServletHolder,String> extraServlets,
                            SortedMap<Class<? extends javax.servlet.Filter>,String> extraRequestFilters)
                     throws Exception

Create a MiniSolrCloudCluster

Parameters:

numServers - number of Solr servers to start

hostContext - context path of Solr servers used by Jetty

baseDir - base directory that the mini cluster should be run from

solrXml - solr.xml file to be uploaded to ZooKeeper

extraServlets - Extra servlets to be started by Jetty

extraRequestFilters - extra filters to be started by Jetty

Throws:

Exception - if there was an error starting the cluster

MiniSolrCloudCluster

public MiniSolrCloudCluster(int numServers,
                            String hostContext,
                            Path baseDir,
                            String solrXml,
                            SortedMap<org.eclipse.jetty.servlet.ServletHolder,String> extraServlets,
                            SortedMap<Class<? extends javax.servlet.Filter>,String> extraRequestFilters,
                            org.apache.solr.client.solrj.embedded.SSLConfig sslConfig)
                     throws Exception

Create a MiniSolrCloudCluster

Parameters:

numServers - number of Solr servers to start

hostContext - context path of Solr servers used by Jetty

baseDir - base directory that the mini cluster should be run from

solrXml - solr.xml file to be uploaded to ZooKeeper

extraServlets - Extra servlets to be started by Jetty

extraRequestFilters - extra filters to be started by Jetty

sslConfig - SSL configuration

Throws:

Exception - if there was an error starting the cluster

MiniSolrCloudCluster

public MiniSolrCloudCluster(int numServers,
                            Path baseDir,
                            String solrXml,
                            JettyConfig jettyConfig)
                     throws Exception

Create a MiniSolrCloudCluster

Parameters:

numServers - number of Solr servers to start

baseDir - base directory that the mini cluster should be run from

solrXml - solr.xml file to be uploaded to ZooKeeper

jettyConfig - Jetty configuration

Throws:

Exception - if there was an error starting the cluster

MiniSolrCloudCluster

public MiniSolrCloudCluster(int numServers,
                            Path baseDir,
                            String solrXml,
                            JettyConfig jettyConfig,
                            ZkTestServer zkTestServer,
                            boolean formatZkServer)
                     throws Exception

Create a MiniSolrCloudCluster

Parameters:

numServers - number of Solr servers to start

baseDir - base directory that the mini cluster should be run from

solrXml - solr.xml file to be uploaded to ZooKeeper

jettyConfig - Jetty configuration

zkTestServer - ZkTestServer to use. If null, one will be created

Throws:

Exception - if there was an error starting the cluster

Method Detail

waitForNode

public void waitForNode(JettySolrRunner jetty,
                        int timeoutSeconds)
                 throws InterruptedException,
                        TimeoutException

Throws:

InterruptedException

TimeoutException

waitForAllNodes

public void waitForAllNodes(int timeout)
                     throws IOException,
                            InterruptedException,
                            TimeoutException

This method wait till all Solr JVMs ( Jettys ) are running . It waits up to the timeout (in seconds) for the JVMs to be up before throwing IllegalStateException. This is called automatically on cluster startup and so is only needed when starting additional Jetty instances.

Parameters:

timeout - number of seconds to wait before throwing an IllegalStateException

Throws:

IOException - if there was an error communicating with ZooKeeper

InterruptedException - if the calling thread is interrupted during the wait operation

TimeoutException - on timeout before all nodes being ready

getZkServer

public ZkTestServer getZkServer()

Returns:

ZooKeeper server used by the MiniCluster

getZkStateReader

public org.apache.solr.common.cloud.ZkStateReader getZkStateReader()

The ZkStateReader inside getSolrClient().

getJettySolrRunners

public List<JettySolrRunner> getJettySolrRunners()

Returns:

Unmodifiable list of all the currently started Solr Jettys.

getRandomJetty

public JettySolrRunner getRandomJetty(Random random)

Returns:

a randomly-selected Jetty

startJettySolrRunner

public JettySolrRunner startJettySolrRunner(String name,
                                            String hostContext,
                                            SortedMap<org.eclipse.jetty.servlet.ServletHolder,String> extraServlets,
                                            SortedMap<Class<? extends javax.servlet.Filter>,String> extraRequestFilters)
                                     throws Exception

Start a new Solr instance

Parameters:

hostContext - context path of Solr servers used by Jetty

extraServlets - Extra servlets to be started by Jetty

extraRequestFilters - extra filters to be started by Jetty

Returns:

new Solr instance

Throws:

Exception

startJettySolrRunner

public JettySolrRunner startJettySolrRunner(String name,
                                            String hostContext,
                                            SortedMap<org.eclipse.jetty.servlet.ServletHolder,String> extraServlets,
                                            SortedMap<Class<? extends javax.servlet.Filter>,String> extraRequestFilters,
                                            org.apache.solr.client.solrj.embedded.SSLConfig sslConfig)
                                     throws Exception

Start a new Solr instance

Parameters:

hostContext - context path of Solr servers used by Jetty

extraServlets - Extra servlets to be started by Jetty

extraRequestFilters - extra filters to be started by Jetty

sslConfig - SSL configuration

Returns:

new Solr instance

Throws:

Exception

getJettySolrRunner

public JettySolrRunner getJettySolrRunner(int index)

startJettySolrRunner

public JettySolrRunner startJettySolrRunner(String name,
                                            String hostContext,
                                            JettyConfig config)
                                     throws Exception

Start a new Solr instance on a particular servlet context

Parameters:

name - the instance name

hostContext - the context to run on

config - a JettyConfig for the instance's JettySolrRunner

Returns:

a JettySolrRunner

Throws:

Exception

startJettySolrRunner

public JettySolrRunner startJettySolrRunner()
                                     throws Exception

Start a new Solr instance, using the default config

Returns:

a JettySolrRunner

Throws:

Exception

stopJettySolrRunner

public JettySolrRunner stopJettySolrRunner(int index)
                                    throws Exception

Stop a Solr instance

Parameters:

index - the index of node in collection returned by getJettySolrRunners()

Returns:

the shut down node

Throws:

Exception

startJettySolrRunner

public JettySolrRunner startJettySolrRunner(JettySolrRunner jetty)
                                     throws Exception

Add a previously stopped node back to the cluster

Parameters:

jetty - a JettySolrRunner previously returned by stopJettySolrRunner(int)

Returns:

the started node

Throws:

Exception - on error

stopJettySolrRunner

public JettySolrRunner stopJettySolrRunner(JettySolrRunner jetty)
                                    throws Exception

Stop the given Solr instance. It will be removed from the cluster's list of running instances.

Parameters:

jetty - a JettySolrRunner to be stopped

Returns:

the same JettySolrRunner instance provided to this method

Throws:

Exception - on error

uploadConfigSet

public void uploadConfigSet(Path configDir,
                            String configName)
                     throws IOException

Upload a config set

Parameters:

configDir - a path to the config set to upload

configName - the name to give the configset

Throws:

IOException

deleteAllCollections

public void deleteAllCollections()
                          throws Exception

Delete all collections (and aliases)

Throws:

Exception

deleteAllConfigSets

public void deleteAllConfigSets()
                         throws Exception

Throws:

Exception

shutdown

public void shutdown()
              throws Exception

Shut down the cluster, including all Solr nodes and ZooKeeper

Throws:

Exception

getBaseDir

public Path getBaseDir()

getSolrClient

public org.apache.solr.client.solrj.impl.CloudSolrClient getSolrClient()

getZkClient

public org.apache.solr.common.cloud.SolrZkClient getZkClient()

zkSetData

public void zkSetData(String path,
                      byte[] data,
                      boolean retryOnConnLoss)
               throws InterruptedException

Set data in zk without exposing caller to the ZK API, i.e. tests won't need to include Zookeeper dependencies

Throws:

InterruptedException

buildSolrClient

protected org.apache.solr.client.solrj.impl.CloudSolrClient buildSolrClient()

getReplicaJetty

public JettySolrRunner getReplicaJetty(org.apache.solr.common.cloud.Replica replica)

Return the jetty that a particular replica resides on

expireZkSession

public void expireZkSession(JettySolrRunner jetty)

Make the zookeeper session on a particular jetty lose connection and expire

injectChaos

public void injectChaos(Random random)
                 throws Exception

Throws:

Exception

getOpenOverseer

public org.apache.solr.cloud.Overseer getOpenOverseer()

getOpenOverseer

public static org.apache.solr.cloud.Overseer getOpenOverseer(List<org.apache.solr.cloud.Overseer> overseers)

waitForActiveCollection

public void waitForActiveCollection(String collection,
                                    long wait,
                                    TimeUnit unit,
                                    int shards,
                                    int totalReplicas)

waitForActiveCollection

public void waitForActiveCollection(String collection,
                                    int shards,
                                    int totalReplicas)

waitForActiveCollection

public void waitForActiveCollection(String collection,
                                    long wait,
                                    TimeUnit unit)

expectedShardsAndActiveReplicas

public static org.apache.solr.common.cloud.CollectionStatePredicate expectedShardsAndActiveReplicas(int expectedShards,
                                                                                                    int expectedReplicas)

expectedActive

public static org.apache.solr.common.cloud.CollectionStatePredicate expectedActive()

waitForJettyToStop

public void waitForJettyToStop(JettySolrRunner runner)
                        throws TimeoutException

Throws:

TimeoutException

dumpMetrics

public void dumpMetrics(File outputDirectory,
                        String fileName)
                 throws IOException

Throws:

IOException

dumpCoreInfo

public void dumpCoreInfo(PrintStream pw)
                  throws IOException

Throws:

IOException