Skip to content
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ npm install

```
artifacts/ # screenshots and (optionally) videos of failed tests
aut/ # Place your .apk / .ipa files here
aut/ # Place your .apk / .app files here (default: bitkit_e2e.apk, Bitkit.app)
docker/ # docker compose regtest based backend for Bitkit wallet
test/
├── specs/ # Test suites (e.g., onboarding.e2e.ts)
Expand Down Expand Up @@ -95,6 +95,8 @@ BACKEND=regtest ./scripts/build-ios-sim.sh

> ⚠️ **The `BACKEND` must match how the app was built.** If the app connects to remote electrum, use `BACKEND=regtest`. If it connects to localhost, use `BACKEND=local`.

**App override:** By default tests use `aut/bitkit_e2e.apk` (Android) and `aut/Bitkit.app` (iOS). Set `AUT_FILENAME` to use a different file in `aut/` (e.g. `AUT_FILENAME=bitkit_rn_regtest.apk`)

```bash
# Run all tests on Android (local backend - default)
npm run e2e:android
Expand Down Expand Up @@ -122,6 +124,12 @@ To run a **specific test case**:
npm run e2e:android -- --mochaOpts.grep "Can pass onboarding correctly"
```

To run against a **different app** in `aut/`:

```bash
AUT_FILENAME=bitkit_rn_regtest.apk npm run e2e:android
```

---

### 🏷️ Tags
Expand Down
2 changes: 1 addition & 1 deletion docs/mainnet-nightly.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The private companion repository (`bitkit-nightly`) is responsible for running t
To execute native E2E tests from an external orchestrator:

- set platform/backend env vars expected by WDIO and helpers
- provide app artifact at `aut/bitkit_e2e.apk` (or `NATIVE_APK_PATH`)
- provide app artifact in `aut/` — default `bitkit_e2e.apk` (Android) / `Bitkit.app` (iOS). Override with `AUT_FILENAME` (e.g. `bitkit_rn_regtest.apk`)
- provide all secrets required by the selected tag(s)
- pass grep/tag filters via CLI args, not by editing spec files

Expand Down
2 changes: 1 addition & 1 deletion scripts/build-rn-android-apk.sh
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ if [[ -z "${ENV_FILE:-}" ]]; then
if [[ "$BACKEND" == "regtest" ]]; then
ENV_FILE=".env.development.template"
else
ENV_FILE=".env.development"
ENV_FILE=".env.test.template"
fi
fi

Expand Down
2 changes: 1 addition & 1 deletion scripts/build-rn-ios-sim.sh
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ if [[ -z "${ENV_FILE:-}" ]]; then
if [[ "$BACKEND" == "regtest" ]]; then
ENV_FILE=".env.development.template"
else
ENV_FILE=".env.development"
ENV_FILE=".env.test.template"
fi
fi

Expand Down
Loading