dannycranmer commented on a change in pull request #17966: URL: https://github.com/apache/flink/pull/17966#discussion_r760888453
########## File path: flink-connectors/flink-connector-aws-base/src/test/java/org/apache/flink/connector/aws/util/AWSGeneralUtilTest.java ########## @@ -0,0 +1,536 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.flink.connector.aws.util; + +import org.apache.flink.connector.aws.config.AWSConfigConstants; +import org.apache.flink.connector.aws.config.AWSConfigConstants.CredentialProvider; + +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.ExpectedException; +import software.amazon.awssdk.auth.credentials.AwsCredentials; +import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider; +import software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider; +import software.amazon.awssdk.auth.credentials.EnvironmentVariableCredentialsProvider; +import software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider; +import software.amazon.awssdk.auth.credentials.SystemPropertyCredentialsProvider; +import software.amazon.awssdk.auth.credentials.WebIdentityTokenFileCredentialsProvider; +import software.amazon.awssdk.http.Protocol; +import software.amazon.awssdk.http.SdkHttpConfigurationOption; +import software.amazon.awssdk.http.async.SdkAsyncHttpClient; +import software.amazon.awssdk.http.nio.netty.NettyNioAsyncHttpClient; +import software.amazon.awssdk.http.nio.netty.internal.NettyConfiguration; +import software.amazon.awssdk.regions.Region; +import software.amazon.awssdk.services.sts.auth.StsAssumeRoleCredentialsProvider; +import software.amazon.awssdk.utils.AttributeMap; + +import java.nio.file.Paths; +import java.time.Duration; +import java.util.Properties; + +import static org.apache.flink.connector.aws.config.AWSConfigConstants.AWS_CREDENTIALS_PROVIDER; +import static org.apache.flink.connector.aws.config.AWSConfigConstants.AWS_REGION; +import static org.apache.flink.connector.aws.config.AWSConfigConstants.CredentialProvider.ASSUME_ROLE; +import static org.apache.flink.connector.aws.config.AWSConfigConstants.CredentialProvider.AUTO; +import static org.apache.flink.connector.aws.config.AWSConfigConstants.CredentialProvider.BASIC; +import static org.apache.flink.connector.aws.config.AWSConfigConstants.CredentialProvider.WEB_IDENTITY_TOKEN; +import static org.apache.flink.connector.aws.config.AWSConfigConstants.roleArn; +import static org.apache.flink.connector.aws.config.AWSConfigConstants.roleSessionName; +import static org.apache.flink.connector.aws.config.AWSConfigConstants.webIdentityTokenFile; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.spy; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; +import static software.amazon.awssdk.http.Protocol.HTTP1_1; + +/** Tests for {@link AWSGeneralUtil}. */ +public class AWSGeneralUtilTest { + @Rule public ExpectedException exception = ExpectedException.none(); + + @Test + public void testGetCredentialsProviderTypeDefaultsAuto() { + assertEquals( + AUTO, + AWSGeneralUtil.getCredentialProviderType( + new Properties(), AWS_CREDENTIALS_PROVIDER)); + } + + @Test + public void testGetCredentialsProviderTypeBasic() { + Properties testConfig = + TestUtil.properties(AWSConfigConstants.accessKeyId(AWS_CREDENTIALS_PROVIDER), "ak"); + testConfig.setProperty(AWSConfigConstants.secretKey(AWS_CREDENTIALS_PROVIDER), "sk"); + + assertEquals( + BASIC, + AWSGeneralUtil.getCredentialProviderType(testConfig, AWS_CREDENTIALS_PROVIDER)); + } + + @Test + public void testGetCredentialsProviderTypeWebIdentityToken() { + Properties testConfig = TestUtil.properties(AWS_CREDENTIALS_PROVIDER, "WEB_IDENTITY_TOKEN"); + + CredentialProvider type = + AWSGeneralUtil.getCredentialProviderType(testConfig, AWS_CREDENTIALS_PROVIDER); + assertEquals(WEB_IDENTITY_TOKEN, type); + } + + @Test + public void testGetCredentialsProviderTypeAssumeRole() { + Properties testConfig = TestUtil.properties(AWS_CREDENTIALS_PROVIDER, "ASSUME_ROLE"); + + CredentialProvider type = + AWSGeneralUtil.getCredentialProviderType(testConfig, AWS_CREDENTIALS_PROVIDER); + assertEquals(ASSUME_ROLE, type); + } + + @Test + public void testGetCredentialsProviderEnvironmentVariables() { + Properties properties = TestUtil.properties(AWS_CREDENTIALS_PROVIDER, "ENV_VAR"); + + AwsCredentialsProvider credentialsProvider = + AWSGeneralUtil.getCredentialsProvider(properties); + + assertTrue(credentialsProvider instanceof EnvironmentVariableCredentialsProvider); + } + + @Test + public void testGetCredentialsProviderSystemProperties() { + Properties properties = TestUtil.properties(AWS_CREDENTIALS_PROVIDER, "SYS_PROP"); + + AwsCredentialsProvider credentialsProvider = + AWSGeneralUtil.getCredentialsProvider(properties); + + assertTrue(credentialsProvider instanceof SystemPropertyCredentialsProvider); + } + + @Test + public void testGetCredentialsProviderWebIdentityTokenFileCredentialsProvider() { + Properties properties = TestUtil.properties(AWS_CREDENTIALS_PROVIDER, "WEB_IDENTITY_TOKEN"); + + AwsCredentialsProvider credentialsProvider = + AWSGeneralUtil.getCredentialsProvider(properties); + + assertTrue(credentialsProvider instanceof WebIdentityTokenFileCredentialsProvider); + } + + @Test + public void testGetWebIdentityTokenFileCredentialsProvider() { + Properties properties = TestUtil.properties(AWS_CREDENTIALS_PROVIDER, "WEB_IDENTITY_TOKEN"); + properties.setProperty(roleArn(AWS_CREDENTIALS_PROVIDER), "roleArn"); + properties.setProperty(roleSessionName(AWS_CREDENTIALS_PROVIDER), "roleSessionName"); + + WebIdentityTokenFileCredentialsProvider.Builder builder = + mockWebIdentityTokenFileCredentialsProviderBuilder(); + + AWSGeneralUtil.getWebIdentityTokenFileCredentialsProvider( + builder, properties, AWS_CREDENTIALS_PROVIDER); + + verify(builder).roleArn("roleArn"); + verify(builder).roleSessionName("roleSessionName"); + verify(builder, never()).webIdentityTokenFile(any()); + } + + @Test + public void testGetWebIdentityTokenFileCredentialsProviderWithWebIdentityFile() { + Properties properties = TestUtil.properties(AWS_CREDENTIALS_PROVIDER, "WEB_IDENTITY_TOKEN"); + properties.setProperty( + webIdentityTokenFile(AWS_CREDENTIALS_PROVIDER), "webIdentityTokenFile"); + + WebIdentityTokenFileCredentialsProvider.Builder builder = + mockWebIdentityTokenFileCredentialsProviderBuilder(); + + AWSGeneralUtil.getWebIdentityTokenFileCredentialsProvider( + builder, properties, AWS_CREDENTIALS_PROVIDER); + + verify(builder).webIdentityTokenFile(Paths.get("webIdentityTokenFile")); + } + + @Test + public void testGetCredentialsProviderAuto() { + Properties properties = TestUtil.properties(AWS_CREDENTIALS_PROVIDER, "AUTO"); + + AwsCredentialsProvider credentialsProvider = + AWSGeneralUtil.getCredentialsProvider(properties); + + assertTrue(credentialsProvider instanceof DefaultCredentialsProvider); + } + + @Test + public void testGetCredentialsProviderAssumeRole() { + Properties properties = spy(TestUtil.properties(AWS_CREDENTIALS_PROVIDER, "ASSUME_ROLE")); + properties.setProperty(AWS_REGION, "eu-west-2"); + + AwsCredentialsProvider credentialsProvider = + AWSGeneralUtil.getCredentialsProvider(properties); + + assertTrue(credentialsProvider instanceof StsAssumeRoleCredentialsProvider); + + verify(properties).getProperty(AWSConfigConstants.roleArn(AWS_CREDENTIALS_PROVIDER)); + verify(properties) + .getProperty(AWSConfigConstants.roleSessionName(AWS_CREDENTIALS_PROVIDER)); + verify(properties).getProperty(AWSConfigConstants.externalId(AWS_CREDENTIALS_PROVIDER)); + verify(properties).getProperty(AWS_REGION); + } + + @Test + public void testGetCredentialsProviderBasic() { + Properties properties = TestUtil.properties(AWS_CREDENTIALS_PROVIDER, "BASIC"); + properties.setProperty(AWSConfigConstants.accessKeyId(AWS_CREDENTIALS_PROVIDER), "ak"); + properties.setProperty(AWSConfigConstants.secretKey(AWS_CREDENTIALS_PROVIDER), "sk"); + + AwsCredentials credentials = + AWSGeneralUtil.getCredentialsProvider(properties).resolveCredentials(); + + assertEquals("ak", credentials.accessKeyId()); + assertEquals("sk", credentials.secretAccessKey()); + } + + @Test + public void testGetCredentialsProviderProfile() { + Properties properties = TestUtil.properties(AWS_CREDENTIALS_PROVIDER, "PROFILE"); + properties.put(AWSConfigConstants.profileName(AWS_CREDENTIALS_PROVIDER), "default"); + properties.put( + AWSConfigConstants.profilePath(AWS_CREDENTIALS_PROVIDER), + "src/test/resources/profile"); + + AwsCredentialsProvider credentialsProvider = + AWSGeneralUtil.getCredentialsProvider(properties); + + assertTrue(credentialsProvider instanceof ProfileCredentialsProvider); + + AwsCredentials credentials = credentialsProvider.resolveCredentials(); + assertEquals("11111111111111111111", credentials.accessKeyId()); + assertEquals("wJalrXUtnFEMI/K7MDENG/bPxRfiCY1111111111", credentials.secretAccessKey()); + } + + @Test + public void testGetCredentialsProviderNamedProfile() { + Properties properties = TestUtil.properties(AWS_CREDENTIALS_PROVIDER, "PROFILE"); + properties.setProperty(AWSConfigConstants.profileName(AWS_CREDENTIALS_PROVIDER), "foo"); + properties.setProperty( + AWSConfigConstants.profilePath(AWS_CREDENTIALS_PROVIDER), + "src/test/resources/profile"); + + AwsCredentialsProvider credentialsProvider = + AWSGeneralUtil.getCredentialsProvider(properties); + + assertTrue(credentialsProvider instanceof ProfileCredentialsProvider); + + AwsCredentials credentials = credentialsProvider.resolveCredentials(); + assertEquals("22222222222222222222", credentials.accessKeyId()); + assertEquals("wJalrXUtnFEMI/K7MDENG/bPxRfiCY2222222222", credentials.secretAccessKey()); + } + + @Test + public void testCreateNettyAsyncHttpClientWithDefaults() throws Exception { + NettyNioAsyncHttpClient.Builder builder = NettyNioAsyncHttpClient.builder(); + + SdkAsyncHttpClient httpClient = AWSGeneralUtil.createAsyncHttpClient(builder); + NettyConfiguration nettyConfiguration = TestUtil.getNettyConfiguration(httpClient); + + SdkAsyncHttpClient httpDefaultClient = NettyNioAsyncHttpClient.create(); + NettyConfiguration nettyDefaultConfiguration = + TestUtil.getNettyConfiguration(httpDefaultClient); + + assertEquals( + AWSGeneralUtil.CONNECTION_ACQUISITION_TIMEOUT.toMillis(), + nettyConfiguration.connectionAcquireTimeoutMillis()); + assertEquals( + nettyDefaultConfiguration.connectionTtlMillis(), + nettyConfiguration.connectionTtlMillis()); + assertEquals( + nettyDefaultConfiguration.connectTimeoutMillis(), + nettyConfiguration.connectTimeoutMillis()); + assertEquals( + nettyDefaultConfiguration.idleTimeoutMillis(), + nettyConfiguration.idleTimeoutMillis()); + assertEquals( + AWSGeneralUtil.HTTP_CLIENT_MAX_CONCURRENCY, nettyConfiguration.maxConnections()); + assertEquals( + nettyDefaultConfiguration.maxPendingConnectionAcquires(), + nettyConfiguration.maxPendingConnectionAcquires()); + assertEquals( + AWSGeneralUtil.HTTP_CLIENT_READ_TIMEOUT.toMillis(), + nettyConfiguration.readTimeoutMillis()); + assertEquals( + nettyDefaultConfiguration.reapIdleConnections(), + nettyConfiguration.reapIdleConnections()); + assertEquals(nettyDefaultConfiguration.tcpKeepAlive(), nettyConfiguration.tcpKeepAlive()); + assertEquals( + nettyDefaultConfiguration.tlsKeyManagersProvider(), + nettyConfiguration.tlsKeyManagersProvider()); + assertEquals( + nettyDefaultConfiguration.tlsTrustManagersProvider(), + nettyConfiguration.tlsTrustManagersProvider()); + assertEquals( + AWSGeneralUtil.TRUST_ALL_CERTIFICATES, nettyConfiguration.trustAllCertificates()); + assertEquals( + nettyDefaultConfiguration.writeTimeoutMillis(), + nettyConfiguration.writeTimeoutMillis()); + assertEquals( + AWSGeneralUtil.HTTP_PROTOCOL, + nettyConfiguration.attribute(SdkHttpConfigurationOption.PROTOCOL)); Review comment: nit: These would be best as single tests. Best practise is to make tests test a single thing, and ideally have a single assertion. This way we fail fast, and get all failures immediately. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
