[FLINK-8296] [kafka] Rework FlinkKafkaConsumerBaseTest to not rely on Java reflection #5188
Conversation
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
… Java reflection Reflection was mainly used to inject mocks into private fields of the FlinkKafkaConsumerBase, without the need to fully execute all operator life cycle methods. This, however, caused the unit tests to be too implementation-specific. This commit reworks the FlinkKafkaConsumerBaseTest to remove test consumer instantiation methods that rely on reflection for dependency injection. All tests now instantiate dummy test consumers normally, and let all tests properly execute all operator life cycle methods regardless of the tested logic.
This was referenced Dec 21, 2017
pnowojski
requested changes
Jan 8, 2018
| int subtaskIndex, | ||
| int totalNumSubtasks) throws Exception { | ||
|
|
||
| final StreamingRuntimeContext runtimeContext = Mockito.mock(StreamingRuntimeContext.class); |
There was a problem hiding this comment.
Please use here proper mock or throw new UnsupportedOperationException() for non supported (instead of returning nulls...). Probably you could extract/re-use one of the already existing logic for instantiating StreamingRuntimeContext (for example MockRuntimeContext or from SourceFunctionUtil)
| when(runtimeContext.getNumberOfParallelSubtasks()).thenReturn(totalNumSubtasks); | ||
| when(runtimeContext.getMetricGroup()).thenReturn(mock(MetricGroup.class)); | ||
|
|
||
| final OperatorStateStore operatorStateStore = mock(OperatorStateStore.class); |
There was a problem hiding this comment.
Same here, proper mock, or one with throwing UnsupportedOperationException
| // also mock the legacy 1.2 Kafka consumer state (return empty state) | ||
| when(operatorStateStore.getSerializableListState(Matchers.anyString())).thenReturn(new TestingListState<>()); | ||
|
|
||
| final FunctionInitializationContext initializationContext = Mockito.mock(FunctionInitializationContext.class); |
| public void testEitherWatermarkExtractor() { | ||
| try { | ||
| new DummyFlinkKafkaConsumer<>().assignTimestampsAndWatermarks((AssignerWithPeriodicWatermarks<Object>) null); | ||
| new DummyFlinkKafkaConsumer<String>(mock(AbstractFetcher.class), mock(AbstractPartitionDiscoverer.class), false) |
There was a problem hiding this comment.
add default constructor with mock(AbstractFetcher.class), mock(AbstractPartitionDiscoverer.class) parameters?
|
Thank you for the review @pnowojski! Have addressed your comments. |
pnowojski
reviewed
Jan 11, 2018
|
Thanks! Merging this ... |
tzulitai
added a commit
to tzulitai/flink
that referenced
this pull request
Jan 12, 2018
… Java reflection Reflection was mainly used to inject mocks into private fields of the FlinkKafkaConsumerBase, without the need to fully execute all operator life cycle methods. This, however, caused the unit tests to be too implementation-specific. This commit reworks the FlinkKafkaConsumerBaseTest to remove test consumer instantiation methods that rely on reflection for dependency injection. All tests now instantiate dummy test consumers normally, and let all tests properly execute all operator life cycle methods regardless of the tested logic. This closes apache#5188.
tzulitai
added a commit
to tzulitai/flink
that referenced
this pull request
Jan 13, 2018
… Java reflection Reflection was mainly used to inject mocks into private fields of the FlinkKafkaConsumerBase, without the need to fully execute all operator life cycle methods. This, however, caused the unit tests to be too implementation-specific. This commit reworks the FlinkKafkaConsumerBaseTest to remove test consumer instantiation methods that rely on reflection for dependency injection. All tests now instantiate dummy test consumers normally, and let all tests properly execute all operator life cycle methods regardless of the tested logic. This closes apache#5188.
glaksh100
pushed a commit
to lyft/flink
that referenced
this pull request
Jun 6, 2018
… Java reflection Reflection was mainly used to inject mocks into private fields of the FlinkKafkaConsumerBase, without the need to fully execute all operator life cycle methods. This, however, caused the unit tests to be too implementation-specific. This commit reworks the FlinkKafkaConsumerBaseTest to remove test consumer instantiation methods that rely on reflection for dependency injection. All tests now instantiate dummy test consumers normally, and let all tests properly execute all operator life cycle methods regardless of the tested logic. This closes apache#5188.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What is the purpose of the change
Prior to this PR, reflection was mainly used to inject mocks into private fields of the
FlinkKafkaConsumerBase, without the need to fully execute all operator life cycle methods.This was done using the
FlinkKafkaConsumerBaseTest::getConsumer(...)method (have been removed by this PR). This, however, caused the unit tests to be too implementation-specific and hard to extend.This PR reworks the
FlinkKafkaConsumerBaseTestto remove the reflection-basedFlinkKafkaConsumerBaseTest::getConsumer(...)method.All tests now instantiate the
DummyFlinkKafkaConsumernormally, and let all tests properly execute all operator life cycle methods regardless of the tested logic.Brief change log
FlinkKafkaConsumerBaseTest::getConsumer(...)method.DummyFlinkKafkaConsumerclassFlinkKafkaConsumerBaseTest::setupConsumer(...)method that iterates through all normal operator life cycle methods.FlinkKafkaConsumerBaseTestis now: 1) instantiate aDummyFlinkKafkaConsumer, and 2) callsetupConsumer(dummyConsumer)to make sure the consumer goes through all life cycle methods, and instance fields are properly instantiated (instead of relying on reflection like before).Verifying this change
Test coverage of the reworked
FlinkKafkaConsumerBaseTesthas not been touched.That unit test verifies this change.
Does this pull request potentially affect one of the following parts:
@Public(Evolving): noDocumentation