Package org.apache.iotdb.itbase.env

Interface BaseEnv

All Known Implementing Classes:

AbstractEnv, AIEnv, Cluster1Env, MultiClusterEnv, RemoteServerEnv, SimpleEnv

public interface BaseEnv

Method Summary

Modifier and Type	Method	Description
void	cleanClusterEnvironment()	Destroy the cluster and all the configurations.
Optional<DataNodeWrapper>	dataNodeIdToWrapper(int nodeId)
void	dumpTestJVMSnapshot()
void	ensureNodeStatus(List<BaseNodeWrapper> nodes, List<NodeStatus> targetStatus)	Ensure all the nodes being in the corresponding status.
ConfigNodeWrapper	generateRandomConfigNodeWrapper()	Get a ConfigNodeWrapper randomly.
DataNodeWrapper	generateRandomDataNodeWrapper()	Get a DataNodeWrapper randomly.
ClusterConfig	getConfig()	Return the ClusterConfig for developers to set values before test.
default IConfigNodeRPCService.Iface	getConfigNodeConnection(int index)
ConfigNodeWrapper	getConfigNodeWrapper(int index)	Get the ConfigNodeWrapper of the specified index.
List<ConfigNodeWrapper>	getConfigNodeWrapperList()
default Connection	getConnection()
Connection	getConnection(String username, String password)
Connection	getConnection(DataNodeWrapper dataNodeWrapper, String username, String password)
default Connection	getConnection(Constant.Version version)
Connection	getConnection(Constant.Version version, String username, String password)
default Connection	getConnectionWithSpecifiedDataNode(DataNodeWrapper dataNode)
Connection	getConnectionWithSpecifiedDataNode(DataNodeWrapper dataNode, String username, String password)
DataNodeWrapper	getDataNodeWrapper(int index)	Get the DataNodeWrapper of the specified index.
List<DataNodeWrapper>	getDataNodeWrapperList()
int	getFirstLeaderSchemaRegionDataNodeIndex()	Get the index of the first dataNode with a SchemaRegion leader.
String	getIP()
IConfigNodeRPCService.Iface	getLeaderConfigNodeConnection()
int	getLeaderConfigNodeIndex()	Get the index of the ConfigNode leader.
String	getLibPath()
List<String>	getMetricPrometheusReporterContents(String authHeader)	Return the content of prometheus
int	getMqttPort()
List<AbstractNodeWrapper>	getNodeWrapperList()
String	getPort()
String	getSbinPath()
ISession	getSessionConnection()
ISession	getSessionConnection(String userName, String password)
ISession	getSessionConnection(ZoneId zoneId)
ISession	getSessionConnection(List<String> nodeUrls)
ISessionPool	getSessionPool(int maxSize)
String	getToolsPath()
default String	getUrlContent(String urlStr, String authHeader)
default Connection	getWriteOnlyConnectionWithSpecifiedDataNode(DataNodeWrapper dataNode)
Connection	getWriteOnlyConnectionWithSpecifiedDataNode(DataNodeWrapper dataNode, String username, String password)
void	initClusterEnvironment()	Init a cluster with default number of ConfigNodes and DataNodes.
void	initClusterEnvironment(int configNodesNum, int dataNodesNum)	Init a cluster with the specified number of ConfigNodes and DataNodes.
void	initClusterEnvironment(int configNodesNum, int dataNodesNum, int testWorkingRetryCount)	Init a cluster with the specified number of ConfigNodes and DataNodes.
void	registerConfigNodeKillPoints(List<String> killPoints)
void	registerDataNodeKillPoints(List<String> killPoints)
void	registerNewConfigNode(boolean isNeedVerify)	Register a new ConfigNode with random ports.
void	registerNewConfigNode(ConfigNodeWrapper newConfigNodeWrapper, boolean isNeedVerify)	Register a new DataNode with specified ConfigNodeWrapper.
void	registerNewDataNode(boolean isNeedVerify)	Register a new DataNode with random ports.
void	registerNewDataNode(DataNodeWrapper newDataNodeWrapper, boolean isNeedVerify)	Register a new DataNode with specified DataNodeWrapper.
void	setTestMethodName(String testCaseName)
void	shutdownAllConfigNodes()	Shutdown all existed ConfigNodes.
void	shutdownAllDataNodes()	Shutdown all existed DataNodes.
void	shutdownConfigNode(int index)	Shutdown an existed ConfigNode.
void	shutdownDataNode(int index)	Shutdown an existed DataNode.
void	shutdownForciblyAllConfigNodes()
void	shutdownForciblyAllDataNodes()	Shutdown forcibly all existed DataNodes.
void	startAllConfigNodes()	Start all existed ConfigNodes.
void	startAllDataNodes()	Start all existed DataNodes.
void	startConfigNode(int index)	Start an existed ConfigNode.
void	startDataNode(int index)	Start an existed DataNode.

Method Details

initClusterEnvironment

void initClusterEnvironment()

Init a cluster with default number of ConfigNodes and DataNodes.

initClusterEnvironment

void initClusterEnvironment(int configNodesNum,
 int dataNodesNum)

Init a cluster with the specified number of ConfigNodes and DataNodes.

Parameters:

configNodesNum - the number of ConfigNodes.

dataNodesNum - the number of DataNodes.

initClusterEnvironment

void initClusterEnvironment(int configNodesNum,
 int dataNodesNum,
 int testWorkingRetryCount)

Init a cluster with the specified number of ConfigNodes and DataNodes.

Parameters:

configNodesNum - the number of ConfigNodes.

dataNodesNum - the number of DataNodes.

testWorkingRetryCount - the retry count when testing the availability of cluster

cleanClusterEnvironment

void cleanClusterEnvironment()

Destroy the cluster and all the configurations.

getConfig

ClusterConfig getConfig()

Return the ClusterConfig for developers to set values before test.

getUrlContent

default String getUrlContent(String urlStr,
 @Nullable
 String authHeader)

getMetricPrometheusReporterContents

List<String> getMetricPrometheusReporterContents(String authHeader)

Return the content of prometheus

getConnection

default Connection getConnection()
                          throws SQLException

Throws:

SQLException

getConnection

default Connection getConnection(Constant.Version version)
                          throws SQLException

Throws:

SQLException

getConnection

Connection getConnection(Constant.Version version,
 String username,
 String password)
                  throws SQLException

Throws:

SQLException

getConnection

Connection getConnection(String username,
 String password)
                  throws SQLException

Throws:

SQLException

getConnection

Connection getConnection(DataNodeWrapper dataNodeWrapper,
 String username,
 String password)
                  throws SQLException

Throws:

SQLException

getWriteOnlyConnectionWithSpecifiedDataNode

default Connection getWriteOnlyConnectionWithSpecifiedDataNode(DataNodeWrapper dataNode)
                                                        throws SQLException

Throws:

SQLException

getWriteOnlyConnectionWithSpecifiedDataNode

Connection getWriteOnlyConnectionWithSpecifiedDataNode(DataNodeWrapper dataNode,
 String username,
 String password)
                                                throws SQLException

Throws:

SQLException

getConnectionWithSpecifiedDataNode

default Connection getConnectionWithSpecifiedDataNode(DataNodeWrapper dataNode)
                                               throws SQLException

Throws:

SQLException

getConnectionWithSpecifiedDataNode

Connection getConnectionWithSpecifiedDataNode(DataNodeWrapper dataNode,
 String username,
 String password)
                                       throws SQLException

Throws:

SQLException

setTestMethodName

void setTestMethodName(String testCaseName)

dumpTestJVMSnapshot

void dumpTestJVMSnapshot()

getNodeWrapperList

List<AbstractNodeWrapper> getNodeWrapperList()

getConfigNodeWrapperList

List<ConfigNodeWrapper> getConfigNodeWrapperList()

getDataNodeWrapperList

List<DataNodeWrapper> getDataNodeWrapperList()

getLeaderConfigNodeConnection

IConfigNodeRPCService.Iface getLeaderConfigNodeConnection()
                                                   throws ClientManagerException,
IOException,
InterruptedException

Throws:

ClientManagerException

IOException

InterruptedException

getSessionPool

ISessionPool getSessionPool(int maxSize)

getSessionConnection

ISession getSessionConnection()
                       throws IoTDBConnectionException

Throws:

IoTDBConnectionException

getSessionConnection

ISession getSessionConnection(ZoneId zoneId)
                       throws IoTDBConnectionException

Throws:

IoTDBConnectionException

getSessionConnection

ISession getSessionConnection(String userName,
 String password)
                       throws IoTDBConnectionException

Throws:

IoTDBConnectionException

getSessionConnection

ISession getSessionConnection(List<String> nodeUrls)
                       throws IoTDBConnectionException

Throws:

IoTDBConnectionException

getFirstLeaderSchemaRegionDataNodeIndex

int getFirstLeaderSchemaRegionDataNodeIndex()
                                     throws IOException,
InterruptedException

Get the index of the first dataNode with a SchemaRegion leader.

Returns:

The index of DataNode with SchemaRegion-leader in dataNodeWrapperList

Throws:

IOException

InterruptedException

getLeaderConfigNodeIndex

int getLeaderConfigNodeIndex()
                      throws IOException,
InterruptedException

Get the index of the ConfigNode leader.

Returns:

The index of ConfigNode-Leader in configNodeWrapperList

Throws:

IOException

InterruptedException

getConfigNodeConnection

default IConfigNodeRPCService.Iface getConfigNodeConnection(int index)
                                                     throws Exception

Throws:

Exception

startConfigNode

void startConfigNode(int index)

Start an existed ConfigNode.

startAllConfigNodes

void startAllConfigNodes()

Start all existed ConfigNodes.

shutdownConfigNode

void shutdownConfigNode(int index)

Shutdown an existed ConfigNode.

shutdownAllConfigNodes

void shutdownAllConfigNodes()

Shutdown all existed ConfigNodes.

shutdownForciblyAllConfigNodes

void shutdownForciblyAllConfigNodes()

ensureNodeStatus

void ensureNodeStatus(List<BaseNodeWrapper> nodes,
 List<NodeStatus> targetStatus)
               throws IllegalStateException

Ensure all the nodes being in the corresponding status.

Parameters:

nodes - the nodes list to query.

targetStatus - the target NodeStatus of each node. It should have the same length with nodes.

Throws:

IllegalStateException - if there are some nodes not in the targetStatus after a period times of check.

getConfigNodeWrapper

ConfigNodeWrapper getConfigNodeWrapper(int index)

Get the ConfigNodeWrapper of the specified index.

Returns:

The ConfigNodeWrapper of the specified index

getDataNodeWrapper

DataNodeWrapper getDataNodeWrapper(int index)

Get the DataNodeWrapper of the specified index.

Returns:

The DataNodeWrapper of the specified index

generateRandomConfigNodeWrapper

ConfigNodeWrapper generateRandomConfigNodeWrapper()

Get a ConfigNodeWrapper randomly.

Returns:

A random available ConfigNodeWrapper

generateRandomDataNodeWrapper

DataNodeWrapper generateRandomDataNodeWrapper()

Get a DataNodeWrapper randomly.

Returns:

A random available ConfigNodeWrapper

registerNewDataNode

void registerNewDataNode(boolean isNeedVerify)

Register a new DataNode with random ports.

registerNewDataNode

void registerNewDataNode(DataNodeWrapper newDataNodeWrapper,
 boolean isNeedVerify)

Register a new DataNode with specified DataNodeWrapper.

registerNewConfigNode

void registerNewConfigNode(boolean isNeedVerify)

Register a new ConfigNode with random ports.

registerNewConfigNode

void registerNewConfigNode(ConfigNodeWrapper newConfigNodeWrapper,
 boolean isNeedVerify)

Register a new DataNode with specified ConfigNodeWrapper.

startDataNode

void startDataNode(int index)

Start an existed DataNode.

startAllDataNodes

void startAllDataNodes()

Start all existed DataNodes.

shutdownDataNode

void shutdownDataNode(int index)

Shutdown an existed DataNode.

shutdownAllDataNodes

void shutdownAllDataNodes()

Shutdown all existed DataNodes.

shutdownForciblyAllDataNodes

void shutdownForciblyAllDataNodes()

Shutdown forcibly all existed DataNodes.

getMqttPort

int getMqttPort()

getIP

String getIP()

getPort

String getPort()

getSbinPath

String getSbinPath()

getToolsPath

String getToolsPath()

getLibPath

String getLibPath()

dataNodeIdToWrapper

Optional<DataNodeWrapper> dataNodeIdToWrapper(int nodeId)

registerConfigNodeKillPoints

void registerConfigNodeKillPoints(List<String> killPoints)

registerDataNodeKillPoints

void registerDataNodeKillPoints(List<String> killPoints)