Package org.apache.flink.testutils.s3

Class S3TestCredentials

java.lang.Object

org.apache.flink.testutils.s3.S3TestCredentials

public class S3TestCredentials
extends Object

Access to credentials to access S3 buckets during integration tests.

Constructor Summary

Constructors

Constructor	Description
S3TestCredentials()

Method Summary

Modifier and Type	Method	Description
static void	assumeCredentialsAvailable()	Checks whether an S3 test bucket is configured in the environment variables of this JVM.
static void	assumeStaticCredentialsAvailable()	Checks whether static access/secret keys are available.
static String	getS3AccessKey()	Gets the S3 Access Key.
static String	getS3SecretKey()	Gets the S3 Secret Key.
static String	getTestBucketUri()	Gets the URI for the path under which all tests should put their data.
static String	getTestBucketUriWithScheme(String scheme)	Gets the URI for the path under which all tests should put their data.
static boolean	hasStaticCredentials()	Checks whether static access/secret keys are configured.

Methods inherited from class java.lang.Object

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

Constructor Detail

S3TestCredentials

public S3TestCredentials()

Method Detail

hasStaticCredentials

public static boolean hasStaticCredentials()

Checks whether static access/secret keys are configured. When they are not, tests should leave credentials to the default AWS provider chain instead of pinning keys into config.

assumeCredentialsAvailable

public static void assumeCredentialsAvailable()

Checks whether an S3 test bucket is configured in the environment variables of this JVM. If not, throws an AssumptionViolatedException which causes JUnit tests to be skipped. This does not check for static access/secret keys; tests that need them should use assumeStaticCredentialsAvailable().

assumeStaticCredentialsAvailable

public static void assumeStaticCredentialsAvailable()

Checks whether static access/secret keys are available. If not, throws an AssumptionViolatedException so JUnit skips tests that specifically require static keys (e.g. credential-key forwarding tests) rather than the default AWS provider chain.

getS3AccessKey

public static String getS3AccessKey()

Gets the S3 Access Key.

This method throws an exception if the key is not available, which is the case in keyless runs where only the bucket is set. Tests should check hasStaticCredentials() or use assumeStaticCredentialsAvailable() first.

getS3SecretKey

public static String getS3SecretKey()

Gets the S3 Secret Key.

This method throws an exception if the key is not available, which is the case in keyless runs where only the bucket is set. Tests should check hasStaticCredentials() or use assumeStaticCredentialsAvailable() first.

getTestBucketUri

public static String getTestBucketUri()

Gets the URI for the path under which all tests should put their data.

This method throws an exception if the bucket was not configured. Tests should use assumeCredentialsAvailable() to skip tests when no bucket is configured.

getTestBucketUriWithScheme

public static String getTestBucketUriWithScheme(String scheme)

Gets the URI for the path under which all tests should put their data.

This method throws an exception if the bucket was not configured. Tests should use assumeCredentialsAvailable() to skip tests when no bucket is configured.