mojo/dart/apptest/lib/apptest.dart

// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

library apptest;

import 'dart:async';

import 'package:mojo/application.dart';
import 'package:mojo/bindings.dart';
import 'package:mojo/core.dart';

// Import and reexport the unittest package. We are a *.dartzip file designed to
// be linked into your_apptest.mojo file and are your main entrypoint.
import 'package:unittest/unittest.dart';
export 'package:unittest/unittest.dart';

final Completer exitCodeCompleter = new Completer();

// This class is an application that does nothing but tears down the connections
// between each test.
class _ConnectionToShellApplication extends Application {
  final List<Function> _testFunctions;

  _ConnectionToShellApplication.fromHandle(
      MojoHandle handle, this._testFunctions)
      : super.fromHandle(handle);

  // Only run the test suite passed in once we have received an initialize()
  // call from the shell. We need to first have a valid connection to the shell
  // so that apptests can connect to other applications.
  void initialize(List<String> args, String url) {
    _testFunctions.forEach((f) => f(this, url));
  }
}

// A configuration which properly shuts down our application at the end.
class _CleanShutdownConfiguration extends SimpleConfiguration {
  final _ConnectionToShellApplication _application;

  _CleanShutdownConfiguration(this._application) : super() {}

  Duration timeout = const Duration(seconds: 10);

  void onTestResult(TestCase externalTestCase) {
    super.onTestResult(externalTestCase);
    _application.resetConnections();
  }

  void onDone(bool success) {
    exitCodeCompleter.complete(success ? 0 : 255);
    closeApplication();
    super.onDone(success);
  }

  Future closeApplication() async {
    await _application.close();
    assert(MojoHandle.reportLeakedHandles());
  }

  void onSummary(int passed, int failed, int errors,
                 List<TestCase> results, String uncaughtError) {
    String status = ((failed > 0) || (errors > 0)) ? "FAILED" : "PASSED";
    print('DART APPTESTS RESULT: $status');
    super.onSummary(passed, failed, errors, results, uncaughtError);
  }
}

// The public interface to apptests.
//
// In a dart mojo application, |incoming_handle| is args[0]. |testFunction| is a
// list of functions that actually contains your testing code, and will pass
// back an application to each of them.
Future<int> runAppTests(var incomingHandle, List<Function> testFunction) async {
  var appHandle = new MojoHandle(incomingHandle);
  var application =
      new _ConnectionToShellApplication.fromHandle(appHandle, testFunction);
  unittestConfiguration = new _CleanShutdownConfiguration(application);

  var exitCode = await exitCodeCompleter.future;
  return exitCode;
}