Eric Seidel
8072ed9ad7
* docs: integration tests design proposal Adds docs/integration_tests.md proposing a desktop-only integration suite that drives the Dart `ShorebirdUpdater` API against the real Rust core via FFI, with a fake HTTP server and per-test tempdir state. Describes a new `library_test_hooks` cdylib that reaches into `updater` via a `test-hooks` Cargo feature, so production C API stays clean. Status: design exploration, not a committed plan. * feat: stage 1 integration test harness for shorebird_code_push Lands the test_hooks crate, the Dart-side loader, and one trivial end-to-end test, per docs/integration_tests.md stage 1. Pieces: - New `library_test_hooks` workspace crate (cdylib). Depends on `updater` with a new `test-hooks` Cargo feature that widens the visibility of internal items (currently `testing_reset_config`) for sibling-crate access only — production builds do not enable it. The crate also re-exports `updater::c_api::dart::*` and `updater::c_api::engine::*`, which keeps the rlib's `#[no_mangle]` symbols out of DCE so the resulting cdylib carries both the production C API and the new `shorebird_test_*` hooks. - Workspace `default-members` excludes `library_test_hooks` so plain `cargo build` / `cargo test` invocations don't unify the `test-hooks` feature into production builds. - `shorebird_code_push/test/integration/all_test.dart` (single file, with a header comment explaining why) loads the cdylib via `DynamicLibrary.open`, reassigns the existing `@visibleForTesting` `Updater.bindings` setter, and exercises both surfaces. The build helper shells out to `cargo build -p library_test_hooks`; if it fails, `markTestSkipped` keeps the suite green on machines without a working Rust toolchain. - ffigen config (`ffigen_test_hooks.yaml`) generates the test-only Dart bindings under `test/integration/generated/`, not `lib/`. - CI: `library_test_hooks` is added to the rust_crate matrix, and the shorebird_code_push job triggers on `library/**` and `library_test_hooks/**` so cdylib changes can't break the Dart-side integration suite without CI noticing. Verified locally: 232 Rust unit tests + 42 Dart tests (41 existing + 1 integration) green; clippy/fmt/cspell clean; production cdylib does not contain `shorebird_test_reset` (`nm` confirms feature isolation). Stages 2 (FakePatchServer + golden path) and 3 (adversarial scenarios) land separately. * fix(integration test): early-return on skip and bump per-test timeout Two issues caught by Shorebird CI on PR #353: 1. `markTestSkipped` does not abort test execution — it only flags the test as skipped on its way out. The body kept running and crashed on the `late testHooks` field when the cdylib build had failed in setUpAll. Move the skip check into the test body itself with an early return; drop the (no-op) skip in `setUp`. 2. Default per-test timeout (30s) also covers `setUpAll`. A cold `cargo build -p library_test_hooks` compiles `updater` and ~100 transitive deps, which can run minutes on CI. Bump to 10 minutes via `@Timeout` on the library. Verified locally: passes when cargo is on PATH (1 passed), reports a clean skip and exit 0 when cargo is removed from PATH (1 skipped). * refactor(integration test): drop ! by promoting testHooks to late final `testHooks` was nullable so accessing it after the skipReason check required `!`, and `markTestSkipped(skipReason!)` had the same smell. Make `testHooks` `late final` (non-nullable, throws if read before setUpAll assigns) and pull `skipReason` into a non-null local before use. Same control flow, no bang operators.
49 lines
1.5 KiB
Dart
49 lines
1.5 KiB
Dart
import 'dart:io';
|
|
|
|
/// Builds `library_test_hooks` and returns the absolute path to the
|
|
/// resulting cdylib artifact.
|
|
///
|
|
/// Throws on any failure (cargo missing, build error, artifact not found).
|
|
/// The test entry point catches and translates these into a
|
|
/// `markTestSkipped`, so this layer can stay simple.
|
|
Future<String> buildTestHooksCdylib() async {
|
|
final workspaceRoot = _resolveWorkspaceRoot();
|
|
|
|
final result = await Process.run(
|
|
'cargo',
|
|
const ['build', '-p', 'library_test_hooks'],
|
|
workingDirectory: workspaceRoot,
|
|
);
|
|
|
|
if (result.exitCode != 0) {
|
|
throw Exception(
|
|
'cargo build -p library_test_hooks failed (exit ${result.exitCode}):\n'
|
|
'stdout:\n${result.stdout}\n'
|
|
'stderr:\n${result.stderr}',
|
|
);
|
|
}
|
|
|
|
final artifact = File(
|
|
'$workspaceRoot/target/debug/${_artifactName('updater_test_hooks')}',
|
|
);
|
|
if (!artifact.existsSync()) {
|
|
throw Exception(
|
|
'cargo build succeeded but artifact not found at ${artifact.path}',
|
|
);
|
|
}
|
|
return artifact.path;
|
|
}
|
|
|
|
/// Resolves the Cargo workspace root from the test process's cwd.
|
|
///
|
|
/// `dart test` runs with cwd = the package root (`shorebird_code_push/`),
|
|
/// so the workspace root is one level up.
|
|
String _resolveWorkspaceRoot() => Directory.current.parent.path;
|
|
|
|
String _artifactName(String libName) {
|
|
if (Platform.isMacOS) return 'lib$libName.dylib';
|
|
if (Platform.isLinux) return 'lib$libName.so';
|
|
if (Platform.isWindows) return '$libName.dll';
|
|
throw UnsupportedError('Unsupported platform: ${Platform.operatingSystem}');
|
|
}
|