TestPlan (WSO2 TestGrid Project - Common POM 1.0.3 API)

java.lang.Object
- org.wso2.testgrid.common.AbstractUUIDEntity
- - org.wso2.testgrid.common.TestPlan

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

TestgridYaml
```
@Entity
public class TestPlan
extends AbstractUUIDEntity
implements Serializable, Cloneable
```
Defines a model object of TestPlan with required attributes.

Since:

1.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TestPlan.DeployerType
This defines the supported deployment automation tools.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TestPlan.DeployerType` This defines the supported deployment automation tools.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEPLOYMENT_PATTERN_COLUMN`
`static String`	`STATUS_COLUMN` Column names of the table.
`static String`	`TEST_PLAN_TABLE` TestPlan table name.
`static String`	`TESTRUN_NUMBER_COLUMN`

Fields inherited from class org.wso2.testgrid.common.AbstractUUIDEntity
ID_COLUMN

Constructor Summary

Constructors
Constructor and Description

TestPlan()

Constructors
Constructor and Description
`TestPlan()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TestPlan`	`clone()`
`String`	`getBuildURL()`
`String`	`getConfigChangeSetBranchName()` Get config change set repository branch name
`String`	`getConfigChangeSetRepository()` Return the path of config change set artifacts.
`TestPlan.DeployerType`	`getDeployerType()` Returns the deployer-type (puppet/ansible) of the test plan.
`DeploymentConfig`	`getDeploymentConfig()` Returns the deployment configuration in the test-plan.
`DeploymentCreationResult`	`getDeploymentCreationResult()`
`DeploymentPattern`	`getDeploymentPattern()` Returns the deployment pattern associated with.
`String`	`getDeploymentRepository()` Returns the path of the deployment repository.
`String`	`getEmailToList()`
`String`	`getInfraParameters()` Returns the infra parameters.
`InfrastructureConfig`	`getInfrastructureConfig()`
`Properties`	`getInfrastructureProperties()`
`InfrastructureProvisionResult`	`getInfrastructureProvisionResult()`
`String`	`getInfrastructureRepository()` Returns the path of the test plans' infrastructure artifacts.
`String`	`getJobName()`
`Properties`	`getJobProperties()` Get the list of build properties associated with this test plan.
`String`	`getKeyFileLocation()` Get the location of the key file used to access the instances.
`String`	`getLogUrl()` Returns the URL to view WSO2 server logs.
`TestPlanPhase`	`getPhase()` Returns the phase of the test-plan
`ResultFormat`	`getResultFormat()` Returns the ResultFormatter object fot the specific TestPlan
`List<ScenarioConfig>`	`getScenarioConfigs()`
`String`	`getScenarioTestsRepository()` Returns the path of the test plans' test artifacts.
`TestPlanStatus`	`getStatus()` Returns the status of the infrastructure.
`int`	`getTestRunNumber()` Returns the test run number.
`List<TestScenario>`	`getTestScenarios()` Returns the associated test scenarios.
`String`	`getWorkspace()` Return the workspace of the TestPlan.
`void`	`setBuildURL(String buildURL)`
`void`	`setConfigChangeSetBranchName(String configChangeSetBranchName)` Set config change set repository branch name
`void`	`setConfigChangeSetRepository(String configChangeSetRepository)` Sets the path of the config change set artifacts.
`void`	`setDeployerType(TestPlan.DeployerType deployerType)` Sets the deployer-type (puppet/ansible) of the test plan.
`void`	`setDeploymentConfig(DeploymentConfig deploymentConfig)` Sets the deployment configuration of the test plan.
`void`	`setDeploymentCreationResult(DeploymentCreationResult deploymentCreationResult)`
`void`	`setDeploymentPattern(DeploymentPattern deploymentPattern)` Sets the deployment pattern associated with.
`void`	`setDeploymentRepository(String deploymentRepository)` Sets the path of the deployment repository, which contains deploy.sh.
`void`	`setEmailToList(String emailToList)`
`void`	`setInfraParameters(String infraParameters)` Sets the infra parameters.
`void`	`setInfrastructureConfig(InfrastructureConfig infrastructureConfig)`
`void`	`setInfrastructureProperties(Properties infrastructureProperties)`
`void`	`setInfrastructureProvisionResult(InfrastructureProvisionResult infrastructureProvisionResult)`
`void`	`setInfrastructureRepository(String infrastructureRepository)` Sets the path of the test plans' infrastructure artifacts.
`void`	`setJobName(String jobName)`
`void`	`setJobProperties(Properties jobProperties)` See `getJobProperties()`
`void`	`setKeyFileLocation(String keyFileLocation)` Sets the location of the key file.
`void`	`setLogUrl(String logUrl)` Returns the URL to view WSO2 server logs.
`void`	`setPhase(TestPlanPhase testPlanPhase)` Set the phase of the test-plan
`void`	`setResultFormat(ResultFormat resultFormat)` Set the ResultFormatter object for the TestPlan
`void`	`setScenarioConfigs(List<ScenarioConfig> scenarioConfig)`
`void`	`setScenarioTestsRepository(String scenarioTestsRepository)` Sets the path of the test plans' test artifacts.
`void`	`setStatus(TestPlanStatus status)` Sets the status of the infrastructure.
`void`	`setTestRunNumber(int testRunNumber)` Sets the test run number.
`void`	`setTestScenarios(List<TestScenario> testScenarios)` Sets the associated test scenarios.
`void`	`setWorkspace(String workspace)`
`String`	`toString()`

Methods inherited from class org.wso2.testgrid.common.AbstractUUIDEntity
generateUUID, getCreatedTimestamp, getId, getModifiedTimestamp, setCreatedTimestamp, setId, setModifiedTimestamp

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - TEST_PLAN_TABLE
```
public static final String TEST_PLAN_TABLE
```
    TestPlan table name.
    
    See Also:
    
    Constant Field Values
  - STATUS_COLUMN
```
public static final String STATUS_COLUMN
```
    Column names of the table.
    
    See Also:
    
    Constant Field Values
  - DEPLOYMENT_PATTERN_COLUMN
```
public static final String DEPLOYMENT_PATTERN_COLUMN
```
    See Also:
    
    Constant Field Values
  - TESTRUN_NUMBER_COLUMN
```
public static final String TESTRUN_NUMBER_COLUMN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TestPlan
```
public TestPlan()
```
- Method Detail
  - getPhase
```
public TestPlanPhase getPhase()
```
    Returns the phase of the test-plan
  - setPhase
```
public void setPhase(TestPlanPhase testPlanPhase)
```
    Set the phase of the test-plan
  - getStatus
```
public TestPlanStatus getStatus()
```
    Returns the status of the infrastructure.
    
    Returns:
    
    infrastructure status
  - setStatus
```
public void setStatus(TestPlanStatus status)
```
    Sets the status of the infrastructure.
    
    Parameters:
    
    status - infrastructure status
  - getInfraParameters
```
public String getInfraParameters()
```
    Returns the infra parameters.
    
    Returns:
    
    infra parameters
  - setInfraParameters
```
public void setInfraParameters(String infraParameters)
```
    Sets the infra parameters.
    
    Parameters:
    
    infraParameters - infra parameters
  - getDeploymentPattern
```
public DeploymentPattern getDeploymentPattern()
```
    Returns the deployment pattern associated with.
    
    Returns:
    
    deployment pattern associated with
  - setDeploymentPattern
```
public void setDeploymentPattern(DeploymentPattern deploymentPattern)
```
    Sets the deployment pattern associated with.
    
    Parameters:
    
    deploymentPattern - deployment pattern associated with
  - getTestRunNumber
```
public int getTestRunNumber()
```
    Returns the test run number.
    
    Returns:
    
    test run number
  - setTestRunNumber
```
public void setTestRunNumber(int testRunNumber)
```
    Sets the test run number.
    
    Parameters:
    
    testRunNumber - test run number
  - getTestScenarios
```
public List<TestScenario> getTestScenarios()
```
    Returns the associated test scenarios.
    
    Returns:
    
    associated test scenarios
  - setTestScenarios
```
public void setTestScenarios(List<TestScenario> testScenarios)
```
    Sets the associated test scenarios.
    
    Parameters:
    
    testScenarios - associated test scenarios
  - getDeployerType
```
public TestPlan.DeployerType getDeployerType()
```
    Returns the deployer-type (puppet/ansible) of the test plan.
    
    Returns:
    
    the deployer-type (puppet/ansible) of the test plan
  - setDeployerType
```
public void setDeployerType(TestPlan.DeployerType deployerType)
```
    Sets the deployer-type (puppet/ansible) of the test plan.
    
    Parameters:
    
    deployerType - deployer-type (puppet/ansible) of the test plan
  - getInfrastructureConfig
```
public InfrastructureConfig getInfrastructureConfig()
```
  - setInfrastructureConfig
```
public void setInfrastructureConfig(InfrastructureConfig infrastructureConfig)
```
  - getDeploymentConfig
```
public DeploymentConfig getDeploymentConfig()
```
    Returns the deployment configuration in the test-plan.
    
    Returns:
    
    the deployment configuration of the test plan
  - setDeploymentConfig
```
public void setDeploymentConfig(DeploymentConfig deploymentConfig)
```
    Sets the deployment configuration of the test plan.
    
    Parameters:
    
    deploymentConfig - the deployment information of the test plan
  - getScenarioConfigs
```
public List<ScenarioConfig> getScenarioConfigs()
```
  - setScenarioConfigs
```
public void setScenarioConfigs(List<ScenarioConfig> scenarioConfig)
```
  - getScenarioTestsRepository
```
public String getScenarioTestsRepository()
```
    Returns the path of the test plans' test artifacts.
    
    Returns:
    
    the path of the test plans' test artifacts.
  - setScenarioTestsRepository
```
public void setScenarioTestsRepository(String scenarioTestsRepository)
```
    Sets the path of the test plans' test artifacts.
    
    Parameters:
    
    scenarioTestsRepository - the path of the test plans' test artifacts.
  - getConfigChangeSetRepository
```
public String getConfigChangeSetRepository()
```
    Return the path of config change set artifacts.
    
    Returns:
    
    the path of config change set artifacts.
  - setConfigChangeSetRepository
```
public void setConfigChangeSetRepository(String configChangeSetRepository)
```
    Sets the path of the config change set artifacts.
    
    Parameters:
    
    configChangeSetRepository - the path of config change set artifacts.
  - 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 -
  - getInfrastructureRepository
```
public String getInfrastructureRepository()
```
    Returns the path of the test plans' infrastructure artifacts.
    
    Returns:
    
    the path of the test plans' infrastructure artifacts
  - setInfrastructureRepository
```
public void setInfrastructureRepository(String infrastructureRepository)
```
    Sets the path of the test plans' infrastructure artifacts.
    
    Parameters:
    
    infrastructureRepository - the path of the test plans' infrastructure artifacts
  - getDeploymentRepository
```
public String getDeploymentRepository()
```
    Returns the path of the deployment repository.
    
    Returns:
    
    the path of the test plans' infrastructure artifacts
  - setDeploymentRepository
```
public void setDeploymentRepository(String deploymentRepository)
```
    Sets the path of the deployment repository, which contains deploy.sh.
    
    Parameters:
    
    deploymentRepository - the path of the deployment repository
  - getJobProperties
```
public Properties getJobProperties()
```
    Get the list of build properties associated with this test plan. The build properties are currently contain properties received via JobConfigFile.getProperties().
    
    Returns:
    
    build proprties
  - setJobProperties
```
public void setJobProperties(Properties jobProperties)
```
    See getJobProperties()
    
    Parameters:
    
    jobProperties - build properties
  - getResultFormat
```
public ResultFormat getResultFormat()
```
    Returns the ResultFormatter object fot the specific TestPlan
    
    Returns:
    
    ResultFormatter object of TestPlan
  - setResultFormat
```
public void setResultFormat(ResultFormat resultFormat)
```
    Set the ResultFormatter object for the TestPlan
    
    Parameters:
    
    resultFormat - ResultFormatter object to be set
  - getKeyFileLocation
```
public String getKeyFileLocation()
```
    Get the location of the key file used to access the instances.
    
    Returns:
    
    location of the key file
  - setKeyFileLocation
```
public void setKeyFileLocation(String keyFileLocation)
```
    Sets the location of the key file.
    
    Parameters:
    
    keyFileLocation - location of the key file
  - getLogUrl
```
public String getLogUrl()
```
    Returns the URL to view WSO2 server logs.
    
    Returns:
    
    Log location URL
  - setLogUrl
```
public void setLogUrl(String logUrl)
```
    Returns the URL to view WSO2 server logs.
    
    Parameters:
    
    logUrl - Log location URL
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clone
```
public TestPlan clone()
```
    Overrides:
    
    clone in class Object
  - getJobName
```
public String getJobName()
```
  - setJobName
```
public void setJobName(String jobName)
```
  - getWorkspace
```
public String getWorkspace()
```
    Return the workspace of the TestPlan. If the workspace is not set it will be derived as below; 1. Derived using the job-name 2. If job-name is not set, derive using product-name 3. If both (1) and (2) is not possible, consider job directory as "product-" (The random directory will be generated only one-time and will be used as its workspace from there onwards.)
  - setWorkspace
```
public void setWorkspace(String workspace)
```
  - getEmailToList
```
public String getEmailToList()
```
  - setEmailToList
```
public void setEmailToList(String emailToList)
```
  - setBuildURL
```
public void setBuildURL(String buildURL)
```
  - getBuildURL
```
public String getBuildURL()
```
  - getInfrastructureProvisionResult
```
public InfrastructureProvisionResult getInfrastructureProvisionResult()
```
  - setInfrastructureProvisionResult
```
public void setInfrastructureProvisionResult(InfrastructureProvisionResult infrastructureProvisionResult)
```
  - getDeploymentCreationResult
```
public DeploymentCreationResult getDeploymentCreationResult()
```
  - setDeploymentCreationResult
```
public void setDeploymentCreationResult(DeploymentCreationResult deploymentCreationResult)
```
  - getInfrastructureProperties
```
public Properties getInfrastructureProperties()
```
  - setInfrastructureProperties
```
public void setInfrastructureProperties(Properties infrastructureProperties)
```

Class TestPlan

Nested Class Summary

Field Summary

Fields inherited from class org.wso2.testgrid.common.AbstractUUIDEntity

Constructor Summary

Method Summary

Methods inherited from class org.wso2.testgrid.common.AbstractUUIDEntity

Methods inherited from class java.lang.Object

Field Detail

TEST_PLAN_TABLE

STATUS_COLUMN

DEPLOYMENT_PATTERN_COLUMN

TESTRUN_NUMBER_COLUMN

Constructor Detail

TestPlan

Method Detail

getPhase

setPhase

getStatus

setStatus

getInfraParameters

setInfraParameters

getDeploymentPattern

setDeploymentPattern

getTestRunNumber

setTestRunNumber

getTestScenarios

setTestScenarios

getDeployerType

setDeployerType

getInfrastructureConfig

setInfrastructureConfig

getDeploymentConfig

setDeploymentConfig

getScenarioConfigs

setScenarioConfigs

getScenarioTestsRepository

setScenarioTestsRepository

getConfigChangeSetRepository

setConfigChangeSetRepository

getConfigChangeSetBranchName

setConfigChangeSetBranchName

getInfrastructureRepository

setInfrastructureRepository

getDeploymentRepository

setDeploymentRepository

getJobProperties

setJobProperties

getResultFormat

setResultFormat

getKeyFileLocation

setKeyFileLocation

getLogUrl

setLogUrl

toString

clone

getJobName

setJobName

getWorkspace

setWorkspace

getEmailToList

setEmailToList

setBuildURL

getBuildURL

getInfrastructureProvisionResult

setInfrastructureProvisionResult

getDeploymentCreationResult

setDeploymentCreationResult

getInfrastructureProperties

setInfrastructureProperties