testsweets 1.6.1

A package to help sync flutter automation data with TestSweets backend

Testsweets

This package is a utility and helper package to the TestSweets product. It is the package responsible for capturing your widget keys to the database which allows us to provide the auto complete functionality when you script your test cases.

Installation

To start using the package you have to add this package to your pubspec.yaml file.

dependencies:
  ...
  testsweets: [latest_version]

Optionally

If you want to add general keys to check for when a certain widget is visible like a dialog or a button you have to add the testsweets_generator package too

dev_dependencies:
  testsweets_generator: [latest_version]
  build_runner: [latest_version]

Setup

After the packages have been added we have to setup the code. TestSweets makes use of Flutter Driver to drive the test cases that we write. This means we have to enable flutter driver for the version of the app that we build that goes through automation. Flutter driver disables certain things like the on screen keyboard

...

void main() {
  // 1. Setup the TestSweets internal dependencies
  await setupTestSweets();
  ...
  runApp(MyApp());
}

in your MaterialApp

...
class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
   // 2. Inside MaterialApp add TestSweetsOverlayView to the builder
   //    with the projectId you get when you created a new project in Testsweets app
      builder: (context, child) => TestSweetsOverlayView(
        projectId: '3OezzTovG9xxxxxxxxx',
        child: child!,
      ),
    // 3. Finally add TestSweetsNavigatorObserver() to determine what view you are on right now
      navigatorObservers: [
        TestSweetsNavigatorObserver.instance,
      ],
    );
  }
}

Using the capture functionality

To run the app in capture mode you just start the application and capture mode will be enabled. This can be turned on or off if you pass captureMode false to the TestSweetsOverlayView.

Intro screen	Entered capture mode	Types of widgets you can capture
Choose a name for the widget	Exit capture mode and go to inspect mode to see your keys

Putting the app in Drive Mode

To ensure the app is built for TestSweets to be able to drive it you you should pass --dart-define=DRIVE_MODE=true when building or running the app for TestSweets.

Build the apk

flutter build apk --debug --dart-define=DRIVE_MODE=true