[Bug]: Detected flaky test com.google.cloud.teleport.templates.TextToBigQueryStreamingTest.wrapBigQueryInsertErrorReturnsValidJSON in v1 module.

[Suraj-Vashista-BK]

Related Template(s)

TextToBigQueryStreamingTest

What happened?

Detected flaky test wrapBigQueryInsertErrorReturnsValidJSON in com.google.cloud.teleport.templates.TextToBigQueryStreamingTest

The following command was used to detect flakiness using nondex:

mvn  -pl v1  edu.illinois:nondex-maven-plugin:2.1.1:nondex -Dtest=com.google.cloud.teleport.templates.TextToBigQueryStreamingTest#wrapBigQueryInsertErrorReturnsValidJSON

nonDex detects flakiness in the lines

DataflowTemplates/v1/src/test/java/com/google/cloud/teleport/templates/TextToBigQueryStreamingTest.java

Lines 70 to 71 in 62335f6

	assertThat(actualOriginalPayload).isEqualTo(expected);
	assertThat(actualPayload).isEqualTo(expected);

With the error message

expected: {"age":20,"name":"Jane"}
but was : {"name":"Jane","age":20}

Explanation

The expected string is being calculated in the line

DataflowTemplates/v1/src/test/java/com/google/cloud/teleport/templates/TextToBigQueryStreamingTest.java

Line 62 in 62335f6

String expected = GSON.toJson(testPerson);

Here using GSON.toJson(testPerson), testPerson which is an object of type TestPerson is converted to a Json String. GSON internally serializes and this can lead to change in the order of the elements which causes non-determinism in the output string.

Proposed Fix
It is very tricky to compare strings when the order can be changed, hence In my fix, we use JsonParser.parseString() as shown below.

assertThat(JsonParser.parseString(actualOriginalPayload)).isEqualTo(JsonParser.parseString(expected)); 
assertThat(JsonParser.parseString(actualPayload)).isEqualTo(JsonParser.parseString(expected));

Here, the JsonParser returns a JsonObject of gson library itself, whose equals implementation is not order-sensitive.

Test Environment:

openjdk version "11.0.20.1"
Apache Maven 3.6.3
Ubuntu 20.04.6 LTS
Linux version 5.4.0-156-generic

Beam Version

Newer than 2.46.0

Relevant log output

Failures: 
TextToBigQueryStreamingTest.wrapBigQueryInsertErrorReturnsValidJSON:70 expected: {"age":20,"name":"Jane"}
but was : {"name":"Jane","age":20}

[github-actions]

Stale issue message

[github-actions]

This issue has been closed due to lack of activity. If you think that is incorrect, or the pull request requires review, you can revive the PR at any time.