mihirgune opened a new pull request, #25486:
URL: https://github.com/apache/flink/pull/25486
<!--
*Thank you very much for contributing to Apache Flink - we are happy that
you want to help us improve Flink. To help the community review your
contribution in the best possible way, please go through the checklist below,
which will get the contribution into a shape in which it can be best reviewed.*
*Please understand that we do not do this to make contributions to Flink a
hassle. In order to uphold a high standard of quality for code contributions,
while at the same time managing a large number of contributions, we need
contributors to prepare the contributions well, and give reviewers enough
contextual information for the review. Please also understand that
contributions that do not follow this guide will take longer to review and thus
typically be picked up with lower priority by the community.*
## Contribution Checklist
- Make sure that the pull request corresponds to a [JIRA
issue](https://issues.apache.org/jira/projects/FLINK/issues). Exceptions are
made for typos in JavaDoc or documentation files, which need no JIRA issue.
- Name the pull request in the form "[FLINK-XXXX] [component] Title of the
pull request", where *FLINK-XXXX* should be replaced by the actual issue
number. Skip *component* if you are unsure about which is the best component.
Typo fixes that have no associated JIRA issue should be named following
this pattern: `[hotfix] [docs] Fix typo in event time introduction` or
`[hotfix] [javadocs] Expand JavaDoc for PuncuatedWatermarkGenerator`.
- Fill out the template below to describe the changes contributed by the
pull request. That will give reviewers the context they need to do the review.
- Make sure that the change passes the automated tests, i.e., `mvn clean
verify` passes. You can set up Azure Pipelines CI to do that following [this
guide](https://cwiki.apache.org/confluence/display/FLINK/Azure+Pipelines#AzurePipelines-Tutorial:SettingupAzurePipelinesforaforkoftheFlinkrepository).
- Each pull request should address only one issue, not mix up code from
multiple issues.
- Each commit in the pull request has a meaningful commit message
(including the JIRA id)
- Once all items of the checklist are addressed, remove the above text and
this checklist, leaving only the filled out template below.
**(The sections below can be removed for hotfixes of typos)**
-->
## What is the purpose of the change
This fix is intended to fix flaky tests in the following classes -
-
`org.apache.flink.table.planner.hint.ClearJoinHintsWithCapitalizeQueryHintsShuttleTest`
-
`org.apache.flink.table.planner.hint.ClearLookupJoinHintsWithInvalidPropagationShuttleTest`
For example, when the following command is run on one of these tests using
the Nondex plugin -
`mvn -pl flink-table/flink-table-planner
edu.illinois:nondex-maven-plugin:2.1.7:nondex
-Dtest=org.apache.flink.table.planner.hint.ClearJoinHintsWithCapitalizeQueryHintsShuttleTest
`This error is thrown.
```
[ERROR]
ClearJoinHintsWithCapitalizeQueryHintsShuttleTest.testClearCaseInsensitiveLookupHint:133->ClearQueryHintsWithInvalidPropagationShuttleTestBase.verifyRelPlan:142
afterPropagatingHints ==> expected: <
LogicalProject(a=[$0], hints=[[[ALIAS options:[t1]]]]),
rowType=[RecordType(BIGINT a)]
+- LogicalCorrelate(correlation=[$cor0], joinType=[inner],
requiredColumns=[{0, 1}], joinHints=[[[lookUp inheritPath:[0]
options:{async=true, output-mode=allow_unordered, table=d, timeout=300 s,
capacity=1000}]]], hints=[[[ALIAS inheritPath:[0] options:[t1]]]]),
rowType=[RecordType(BIGINT a, TIMESTAMP_LTZ(3) *PROCTIME* pts, BIGINT a0)]
:- LogicalProject(a=[$0], pts=[PROCTIME()]), rowType=[RecordType(BIGINT
a, TIMESTAMP_LTZ(3) *PROCTIME* pts)]
: +- LogicalTableScan(table=[[builtin, default, src]]),
rowType=[RecordType(BIGINT a)]
+- LogicalFilter(condition=[=($cor0.a, $0)]), rowType=[RecordType(BIGINT
a)]
+- LogicalSnapshot(period=[PROCTIME()]), rowType=[RecordType(BIGINT a)]
+- LogicalTableScan(table=[[builtin, default, lookup]]),
rowType=[RecordType(BIGINT a)]
> but was: <
LogicalProject(a=[$0], hints=[[[ALIAS options:[t1]]]]),
rowType=[RecordType(BIGINT a)]
+- LogicalCorrelate(correlation=[$cor0], joinType=[inner],
requiredColumns=[{0, 1}], joinHints=[[[lookUp inheritPath:[0] options:{table=d,
timeout=300 s, capacity=1000, output-mode=allow_unordered, async=true}]]],
hints=[[[ALIAS inheritPath:[0] options:[t1]]]]), rowType=[RecordType(BIGINT a,
TIMESTAMP_LTZ(3) *PROCTIME* pts, BIGINT a0)]
:- LogicalProject(a=[$0], pts=[PROCTIME()]), rowType=[RecordType(BIGINT
a, TIMESTAMP_LTZ(3) *PROCTIME* pts)]
: +- LogicalTableScan(table=[[builtin, default, src]]),
rowType=[RecordType(BIGINT a)]
+- LogicalFilter(condition=[=($cor0.a, $0)]), rowType=[RecordType(BIGINT
a)]
+- LogicalSnapshot(period=[PROCTIME()]), rowType=[RecordType(BIGINT a)]
+- LogicalTableScan(table=[[builtin, default, lookup]]),
rowType=[RecordType(BIGINT a)]
```
This flakiness presents itself because the test is doing a direct string
comparison over String forms of objects. Since the hintOptions required for
these tests are stored in a map
(`org.apache.flink.table.planner.plan.nodes.exec.spec.LookupJoinHintTestUtil#getLookupJoinHintOptions`),
their ordering is non-deterministic, and thus leads to these tests
intermittently failing. Furthermore, the examples that were used to compare
these tests with (in files
`flink-table/flink-table-planner/src/test/resources/org/apache/flink/table/planner/hint/ClearJoinHintsWithCapitalizeQueryHintsShuttleTest.xml`
and
`flink-table/flink-table-planner/src/test/resources/org/apache/flink/table/planner/hint/ClearJoinHintsWithCapitalizeQueryHintsShuttleTest.xml`
do not have consistent ordering for hintOptions.
The following tests have been fixed with this change -
-
`org.apache.flink.table.planner.hint.ClearJoinHintsWithCapitalizeQueryHintsShuttleTest#testClearCaseInsensitiveLookupHint`
-
`org.apache.flink.table.planner.hint.ClearLookupJoinHintsWithInvalidPropagationShuttleTest#testNoNeedToClearLookupHint`
-
`org.apache.flink.table.planner.hint.ClearLookupJoinHintsWithInvalidPropagationShuttleTest#testClearLookupHintWithInvalidPropagationToSubQuery`
-
`org.apache.flink.table.planner.hint.ClearLookupJoinHintsWithInvalidPropagationShuttleTest#testNoNeedToClearLookupHintWhileJoinWithUnnest`
-
`org.apache.flink.table.planner.hint.ClearLookupJoinHintsWithInvalidPropagationShuttleTest#testNoNeedToClearLookupHintWhileJoinWithUDTF`
## Brief change log
- To fix the flakiness in these tests, the hint options
(`org.apache.flink.table.planner.plan.nodes.exec.spec.LookupJoinHintTestUtil#getLookupJoinHintOptions`)
have been changed to use a LinkedHashMap instead of a HashMap, which will
preserve insertion order.
- The test files
`flink-table/flink-table-planner/src/test/resources/org/apache/flink/table/planner/hint/ClearJoinHintsWithCapitalizeQueryHintsShuttleTest.xml`
and
`flink-table/flink-table-planner/src/test/resources/org/apache/flink/table/planner/hint/ClearLookupJoinHintsWithInvalidPropagationShuttleTest.xml`
have been amended to have a consistent ordering for hint options.
## Verifying this change
Please make sure both new and modified tests in this PR follow [the
conventions for tests defined in our code quality
guide](https://flink.apache.org/how-to-contribute/code-style-and-quality-common/#7-testing).
This change added tests and can be verified as follows:
- *Fixed test cases that relied on non-deterministic aspects of a data
structure - the ordering within a map and made them reliable.*
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): (no)
- The public API, i.e., is any changed class annotated with
`@Public(Evolving)`: (no)
- The serializers: (no)
- The runtime per-record code paths (performance sensitive): (no)
- Anything that affects deployment or recovery: JobManager (and its
components), Checkpointing, Kubernetes/Yarn, ZooKeeper: (no)
- The S3 file system connector: (no)
## Documentation
- Does this pull request introduce a new feature? (no)
- If yes, how is the feature documented? (not applicable)
--
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]
