fix flaky test

[Rette66]

Description

Fixed the flaky test when multiple attributes are specified it should examine all inside the AttributeSetTest class
Detected flaky test when setting an expectation as an object it should be serialized to json inside the DefaultMockServerTest class.
Detected flaky tests put /1, with missing item, should create item put /1, with existent item, should replace item get /1, with existent item, should return item get /, with one item, should return item get /, with multiple items, should return array inside the DefaultMockServerCrudTest class.

Root Cause

All tests mentioned above have been reported as flaky when run with the NonDex tool.

AttributeSetTest

when multiple attributes are specified it should examine all inside the AttributeSetTest class utilize Attribute and AttributeSet to perform test operation. However, groovy's AttributeSet does not guarantee the elements' order. Therefore, the indexOf() method will give different results based on the index of a3 at line 114.

kubernetes-client/junit/mockwebserver/src/test/groovy/io/fabric8/mockwebserver/crud/AttributeSetTest.groovy

Lines 109 to 114 in 56a6c2c

	AttributeSet selectorWithTwo = new AttributeSet(a2, a3);
	then:
	// Assert that the order is suitable for testing. The failing attribute should
	// be in the *second* position to ensure we're examining all the values of the selector
	assert new ArrayList<>(selectorWithTwo.attributes.values()).indexOf(a3) == 1;

DefaultMockServerTest

when setting an expectation as an object it should be serialized to json inside the DefaultMockServerTest class invokes the method clinent.newCall() which will return a response type result. Then convert this result to a string and compare it with the expected string. However, I guess the Response type will not guarantee elements order inside it. Therefore, converting Response to a string will generate a string that has a different order from the expected string.

kubernetes-client/junit/mockwebserver/src/test/groovy/io/fabric8/mockwebserver/DefaultMockServerTest.groovy

Lines 243 to 247 in 56a6c2c

	Response response1 = client.newCall(request).execute()
	then:
	assert response1.code() == 200
	assert response1.body().string() == "{\"id\":0,\"username\":\"root\",\"enabled\":true}"

DefaultMockServerCrudTest

Tests in this class have the same problem as the test in the DefaultMockServerTest class. Invoking to client.newCall() returns a Response type result that cannot guarantee a specific order for elements inside. Therefore, converting to a string will not generate the expected string.

kubernetes-client/junit/mockwebserver/src/test/groovy/io/fabric8/mockwebserver/DefaultMockServerCrudTest.groovy

Lines 84 to 89 in 56a6c2c

	def result = client.newCall(new Request.Builder().url(server.url("/")).build()).execute()
	then:
	assert result.code() == 200
	assert result.body().string() ==
	"[{\"id\":1,\"username\":\"user\",\"enabled\":true},{\"id\":2,\"username\":\"user-2\",\"enabled\":true}]"

To reproduce run:

mvn -pl junit/mockwebserver/ edu.illinois:nondex-maven-plugin:2.1.1:nondex -Dtest=<test_name>

Fix

AttributeSetTest

I fixed this test by creating a new LinkedHashSet to store Attribute. LinkedHashSet will guarantee the order of Attribute inside it.

DefaultMockServerTest & DefaultMockServerCrudTest

For tests in these two classes, a simple way to fix them is to create another Response object and assign expected data to the object. However, I cannot find any information about how to create a Response object and assign a value to it. Therefore, I can only discuss one possible solution here.

Key changed/added classes in this PR

• io.fabric8.mockwebserver.crud.AttributeSetTest

Type of change

• Bug fix (non-breaking change which fixes an issue)
• Feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change
• Chore (non-breaking change which doesn't affect codebase;
  test, version modification, documentation, etc.)

Checklist

• Code contributed by me aligns with current project license: Apache 2.0
• I Added CHANGELOG entry regarding this change
• I have implemented unit tests to cover my changes
• I have added/updated the javadocs and other documentation accordingly
• No new bugs, code smells, etc. in SonarCloud report
• I tested my code in Kubernetes
• I tested my code in OpenShift

[sonarqubecloud]

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud