org.apache.beam.it.gcp.artifacts

Interface ArtifactClient

All Superinterfaces:

org.apache.beam.it.common.ResourceManager

All Known Implementing Classes:

GcsResourceManager

public interface ArtifactClient
extends org.apache.beam.it.common.ResourceManager

Interface for working with test artifacts.

It is the responsibility of implementations to make sure that artifacts are kept separate from each other. Using a GCS path, this isolation would create a path like the following: gs://test-class-name/run-id/test-method-name. Each directory means:

• test-class-name: A name given to the directory for a test class. This does not need to be identical to the class name, but it should clearly identify the class from other test classes. This is intended for long-lived artifacts that have value beyond a specific run of a test, such as a result file.
• run-id: An id assigned to a run of that test class. This will be handled by implementations of this client. It is intended for artifacts that may be referenced by multiple methods in a test class.
• test-method-name: A name given to the directory for a method within the test class. This does not need to be identical to the method name, but it should clearly identify the method from other test methods within the same test class. This is intended for input and output artifacts specific to the test method.

Separate input/output directories are optional and the responsibility of the test writer to maintain.

Method Summary

Modifier and Type	Method and Description
void	cleanupAll() Deletes all the files located under test-class-name/run-id.
Artifact	createArtifact(java.lang.String artifactName, byte[] contents) Creates a new artifact in whatever service is being used to store them.
Artifact	createArtifact(java.lang.String artifactName, java.lang.String contents) Creates a new artifact in whatever service is being used to store them.
java.lang.String	getPathForArtifact(java.lang.String artifactName) Returns a path the artifact will be created at.
java.util.List<Artifact>	listArtifacts(java.lang.String prefix, java.util.regex.Pattern regex) Lists all artifacts under test-class-name/run-id/prefix.
java.util.List<Artifact>	listArtifacts(TestName testName, java.util.regex.Pattern regex) Lists all artifacts under test-class-name/run-id/prefix.
java.lang.String	runId() Returns the id associated with the particular run of the test class.
Artifact	uploadArtifact(java.lang.String artifactName, java.nio.file.Path localPath) Uploads a local file to the service being used for storing artifacts.
Artifact	uploadArtifact(java.lang.String artifactName, java.lang.String localPath) Uploads a local file to the service being used for storing artifacts.

Method Detail

runId

java.lang.String runId()

Returns the id associated with the particular run of the test class.

getPathForArtifact

java.lang.String getPathForArtifact(java.lang.String artifactName)

Returns a path the artifact will be created at.

Parameters:

artifactName - Artifact name

Returns:

GCS path where the artifact will be created

createArtifact

Artifact createArtifact(java.lang.String artifactName,
                        java.lang.String contents)

Creates a new artifact in whatever service is being used to store them.

Parameters:

artifactName - the name of the artifact. If this is supposed to go under an input/output directory, then it should include that (example: input/artifact.txt)

contents - the contents of the artifact in String format

Returns:

a representation of the created artifact

createArtifact

Artifact createArtifact(java.lang.String artifactName,
                        byte[] contents)

Creates a new artifact in whatever service is being used to store them.

Parameters:

artifactName - the name of the artifact. If this is supposed to go under an input/output directory, then it should include that (example: input/artifact.txt)

contents - the contents of the artifact in byte array format

Returns:

a representation of the created artifact

uploadArtifact

Artifact uploadArtifact(java.lang.String artifactName,
                        java.lang.String localPath)
                 throws java.io.IOException

Uploads a local file to the service being used for storing artifacts.

Parameters:

artifactName - the name of the artifact. If this is supposed to go under an input/output directory, then it should include that (example: input/artifact.txt)

localPath - the absolute local path to the file to upload

Returns:

a representation of the uploaded artifact

Throws:

java.io.IOException - if there is an issue reading the local file

uploadArtifact

Artifact uploadArtifact(java.lang.String artifactName,
                        java.nio.file.Path localPath)
                 throws java.io.IOException

Uploads a local file to the service being used for storing artifacts.

Parameters:

artifactName - the name of the artifact. If this is supposed to go under an input/output directory, then it should include that (example: input/artifact.txt)

localPath - the local path to the file to upload

Returns:

a representation of the uploaded artifact

Throws:

java.io.IOException - if there is an issue reading the local file

listArtifacts

java.util.List<Artifact> listArtifacts(TestName testName,
                                       java.util.regex.Pattern regex)

Lists all artifacts under test-class-name/run-id/prefix.

Parameters:

testName - the test name to use as the prefix on the testing artifacts.

regex - a regex to use for filtering out unwanted artifacts

Returns:

all the artifacts whose name matches regex

listArtifacts

java.util.List<Artifact> listArtifacts(java.lang.String prefix,
                                       java.util.regex.Pattern regex)

Lists all artifacts under test-class-name/run-id/prefix.

Parameters:

prefix - the prefix to use along with the fixed values method above. This must include the test-method-name value, but it can include other directories or files under it.

regex - a regex to use for filtering out unwanted artifacts

Returns:

all the artifacts whose name matches regex

cleanupAll

void cleanupAll()

Deletes all the files located under test-class-name/run-id.

Specified by:

cleanupAll in interface org.apache.beam.it.common.ResourceManager