TestGridUtil (WSO2 TestGrid Project - Common POM 1.0.4 API)

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()

Constructors
Constructor and Description
`TestGridUtil()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static String`	`convertToJsonString(Properties properties)` transform the properties object into a json string.
`static String`	`deriveLogDownloadLocation(TestPlan testPlan)` Returns the path of the directory where log files will be downloaded.
`static String`	`deriveScenarioArtifactPath(TestScenario testScenario, String fileName)` Derives the relative path of a scenario-artifact.
`static String`	`deriveTestGridLogFilePath(String productName, String logFileName)` Returns the path of the log file.
`static String`	`deriveTestPlanDirName(TestPlan testPlan)` Deprecated.
`static String`	`deriveTestPlanId(TestPlan testPlan, InfrastructureCombination infraCombination, DeploymentPattern deploymentPattern)` Returns the test-plan id based on the test-plan and the properties relevant to it.
`static String`	`deriveTestRunLogFilePath(TestPlan testPlan, Boolean truncated)` Returns the path of the test-run log file.
`static int`	`fibonacci(int index)` Returns the number in fibonacci series for a given position.
`static Path`	`getConfigFilePath()` Returns the path of config.properties.
`static String`	`getDashboardURLFor(String productName)` Generate the Dashboard URL for the given product/job name.
`static String`	`getDashboardURLFor(TestPlan testPlan)` Generate the Dashboard URL for the given test plan
`static String`	`getDeploymentPatternName(TestPlan testPlan)` Return the deployment pattern name under the DeploymentConfig of a `TestPlan`.
`static String`	`getHashValue(Path filePath)` Returns the MD5 hash value of a given file.
`static List<InfrastructureParameter>`	`getInfraParamsOfTestPlan(Set<InfrastructureValueSet> valueSets, TestPlan testPlan)` Read the infra params from the infrastructure_parameter db table, and return the list of infra params used in the given test plan.
`static String`	`getParameterString(String fileInput, Properties properties)` Deprecated. Parameter parsing should only happen via the databuckets
`static Path`	`getSurefireReportsDir(TestPlan testPlan)` Returns the absolute path of the integration test log file.
`static String`	`getTestGridHomePath()` Returns the path of the test grid home.
`static Path`	`getTestPlanRequestDirectory()` Returns the directory location where the test-plan requests are stored.
`static Path`	`getTestScenarioArtifactPath(TestScenario testScenario)`
`static boolean`	`isDebugMode(TestPlan testPlan)` Checks whether debug mode is enabled for this test plan or not.
`static TestPlan`	`mergeTestPlans(TestPlan testPlanConfig, TestPlan testPlanPersisted, boolean addToConfigYaml)` Copies non existing properties from a persisted test plan to a test plan object generated from the config.
`static List<InfrastructureParameter>`	`parseInfraParameters(Set<InfrastructureValueSet> valueSets, String infraParameters)` Parse infrastructure parameters to its display values.
`static Map<String,String>`	`parseInfraParametersString(String infraParams)` Parse the infra param string of `TestPlan.getInfraParameters()` into a map of key-value pairs.
`static TestPlan`	`toTestPlanEntity(DeploymentPattern deploymentPattern, TestPlan testPlan)` This method generates TestPlan object model that from the given input parameters.
`static TestPlan`	`updateFinalTestPlanPhase(TestPlan testPlan)`

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
  - getTestGridHomePath
```
public static String getTestGridHomePath()
```
    Returns the path of the test grid home.
    
    Returns:
    
    test grid home path
  - getTestPlanRequestDirectory
```
public static Path getTestPlanRequestDirectory()
                                        throws IOException
```
    Returns the directory location where the test-plan requests are stored.
    
    Returns:
    
    path of the test plan requests directory
    
    Throws:
    
    IOException - thrown when error on calculating test plan artifacts directory
  - parseInfraParametersString
```
public static Map<String,String> parseInfraParametersString(String infraParams)
```
    Parse the infra param string of TestPlan.getInfraParameters() into a map of key-value pairs.
    
    Parameters:
    
    infraParams - the TestPlan.getInfraParameters()
    
    Returns:
    
    Map of key-value pair where key == infra type, and value == infra value.
  - convertToJsonString
```
public static String convertToJsonString(Properties properties)
```
    transform the properties object into a json string.
  - getParameterString
```
public static String getParameterString(String fileInput,
                                        Properties properties)
```
    Deprecated. Parameter parsing should only happen via the databuckets
    
    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
  - mergeTestPlans
```
public static TestPlan mergeTestPlans(TestPlan testPlanConfig,
                                      TestPlan testPlanPersisted,
                                      boolean addToConfigYaml)
```
    Copies non existing properties from a persisted test plan to a test plan object generated from the config.
    
    Parameters:
    
    testPlanConfig - an instance of test plan which is generated from the config
    
    testPlanPersisted - an instance of test plan which is persisted in the db
    
    Returns:
    
    an instance of TestPlan with merged properties
  - 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.
  - getConfigFilePath
```
public static Path getConfigFilePath()
```
    Returns the path of config.properties.
    
    Returns:
    
    path of /config.properties
  - deriveTestGridLogFilePath
```
public static String deriveTestGridLogFilePath(String productName,
                                               String logFileName)
```
    Returns the path of the log file.
    
    Parameters:
    
    productName - product name
    
    Returns:
    
    log file path
  - deriveScenarioArtifactPath
```
public static String deriveScenarioArtifactPath(TestScenario testScenario,
                                                String fileName)
```
    Derives the relative path of a scenario-artifact.
    TESTGRID_HOME/jobs/#name#/builds/#depl_name#_#infra-uuid#_#test-run-num#/#scenario_dir#/#file_name#
    
    Parameters:
    
    testScenario - test-scenario of the artifact
    
    fileName - name of the artifact
    
    Returns:
    
    relative path of the artifact
  - getTestScenarioArtifactPath
```
public static Path getTestScenarioArtifactPath(TestScenario testScenario)
```
  - deriveTestRunLogFilePath
```
public static String deriveTestRunLogFilePath(TestPlan testPlan,
                                              Boolean truncated)
```
    Returns the path of the test-run log file.
    /test-run.log
    
    Parameters:
    
    testPlan - test-plan
    
    truncated - whether the truncated log or the raw log file
    
    Returns:
    
    log file path
  - getSurefireReportsDir
```
public static Path getSurefireReportsDir(TestPlan testPlan)
```
    Returns the absolute path of the integration test log file. This returns the ${data-bucket}/surefire-reports dir. The data-bucket dir is calculated via @DataBucketsHelper.getOutputLocation(TestPlan).
    
    Parameters:
    
    testPlan - test-plan
    
    Returns:
    
    surefire-reports dir location
  - deriveLogDownloadLocation
```
public static String deriveLogDownloadLocation(TestPlan testPlan)
```
    Returns the path of the directory where log files will be downloaded.
    
    Parameters:
    
    testPlan - TestPlan object
    
    Returns:
    
    File download location path
  - deriveTestPlanId
```
public static String deriveTestPlanId(TestPlan testPlan,
                                      InfrastructureCombination infraCombination,
                                      DeploymentPattern deploymentPattern)
```
    Returns the test-plan id based on the test-plan and the properties relevant to it. The format of the test-plan is: ___ eg: 15th test-plan of the product 'product-abc' for deployment-pattern 'integration-tests', for infra-combination {ORACLE_JDK8, mysql 5.7, CentOS 7.4} will be; product-abc_integration-tests_ORACLE_JDK8-mysql-5-7-CentOS-7-4_run15
    
    Parameters:
    
    testPlan - test-plan
    
    infraCombination - infrastructure combination of the test-plan
    
    deploymentPattern - deployment-pattern of the test-plan
    
    Returns:
    
    test-plan directory name.
  - deriveTestPlanDirName
```
@Deprecated
public static String deriveTestPlanDirName(TestPlan testPlan)
```
    Deprecated.
    
    Returns the test-plan directory name based on the test-plan content.
    
    Parameters:
    
    testPlan - test-plan
    
    Returns:
    
    test-plan directory name.
  - isDebugMode
```
public static boolean isDebugMode(TestPlan testPlan)
```
    Checks whether debug mode is enabled for this test plan or not. Debug mode can be enabled by adding a property "DEBUG_MODE: true" to job-config.yaml.
    
    Parameters:
    
    testPlan - the test plan
    
    Returns:
    
    true if DEBUG_MODE property is set, and its value is true in job-config.xml
  - getDashboardURLFor
```
public static String getDashboardURLFor(String productName)
```
    Generate the Dashboard URL for the given product/job name. Ex. https://testgrid-live.private.wso2.com/wso2am-intg
    
    Parameters:
    
    productName - the job name
    
    Returns:
    
    the dashboard url of the given job
  - getDashboardURLFor
```
public static String getDashboardURLFor(TestPlan testPlan)
```
    Generate the Dashboard URL for the given test plan
    
    Parameters:
    
    testPlan - test plan
    
    Returns:
    
    the dashboard url of the given testplan
  - getInfraParamsOfTestPlan
```
public static List<InfrastructureParameter> getInfraParamsOfTestPlan(Set<InfrastructureValueSet> valueSets,
                                                                     TestPlan testPlan)
```
    Read the infra params from the infrastructure_parameter db table, and return the list of infra params used in the given test plan.
    
    Parameters:
    
    valueSets - infrastructure parameters value set
    
    testPlan - test plan to get infrastructure parameters
    
    Returns:
    
    a list of InfrastructureParameter
  - parseInfraParameters
```
public static List<InfrastructureParameter> parseInfraParameters(Set<InfrastructureValueSet> valueSets,
                                                                 String infraParameters)
```
    Parse infrastructure parameters to its display values. Returns the value of corresponding value in NAME column of infrastructure_parameter table.
    
    Parameters:
    
    valueSets - infrastructure parameter value set
    
    infraParameters - inra parameter string to parse
    
    Returns:
    
    a list of printable infra parameters
  - getHashValue
```
public static String getHashValue(Path filePath)
                           throws IOException,
                                  NoSuchAlgorithmException
```
    Returns the MD5 hash value of a given file.
    
    Parameters:
    
    filePath - path to file
    
    Returns:
    
    md5 hash String
    
    Throws:
    
    IOException - if file reading fails
    
    NoSuchAlgorithmException - if hash generation fails
  - fibonacci
```
public static int fibonacci(int index)
```
    Returns the number in fibonacci series for a given position.
    
    Parameters:
    
    index - position to get the number from fibinacci series
    
    Returns:
    
    the number pertaining to the position
  - updateFinalTestPlanPhase
```
public static TestPlan updateFinalTestPlanPhase(TestPlan testPlan)
```

Class TestGridUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TestGridUtil

Method Detail

getTestGridHomePath

getTestPlanRequestDirectory

parseInfraParametersString

convertToJsonString

getParameterString

toTestPlanEntity

mergeTestPlans

getDeploymentPatternName

getConfigFilePath

deriveTestGridLogFilePath

deriveScenarioArtifactPath

getTestScenarioArtifactPath

deriveTestRunLogFilePath

getSurefireReportsDir

deriveLogDownloadLocation

deriveTestPlanId

deriveTestPlanDirName

isDebugMode

getDashboardURLFor

getDashboardURLFor

getInfraParamsOfTestPlan

parseInfraParameters

getHashValue

fibonacci

updateFinalTestPlanPhase