org.wso2.testgrid.common

Interface InfrastructureProvider

public interface InfrastructureProvider

This Interface has to be implemented by the InfrastructureProviders like AWS, GCC, OpenStack.

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(Script.ScriptType scriptType) This method returns whether the provider can handle the requested infrastructure.
void	cleanup(TestPlan testPlan) This method can be used to cleanup any additional infrastructure provided.
String	getProviderName() This method returns the provider name (AWS/GCP/Open Stack etc).
void	init(TestPlan testPlan) This method can be used to initialize the infrastructure provider.
InfrastructureProvisionResult	provision(TestPlan testPlan, Script script) This method creates the necessary infrastructureConfig using the provided configuration.
boolean	release(InfrastructureConfig infrastructureConfig, String infraRepoDir, TestPlan testPlan, Script script) This method executes commands needed to remove the infrastructure.

Method Detail

getProviderName

String getProviderName()

This method returns the provider name (AWS/GCP/Open Stack etc).

Returns:

a String indicating the name of the provider.

canHandle

boolean canHandle(Script.ScriptType scriptType)

This method returns whether the provider can handle the requested infrastructure.

Returns:

a boolean indicating whether can handle or not.

init

void init(TestPlan testPlan)
   throws TestGridInfrastructureException

This method can be used to initialize the infrastructure provider. Initialization may include usecases such as the initial log-in into a cloud provider.

Throws:

TestGridInfrastructureException

cleanup

void cleanup(TestPlan testPlan)
      throws TestGridInfrastructureException

This method can be used to cleanup any additional infrastructure provided. This should be executed after running all the scenarios.

Throws:

TestGridInfrastructureException

provision

InfrastructureProvisionResult provision(TestPlan testPlan,
                                        Script script)
                                 throws TestGridInfrastructureException

This method creates the necessary infrastructureConfig using the provided configuration.

Parameters:

testPlan - TestPlan with current test run specifications

Returns:

Deployment Deployment object including the created host, ip details

Throws:

TestGridInfrastructureException - thrown when error occurs in the infrastructure creation process.

release

boolean release(InfrastructureConfig infrastructureConfig,
                String infraRepoDir,
                TestPlan testPlan,
                Script script)
         throws TestGridInfrastructureException

This method executes commands needed to remove the infrastructure.

Parameters:

infrastructureConfig - an instance of a InfrastructureConfig in which Infrastructure should be removed.

infraRepoDir - location of the cloned repository related to infrastructure.

Returns:

boolean status of the operation

Throws:

TestGridInfrastructureException - thrown when error occurs in the infrastructure destroy process.