Functional test AEPTestUtils update (part 2) #156

timkimadobe · 2024-06-07T23:57:46Z

Description

This PR updates the second part of functional test classes:

EdgeFunctionalTests.java
EdgePathOverwriteTests.java

to use the AEPTestUtils library, with the following changes:

Map equality logic is updated to use JSON comparison APIs
Remove usages of Map/bytes flatten
Remove local versions of test util classes
Make sure Java collection .get() is protected with size checks
Update to use TestableNetworkRequest from NetworkService methods

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

I have signed the Adobe Open Source CLA.
My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

Replace local getPayloadJson method and usages

Replace usage of local getPayloadJson

addb · 2024-06-08T00:00:52Z

code/edge/src/androidTest/java/com/adobe/marketing/mobile/EdgeFunctionalTests.java

-		Map<String, String> flattenedData = TestUtils.flattenMap(eventData);
-		assertEquals(1, flattenedData.size());
-		assertEquals("xdm", flattenedData.get("xdm.testString"));
+		String expected = "{" + "  \"xdm\": {" + "    \"testString\": \"xdm\"" + "  }" + "}";


can we update the value to something like "testValue" instead of "xdm"

Yes! Updated

…to update testValue for clarity

…iteTests.java

addb

Looks good. Have put some nit comments.

addb · 2024-06-08T00:13:07Z

code/edge/src/androidTest/java/com/adobe/marketing/mobile/EdgeFunctionalTests.java

+		String expected =
+			"{" +
+			"  \"xdm\": {" +
+			"    \"testString\": \"xdm\"," +


nit: "testString": "stringValue"

addb · 2024-06-08T00:13:15Z

code/edge/src/androidTest/java/com/adobe/marketing/mobile/EdgeFunctionalTests.java

+		String expected =
+			"{" +
+			"  \"xdm\": {" +
+			"    \"testString\": \"xdm\"" +


nit: "testString": "stringValue"

Updated! However, in this case do we want to make the value under XDM distinct from the one under data?

code/edge/src/androidTest/java/com/adobe/marketing/mobile/EdgeFunctionalTests.java

addb · 2024-06-08T00:14:09Z

code/edge/src/androidTest/java/com/adobe/marketing/mobile/EdgeFunctionalTests.java

-		Map<String, String> flattenedData = TestUtils.flattenMap(eventData);
-		assertEquals(1, flattenedData.size());
-		assertEquals("xdm", flattenedData.get("xdm.testString"));
+		String expected = "{\"xdm\": {\"testString\": \"testValue\"}}";


nit: "testString": "stringValue"

addb · 2024-06-08T00:15:38Z

code/edge/src/androidTest/java/com/adobe/marketing/mobile/EdgeFunctionalTests.java

+			"        \"testMap\": {" +
+			"          \"key\": \"value\"" +
+			"        }," +
+			"        \"testString\": \"xdmValue\"," +


nit: "testString": "stringValue"

addb · 2024-06-08T00:25:07Z

code/edge/src/androidTest/java/com/adobe/marketing/mobile/EdgeFunctionalTests.java

+			"      }," +
+			"      \"xdm\": {" +
+			"        \"_id\": \"STRING_TYPE\"," +
+			"        \"boolObject\": true," +


nit: make it same as testString, testBool, testInt ?

In this case, in order to do a proper type match, the expected value does need to be the actual type being matched (that is, an actual Bool, actual Int etc)

"STRING_TYPE" is more of a convention to make it more clear from looking at the expected JSON that we are not looking for a specific String value, but just matching type; but this is not determined from the "STRING_TYPE" value itself, rather the ValueTypeMatch with the paths specified

I actually mean the keys. Everywhere we have keys in format "testString", "testBool", here we have "boolObject", "doubleObject" etc...

Oh I see, that's a great point! Will update to use these for the key names, thanks Arjun

timkimadobe

Thanks for the review @addb! Updated based on feedback
I also updated the EdgePathOverwriteTests.java cases to use the "stringValue" as well

timkimadobe · 2024-06-08T00:39:08Z

code/edge/src/androidTest/java/com/adobe/marketing/mobile/EdgeFunctionalTests.java

+		String expected =
+			"{" +
+			"  \"xdm\": {" +
+			"    \"testString\": \"xdm\"" +


Updated! However, in this case do we want to make the value under XDM distinct from the one under data?

timkimadobe · 2024-06-08T00:39:09Z

code/edge/src/androidTest/java/com/adobe/marketing/mobile/EdgeFunctionalTests.java

+		String expected =
+			"{" +
+			"  \"xdm\": {" +
+			"    \"testString\": \"xdm\"," +


code/edge/src/androidTest/java/com/adobe/marketing/mobile/EdgeFunctionalTests.java

timkimadobe · 2024-06-08T00:39:49Z

code/edge/src/androidTest/java/com/adobe/marketing/mobile/EdgeFunctionalTests.java

-		Map<String, String> flattenedData = TestUtils.flattenMap(eventData);
-		assertEquals(1, flattenedData.size());
-		assertEquals("xdm", flattenedData.get("xdm.testString"));
+		String expected = "{\"xdm\": {\"testString\": \"testValue\"}}";


timkimadobe · 2024-06-08T00:39:53Z

code/edge/src/androidTest/java/com/adobe/marketing/mobile/EdgeFunctionalTests.java

+			"        \"testMap\": {" +
+			"          \"key\": \"value\"" +
+			"        }," +
+			"        \"testString\": \"xdmValue\"," +


timkimadobe · 2024-06-08T00:42:24Z

code/edge/src/androidTest/java/com/adobe/marketing/mobile/EdgeFunctionalTests.java

+			"      }," +
+			"      \"xdm\": {" +
+			"        \"_id\": \"STRING_TYPE\"," +
+			"        \"boolObject\": true," +


In this case, in order to do a proper type match, the expected value does need to be the actual type being matched (that is, an actual Bool, actual Int etc)

"STRING_TYPE" is more of a convention to make it more clear from looking at the expected JSON that we are not looking for a specific String value, but just matching type; but this is not determined from the "STRING_TYPE" value itself, rather the ValueTypeMatch with the paths specified

code/edge/src/androidTest/java/com/adobe/marketing/mobile/EdgeFunctionalTests.java

addb · 2024-06-11T22:05:11Z

code/edge/src/androidTest/java/com/adobe/marketing/mobile/EdgeFunctionalTests.java

@@ -796,8 +916,7 @@ public void testSendEvent_twoConsecutiveCalls_appendsReceivedClientSideStore() t
 			TIMEOUT_MILLIS
 		);
 		assertEquals(1, resultRequests.size());
-		Map<String, String> requestBody = mockNetworkService.getFlattenedNetworkRequestBody(resultRequests.get(0));
-		assertEquals("Expected request body with 12 elements, but found: " + requestBody, 12, requestBody.size());
+		assertTypeMatch("{}", resultRequests.get(0).getBodyJson(), new ElementCount(12, Subtree));


nit: Should we add comments. Asserting body has 12 elements (kv)

…roperty names Add code comments for ElementCount cases to make assertion logic clearer

…yloads

* Update EdgeFunctionalTests.java to use AEPTestUtils * Apply lint formatting to EdgeFunctionalTests.java * Update EdgePathOverwriteTests.java to use JSON comparison APIs * Apply lint formatting for EdgePathOverwriteTests.java * Update EdgeFunctionalTests.java to use TestableNetworkRequest Replace local getPayloadJson method and usages * Update EdgePathOverwriteTests.java to use TestableNetworkRequest Replace usage of local getPayloadJson * Update testSendEvent_withXDMDataAndNullData_sendsCorrectRequestEvent to update testValue for clarity * Apply lint formatting for EdgeFunctionalTests.java and EdgePathOverwriteTests.java * Update to use stringValue for test case strings in event payloads * Update EdgeFunctionalTests and TestXDMSchema to use "test" prefixed property names Add code comments for ElementCount cases to make assertion logic clearer * Remove test case comments for JSON assertions with actual expected payloads

* Update IdentityStateFunctionalTests.java to use JSON comparison APIs * Apply lint formatting to IdentityStateFunctionalTests.java * Update NetworkResponseHandlerFunctionalTests.java to use JSON comparison APIs * Apply lint formatting for NetworkResponseHandlerFunctionalTests.java * Update NoConfigFunctionalTests.java to use JSON comparison APIs * Apply lint formatting for NoConfigFunctionalTests.java * Update RestartFunctionalTests.java to use AEPTestUtils * Apply lint formatting to RestartFunctionalTests.java * Update SampleFunctionalTests.java to use JSON comparison APIs * Apply lint formatting for SampleFunctionalTests.java * Update converted test classes to use TestableNetworkRequest and remove local getJsonPayload method * Add missing step to verify the request is not sent because the configuration state is pending and not because the identity state is not set * Functional test AEPTestUtils update (part 2) (#156) * Update EdgeFunctionalTests.java to use AEPTestUtils * Apply lint formatting to EdgeFunctionalTests.java * Update EdgePathOverwriteTests.java to use JSON comparison APIs * Apply lint formatting for EdgePathOverwriteTests.java * Update EdgeFunctionalTests.java to use TestableNetworkRequest Replace local getPayloadJson method and usages * Update EdgePathOverwriteTests.java to use TestableNetworkRequest Replace usage of local getPayloadJson * Update testSendEvent_withXDMDataAndNullData_sendsCorrectRequestEvent to update testValue for clarity * Apply lint formatting for EdgeFunctionalTests.java and EdgePathOverwriteTests.java * Update to use stringValue for test case strings in event payloads * Update EdgeFunctionalTests and TestXDMSchema to use "test" prefixed property names Add code comments for ElementCount cases to make assertion logic clearer * Remove test case comments for JSON assertions with actual expected payloads * Update AEPTestUtils to latest version * Update test case setup for testHandleExperienceEventRequest_withPendingConfigurationState_expectEventsQueueIsBlocked to set an identity state beforehand * Apply lint formatting for NoConfigFunctionalTests.java * Add test case comments for clarity * RestartFunctionalTests.java - update tearDown to reset all test helpers

* Functional test AEPTestUtils update (part 1) (#155) * Replace local test utils with AEPTestUtils * Update ConfigOverridesFunctionalTests.kt to use AEPTestUtils * Remove local test-utils files * Update CompletionHandlerFunctionalTests.java to use AEPTestUtils * Update ConsentStatusChangeFunctionalTests.java to use AEPTestUtils Apply lint formatting * Update ConfigOverridesFunctionalTests.kt to use static assertExactMatch * Update AEPTestUtils to the latest version * Remove unconverted functional tests * Revert "Remove unconverted functional tests" This reverts commit 2d0013a. * Update AEPTestUtils to latest version * Update CompletionHandlerFunctionalTests.java to use TestableNetworkRequest * Update ConsentStatusChangeFunctionalTests.java to use TestableNetworkRequest type Update list get operations to safe versions * Update ConsentStatusChangeFunctionalTests.java to use TestableNetworkRequest * ConsentStatusChangeFunctionalTests.java add collection size check before access * Remove Long conversion for result list size check in ConfigOverridesFunctionalTests.kt * Functional test AEPTestUtils update (part 2) (#156) * Update EdgeFunctionalTests.java to use AEPTestUtils * Apply lint formatting to EdgeFunctionalTests.java * Update EdgePathOverwriteTests.java to use JSON comparison APIs * Apply lint formatting for EdgePathOverwriteTests.java * Update EdgeFunctionalTests.java to use TestableNetworkRequest Replace local getPayloadJson method and usages * Update EdgePathOverwriteTests.java to use TestableNetworkRequest Replace usage of local getPayloadJson * Update testSendEvent_withXDMDataAndNullData_sendsCorrectRequestEvent to update testValue for clarity * Apply lint formatting for EdgeFunctionalTests.java and EdgePathOverwriteTests.java * Update to use stringValue for test case strings in event payloads * Update EdgeFunctionalTests and TestXDMSchema to use "test" prefixed property names Add code comments for ElementCount cases to make assertion logic clearer * Remove test case comments for JSON assertions with actual expected payloads * Functional test AEPTestUtils update (part 3) (#157) * Update IdentityStateFunctionalTests.java to use JSON comparison APIs * Apply lint formatting to IdentityStateFunctionalTests.java * Update NetworkResponseHandlerFunctionalTests.java to use JSON comparison APIs * Apply lint formatting for NetworkResponseHandlerFunctionalTests.java * Update NoConfigFunctionalTests.java to use JSON comparison APIs * Apply lint formatting for NoConfigFunctionalTests.java * Update RestartFunctionalTests.java to use AEPTestUtils * Apply lint formatting to RestartFunctionalTests.java * Update SampleFunctionalTests.java to use JSON comparison APIs * Apply lint formatting for SampleFunctionalTests.java * Update converted test classes to use TestableNetworkRequest and remove local getJsonPayload method * Add missing step to verify the request is not sent because the configuration state is pending and not because the identity state is not set * Functional test AEPTestUtils update (part 2) (#156) * Update EdgeFunctionalTests.java to use AEPTestUtils * Apply lint formatting to EdgeFunctionalTests.java * Update EdgePathOverwriteTests.java to use JSON comparison APIs * Apply lint formatting for EdgePathOverwriteTests.java * Update EdgeFunctionalTests.java to use TestableNetworkRequest Replace local getPayloadJson method and usages * Update EdgePathOverwriteTests.java to use TestableNetworkRequest Replace usage of local getPayloadJson * Update testSendEvent_withXDMDataAndNullData_sendsCorrectRequestEvent to update testValue for clarity * Apply lint formatting for EdgeFunctionalTests.java and EdgePathOverwriteTests.java * Update to use stringValue for test case strings in event payloads * Update EdgeFunctionalTests and TestXDMSchema to use "test" prefixed property names Add code comments for ElementCount cases to make assertion logic clearer * Remove test case comments for JSON assertions with actual expected payloads * Update AEPTestUtils to latest version * Update test case setup for testHandleExperienceEventRequest_withPendingConfigurationState_expectEventsQueueIsBlocked to set an identity state beforehand * Apply lint formatting for NoConfigFunctionalTests.java * Add test case comments for clarity * RestartFunctionalTests.java - update tearDown to reset all test helpers

timkimadobe added 6 commits June 7, 2024 16:31

Update EdgeFunctionalTests.java to use AEPTestUtils

aa376aa

Apply lint formatting to EdgeFunctionalTests.java

dc1c9d3

Update EdgePathOverwriteTests.java to use JSON comparison APIs

55e012b

Apply lint formatting for EdgePathOverwriteTests.java

18df84b

Update EdgeFunctionalTests.java to use TestableNetworkRequest

a994baa

Replace local getPayloadJson method and usages

Update EdgePathOverwriteTests.java to use TestableNetworkRequest

fcfd692

Replace usage of local getPayloadJson

timkimadobe requested review from addb and cacheung June 7, 2024 23:58

addb reviewed Jun 8, 2024

View reviewed changes

timkimadobe added 2 commits June 7, 2024 17:07

Update testSendEvent_withXDMDataAndNullData_sendsCorrectRequestEvent …

35af640

…to update testValue for clarity

Apply lint formatting for EdgeFunctionalTests.java and EdgePathOverwr…

5e09f9e

…iteTests.java

addb approved these changes Jun 8, 2024

View reviewed changes

timkimadobe commented Jun 8, 2024

View reviewed changes

Update to use stringValue for test case strings in event payloads

56a388d

cacheung reviewed Jun 10, 2024

View reviewed changes

code/edge/src/androidTest/java/com/adobe/marketing/mobile/EdgeFunctionalTests.java Show resolved Hide resolved

addb reviewed Jun 11, 2024

View reviewed changes

cacheung approved these changes Jun 11, 2024

View reviewed changes

timkimadobe added 2 commits June 11, 2024 15:30

Update EdgeFunctionalTests and TestXDMSchema to use "test" prefixed p…

8b75ecd

…roperty names Add code comments for ElementCount cases to make assertion logic clearer

Remove test case comments for JSON assertions with actual expected pa…

b5800b6

…yloads

addb approved these changes Jun 12, 2024

View reviewed changes

timkimadobe merged commit 0e03c6f into adobe:feature/functional-test-aeptestutils Jun 13, 2024
4 of 6 checks passed

timkimadobe deleted the testutils-functional-test4 branch June 13, 2024 21:04

emdobrin linked an issue Jun 14, 2024 that may be closed by this pull request

Refactor functional and integration tests to use new test utils #127

Closed

timkimadobe mentioned this pull request Jun 19, 2024

Functional test AEPTestUtils update #159

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Functional test AEPTestUtils update (part 2) #156

Functional test AEPTestUtils update (part 2) #156

timkimadobe commented Jun 7, 2024

addb Jun 8, 2024

timkimadobe Jun 8, 2024

addb left a comment

addb Jun 8, 2024

timkimadobe Jun 8, 2024

addb Jun 8, 2024

timkimadobe Jun 8, 2024

addb Jun 8, 2024

timkimadobe Jun 8, 2024

addb Jun 8, 2024

timkimadobe Jun 8, 2024

addb Jun 8, 2024

timkimadobe Jun 8, 2024

addb Jun 11, 2024

timkimadobe Jun 11, 2024

timkimadobe left a comment

timkimadobe Jun 8, 2024

timkimadobe Jun 8, 2024

timkimadobe Jun 8, 2024

timkimadobe Jun 8, 2024

timkimadobe Jun 8, 2024

addb Jun 11, 2024 •

edited

Loading

Functional test AEPTestUtils update (part 2) #156

Functional test AEPTestUtils update (part 2) #156

Conversation

timkimadobe commented Jun 7, 2024

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

addb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timkimadobe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

addb Jun 11, 2024 • edited Loading

Choose a reason for hiding this comment

addb Jun 11, 2024 •

edited

Loading