Integration test AEPTestUtils migration #158

timkimadobe · 2024-06-13T23:31:02Z

Description

This PR updates the integration test classes:

ConfigOverridesIntegrationTests.kt
UpstreamIntegrationTests.kt

to use the AEPTestUtils library, with the following changes:

Replace local test helper classes with AEPTestUtils versions
Update usages of JSON comparison APIs to reflect:
1. Automatic conversion of common types into JSONObject/JSONArray - removing manual conversion
2. Migrating usage of legacy APIs typeMatchPaths and exactMatchPaths
Code style updates
2. JUnit assertEquals is imported directly
3. assertExactMatch and assertTypeMatch from JSON comparison is imported directly
4. Remove .trimIndent() from JSON strings
5. Remove JSON suffix from var names
6. Use "STRING_TYPE" convention in expected JSON strings to make value type match intent clearer

Specific changes:

testSendEvent_withPriorState_receivesExpectedStateStoreEventHandle: Added event expectation to test setup to properly await event processing before beginning test logic

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.

…rtEquals Import the junit.Assert.assertEquals method so prefix is not required

…icitly use AnyOrderMatch where required Fix testSendEvent_withPriorState_receivesExpectedStateStoreEventHandle test setup by adding expectation assertion

…idDatastreamIdOverride_receivesErrorResponse

codecov · 2024-06-13T23:44:38Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (dev@a6ebbe7). Learn more about missing BASE report.

Additional details and impacted files

@@          Coverage Diff           @@
##             dev     #158   +/-   ##
======================================
  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-14T00:18:29Z

...src/androidTest/java/com/adobe/marketing/mobile/edge/integration/UpstreamIntegrationTests.kt

-                expected = JSONObject(expectedLocationHintJSON),
-                actual = JSONObject(locationHintResult.eventData),
-                exactMatchPaths = listOf("payload[*].scope", "payload[*].hint")
+            assertTypeMatch(


As discussed, we can do assertExactMatch here and typeMatch the "payload[*].ttlSeconds".

Thank you! Updated

cacheung · 2024-06-14T00:22:58Z

...src/androidTest/java/com/adobe/marketing/mobile/edge/integration/UpstreamIntegrationTests.kt

-            expected = JSONObject(expectedLocationHintJSON),
-            actual = JSONObject(locationHintResult.eventData),
-            exactMatchPaths = listOf("payload[*].scope")
+        assertTypeMatch(


As discussed, we can do assertExactMatch here and typeMatch the "payload[*].ttlSeconds".

I think in this case we should be ok to keep typeMatch here since 2/3 properties use type match

I am fine with this.

timkimadobe

Thanks for the review @cacheung! Updated based on feedback

timkimadobe · 2024-06-14T00:38:06Z

...src/androidTest/java/com/adobe/marketing/mobile/edge/integration/UpstreamIntegrationTests.kt

-            expected = JSONObject(expectedLocationHintJSON),
-            actual = JSONObject(locationHintResult.eventData),
-            exactMatchPaths = listOf("payload[*].scope")
+        assertTypeMatch(


I think in this case we should be ok to keep typeMatch here since 2/3 properties use type match

timkimadobe · 2024-06-14T00:38:27Z

...src/androidTest/java/com/adobe/marketing/mobile/edge/integration/UpstreamIntegrationTests.kt

-                expected = JSONObject(expectedLocationHintJSON),
-                actual = JSONObject(locationHintResult.eventData),
-                exactMatchPaths = listOf("payload[*].scope", "payload[*].hint")
+            assertTypeMatch(


Thank you! Updated

addb · 2024-06-18T16:03:22Z

...src/androidTest/java/com/adobe/marketing/mobile/edge/integration/UpstreamIntegrationTests.kt

            }
          ]
        }
-        """.trimIndent()
+        """

        // Unsafe access used since testSendEvent_receivesExpectedEventHandles guarantees existence
        val stateStoreEvent = TestSetupHelper.getEdgeEventHandles(expectedHandleType = TestConstants.EventSource.STATE_STORE)
            .last()

        // Exact match used here to strictly validate `payload` array element count == 2


nit: update comment

Updated! I also updated the test case logic to actually apply the collection element count restriction on payload and also the elements under it, to better reflect the test case intent

addb · 2024-06-18T16:10:21Z

...src/androidTest/java/com/adobe/marketing/mobile/edge/integration/UpstreamIntegrationTests.kt

        realNetworkService.assertAllNetworkRequestExpectations()
-        val matchingResponses = realNetworkService.getResponsesFor(networkRequest = invalidNetworkRequest)
+
+        val matchingResponses = realNetworkService.getResponsesFor(invalidNetworkRequest)

        Assert.assertEquals(1, matchingResponses?.size)


Follow similar usages everywhere.

Import all the required functions like the configOverrideIntegrationTests and update the usages.

import org.junit.Assert.assertEquals import org.junit.Assert.assertNull

Updated! Thank you

timkimadobe

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

timkimadobe · 2024-06-18T21:07:32Z

...src/androidTest/java/com/adobe/marketing/mobile/edge/integration/UpstreamIntegrationTests.kt

            }
          ]
        }
-        """.trimIndent()
+        """

        // Unsafe access used since testSendEvent_receivesExpectedEventHandles guarantees existence
        val stateStoreEvent = TestSetupHelper.getEdgeEventHandles(expectedHandleType = TestConstants.EventSource.STATE_STORE)
            .last()

        // Exact match used here to strictly validate `payload` array element count == 2


Updated! I also updated the test case logic to actually apply the collection element count restriction on payload and also the elements under it, to better reflect the test case intent

timkimadobe · 2024-06-18T21:09:45Z

...src/androidTest/java/com/adobe/marketing/mobile/edge/integration/UpstreamIntegrationTests.kt

        realNetworkService.assertAllNetworkRequestExpectations()
-        val matchingResponses = realNetworkService.getResponsesFor(networkRequest = invalidNetworkRequest)
+
+        val matchingResponses = realNetworkService.getResponsesFor(invalidNetworkRequest)

        Assert.assertEquals(1, matchingResponses?.size)


Updated! Thank you

timkimadobe added 8 commits June 6, 2024 18:17

Replace local test utils dependency with AEPTestUtils

d418cfa

Update UpstreamIntegrationTests.kt to use latest JSON comparison APIs

cb45d57

Update ConfigOverridesIntegrationTests.kt to use JSON comparison asse…

14b6291

…rtEquals Import the junit.Assert.assertEquals method so prefix is not required

Fix UpstreamIntegrationTests.kt usage of JSON comparison APIs to expl…

2f5f72f

…icitly use AnyOrderMatch where required Fix testSendEvent_withPriorState_receivesExpectedStateStoreEventHandle test setup by adding expectation assertion

Update AEPTestUtils to latest version

cb92e79

Fix JSON assertion to use assertExactMatch in testSendEvent_withInval…

579b779

…idDatastreamIdOverride_receivesErrorResponse

Update tearDown to reset all helpers in UpstreamIntegrationTests.kt

0df1ab8

Clean up code comments

bed8af0

timkimadobe requested review from addb and cacheung June 13, 2024 23:31

cacheung reviewed Jun 14, 2024

View reviewed changes

timkimadobe added 2 commits June 13, 2024 17:43

Update AEPTestUtils to latest version

c57619a

Update JSON comparison API to use default mode with more cases

5c31c76

timkimadobe commented Jun 14, 2024

View reviewed changes

timkimadobe requested a review from cacheung June 14, 2024 01:15

cacheung approved these changes 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

addb reviewed Jun 18, 2024

View reviewed changes

timkimadobe added 2 commits June 18, 2024 14:09

Update test case logic to better reflect intent and update comment

abbdb02

Static import junit assertion methods and update usages

a6a4afc

timkimadobe commented Jun 18, 2024

View reviewed changes

addb approved these changes Jun 18, 2024

View reviewed changes

timkimadobe merged commit 2b1c320 into adobe:dev Jun 18, 2024
8 checks passed

timkimadobe deleted the testutils-integration-tests branch June 18, 2024 21:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Integration test AEPTestUtils migration #158

Integration test AEPTestUtils migration #158

timkimadobe commented Jun 13, 2024

codecov bot commented Jun 13, 2024 •

edited

Loading

cacheung Jun 14, 2024

timkimadobe Jun 14, 2024

cacheung Jun 14, 2024

timkimadobe Jun 14, 2024

cacheung Jun 14, 2024

timkimadobe left a comment

timkimadobe Jun 14, 2024

timkimadobe Jun 14, 2024

addb Jun 18, 2024

timkimadobe Jun 18, 2024

addb Jun 18, 2024

timkimadobe Jun 18, 2024

timkimadobe left a comment

timkimadobe Jun 18, 2024

timkimadobe Jun 18, 2024

Integration test AEPTestUtils migration #158

Integration test AEPTestUtils migration #158

Conversation

timkimadobe commented Jun 13, 2024

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

codecov bot commented Jun 13, 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

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

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

codecov bot commented Jun 13, 2024 •

edited

Loading