Package org.apache.iotdb.it.env.cluster.env

Class AbstractEnv

java.lang.Object

org.apache.iotdb.it.env.cluster.env.AbstractEnv

All Implemented Interfaces:

BaseEnv

Direct Known Subclasses:

AIEnv, Cluster1Env, MultiClusterEnv, SimpleEnv

public abstract class AbstractEnv
extends Object
implements BaseEnv

Field Summary

Fields

Modifier and Type	Field	Description
protected List<AINodeWrapper>	aiNodeWrapperList
protected List<ConfigNodeWrapper>	configNodeWrapperList
protected List<DataNodeWrapper>	dataNodeWrapperList
protected int	index
protected int	retryCount
protected long	startTime
protected String	testMethodName

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEnv()
protected	AbstractEnv(long startTime)

Method Summary

Modifier and Type	Method	Description
void	checkClusterStatus(Predicate<Map<Integer,String>> statusCheck)	check whether all nodes' status match the provided predicate with RPC.
void	checkClusterStatusOneUnknownOtherRunning()
void	checkClusterStatusWithoutUnknown()
void	checkNodeInStatus(int nodeId, NodeStatus expectation)
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.
IConfigNodeRPCService.Iface	getConfigNodeConnection(int index)
ConfigNodeWrapper	getConfigNodeWrapper(int index)	Get the ConfigNodeWrapper of the specified index.
List<ConfigNodeWrapper>	getConfigNodeWrapperList()
Connection	getConnection(String username, String password)
Connection	getConnection(DataNodeWrapper dataNodeWrapper, String username, String password)
Connection	getConnection(Constant.Version version, String username, String password)
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()	Get connection to ConfigNode-Leader in ClusterIT environment
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()
protected List<NodeConnection>	getReadConnections(Constant.Version version, String username, String password)
protected List<NodeConnection>	getReadConnections(Constant.Version version, DataNodeWrapper dataNode, String username, String password)
String	getSbinPath()
ISession	getSessionConnection()
ISession	getSessionConnection(String userName, String password)
ISession	getSessionConnection(ZoneId zoneId)
ISession	getSessionConnection(List<String> nodeUrls)
ISessionPool	getSessionPool(int maxSize)
String	getTestClassName()
String	getTestMethodName()
String	getToolsPath()
protected NodeConnection	getWriteConnection(Constant.Version version, String username, String password)
protected NodeConnection	getWriteConnectionFromDataNodeList(List<DataNodeWrapper> dataNodeList, Constant.Version version, String username, String password)
protected NodeConnection	getWriteConnectionWithSpecifiedDataNode(DataNodeWrapper dataNode, Constant.Version version, String username, String password)
Connection	getWriteOnlyConnectionWithSpecifiedDataNode(DataNodeWrapper dataNode, String username, String password)
protected void	initEnvironment(int configNodesNum, int dataNodesNum)
protected void	initEnvironment(int configNodesNum, int dataNodesNum, int testWorkingRetryCount)
protected void	initEnvironment(int configNodesNum, int dataNodesNum, int retryCount, boolean addAINode)
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 testMethodName)
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.
protected void	testJDBCConnection()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.iotdb.itbase.env.BaseEnv

getConnection, getConnection, getConnectionWithSpecifiedDataNode, getUrlContent, getWriteOnlyConnectionWithSpecifiedDataNode, initClusterEnvironment, initClusterEnvironment, initClusterEnvironment

Field Details

configNodeWrapperList

protected List<ConfigNodeWrapper> configNodeWrapperList

dataNodeWrapperList

protected List<DataNodeWrapper> dataNodeWrapperList

aiNodeWrapperList

protected List<AINodeWrapper> aiNodeWrapperList

testMethodName

protected String testMethodName

index

protected int index

startTime

protected long startTime

retryCount

protected int retryCount

Constructor Details

AbstractEnv

protected AbstractEnv()

AbstractEnv

protected AbstractEnv(long startTime)

Method Details

getConfig

public ClusterConfig getConfig()

Description copied from interface: BaseEnv

Return the ClusterConfig for developers to set values before test.

Specified by:

getConfig in interface BaseEnv

getMetricPrometheusReporterContents

public List<String> getMetricPrometheusReporterContents(String authHeader)

Description copied from interface: BaseEnv

Return the content of prometheus

Specified by:

getMetricPrometheusReporterContents in interface BaseEnv

initEnvironment

protected void initEnvironment(int configNodesNum,
 int dataNodesNum)

initEnvironment

protected void initEnvironment(int configNodesNum,
 int dataNodesNum,
 int testWorkingRetryCount)

initEnvironment

protected void initEnvironment(int configNodesNum,
 int dataNodesNum,
 int retryCount,
 boolean addAINode)

getTestClassName

public String getTestClassName()

checkNodeInStatus

public void checkNodeInStatus(int nodeId,
 NodeStatus expectation)

checkClusterStatusWithoutUnknown

public void checkClusterStatusWithoutUnknown()

checkClusterStatusOneUnknownOtherRunning

public void checkClusterStatusOneUnknownOtherRunning()

checkClusterStatus

public void checkClusterStatus(Predicate<Map<Integer,String>> statusCheck)

check whether all nodes' status match the provided predicate with RPC. after retryCount times, if the status of all nodes still not match the predicate, throw AssertionError.

Parameters:

statusCheck - the predicate to test the status of nodes

cleanClusterEnvironment

public void cleanClusterEnvironment()

Description copied from interface: BaseEnv

Destroy the cluster and all the configurations.

Specified by:

cleanClusterEnvironment in interface BaseEnv

getConnection

public Connection getConnection(String username,
 String password)
                         throws SQLException

Specified by:

getConnection in interface BaseEnv

Throws:

SQLException

getConnection

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

Specified by:

getConnection in interface BaseEnv

Throws:

SQLException

getWriteOnlyConnectionWithSpecifiedDataNode

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

Specified by:

getWriteOnlyConnectionWithSpecifiedDataNode in interface BaseEnv

Throws:

SQLException

getConnectionWithSpecifiedDataNode

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

Specified by:

getConnectionWithSpecifiedDataNode in interface BaseEnv

Throws:

SQLException

getConnection

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

Specified by:

getConnection in interface BaseEnv

Throws:

SQLException

getSessionConnection

public ISession getSessionConnection()
                              throws IoTDBConnectionException

Specified by:

getSessionConnection in interface BaseEnv

Throws:

IoTDBConnectionException

getSessionConnection

public ISession getSessionConnection(ZoneId zoneId)
                              throws IoTDBConnectionException

Specified by:

getSessionConnection in interface BaseEnv

Throws:

IoTDBConnectionException

getSessionConnection

public ISession getSessionConnection(String userName,
 String password)
                              throws IoTDBConnectionException

Specified by:

getSessionConnection in interface BaseEnv

Throws:

IoTDBConnectionException

getSessionConnection

public ISession getSessionConnection(List<String> nodeUrls)
                              throws IoTDBConnectionException

Specified by:

getSessionConnection in interface BaseEnv

Throws:

IoTDBConnectionException

getSessionPool

public ISessionPool getSessionPool(int maxSize)

Specified by:

getSessionPool in interface BaseEnv

getWriteConnection

protected NodeConnection getWriteConnection(Constant.Version version,
 String username,
 String password)
                                     throws SQLException

Throws:

SQLException

getWriteConnectionWithSpecifiedDataNode

protected NodeConnection getWriteConnectionWithSpecifiedDataNode(DataNodeWrapper dataNode,
 Constant.Version version,
 String username,
 String password)
                                                          throws SQLException

Throws:

SQLException

getWriteConnectionFromDataNodeList

protected NodeConnection getWriteConnectionFromDataNodeList(List<DataNodeWrapper> dataNodeList,
 Constant.Version version,
 String username,
 String password)
                                                     throws SQLException

Throws:

SQLException

getReadConnections

protected List<NodeConnection> getReadConnections(Constant.Version version,
 String username,
 String password)
                                           throws SQLException

Throws:

SQLException

getReadConnections

protected List<NodeConnection> getReadConnections(Constant.Version version,
 DataNodeWrapper dataNode,
 String username,
 String password)
                                           throws SQLException

Throws:

SQLException

testJDBCConnection

protected void testJDBCConnection()

getTestMethodName

public String getTestMethodName()

setTestMethodName

public void setTestMethodName(String testMethodName)

Specified by:

setTestMethodName in interface BaseEnv

dumpTestJVMSnapshot

public void dumpTestJVMSnapshot()

Specified by:

dumpTestJVMSnapshot in interface BaseEnv

getNodeWrapperList

public List<AbstractNodeWrapper> getNodeWrapperList()

Specified by:

getNodeWrapperList in interface BaseEnv

getConfigNodeWrapperList

public List<ConfigNodeWrapper> getConfigNodeWrapperList()

Specified by:

getConfigNodeWrapperList in interface BaseEnv

getDataNodeWrapperList

public List<DataNodeWrapper> getDataNodeWrapperList()

Specified by:

getDataNodeWrapperList in interface BaseEnv

getLeaderConfigNodeConnection

public IConfigNodeRPCService.Iface getLeaderConfigNodeConnection()
                                                          throws IOException,
InterruptedException

Get connection to ConfigNode-Leader in ClusterIT environment

Notice: The caller should always use try-with-resource to invoke this interface in order to return client to ClientPool automatically

Specified by:

getLeaderConfigNodeConnection in interface BaseEnv

Returns:

SyncConfigNodeIServiceClient that connects to the ConfigNode-Leader

Throws:

IOException

InterruptedException

getConfigNodeConnection

public IConfigNodeRPCService.Iface getConfigNodeConnection(int index)
                                                    throws Exception

Specified by:

getConfigNodeConnection in interface BaseEnv

Throws:

Exception

getFirstLeaderSchemaRegionDataNodeIndex

public int getFirstLeaderSchemaRegionDataNodeIndex()
                                            throws IOException,
InterruptedException

Description copied from interface: BaseEnv

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

Specified by:

getFirstLeaderSchemaRegionDataNodeIndex in interface BaseEnv

Returns:

The index of DataNode with SchemaRegion-leader in dataNodeWrapperList

Throws:

IOException

InterruptedException

getLeaderConfigNodeIndex

public int getLeaderConfigNodeIndex()
                             throws IOException,
InterruptedException

Description copied from interface: BaseEnv

Get the index of the ConfigNode leader.

Specified by:

getLeaderConfigNodeIndex in interface BaseEnv

Returns:

The index of ConfigNode-Leader in configNodeWrapperList

Throws:

IOException

InterruptedException

startConfigNode

public void startConfigNode(int index)

Description copied from interface: BaseEnv

Start an existed ConfigNode.

Specified by:

startConfigNode in interface BaseEnv

startAllConfigNodes

public void startAllConfigNodes()

Description copied from interface: BaseEnv

Start all existed ConfigNodes.

Specified by:

startAllConfigNodes in interface BaseEnv

shutdownConfigNode

public void shutdownConfigNode(int index)

Description copied from interface: BaseEnv

Shutdown an existed ConfigNode.

Specified by:

shutdownConfigNode in interface BaseEnv

shutdownAllConfigNodes

public void shutdownAllConfigNodes()

Description copied from interface: BaseEnv

Shutdown all existed ConfigNodes.

Specified by:

shutdownAllConfigNodes in interface BaseEnv

shutdownForciblyAllConfigNodes

public void shutdownForciblyAllConfigNodes()

Specified by:

shutdownForciblyAllConfigNodes in interface BaseEnv

getConfigNodeWrapper

public ConfigNodeWrapper getConfigNodeWrapper(int index)

Description copied from interface: BaseEnv

Get the ConfigNodeWrapper of the specified index.

Specified by:

getConfigNodeWrapper in interface BaseEnv

Returns:

The ConfigNodeWrapper of the specified index

getDataNodeWrapper

public DataNodeWrapper getDataNodeWrapper(int index)

Description copied from interface: BaseEnv

Get the DataNodeWrapper of the specified index.

Specified by:

getDataNodeWrapper in interface BaseEnv

Returns:

The DataNodeWrapper of the specified index

generateRandomConfigNodeWrapper

public ConfigNodeWrapper generateRandomConfigNodeWrapper()

Description copied from interface: BaseEnv

Get a ConfigNodeWrapper randomly.

Specified by:

generateRandomConfigNodeWrapper in interface BaseEnv

Returns:

A random available ConfigNodeWrapper

generateRandomDataNodeWrapper

public DataNodeWrapper generateRandomDataNodeWrapper()

Description copied from interface: BaseEnv

Get a DataNodeWrapper randomly.

Specified by:

generateRandomDataNodeWrapper in interface BaseEnv

Returns:

A random available ConfigNodeWrapper

registerNewDataNode

public void registerNewDataNode(boolean isNeedVerify)

Description copied from interface: BaseEnv

Register a new DataNode with random ports.

Specified by:

registerNewDataNode in interface BaseEnv

registerNewConfigNode

public void registerNewConfigNode(boolean isNeedVerify)

Description copied from interface: BaseEnv

Register a new ConfigNode with random ports.

Specified by:

registerNewConfigNode in interface BaseEnv

registerNewConfigNode

public void registerNewConfigNode(ConfigNodeWrapper newConfigNodeWrapper,
 boolean isNeedVerify)

Description copied from interface: BaseEnv

Register a new DataNode with specified ConfigNodeWrapper.

Specified by:

registerNewConfigNode in interface BaseEnv

registerNewDataNode

public void registerNewDataNode(DataNodeWrapper newDataNodeWrapper,
 boolean isNeedVerify)

Description copied from interface: BaseEnv

Register a new DataNode with specified DataNodeWrapper.

Specified by:

registerNewDataNode in interface BaseEnv

startDataNode

public void startDataNode(int index)

Description copied from interface: BaseEnv

Start an existed DataNode.

Specified by:

startDataNode in interface BaseEnv

startAllDataNodes

public void startAllDataNodes()

Description copied from interface: BaseEnv

Start all existed DataNodes.

Specified by:

startAllDataNodes in interface BaseEnv

shutdownDataNode

public void shutdownDataNode(int index)

Description copied from interface: BaseEnv

Shutdown an existed DataNode.

Specified by:

shutdownDataNode in interface BaseEnv

shutdownAllDataNodes

public void shutdownAllDataNodes()

Description copied from interface: BaseEnv

Shutdown all existed DataNodes.

Specified by:

shutdownAllDataNodes in interface BaseEnv

shutdownForciblyAllDataNodes

public void shutdownForciblyAllDataNodes()

Description copied from interface: BaseEnv

Shutdown forcibly all existed DataNodes.

Specified by:

shutdownForciblyAllDataNodes in interface BaseEnv

ensureNodeStatus

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

Description copied from interface: BaseEnv

Ensure all the nodes being in the corresponding status.

Specified by:

ensureNodeStatus in interface BaseEnv

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.

getMqttPort

public int getMqttPort()

Specified by:

getMqttPort in interface BaseEnv

getIP

public String getIP()

Specified by:

getIP in interface BaseEnv

getPort

public String getPort()

Specified by:

getPort in interface BaseEnv

getSbinPath

public String getSbinPath()

Specified by:

getSbinPath in interface BaseEnv

getToolsPath

public String getToolsPath()

Specified by:

getToolsPath in interface BaseEnv

getLibPath

public String getLibPath()

Specified by:

getLibPath in interface BaseEnv

dataNodeIdToWrapper

public Optional<DataNodeWrapper> dataNodeIdToWrapper(int nodeId)

Specified by:

dataNodeIdToWrapper in interface BaseEnv

registerConfigNodeKillPoints

public void registerConfigNodeKillPoints(List<String> killPoints)

Specified by:

registerConfigNodeKillPoints in interface BaseEnv

registerDataNodeKillPoints

public void registerDataNodeKillPoints(List<String> killPoints)

Specified by:

registerDataNodeKillPoints in interface BaseEnv