-
Notifications
You must be signed in to change notification settings - Fork 57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[FLINK-31986][Connectors/Kinesis] Setup integration tests for FLIP-27 Kinesis source #172
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
220 changes: 220 additions & 0 deletions
220
...s/src/test/java/org/apache/flink/connector/kinesis/source/KinesisStreamsSourceITCase.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,220 @@ | ||
| package org.apache.flink.connector.kinesis.source; | ||
|
|
||
| import org.apache.flink.api.common.eventtime.WatermarkStrategy; | ||
| import org.apache.flink.api.common.serialization.SimpleStringSchema; | ||
| import org.apache.flink.api.common.time.Deadline; | ||
| import org.apache.flink.api.common.typeinfo.TypeInformation; | ||
| import org.apache.flink.configuration.Configuration; | ||
| import org.apache.flink.connector.aws.testutils.AWSServicesTestUtils; | ||
| import org.apache.flink.connector.aws.testutils.LocalstackContainer; | ||
| import org.apache.flink.connector.aws.util.AWSGeneralUtil; | ||
| import org.apache.flink.streaming.api.environment.StreamExecutionEnvironment; | ||
| import org.apache.flink.test.junit5.MiniClusterExtension; | ||
|
|
||
| import com.google.common.collect.Lists; | ||
| import org.assertj.core.api.Assertions; | ||
| import org.junit.jupiter.api.AfterEach; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.extension.ExtendWith; | ||
| import org.rnorth.ducttape.ratelimits.RateLimiter; | ||
| import org.rnorth.ducttape.ratelimits.RateLimiterBuilder; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| import org.testcontainers.junit.jupiter.Container; | ||
| import org.testcontainers.junit.jupiter.Testcontainers; | ||
| import org.testcontainers.utility.DockerImageName; | ||
| import software.amazon.awssdk.core.SdkBytes; | ||
| import software.amazon.awssdk.core.SdkSystemSetting; | ||
| import software.amazon.awssdk.http.SdkHttpClient; | ||
| import software.amazon.awssdk.regions.Region; | ||
| import software.amazon.awssdk.services.kinesis.KinesisClient; | ||
| import software.amazon.awssdk.services.kinesis.model.CreateStreamRequest; | ||
| import software.amazon.awssdk.services.kinesis.model.DescribeStreamRequest; | ||
| import software.amazon.awssdk.services.kinesis.model.PutRecordsRequest; | ||
| import software.amazon.awssdk.services.kinesis.model.PutRecordsRequestEntry; | ||
| import software.amazon.awssdk.services.kinesis.model.PutRecordsResponse; | ||
| import software.amazon.awssdk.services.kinesis.model.PutRecordsResultEntry; | ||
| import software.amazon.awssdk.services.kinesis.model.StreamStatus; | ||
|
|
||
| import java.time.Duration; | ||
| import java.util.List; | ||
| import java.util.stream.Collectors; | ||
| import java.util.stream.IntStream; | ||
|
|
||
| import static java.util.concurrent.TimeUnit.SECONDS; | ||
| import static org.apache.flink.connector.aws.config.AWSConfigConstants.AWS_ACCESS_KEY_ID; | ||
| import static org.apache.flink.connector.aws.config.AWSConfigConstants.AWS_ENDPOINT; | ||
| import static org.apache.flink.connector.aws.config.AWSConfigConstants.AWS_REGION; | ||
| import static org.apache.flink.connector.aws.config.AWSConfigConstants.AWS_SECRET_ACCESS_KEY; | ||
| import static org.apache.flink.connector.aws.config.AWSConfigConstants.HTTP_PROTOCOL_VERSION; | ||
| import static org.apache.flink.connector.aws.config.AWSConfigConstants.TRUST_ALL_CERTIFICATES; | ||
|
|
||
| /** IT cases for using {@code KinesisStreamsSource} using a localstack container. */ | ||
| @Testcontainers | ||
| @ExtendWith(MiniClusterExtension.class) | ||
| public class KinesisStreamsSourceITCase { | ||
|
|
||
| private static final Logger LOG = LoggerFactory.getLogger(KinesisStreamsSourceITCase.class); | ||
| private static final String LOCALSTACK_DOCKER_IMAGE_VERSION = "localstack/localstack:3.7.2"; | ||
|
|
||
| @Container | ||
| private static final LocalstackContainer MOCK_KINESIS_CONTAINER = | ||
| new LocalstackContainer(DockerImageName.parse(LOCALSTACK_DOCKER_IMAGE_VERSION)); | ||
|
|
||
| private StreamExecutionEnvironment env; | ||
| private SdkHttpClient httpClient; | ||
| private KinesisClient kinesisClient; | ||
|
|
||
| @BeforeEach | ||
| void setUp() { | ||
| System.setProperty(SdkSystemSetting.CBOR_ENABLED.property(), "false"); | ||
|
|
||
| env = StreamExecutionEnvironment.getExecutionEnvironment(); | ||
| env.setParallelism(1); | ||
|
|
||
| httpClient = AWSServicesTestUtils.createHttpClient(); | ||
| kinesisClient = | ||
| AWSServicesTestUtils.createAwsSyncClient( | ||
| MOCK_KINESIS_CONTAINER.getEndpoint(), httpClient, KinesisClient.builder()); | ||
| } | ||
|
|
||
| @AfterEach | ||
| void teardown() { | ||
| System.clearProperty(SdkSystemSetting.CBOR_ENABLED.property()); | ||
| AWSGeneralUtil.closeResources(httpClient, kinesisClient); | ||
| } | ||
|
|
||
| @Test | ||
| void nonExistentStreamShouldResultInFailure() { | ||
hlteoh37 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Assertions.assertThatExceptionOfType(RuntimeException.class) | ||
| .isThrownBy( | ||
| () -> | ||
| new Scenario() | ||
| .localstackStreamName("stream-exists") | ||
| .withSourceConnectionStreamArn( | ||
| "arn:aws:kinesis:ap-southeast-1:000000000000:stream/stream-not-exists") | ||
| .runScenario()) | ||
| .withStackTraceContaining( | ||
| "Stream arn arn:aws:kinesis:ap-southeast-1:000000000000:stream/stream-not-exists not found"); | ||
| } | ||
|
|
||
| @Test | ||
| void validStreamIsConsumed() throws Exception { | ||
| new Scenario() | ||
| .localstackStreamName("valid-stream") | ||
| .withSourceConnectionStreamArn( | ||
| "arn:aws:kinesis:ap-southeast-1:000000000000:stream/valid-stream") | ||
| .runScenario(); | ||
| } | ||
|
|
||
| private Configuration getDefaultConfiguration() { | ||
| Configuration configuration = new Configuration(); | ||
| configuration.setString(AWS_ENDPOINT, MOCK_KINESIS_CONTAINER.getEndpoint()); | ||
| configuration.setString(AWS_ACCESS_KEY_ID, "accessKeyId"); | ||
| configuration.setString(AWS_SECRET_ACCESS_KEY, "secretAccessKey"); | ||
| configuration.setString(AWS_REGION, Region.AP_SOUTHEAST_1.toString()); | ||
| configuration.setString(TRUST_ALL_CERTIFICATES, "true"); | ||
| configuration.setString(HTTP_PROTOCOL_VERSION, "HTTP1_1"); | ||
| return configuration; | ||
| } | ||
|
|
||
| private class Scenario { | ||
| private final int expectedElements = 1000; | ||
| private String localstackStreamName = null; | ||
| private String sourceConnectionStreamArn; | ||
| private final Configuration configuration = | ||
| KinesisStreamsSourceITCase.this.getDefaultConfiguration(); | ||
|
|
||
| public void runScenario() throws Exception { | ||
| if (localstackStreamName != null) { | ||
| prepareStream(localstackStreamName); | ||
| } | ||
|
|
||
| putRecords(localstackStreamName, expectedElements); | ||
|
|
||
| KinesisStreamsSource<String> kdsSource = | ||
| KinesisStreamsSource.<String>builder() | ||
| .setStreamArn(sourceConnectionStreamArn) | ||
| .setSourceConfig(configuration) | ||
| .setDeserializationSchema(new SimpleStringSchema()) | ||
| .build(); | ||
|
|
||
| List<String> result = | ||
| env.fromSource(kdsSource, WatermarkStrategy.noWatermarks(), "Kinesis source") | ||
| .returns(TypeInformation.of(String.class)) | ||
| .executeAndCollect(expectedElements); | ||
|
|
||
| Assertions.assertThat(result.size()).isEqualTo(expectedElements); | ||
| } | ||
|
|
||
| public Scenario withSourceConnectionStreamArn(String sourceConnectionStreamArn) { | ||
| this.sourceConnectionStreamArn = sourceConnectionStreamArn; | ||
| return this; | ||
| } | ||
|
|
||
| public Scenario localstackStreamName(String localstackStreamName) { | ||
| this.localstackStreamName = localstackStreamName; | ||
| return this; | ||
| } | ||
|
|
||
| private void prepareStream(String streamName) throws Exception { | ||
| final RateLimiter rateLimiter = | ||
| RateLimiterBuilder.newBuilder() | ||
| .withRate(1, SECONDS) | ||
| .withConstantThroughput() | ||
| .build(); | ||
|
|
||
| kinesisClient.createStream( | ||
| CreateStreamRequest.builder().streamName(streamName).shardCount(1).build()); | ||
|
|
||
| Deadline deadline = Deadline.fromNow(Duration.ofMinutes(1)); | ||
| while (!rateLimiter.getWhenReady(() -> streamExists(streamName))) { | ||
| if (deadline.isOverdue()) { | ||
| throw new RuntimeException("Failed to create stream within time"); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private void putRecords(String streamName, int numRecords) { | ||
| List<byte[]> messages = | ||
| IntStream.range(0, numRecords) | ||
| .mapToObj(String::valueOf) | ||
| .map(String::getBytes) | ||
| .collect(Collectors.toList()); | ||
|
|
||
| for (List<byte[]> partition : Lists.partition(messages, 500)) { | ||
| List<PutRecordsRequestEntry> entries = | ||
| partition.stream() | ||
| .map( | ||
| msg -> | ||
| PutRecordsRequestEntry.builder() | ||
| .partitionKey("fakePartitionKey") | ||
| .data(SdkBytes.fromByteArray(msg)) | ||
| .build()) | ||
| .collect(Collectors.toList()); | ||
| PutRecordsRequest requests = | ||
| PutRecordsRequest.builder().streamName(streamName).records(entries).build(); | ||
| PutRecordsResponse putRecordResult = kinesisClient.putRecords(requests); | ||
| for (PutRecordsResultEntry result : putRecordResult.records()) { | ||
| LOG.debug("Added record: {}", result.sequenceNumber()); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private boolean streamExists(final String streamName) { | ||
| try { | ||
| return kinesisClient | ||
| .describeStream( | ||
| DescribeStreamRequest.builder() | ||
| .streamName(streamName) | ||
| .build()) | ||
| .streamDescription() | ||
| .streamStatus() | ||
| == StreamStatus.ACTIVE; | ||
| } catch (Exception e) { | ||
| return false; | ||
| } | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do we test using s3? Can we use kinesis instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We are actually testing Kinesis only. The S3 dependency is required because the LocalStack container in the connector base arbitrarily creates an S3 bucket and lists its contents to test readiness. LocalstackContainer.java#L61-L83
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right - thanks!