org.wso2.appserver.integration.common.utils

Class CarbonCommandToolsUtil

java.lang.Object

org.wso2.appserver.integration.common.utils.CarbonCommandToolsUtil

public class CarbonCommandToolsUtil
extends Object

This class has the method which using by carbon tools test cases

Constructor Summary

Constructors

Constructor and Description
CarbonCommandToolsUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static String	getCurrentOperatingSystem() This method is to get operating system
static DataSourceBean	getDataSourceInformation(String dataSourceName) Get the data source information from the automation configuration file
static boolean	isScriptRunSuccessfully(String directory, String[] cmdArray, String expectedString) This method is to execute commands and reading the logs to find the expected string.
static boolean	isServerDown(int portOffset) This method is to check whether server is down or not
static boolean	isServerStartedUp(org.wso2.carbon.automation.engine.context.AutomationContext automationContext, int portOffset) This method to check whether server is up or not This method wait for some time to check login status by checking the port and login This will throw an exception if port is not open or couldn't login
static boolean	searchOnLogs(String backEndUrl, String[] searchStringArray, String cookie) This method to find multiple strings in same line in log
static void	serverShutdown(int portOffset, org.wso2.carbon.automation.engine.context.AutomationContext automationContext) This method is to shutdown a server
static Process	startServerUsingCarbonHome(String carbonHome, int portOffset, org.wso2.carbon.automation.engine.context.AutomationContext automationContext, String[] parameters) This method is for start a as server

Methods inherited from class java.lang.Object

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

Constructor Detail

CarbonCommandToolsUtil

public CarbonCommandToolsUtil()

Method Detail

startServerUsingCarbonHome

public static Process startServerUsingCarbonHome(String carbonHome,
                                 int portOffset,
                                 org.wso2.carbon.automation.engine.context.AutomationContext automationContext,
                                 String[] parameters)
                                          throws Exception

This method is for start a as server

Parameters:

carbonHome - - carbon home

portOffset - - port offset

automationContext - - AutomationContext

parameters - - server startup arguments as an string array

Returns:

Process of the startup execution

Throws:

Exception - - Error occurred when starting the the server

serverShutdown

public static void serverShutdown(int portOffset,
                  org.wso2.carbon.automation.engine.context.AutomationContext automationContext)
                           throws CarbonToolsIntegrationTestException

This method is to shutdown a server

Parameters:

portOffset - - port offset

automationContext - - AutomationContext

Throws:

CarbonToolsIntegrationTestException - - Error when trying to shutdown the server

isServerDown

public static boolean isServerDown(int portOffset)

This method is to check whether server is down or not

Parameters:

portOffset - - port offset

Returns:

boolean - if server is down true : else false

getCurrentOperatingSystem

public static String getCurrentOperatingSystem()

This method is to get operating system

Returns:

if current os is windows return true : else false

isScriptRunSuccessfully

public static boolean isScriptRunSuccessfully(String directory,
                              String[] cmdArray,
                              String expectedString)
                                       throws CarbonToolsIntegrationTestException

This method is to execute commands and reading the logs to find the expected string.

Parameters:

directory - - Directory which has the file to be executed .

cmdArray - - Command array to be executed.

expectedString - - Expected string in the log.

Returns:

boolean - true : Found the expected string , false : not found the expected string.

Throws:

CarbonToolsIntegrationTestException - - Error while running the command.

searchOnLogs

public static boolean searchOnLogs(String backEndUrl,
                   String[] searchStringArray,
                   String cookie)
                            throws CarbonToolsIntegrationTestException

This method to find multiple strings in same line in log

Parameters:

backEndUrl - - server back end url

searchStringArray - - String array to be find in the log

cookie - - cookie

Returns:

- if found all the string in one line: true else false

Throws:

CarbonToolsIntegrationTestException - - Error when getting the logs and search the string

isServerStartedUp

public static boolean isServerStartedUp(org.wso2.carbon.automation.engine.context.AutomationContext automationContext,
                        int portOffset)
                                 throws Exception

This method to check whether server is up or not This method wait for some time to check login status by checking the port and login This will throw an exception if port is not open or couldn't login

Parameters:

automationContext - - AutomationContext

Returns:

true: If server is up else false

Throws:

Exception - - Error while waiting for login

getDataSourceInformation

public static DataSourceBean getDataSourceInformation(String dataSourceName)
                                               throws XPathExpressionException

Get the data source information from the automation configuration file

Parameters:

dataSourceName - - Data source name given in the configuration file

Returns:

DataSourceInformation - Information about the data source.

Throws:

XPathExpressionException - - Throws if an exception occurred when getting data for configuration file