org.wso2.testgrid.common.util

Class TestGridUtil

java.lang.Object

org.wso2.testgrid.common.util.TestGridUtil

public final class TestGridUtil
extends Object

This Util class holds the common utility methods.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
TestGridUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	executeCommand(String command, File workingDirectory) Executes a command.
static String	executeCommand(String command, File workingDirectory, DeploymentCreationResult deploymentCreationResult) Executes a command.
static String	getDeploymentPatternName(TestPlan testPlan) Return the deployment pattern name under the DeploymentConfig of a TestPlan.
static String	getParameterString(String fileInput, Properties properties) This method builds and returns the parameter string from given properties.
static String	getTestGridHomePath() Returns the path of the test grid home.
static Path	getTestPlanDirectory() Returns the directory location where the test-plans are stored.
static Path	getTestRunArtifactsDirectory(TestPlan testPlan) Returns the directory location where the test run artifacts resides.
static TestPlan	toTestPlanEntity(DeploymentPattern deploymentPattern, TestPlan testPlan) This method generates TestPlan object model that from the given input parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestGridUtil

public TestGridUtil()

Method Detail

executeCommand

public static boolean executeCommand(String command,
                                     File workingDirectory)
                              throws CommandExecutionException

Executes a command. Used for creating the infrastructure and deployment.

Parameters:

command - Command to execute

Returns:

boolean for successful/unsuccessful command execution

Throws:

CommandExecutionException

executeCommand

public static String executeCommand(String command,
                                    File workingDirectory,
                                    DeploymentCreationResult deploymentCreationResult)
                             throws CommandExecutionException

Executes a command. Used to execute a script with given deployment details as environment variables.

Parameters:

command - Command to execute.

workingDirectory - Directory the command is executed.

deploymentCreationResult - Deployment creation output.

Returns:

The output of script execution as a String.

Throws:

CommandExecutionException - When there is an error executing the command.

getTestGridHomePath

public static String getTestGridHomePath()
                                  throws IOException

Returns the path of the test grid home.

Returns:

test grid home path

Throws:

IOException

getTestPlanDirectory

public static Path getTestPlanDirectory()
                                 throws IOException

Returns the directory location where the test-plans are stored.

Returns:

path of the test plans directory

Throws:

IOException - thrown when error on calculating test plan artifacts directory

getTestRunArtifactsDirectory

public static Path getTestRunArtifactsDirectory(TestPlan testPlan)
                                         throws TestGridException

Returns the directory location where the test run artifacts resides.

Parameters:

testPlan - test plan for getting the test run artifacts location

Returns:

path of the test run artifacts

Throws:

TestGridException - thrown when error on calculating test run artifacts directory

getParameterString

public static String getParameterString(String fileInput,
                                        Properties properties)

This method builds and returns the parameter string from given properties.

Parameters:

properties - Properties with required paramters as key value pairs

Returns:

the String representation of input paramters

toTestPlanEntity

public static TestPlan toTestPlanEntity(DeploymentPattern deploymentPattern,
                                        TestPlan testPlan)
                                 throws CommandExecutionException

This method generates TestPlan object model that from the given input parameters.

Parameters:

deploymentPattern - deployment pattern

testPlan - testPlan object

Returns:

TestPlan object model

Throws:

CommandExecutionException

getDeploymentPatternName

public static String getDeploymentPatternName(TestPlan testPlan)

Return the deployment pattern name under the DeploymentConfig of a TestPlan. If not found, return the provisioner name under Infrastructure.

Parameters:

testPlan - the test-plan config

Returns:

the deployment pattern name.