Fix flaky test for TestAzureLogAnalyticsProvenanceReportingTask.testAddField2 in dir nifi-nar-bundles/nifi-azure-bundle/nifi-azure-reporting-task by LinkedHashMap #1
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.
The problem occurs at the method
TestAzureLogAnalyticsProvenanceReportingTask.testAddField2, which compares twoJsonobjectafter callingtoString()method. OneJsonobjectisexpectedJson, which is generated by a hardcodedString expectedjsonStringwith a fixed sequence of JSON fields. AnotherJsonobjectisactualJson, which by passing HashMap as a parameter to the methodAzureLogAnalyticsProvenanceReportingTask.addField. This method will add entries of the map to theJsonObjectBuilder builder, thenactualJsonis generated by callingbuilder.build().The flaky test exists since the HashMap is non-deterministic or unordered, so the sequence of adding entries to
builderis non-deterministic. Thus,assertEquals(expectedJson.toString(), actualJson.toString());could result some tests fail.The solution is changing
HashMaptoLinkedHashMap, an ordered map, and then adding entries by order.This PR uses LinkedHashMap to make the
testAddField2deterministic.The reason that it may be accepted by open-source developers is that I only changed a couple of lines in the test method, without changing any main code. The functioning of the whole project will work as before. Also, I only imported the
LinkedHashMapfromjava.utilpackage, which will not affect the security of the codebase from my view.