xiaolong-sn commented on a change in pull request #12944: URL: https://github.com/apache/flink/pull/12944#discussion_r458720418
########## File path: flink-connectors/flink-connector-kinesis/src/test/java/org/apache/flink/streaming/connectors/kinesis/util/AwsV2UtilTest.java ########## @@ -0,0 +1,407 @@ +/* + * 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.streaming.connectors.kinesis.util; + +import org.apache.flink.streaming.connectors.kinesis.config.AWSConfigConstants; +import org.apache.flink.streaming.connectors.kinesis.config.ConsumerConfigConstants; + +import com.amazonaws.ClientConfiguration; +import com.amazonaws.ClientConfigurationFactory; +import org.junit.Test; +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.core.client.config.ClientOverrideConfiguration; +import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption; +import software.amazon.awssdk.http.async.SdkAsyncHttpClient; +import software.amazon.awssdk.http.nio.netty.NettyNioAsyncHttpClient; +import software.amazon.awssdk.regions.Region; +import software.amazon.awssdk.services.kinesis.KinesisAsyncClientBuilder; +import software.amazon.awssdk.services.sts.auth.StsAssumeRoleCredentialsProvider; + +import java.net.URI; +import java.nio.file.Paths; +import java.time.Duration; +import java.util.Properties; + +import static org.apache.flink.streaming.connectors.kinesis.config.AWSConfigConstants.AWS_CREDENTIALS_PROVIDER; +import static org.apache.flink.streaming.connectors.kinesis.config.AWSConfigConstants.AWS_REGION; +import static org.apache.flink.streaming.connectors.kinesis.config.AWSConfigConstants.roleArn; +import static org.apache.flink.streaming.connectors.kinesis.config.AWSConfigConstants.roleSessionName; +import static org.apache.flink.streaming.connectors.kinesis.config.AWSConfigConstants.webIdentityTokenFile; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.anyBoolean; +import static org.mockito.ArgumentMatchers.anyInt; +import static org.mockito.ArgumentMatchers.argThat; +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; + +/** + * Tests for {@link AwsV2Util}. + */ +public class AwsV2UtilTest { + + @Test + public void testGetCredentialsProviderEnvironmentVariables() { + Properties properties = properties(AWS_CREDENTIALS_PROVIDER, "ENV_VAR"); + + AwsCredentialsProvider credentialsProvider = AwsV2Util.getCredentialsProvider(properties); + + assertTrue(credentialsProvider instanceof EnvironmentVariableCredentialsProvider); + } + + @Test + public void testGetCredentialsProviderSystemProperties() { + Properties properties = properties(AWS_CREDENTIALS_PROVIDER, "SYS_PROP"); + + AwsCredentialsProvider credentialsProvider = AwsV2Util.getCredentialsProvider(properties); + + assertTrue(credentialsProvider instanceof SystemPropertyCredentialsProvider); + } + + @Test + public void testGetCredentialsProviderWebIdentityTokenFileCredentialsProvider() { + Properties properties = properties(AWS_CREDENTIALS_PROVIDER, "WEB_IDENTITY_TOKEN"); + + AwsCredentialsProvider credentialsProvider = AwsV2Util.getCredentialsProvider(properties); + + assertTrue(credentialsProvider instanceof WebIdentityTokenFileCredentialsProvider); + } + + @Test + public void testGetWebIdentityTokenFileCredentialsProvider() { + Properties properties = 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(); + + AwsV2Util.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 = properties(AWS_CREDENTIALS_PROVIDER, "WEB_IDENTITY_TOKEN"); + properties.setProperty(webIdentityTokenFile(AWS_CREDENTIALS_PROVIDER), "webIdentityTokenFile"); + + WebIdentityTokenFileCredentialsProvider.Builder builder = mockWebIdentityTokenFileCredentialsProviderBuilder(); + + AwsV2Util.getWebIdentityTokenFileCredentialsProvider(builder, properties, AWS_CREDENTIALS_PROVIDER); + + verify(builder).webIdentityTokenFile(Paths.get("webIdentityTokenFile")); + } + + @Test + public void testGetCredentialsProviderAuto() { + Properties properties = properties(AWS_CREDENTIALS_PROVIDER, "AUTO"); + + AwsCredentialsProvider credentialsProvider = AwsV2Util.getCredentialsProvider(properties); + + assertTrue(credentialsProvider instanceof DefaultCredentialsProvider); + } + + @Test + public void testGetCredentialsProviderAssumeRole() { + Properties properties = spy(properties(AWS_CREDENTIALS_PROVIDER, "ASSUME_ROLE")); + properties.setProperty(AWS_REGION, "eu-west-2"); + + AwsCredentialsProvider credentialsProvider = AwsV2Util.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 = properties(AWS_CREDENTIALS_PROVIDER, "BASIC"); + properties.setProperty(AWSConfigConstants.accessKeyId(AWS_CREDENTIALS_PROVIDER), "ak"); + properties.setProperty(AWSConfigConstants.secretKey(AWS_CREDENTIALS_PROVIDER), "sk"); + + AwsCredentials credentials = AwsV2Util.getCredentialsProvider(properties).resolveCredentials(); + + assertEquals("ak", credentials.accessKeyId()); + assertEquals("sk", credentials.secretAccessKey()); + } + + @Test + public void testGetCredentialsProviderProfile() { + Properties properties = 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 = AwsV2Util.getCredentialsProvider(properties); + + assertTrue(credentialsProvider instanceof ProfileCredentialsProvider); + + AwsCredentials credentials = credentialsProvider.resolveCredentials(); + assertEquals("11111111111111111111", credentials.accessKeyId()); + assertEquals("wJalrXUtnFEMI/K7MDENG/bPxRfiCY1111111111", credentials.secretAccessKey()); + } + + @Test + public void testGetCredentialsProviderNamedProfile() { Review comment: Should we just throw an exception when the `CredentialsProvicer` is set to an illegal name, rather than give it a default value? ########## File path: flink-connectors/flink-connector-kinesis/src/main/java/org/apache/flink/streaming/connectors/kinesis/util/AwsV2Util.java ########## @@ -0,0 +1,237 @@ +/* + * 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.streaming.connectors.kinesis.util; + +import org.apache.flink.annotation.Internal; +import org.apache.flink.annotation.VisibleForTesting; +import org.apache.flink.streaming.connectors.kinesis.config.AWSConfigConstants; +import org.apache.flink.streaming.connectors.kinesis.config.AWSConfigConstants.CredentialProvider; + +import com.amazonaws.ClientConfiguration; +import com.amazonaws.auth.AWSCredentialsProvider; +import software.amazon.awssdk.auth.credentials.AwsBasicCredentials; +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.core.client.config.ClientOverrideConfiguration; +import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption; +import software.amazon.awssdk.http.async.SdkAsyncHttpClient; +import software.amazon.awssdk.http.nio.netty.NettyNioAsyncHttpClient; +import software.amazon.awssdk.profiles.ProfileFile; +import software.amazon.awssdk.regions.Region; +import software.amazon.awssdk.services.kinesis.KinesisAsyncClient; +import software.amazon.awssdk.services.kinesis.KinesisAsyncClientBuilder; +import software.amazon.awssdk.services.sts.StsClient; +import software.amazon.awssdk.services.sts.auth.StsAssumeRoleCredentialsProvider; +import software.amazon.awssdk.services.sts.model.AssumeRoleRequest; + +import java.net.URI; +import java.nio.file.Paths; +import java.time.Duration; +import java.util.Optional; +import java.util.Properties; + +/** + * Utility methods specific to Amazon Web Service SDK v2.x. + */ +@Internal +public class AwsV2Util { + + /** + * Creates an Amazon Kinesis Async Client from the provided properties. + * Configuration is copied from AWS SDK v1 configuration class as per: + * - https://github.com/aws/aws-sdk-java-v2/blob/2.13.52/docs/LaunchChangelog.md#134-client-override-retry-configuration + * + * @param configProps configuration properties + * @param config the AWS SDK v1.x client configuration used to create the client + * @return a new Amazon Kinesis Client + */ + public static KinesisAsyncClient createKinesisAsyncClient(final Properties configProps, final ClientConfiguration config) { + final SdkAsyncHttpClient httpClient = createHttpClient(config, NettyNioAsyncHttpClient.builder()); + final ClientOverrideConfiguration overrideConfiguration = createClientOverrideConfiguration(config, ClientOverrideConfiguration.builder()); + final KinesisAsyncClientBuilder clientBuilder = KinesisAsyncClient.builder(); + + return createKinesisAsyncClient(configProps, clientBuilder, httpClient, overrideConfiguration); + } + + @VisibleForTesting + static SdkAsyncHttpClient createHttpClient( + final ClientConfiguration config, + final NettyNioAsyncHttpClient.Builder httpClientBuilder) { + httpClientBuilder + .maxConcurrency(config.getMaxConnections()) + .connectionTimeout(Duration.ofMillis(config.getConnectionTimeout())) + .writeTimeout(Duration.ofMillis(config.getSocketTimeout())) + .connectionMaxIdleTime(Duration.ofMillis(config.getConnectionMaxIdleMillis())) + .useIdleConnectionReaper(config.useReaper()); + + if (config.getConnectionTTL() > -1) { + httpClientBuilder.connectionTimeToLive(Duration.ofMillis(config.getConnectionTTL())); + } + + return httpClientBuilder.build(); + } + + @VisibleForTesting + static ClientOverrideConfiguration createClientOverrideConfiguration( + final ClientConfiguration config, + final ClientOverrideConfiguration.Builder overrideConfigurationBuilder) { + + overrideConfigurationBuilder + .putAdvancedOption(SdkAdvancedClientOption.USER_AGENT_PREFIX, AWSUtil.formatFlinkUserAgentPrefix()) + .putAdvancedOption(SdkAdvancedClientOption.USER_AGENT_SUFFIX, config.getUserAgentSuffix()); + + if (config.getRequestTimeout() > 0) { + overrideConfigurationBuilder.apiCallAttemptTimeout(Duration.ofMillis(config.getRequestTimeout())); + } + + if (config.getClientExecutionTimeout() > 0) { + overrideConfigurationBuilder.apiCallTimeout(Duration.ofMillis(config.getClientExecutionTimeout())); + } + + return overrideConfigurationBuilder.build(); + } + + @VisibleForTesting + static KinesisAsyncClient createKinesisAsyncClient( + final Properties configProps, + final KinesisAsyncClientBuilder clientBuilder, + final SdkAsyncHttpClient httpClient, + final ClientOverrideConfiguration overrideConfiguration) { + + if (configProps.containsKey(AWSConfigConstants.AWS_ENDPOINT)) { + final URI endpointOverride = URI.create(configProps.getProperty(AWSConfigConstants.AWS_ENDPOINT)); + clientBuilder.endpointOverride(endpointOverride); + } + + return clientBuilder + .httpClient(httpClient) + .overrideConfiguration(overrideConfiguration) + .credentialsProvider(getCredentialsProvider(configProps)) + .region(getRegion(configProps)) + .build(); + } + + /** + * Return a {@link AWSCredentialsProvider} instance corresponding to the configuration properties. + * + * @param configProps the configuration properties + * @return The corresponding AWS Credentials Provider instance + */ + public static AwsCredentialsProvider getCredentialsProvider(final Properties configProps) { Review comment: Why should we overload this method? Will there be an alternative prefix? ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: [email protected]
