test: SDKE-632 Add New Integration Tests (#461)

* refactor: Remove specific line numbers from test comments

- Made comments more maintainable by removing hardcoded line references
- Comments now reference source methods without specific line numbers

* Add integration test for getUserAudiences API

- Tests retrieving user audience memberships via Identity API
- Covers successful audience retrieval with mock data
- Verifies getAudiencesWithCompletionHandler method
- Includes enabled AudienceAPI flag in config for testing

* Add integration test for timed events

- Add testLogTimedEvent function to test begin/end timed event flow
- Test uses fixed 2-second delay for deterministic behavior
- Add WireMock recordings for timed event API call
- Verify event duration is properly calculated and sent

* Add integration test for logError

- Tests error logging with custom event info dictionary
- Verifies error events are properly sent with attributes (cause: slippery floor)
- Covers error severity level and exception handling attributes
- Adds iba (instruction base address) and el (event length) to dynamic fields list
- Fixes timed event mapping to ignore variable event length values

* Add integration test for logException

- Tests NSException logging functionality
- Covers exception name, reason, and SDK handling
- Based on ViewController.m logException method
- Fixes dynamic 'is' field in mapping-log-error.json to use ${json-unit.ignore}

* feat: Pass API keys via environment variables in integration tests

- Read MPARTICLE_API_KEY and MPARTICLE_API_SECRET from environment variables in main.swift
- Pass environment variables to simulator using SIMCTL_CHILD_ prefix in common.sh
- Add documentation for required environment variables in README.md
- Validate that environment variables are set before launching tests

* Add integration test for setUserAttribute

- Tests setting predefined user attributes (Age, Gender)
- Covers custom user attributes (Achieved Level)
- Verifies attributes are properly sent in events batch
- Related to SDKE-632

* Add integration test for incrementUserAttribute

- Tests incrementing a numeric user attribute by a specified value
- Covers setting initial attribute value and incrementing it
- Verifies both SET and INCREMENT operations are properly handled
- Related to user attribute management functionality

* - decrease timeout

* Add mapping for Rokt identify request

* Auto-create/remove proxy mappings in recorder/verification scripts

- Add create_proxy_mappings() function to common.sh
- Add remove_proxy_mappings() function to common.sh
- Call create_proxy_mappings in run_wiremock_recorder.sh
- Call remove_proxy_mappings in run_clean_integration_tests.sh
- Remove static proxy mapping files (now generated dynamically)

* Allow running verification tests without API keys

- Use fake keys (us1-00000000...) when env vars not set
- Real keys only required for recording mode
- Update README.md to document this behavior
- Add key validation in run_wiremock_recorder.sh

* Add integration test for setSessionAttribute

- Test sets session attribute 'Station' with value 'Classic Rock'
- Session attributes are sent in session end message (dt: se)
- Calls endSession() to trigger sending the attribute
- Added corresponding WireMock mapping and body files

* Add integration test for incrementSessionAttribute

- Test increments session attribute 'Song Count' by 1 (initial value 5 → 6)
- Requires beginSession() since previous test ends session
- Session attributes are sent in session end message (dt: se)
- Added two mappings: session start (ss) and session end (se)
- Based on ViewController.m lines 348-351

* Add integration test for CCPA consent state

Test 14: Toggle CCPA Consent
- Sets CCPA consent state on current user with all fields (consented, document, timestamp, location, hardwareId)
- Logs event to trigger upload that includes consent data in request body
- Verifies CCPA data is transmitted in 'con.ccpa.data_sale_opt_out' field

Based on ViewController.m toggleCCPAConsent method (lines 357-386)

* Add integration test for toggleGDPRConsent

- Test sets GDPR consent state on the current user
- Based on ViewController.m toggleGDPRConsent method (lines 388-416)
- Creates MPGDPRConsent with consented=true, document, timestamp, location, hardwareId
- Adds GDPR consent with purpose 'My GDPR Purpose' to MPConsentState
- Preserves existing CCPA consent state
- Logs event to trigger upload with consent state in 'con' field
- Uses static timestamp for deterministic testing

* Add integration test for logIDFA (modify iOS Advertiser ID)

- Test modifies user identity to add/update the iOS Advertiser ID via Identity API
- Uses static IDFA value for deterministic testing
- Based on ViewController.m logIDFA method (lines 418-429)
- Added corresponding WireMock mapping and body files

* Add integration test for setATTStatus (App Tracking Transparency)

- Test sets ATT status to 'authorized' with static timestamp
- Based on ViewController.m requestIDFA method (lines 431-476)
- ATT status is sent in device info ('atts' field)
- ATT timestamp is sent in device info ('attt' field)
- Added corresponding WireMock mapping and body files

Author: denischilik

IntegrationTests/README.md

@@ -10,6 +10,21 @@ Before getting started, install Tuist:
 brew install tuist
 ```
 
+### Environment Variables
+
+mParticle API credentials are required **only for recording** new API interactions:
+
+```bash
+export MPARTICLE_API_KEY="your-api-key"
+export MPARTICLE_API_SECRET="your-api-secret"
+```
+
+**Recording mode (`run_wiremock_recorder.sh`):** Real API keys are required to record actual API responses from mParticle servers.
+
+**Verification mode (`run_clean_integration_tests.sh`):** API keys are **optional**. If not set, the tests will automatically use fake keys (`us1-00000000000000000000000000000000`) that match the WireMock URL patterns. This allows running integration tests without exposing real credentials.
+
+**Note:** Fake keys must match the pattern `us1-[a-f0-9]+` to work with WireMock mappings.
+
 Then generate the Xcode project:
 
 ```bash

IntegrationTests/Sources/main.swift

@@ -158,6 +158,18 @@ install_application() {
 
 launch_application() {
   echo "▶️ Launching application..."
+  
+  # Launch with environment variables using SIMCTL_CHILD_ prefix
+  # If not set, the app will use fake keys for verification mode
+  local launch_cmd="xcrun simctl launch \"$DEVICE_ID\" \"$BUNDLE_ID\""
+  
+  if [ -n "$MPARTICLE_API_KEY" ]; then
+    export SIMCTL_CHILD_MPARTICLE_API_KEY="$MPARTICLE_API_KEY"
+  fi
+  if [ -n "$MPARTICLE_API_SECRET" ]; then
+    export SIMCTL_CHILD_MPARTICLE_API_SECRET="$MPARTICLE_API_SECRET"
+  fi
+  
   LAUNCH_OUTPUT=$(xcrun simctl launch "$DEVICE_ID" "$BUNDLE_ID")
   APP_PID=$(echo "$LAUNCH_OUTPUT" | awk -F': ' '{print $2}')
 
@@ -171,7 +183,7 @@ launch_application() {
 
 wait_for_app_completion() {
   echo "⏳ Waiting for app to complete execution..."
-  local MAX_WAIT=60
+  local MAX_WAIT=120
   local WAIT_COUNT=0
   while kill -0 "$APP_PID" 2>/dev/null; do
     sleep 1
@@ -262,3 +274,47 @@ stop_wiremock_with_logs() {
   stop_wiremock
 }
 
+create_proxy_mappings() {
+  echo "📝 Creating proxy mappings for recording mode..."
+  
+  local PROXY_DIR="${MAPPINGS_DIR}/mappings"
+  mkdir -p "$PROXY_DIR"
+  
+  # Create proxy-identify.json
+  cat > "${PROXY_DIR}/proxy-identify.json" << 'EOF'
+{
+  "priority": 1,
+  "request": {
+    "urlPathPattern": "/v1/identify"
+  },
+  "response": {
+    "proxyBaseUrl": "https://identity.mparticle.com"
+  }
+}
+EOF
+
+  # Create proxy-events.json
+  cat > "${PROXY_DIR}/proxy-events.json" << 'EOF'
+{
+  "priority": 1,
+  "request": {
+    "urlPathPattern": "/v2/events"
+  },
+  "response": {
+    "proxyBaseUrl": "https://nativesdks.mparticle.com"
+  }
+}
+EOF
+
+  echo "✅ Proxy mappings created"
+}
+
+remove_proxy_mappings() {
+  echo "🗑️  Removing proxy mappings for verification mode..."
+  
+  rm -f "${MAPPINGS_DIR}/mappings/proxy-identify.json" 2>/dev/null || true
+  rm -f "${MAPPINGS_DIR}/mappings/proxy-events.json" 2>/dev/null || true
+  
+  echo "✅ Proxy mappings removed"
+}
+

IntegrationTests/common.sh

@@ -167,6 +167,7 @@ find_app_path
 reset_simulators
 find_available_device
 find_device
+remove_proxy_mappings
 escape_mapping_bodies
 start_wiremock "verify"
 wait_for_wiremock

IntegrationTests/run_clean_integration_tests.sh

@@ -10,6 +10,13 @@ TARGET_URL=${4:-"https://config2.mparticle.com"}
 SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 source "${SCRIPT_DIR}/common.sh"
 
+# === Check required environment variables for recording ===
+if [ -z "$MPARTICLE_API_KEY" ] || [ -z "$MPARTICLE_API_SECRET" ]; then
+  echo "❌ Error: MPARTICLE_API_KEY and MPARTICLE_API_SECRET environment variables must be set for recording mode"
+  echo "   Real API keys are required to record actual API responses from mParticle servers"
+  exit 1
+fi
+
 # === Build framework and generate project ===
 build_framework
 
@@ -23,6 +30,9 @@ CONTAINER_NAME="wiremock-recorder"
 mkdir -p "${MAPPINGS_DIR}/mappings"
 mkdir -p "${MAPPINGS_DIR}/__files"
 
+# Create proxy mappings for recording
+create_proxy_mappings
+
 # Trap to ensure cleanup on exit
 trap stop_wiremock EXIT INT TERM
 

IntegrationTests/run_wiremock_recorder.sh

@@ -41,8 +41,10 @@
     'dlc',     # Device Locale
     'dn',      # Device Name
     'dosv',    # Device OS Version
+    'el',      # Event Length (duration in milliseconds for timed events)
     'en',      # Event Number (position in session, e.g., 0, 1, 2...)
     'est',     # Event Start Time
+    'iba',     # Instruction Base Address (memory address for errors)
     'ict',     # Init Config Time
     'id',      # ID (various message/event IDs)
     'lud',     # Last Update Date

IntegrationTests/transform_mapping_body.py

@@ -0,0 +1 @@
+{"dt":"rh","id":"e3d7fc9b-15d2-4109-b90b-1dc892641c97","ct":1764796657912,"msgs":[],"ci":{"mpid":6504934091054997508,"ck":{"uid":{"c":"g=7f6d2e60-d81a-4edf-a5d6-996c6f15fa70","e":"2035-11-04T19:37:06.7933933Z"}},"das":"7f6d2e60-d81a-4edf-a5d6-996c6f15fa70"}}

IntegrationTests/wiremock-recordings/__files/body-ccpa-consent.json

@@ -0,0 +1 @@
+{"dt":"rh","id":"a7c8f4d7-aeb2-4f55-91e5-91a267afc382","ct":1764858535905,"err":[{"dt":"err","id":"92e1921b-09d0-434c-a3ef-0484baa5c2c3","ct":1764858535905,"msg":"Invalid Consent State provided - please verify the Consent Purposes that you have defined for this workspace.","code":"invalid_consent"}]}

IntegrationTests/wiremock-recordings/__files/body-gdpr-consent.json

@@ -0,0 +1 @@
+{"audience_memberships":[{"audience_id":12345,"audience_name":"Test Audience 1"},{"audience_id":67890,"audience_name":"Test Audience 2"}]}

IntegrationTests/wiremock-recordings/__files/body-get-user-audiences.json

@@ -0,0 +1 @@
+{"dt":"rh","id":"71a50897-9ff8-4b56-9a73-9ff4281cf33a","ct":1764789344543,"msgs":[],"ci":{"mpid":6504934091054997508,"ck":{"uid":{"c":"g=a6af0b2e-86ae-4d5f-a0d2-2e5d6d71fcb4","e":"2035-11-04T19:37:06.7933933Z"}},"das":"a6af0b2e-86ae-4d5f-a0d2-2e5d6d71fcb4"}}