mirror of
https://github.com/openobserve/openobserve.git
synced 2026-11-04 00:08:55 +00:00
## What this PR adds end-to-end test suite for the **Mobile RUM SDK** under `tests/mobile-testing/`, plus a **self-contained CI workflow** that runs it on real emulators/simulators against an OpenObserve **built from this PR's source**. Test / fixture / CI only — no product-code/existing test changes ## How each test works (3 layers) Every scenario is a real end-to-end journey, so a failure points at the actual broken layer: 1. **Drive** — a Maestro flow taps through the app like a user (`maestro/<track>/*.yaml`). 2. **API** — query the `_rumdata` stream and assert the telemetry is correct (`utils/ooClient.js`, poll-and-retry for async ingestion). 3. **UI** — open the RUM dashboard and assert the sessions ## Coverage (42 tests across 4 platforms) The **native platforms (android-native, ios-native) are now at parity with React Native** — each new native test (masking, network, bg/fg, user-identity, no-phone-home) was built + validated on a real emulator/simulator before landing. | Capability | Layer | RN-Android | Android-native | RN-iOS | iOS-native | |---|---|:-:|:-:|:-:|:-:| | Core telemetry (views/actions/handled-error/crash → `_rumdata`) | API | ✅ | ✅ | ✅ | ✅ | | Crash session viewable in dashboard | UI | ✅ | ✅ | ✅ | ✅ | | Attributes: env / service / version tagging | API | ✅ | ✅ | ✅ | ✅ | | User identity (`setUser`) | API | ✅ | ✅ | ✅ | ✅ | | Network: fetch → resource + 4xx/5xx | API | ✅ | ✅ | ✅ | ✅ | | Session-replay PII masking | UI | ✅ | ✅ | ✅ | ✅ | | Background / foreground view transitions | API | ✅ | ✅ | — | ✅ | | No-phone-home (no egress to Datadog hosts) | security | ✅ | ✅ | — | ✅ | - Shared per-capability factories keep the specs DRY (`utils/rumChecks.js`, `utils/coreRumSpec.js`). - Negatives are covered: 4xx capture, PII-must-not-leak (masking), no phone-home, handled-error ≠ crash. - `o2-enterprise#2289` dashboard bugs are kept as inline skips that flip green once fixed. - Full capability × platform detail + on-device status: `docs/COVERAGE-MATRIX.md`. ## Fixture apps + build-time config - Four vendored apps under `apps/`: `o2-rum-tester` (React Native — drives both RN platforms), `o2-native-android` (Kotlin), `o2-native-ios` (Swift / xcodegen). - Each reads its RUM target (endpoint / org / token) and SDK version from a **build-time-overridable** config. The committed default is the current pin, so local dev is unchanged; CI regenerates it to point at the runner's OpenObserve and can pin the latest SDK on release. ## CI — `.github/workflows/mobile-sdk-e2e.yml` (self-contained, no secrets) - **Build once per OS from source.** `build_oo_linux` / `build_oo_macos` compile OpenObserve (binary + embedded web UI) from this PR's code and cache it. Device jobs download and run it **natively**, and the app posts real RUM to it (Android reaches the host at `10.0.2.2`, the iOS simulator via `localhost`). No Docker, no shared cluster, no secrets. - **Device jobs run in parallel.** `android` (Linux + KVM emulator → rn-android + android-native) and `ios` (macOS simulator, pinned Xcode 16.4 → rn-ios + ios-native). - **`merge_reports`** combines both platforms into one browsable HTML report — even when a device job fails. - **`decide` picks which platform runs, to keep scarce macOS runners in check:** - PR touching Android or shared mobile-RUM code → **Android auto-runs**; iOS is gated behind the `mobile-e2e` label. - `mobile-e2e` label → both platforms (full pre-merge gate). - `repository_dispatch(mobile-sdk-release)` from an SDK repo → runs that SDK's platform (companion PRs wire this up: openobserve-react-native-rum#3, openobserve-sdk-android#1, openobserve-sdk-ios#1). - `workflow_dispatch` → manual, choose platforms. *Separate workflow :* it needs macOS **and** Android emulators, builds 4 phone apps, and is dispatch-driven — matching the repo's existing per-suite split ## Status Green end-to-end on GitHub runners (Android + iOS device jobs + merge) : https://github.com/openobserve/openobserve/actions/runs/31733717758/job/94565520891 --------- Co-authored-by: Shrinath Rao <shnath@openobserve.ai>
61 lines
2.2 KiB
JavaScript
61 lines
2.2 KiB
JavaScript
// Runs a Maestro flow (the "drive the app" layer). Cross-platform selectors by text,
|
|
// so flows are robust — no coordinate taps.
|
|
const { execFileSync } = require('child_process');
|
|
const path = require('path');
|
|
const os = require('os');
|
|
|
|
const MAESTRO_BIN = path.join(os.homedir(), '.maestro', 'bin', 'maestro');
|
|
|
|
function maestroEnv() {
|
|
const androidHome = process.env.ANDROID_HOME || '/opt/homebrew/share/android-commandlinetools';
|
|
const javaHome = process.env.JAVA_HOME || '/opt/homebrew/opt/openjdk@17';
|
|
return {
|
|
...process.env,
|
|
ANDROID_HOME: androidHome,
|
|
ANDROID_SDK_ROOT: androidHome,
|
|
JAVA_HOME: javaHome,
|
|
PATH: [
|
|
path.join(os.homedir(), '.maestro', 'bin'),
|
|
path.join(javaHome, 'bin'),
|
|
path.join(androidHome, 'platform-tools'),
|
|
process.env.PATH,
|
|
].join(':'),
|
|
};
|
|
}
|
|
|
|
/** First attached Android emulator (e.g. "emulator-5554"), or '' if none. */
|
|
function androidEmulator() {
|
|
const androidHome = process.env.ANDROID_HOME || '/opt/homebrew/share/android-commandlinetools';
|
|
try {
|
|
const out = execFileSync(path.join(androidHome, 'platform-tools', 'adb'), ['devices'], {
|
|
encoding: 'utf8',
|
|
});
|
|
const line = out.split('\n').find((l) => /^emulator-\d+\s+device/.test(l));
|
|
return line ? line.split(/\s+/)[0] : '';
|
|
} catch (e) {
|
|
return '';
|
|
}
|
|
}
|
|
|
|
/** Run a flow file under maestro/. Returns { ok }. Throws on non-zero unless throwOnFail=false. */
|
|
function runFlow(relativeFlowPath, { throwOnFail = true, device = '' } = {}) {
|
|
const flow = path.join(__dirname, '..', 'maestro', relativeFlowPath);
|
|
// iOS passes the simulator udid explicitly; Android flows default to the attached emulator
|
|
// (needed because Maestro is ambiguous when a sim AND an emulator are both booted).
|
|
const target = device || androidEmulator();
|
|
const args = target ? ['--device', target, 'test', flow] : ['test', flow];
|
|
try {
|
|
execFileSync(MAESTRO_BIN, args, {
|
|
env: maestroEnv(),
|
|
stdio: 'inherit',
|
|
timeout: 5 * 60 * 1000,
|
|
});
|
|
return { ok: true };
|
|
} catch (e) {
|
|
if (throwOnFail) throw new Error(`Maestro flow failed: ${relativeFlowPath}\n${e.message}`);
|
|
return { ok: false };
|
|
}
|
|
}
|
|
|
|
module.exports = { runFlow, MAESTRO_BIN };
|