Fix flaky test in LogUtilTest.groovy

[KiruthikaJanakiraman]

I confirm that this contribution is made under the terms of the license found in the root directory of this repository's source tree and that I have the authority necessary to make this contribution on behalf of its copyright owner.

Problem

This PR aims to fix the flaky test: com.yahoo.parsec.logging.LogUtilTest."test generateLog with custom data object should return info contain custom json data"

parsec-libraries/parsec-logging/src/test/groovy/com/yahoo/parsec/logging/LogUtilTest.groovy

Lines 39 to 45 in 142bc4c

	def "test generateLog with custom data object should return info contain custom json data"() {
	when:
	def result = LogUtil.generateLog(null, null, null, new SimpleDataObject("key1", "value1"))
	then:
	result.matches(/.* timestamp=".+", log_data=\{"key":"key1","value":"value1"\}/)
	}

The above check fails as the order of the items in log_data varies upon non-determintic shuffling.

I found and confirmed the flaky behaviour of the test using an open-source research tool NonDex, which shuffles implementations of nondeterminism operations.

Solution

This PR fixes the test by checking for both possibilities of log_data.

parsec-libraries/parsec-logging/src/test/groovy/com/yahoo/parsec/logging/LogUtilTest.groovy

Line 44 in bec72f0

result.matches(/.* timestamp=".+", log_data=\{"key":"key1","value":"value1"\}/) || result.matches(/.* timestamp=".+", log_data=\{"value":"value1","key":"key1"\}/)

Steps to reproduce

The following command can be used to reproduce the assertion errors and verify the fix.

Integrate NonDex:

Add the following snippet to the top of the build.gradle in $PROJ_DIR:

plugins {
    id 'edu.illinois.nondex' version '2.1.1-1'
}

Append to build.gradle in $PROJ_DIR:

apply plugin: 'edu.illinois.nondex'

Execute Test with Gradle:

./gradlew test --info parsec-logging:test --tests=com.yahoo.parsec.logging.LogUtilTest."test generateLog with custom data object should return info contain custom json data"

Run NonDex:

./gradlew test --info parsec-logging:nondexTest --tests=com.yahoo.parsec.logging.LogUtilTest."test generateLog with custom data object should return info contain custom json data" --nondexRuns=50

Test Environment:

Java version "1.8.0_381"
macOS Venture Version 13.4.1 (22F82)

Please let me know if you have any concerns or questions.