org.wso2.testgrid.common.util

Class S3StorageUtil

java.lang.Object

org.wso2.testgrid.common.util.S3StorageUtil

public final class S3StorageUtil
extends Object

This Util class holds the utility methods used to manage TestGrid S3 storage.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
S3StorageUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	deleteTestPlan(TestPlan testPlan) This method delete the log files for a given test plan in S3
static String	deriveS3DeploymentOutputsDir(TestPlan testPlan, ArtifactReadable awsArtifactReader) Returns the path for deployment-outputs for a given test-plan
static String	deriveS3ScenarioArchiveFileDir(TestPlan testPlan, String scenarioDir, ArtifactReadable awsArtifactReader) Returns the scenario-archive file path in S3 for a scenario of a test-plan.
static String	deriveS3ScenarioOutputsFilePath(TestPlan testPlan, ArtifactReadable artifactReadable) Returns the path to output.properties generated during scenario execution.
static String	deriveS3TestPlanDirPath(TestPlan testPlan, ArtifactReadable awsArtifactReader) Returns the test-plan directory path in S3 for the test-plan.
static String	deriveS3TestsResultsArchivePath(TestPlan testPlan, ArtifactReadable awsArtifactReader) Returns the test results archive file path in S3 of a test-plan.
static String	getS3BucketURL() Generate the S3 bucket URL for the current environment.
static String	getS3LocationForTestRunLogFile(TestPlan testPlan, Boolean truncated, ArtifactReadable awsArtifactReader) Returns the path of the test-run log file in S3 bucket.

Methods inherited from class java.lang.Object

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

Constructor Detail

S3StorageUtil

public S3StorageUtil()

Method Detail

getS3LocationForTestRunLogFile

public static String getS3LocationForTestRunLogFile(TestPlan testPlan,
                                                    Boolean truncated,
                                                    ArtifactReadable awsArtifactReader)

Returns the path of the test-run log file in S3 bucket.

/builds/#depl_name#_#infra-uuid#_#test-run-num#/test-run.log

Parameters:

testPlan - test-plan

truncated - whether the truncated log or the raw log file

Returns:

log file path

getS3BucketURL

public static String getS3BucketURL()

Generate the S3 bucket URL for the current environment. Ex. https://s3.amazonaws.com/bucket1

Returns:

the S3 bucket url of the environment

deleteTestPlan

public static boolean deleteTestPlan(TestPlan testPlan)

This method delete the log files for a given test plan in S3

Parameters:

testPlan - Test plan which the data need to be deleted

deriveS3TestPlanDirPath

public static String deriveS3TestPlanDirPath(TestPlan testPlan,
                                             ArtifactReadable awsArtifactReader)

Returns the test-plan directory path in S3 for the test-plan.

Parameters:

testPlan - test-plan

Returns:

test-plan directory name.

deriveS3ScenarioArchiveFileDir

public static String deriveS3ScenarioArchiveFileDir(TestPlan testPlan,
                                                    String scenarioDir,
                                                    ArtifactReadable awsArtifactReader)

Returns the scenario-archive file path in S3 for a scenario of a test-plan.

Parameters:

testPlan - test-plan

scenarioDir - name of the scenario

Returns:

archive-file directory name.

deriveS3DeploymentOutputsDir

public static String deriveS3DeploymentOutputsDir(TestPlan testPlan,
                                                  ArtifactReadable awsArtifactReader)

Returns the path for deployment-outputs for a given test-plan

Parameters:

testPlan - test-plan

awsArtifactReader - AWSArtifactReadable

Returns:

deployment-outputs directory path

deriveS3ScenarioOutputsFilePath

public static String deriveS3ScenarioOutputsFilePath(TestPlan testPlan,
                                                     ArtifactReadable artifactReadable)

Returns the path to output.properties generated during scenario execution.

Parameters:

testPlan - test plan to get outputs of

artifactReadable - AWSArtifactReadable

Returns:

scenario output filepath in S3

deriveS3TestsResultsArchivePath

public static String deriveS3TestsResultsArchivePath(TestPlan testPlan,
                                                     ArtifactReadable awsArtifactReader)

Returns the test results archive file path in S3 of a test-plan.

Parameters:

testPlan - test-plan

awsArtifactReader - AWS artifact reader for accessing the S3 storage

Returns:

archive-file directory name.