maestro_test 0.3.0

Simple, easy-to-learn, Flutter-native UI testing framework eliminating limitations of flutter_driver

maestro_test

maestro_test package builds on top of flutter_driver to make it easy to control the native device from Dart. It does this by using Android's UIAutomator library.

It also provides a new custom selector system to make writing Flutter widget tests more concisce, and writing them faster & more fun.

Installation

Add maestro_test as a dev dependency in pubspec.yaml:

dev_dependencies:
  maestro_test: ^0.3.0

Usage

// example/integration_test/example_test.dart
import 'package:example/main.dart';
import 'package:flutter/material.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:maestro_test/maestro_test.dart';

void main() {
  final maestro = Maestro.forTest();

  maestroTest(
    'counter state is the same after going to Home and going back',
    ($) async {
      await tester.pumpWidgetAndSettle(const MyApp());

      await $(FloatingActionButton).tap();
      expect($(#counterText).text, '1');

      await maestro.pressHome();
      await maestro.pressDoubleRecentApps();

      expect($(#counterText).text, '1');
      await $(FloatingActionButton).tap();
      expect($(#counterText).text, '2');

      await maestro.openHalfNotificationShade();
      await maestro.pressBack();
    },
  );
}

Custom selectors

import 'package:example/main.dart';
import 'package:flutter/material.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:maestro_test/maestro_test.dart';

void main() {
  maestroTest(
    'counter state is the same after going to Home and switching apps',
    ($) async {
      await $.pumpWidgetAndSettle(const MyApp());

      // Find widget with text 'Log in' which is a descendant of widget with key
      // box1 which is a descendant of a Scaffold widget and tap on it.
      await $(Scaffold).$(#box1).$('Log in').tap();

      // Selects the first Scrollable which has a Text descendant
      $(Scrollable).withDescendant(Text);
    },
  );
}