Skip to content

Latest commit

 

History

History
45 lines (36 loc) · 1.76 KB

README.md

File metadata and controls

45 lines (36 loc) · 1.76 KB
Raw

toggle

version 1.0.0 build status coverage: 100%

Allows you to substitute one service for another while testing. The primary use case is to test an application using in-memory services, although it may be using database services in the real world. This makes tests a bit faster, and also means that you don't have to write any boilerplate code to clean up a database between test runs.

Installation

In your pubspec.yaml file:

dependencies:
  angel_toggle: ^1.0.0

Usage

Within angel_toggle, there are two ways to specify that your application is running in "test mode":

  1. app.properties contains a key testMode, the value of which is true.
  2. Platform.script contains the string test (case-insensitive). This means you have to do no further configuration when running from the test/ directory.

This package exports a single plug-in:

toggleService

If the application is running in test mode, then the second generator will be called. Otherwise, it defaults to the first generator.

If you really need to delay the mounting of the service, add this plug-in to app.justBeforeStart. If no second generator is provided, it will default to a MapService.

import 'package:angel_framework/angel_framework.dart';
import 'package:angel_toggle/angel_toggle.dart';

configureServer(Angel app) async {
  await app.configure(toggleService('/api/todos', () => new MongoService(...)));
}

Using the plug-in will print a message to the console, notifying you that a service has been toggled out.