org.wso2.testgrid.common.config

Class JobConfigFile

java.lang.Object

org.wso2.testgrid.common.config.JobConfigFile

public class JobConfigFile
extends Object

Describes the job configuration of a given product.

This is a flat, yaml configuration that lists all the repositories and other inputs such as the location of credentials.properties.

Constructor Summary

Constructors

Constructor and Description
JobConfigFile()

Method Summary

Modifier and Type	Method and Description
String	getConfigChangeSetBranchName() Get config change set repository branch name
String	getConfigChangeSetRepository() Get config change set repository
String	getDeploymentRepository()
String	getInfrastructureRepository()
String	getJobName()
String	getKeyFileLocation()
Properties	getProperties() Get a list of dynamic properties added to the job-config.yaml.
String	getScenarioTestsRepository()
String	getTestgridYamlLocation() The recommended way to load the testgrid.yaml config is via the testgrid.yaml file located inside testgrid-compatible repositories.
String	getWorkingDir() The relative paths mentioned in the JobConfigFile are resolved wrt to the working directory.
boolean	isRelativePaths() Default is set to true.
void	setConfigChangeSetBranchName(String configChangeSetBranchName) Set config change set repository branch name
void	setConfigChangeSetRepository(String configChangeSetRepository) Set config change set repository
void	setDeploymentRepository(String deploymentRepository)
void	setInfrastructureRepository(String infrastructureRepository)
void	setJobName(String jobName)
void	setKeyFileLocation(String keyFileLocation)
void	setProperties(Properties properties)
void	setRelativePaths(boolean relativePaths) Set whether the paths in the @JobConfigFile need to be resolved as relative paths or not.
void	setScenarioTestsRepository(String scenarioTestsRepository)
void	setTestgridYamlLocation(String testgridYamlLocation)
void	setWorkingDir(String workingDir)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JobConfigFile

public JobConfigFile()

Method Detail

getInfrastructureRepository

public String getInfrastructureRepository()

setInfrastructureRepository

public void setInfrastructureRepository(String infrastructureRepository)

getDeploymentRepository

public String getDeploymentRepository()

setDeploymentRepository

public void setDeploymentRepository(String deploymentRepository)

getScenarioTestsRepository

public String getScenarioTestsRepository()

setScenarioTestsRepository

public void setScenarioTestsRepository(String scenarioTestsRepository)

getConfigChangeSetRepository

public String getConfigChangeSetRepository()

Get config change set repository

Returns:

the config change set repository

setConfigChangeSetRepository

public void setConfigChangeSetRepository(String configChangeSetRepository)

Set config change set repository

Parameters:

configChangeSetRepository - the config chage set repository

getConfigChangeSetBranchName

public String getConfigChangeSetBranchName()

Get config change set repository branch name

Returns:

setConfigChangeSetBranchName

public void setConfigChangeSetBranchName(String configChangeSetBranchName)

Set config change set repository branch name

Parameters:

configChangeSetBranchName -

getTestgridYamlLocation

public String getTestgridYamlLocation()

The recommended way to load the testgrid.yaml config is via the testgrid.yaml file located inside testgrid-compatible repositories.

But, sometimes we need a way to execute testgrid even if the testgrid.yaml is not present in there in a given repository. In that case, we should be able to receive a testgrid.yaml from an external location.

Returns:

the location of the testgrid.yaml provided from an external location.

setTestgridYamlLocation

public void setTestgridYamlLocation(String testgridYamlLocation)

isRelativePaths

public boolean isRelativePaths()

Default is set to true. Default, along with getWorkingDir() set is good enough for most of the scenarios. Users are expected to pass the working-dir as a cmd-line argument rather than hard-coding it inside the job-config.yaml

Returns:

whether the dir paths mentioned in job-config.yaml are relative paths.

setRelativePaths

public void setRelativePaths(boolean relativePaths)

Set whether the paths in the @JobConfigFile need to be resolved as relative paths or not.

Parameters:

relativePaths - enable/disable the relative path based processing.

See Also:

isRelativePaths()

getWorkingDir

public String getWorkingDir()

The relative paths mentioned in the JobConfigFile are resolved wrt to the working directory.

It is optional to set this property. If not set, the paths are resolved from the location of the --file input of GenerateTestPlanCommand.

In the Jenkins context, this should be resolved to the workspace of the particular jenkins job's build.

In future, this location will be changed to the workspace of the given test-run inside the TESTGRID_HOME.

Returns:

the working directory

setWorkingDir

public void setWorkingDir(String workingDir)

getKeyFileLocation

public String getKeyFileLocation()

setKeyFileLocation

public void setKeyFileLocation(String keyFileLocation)

getProperties

public Properties getProperties()

Get a list of dynamic properties added to the job-config.yaml. An example include the product dist download location.

Returns:

list of properties

setProperties

public void setProperties(Properties properties)

Parameters:

properties - properties to set.

See Also:

getProperties()

toString

public String toString()

Overrides:

toString in class Object

getJobName

public String getJobName()

setJobName

public void setJobName(String jobName)