Functional test AEPTestUtils update (part 3) #157

timkimadobe · 2024-06-11T22:02:43Z

Description

This PR updates the final part of functional test classes:

IdentityStateFunctionalTests.java
NetworkResponseHandlerFunctionalTests.java
NoConfigFunctionalTests.java
RestartFunctionalTests.java
SampleFunctionalTests.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.

…son APIs

…e local getJsonPayload method

…uration state is pending and not because the identity state is not set

* 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

…ngConfigurationState_expectEventsQueueIsBlocked to set an identity state beforehand

codecov · 2024-06-14T01:33:32Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (feature/functional-test-aeptestutils@0e03c6f). Learn more about missing BASE report.

Additional details and impacted files

@@                           Coverage Diff                           @@
##             feature/functional-test-aeptestutils     #157   +/-   ##
=======================================================================
  Coverage                                        ?   84.69%           
  Complexity                                      ?      407           
=======================================================================
  Files                                           ?       30           
  Lines                                           ?     1639           
  Branches                                        ?      237           
=======================================================================
  Hits                                            ?     1388           
  Misses                                          ?      160           
  Partials                                        ?       91

Flag	Coverage Δ
-tests	`84.69% <ø> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

cacheung · 2024-06-14T17:31:34Z

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

+			networkRequest.getBodyJson(),
+			new CollectionEqualCount(Subtree, "meta.state.entries"),
+			new AnyOrderMatch("meta.state.entries"),
+			new ElementCount(18, Subtree)


Do we need // Asserting body has 18 total key value elements here?

Added code comment!

cacheung · 2024-06-14T17:33:52Z

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

+			networkRequest.getBodyJson(),
+			new CollectionEqualCount(Subtree, "meta.state.entries"),
+			new AnyOrderMatch("meta.state.entries"),
+			new ElementCount(18, Subtree)


Do we need // Asserting body has 18 total key value elements here?

Added code comment!

addb · 2024-06-14T18:37:15Z

...e/src/androidTest/java/com/adobe/marketing/mobile/NetworkResponseHandlerFunctionalTests.java

+			"  \"title\": \"Failed to process personalization event\"," +
+			"  \"type\": \"personalization\"" +
+			"}";
+		JSONAsserts.assertEquals(expectedEventData2, dispatchEvents.get(1).getEventData());


assertEquals also compares agains the expected right? Does it atleast compare the size (no of keys) for both expected vs actual Also we could take scope into account?

I believe assertEquals should have 2 way equality by default and one simple addition would be to by default compare sizes to start with if we are not doing it currently.

Yes the logic for assertEquals requires exact equality between expected and actual:

keys/array values present must be equal (collection size equal)

values must be exactly equal (type + literal value)

So in this test case, the actual must be exactly equal to the expectation

timkimadobe

Thanks for the reviews @cacheung and @addb! Updated based on feedback

timkimadobe · 2024-06-18T20:57:23Z

...e/src/androidTest/java/com/adobe/marketing/mobile/NetworkResponseHandlerFunctionalTests.java

+			"  \"title\": \"Failed to process personalization event\"," +
+			"  \"type\": \"personalization\"" +
+			"}";
+		JSONAsserts.assertEquals(expectedEventData2, dispatchEvents.get(1).getEventData());


Yes the logic for assertEquals requires exact equality between expected and actual:

keys/array values present must be equal (collection size equal)

values must be exactly equal (type + literal value)

So in this test case, the actual must be exactly equal to the expectation

timkimadobe · 2024-06-18T20:59:32Z

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

+			networkRequest.getBodyJson(),
+			new CollectionEqualCount(Subtree, "meta.state.entries"),
+			new AnyOrderMatch("meta.state.entries"),
+			new ElementCount(18, Subtree)


Added code comment!

timkimadobe · 2024-06-18T21:00:19Z

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

+			networkRequest.getBodyJson(),
+			new CollectionEqualCount(Subtree, "meta.state.entries"),
+			new AnyOrderMatch("meta.state.entries"),
+			new ElementCount(18, Subtree)


Added code comment!

…nctional-test5

cacheung · 2024-06-18T23:54:50Z

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

@@ -56,6 +57,11 @@ public void setup() throws Exception {
 		resetTestExpectations();
 	}

+	@After
+	public void tearDown() {
+		mockNetworkService.reset();


do we need to update this to resetTestExpectation?

Thank you! Updated

* 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 12 commits June 11, 2024 14:59

Update IdentityStateFunctionalTests.java to use JSON comparison APIs

fba6682

Apply lint formatting to IdentityStateFunctionalTests.java

4e15bb4

Update NetworkResponseHandlerFunctionalTests.java to use JSON compari…

ee7eced

…son APIs

Apply lint formatting for NetworkResponseHandlerFunctionalTests.java

12b547e

Update NoConfigFunctionalTests.java to use JSON comparison APIs

9ab3f5e

Apply lint formatting for NoConfigFunctionalTests.java

4f2ec7a

Update RestartFunctionalTests.java to use AEPTestUtils

4e2547a

Apply lint formatting to RestartFunctionalTests.java

ff36317

Update SampleFunctionalTests.java to use JSON comparison APIs

0f0c8cd

Apply lint formatting for SampleFunctionalTests.java

30133ab

Update converted test classes to use TestableNetworkRequest and remov…

7517eb3

…e local getJsonPayload method

Add missing step to verify the request is not sent because the config…

470f92d

…uration state is pending and not because the identity state is not set

timkimadobe requested review from cacheung and addb June 13, 2024 21:04

timkimadobe added 4 commits June 13, 2024 17:01

Update AEPTestUtils to latest version

72fb697

Update test case setup for testHandleExperienceEventRequest_withPendi…

4f97907

…ngConfigurationState_expectEventsQueueIsBlocked to set an identity state beforehand

Apply lint formatting for NoConfigFunctionalTests.java

2c1a360

cacheung reviewed Jun 14, 2024

View reviewed changes

addb reviewed Jun 14, 2024

View reviewed changes

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

Add test case comments for clarity

3224028

timkimadobe commented Jun 18, 2024

View reviewed changes

Merge branch 'feature/functional-test-aeptestutils' into testutils-fu…

877108e

…nctional-test5

timkimadobe requested review from cacheung and addb June 18, 2024 21:35

cacheung approved these changes Jun 18, 2024

View reviewed changes

cacheung reviewed Jun 18, 2024

View reviewed changes

RestartFunctionalTests.java - update tearDown to reset all test helpers

a22da4d

timkimadobe merged commit 733df31 into adobe:feature/functional-test-aeptestutils Jun 19, 2024
8 checks passed

timkimadobe deleted the testutils-functional-test5 branch June 19, 2024 00:32

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 3) #157

Functional test AEPTestUtils update (part 3) #157

timkimadobe commented Jun 11, 2024 •

edited

Loading

codecov bot commented Jun 14, 2024 •

edited

Loading

cacheung Jun 14, 2024

timkimadobe Jun 18, 2024

cacheung Jun 14, 2024

timkimadobe Jun 18, 2024

addb Jun 14, 2024

addb Jun 14, 2024

timkimadobe Jun 18, 2024

timkimadobe left a comment

timkimadobe Jun 18, 2024

timkimadobe Jun 18, 2024

timkimadobe Jun 18, 2024

cacheung Jun 18, 2024

timkimadobe Jun 19, 2024

Functional test AEPTestUtils update (part 3) #157

Functional test AEPTestUtils update (part 3) #157

Conversation

timkimadobe commented Jun 11, 2024 • edited Loading

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

codecov bot commented Jun 14, 2024 • edited Loading

Codecov Report

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

timkimadobe commented Jun 11, 2024 •

edited

Loading

codecov bot commented Jun 14, 2024 •

edited

Loading