how_do_i_run_a_script

Question

How do I run a script inside of a test?

Answer

Use Process.run

1) Create a flutter application.

flutter create ftc
cd ftc

2) Get dependencies

flutter packages get

3) Replace the lib/main.dart file

Replace the lib/main.dart file with the following:

import 'package:flutter/material.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: Center(
          child: Text("A script will be run during the test"),
        ),
      ),
    );
  }
}

4) Replace the test/widget_test.dart file.

Replace the test/widget_test.dart file with the following:

import 'package:flutter_test/flutter_test.dart';
import 'package:ftc/main.dart';
import 'dart:io';

void main() async {
  testWidgets("How do I run a script?", (WidgetTester tester) async {
    await tester.pumpWidget(MyApp());

    // Running a script inside of flutter_test is different than with flutter_driver.
    // With flutter_test, we need to:
    // a) use tester.runAsync, and
    // b) write the path of the script from the perspective of this file
    ProcessResult result = await tester.runAsync(() async {
      return await Process.run('../echo.sh', ['1']);
    });

    //Note: echo appends a newline to the result
    expect(result.stdout, '1\n');
  });
}

5) Add an echo.sh script

Create a file called echo.sh and add the following to it:

#!/bin/bash

echo "$1"

Then run:

chmod +x echo.sh

6) Run the flutter tests

flutter test

Run tests from example code in cookbook itself

If you have cloned flutter_test_cookbook and simply want to run the tests from this recipe, then:

flutter create .
flutter packages get
flutter test

Outputs when recipe was made / updated

Output of running flutter tests

$ flutter test 
00:01 +1: All tests passed!  

Output of running flutter doctor -v

$ flutter doctor -v
[✓] Flutter (Channel stable, v1.12.13+hotfix.5, on Mac OS X 10.15.2 19C57, locale en-US)
    • Flutter version 1.12.13+hotfix.5 at /Users/matthew/gadfly/flutter_versions/flutter_1.12.13+hotfix.5
    • Framework revision 27321ebbad (3 months ago), 2019-12-10 18:15:01 -0800
    • Engine revision 2994f7e1e6
    • Dart version 2.7.0

[✓] Android toolchain - develop for Android devices (Android SDK version 28.0.3)
    • Android SDK at /Users/matthew/Library/Android/sdk
    • Android NDK location not configured (optional; useful for native profiling support)
    • Platform android-29, build-tools 28.0.3
    • Java binary at: /Applications/Android Studio.app/Contents/jre/jdk/Contents/Home/bin/java
    • Java version OpenJDK Runtime Environment (build 1.8.0_152-release-1343-b01)
    • All Android licenses accepted.

[✓] Xcode - develop for iOS and macOS (Xcode 11.3.1)
    • Xcode at /Applications/Xcode.app/Contents/Developer
    • Xcode 11.3.1, Build version 11C504
    • CocoaPods version 1.8.4

[✓] Android Studio (version 3.4)
    • Android Studio at /Applications/Android Studio.app/Contents
    • Flutter plugin version 35.2.1
    • Dart plugin version 183.6270
    • Java version OpenJDK Runtime Environment (build 1.8.0_152-release-1343-b01)

[✓] IntelliJ IDEA Community Edition (version 2019.3.3)
    • IntelliJ at /Applications/IntelliJ IDEA CE.app
    • Flutter plugin version 44.0.3
    • Dart plugin version 193.6494.35

[✓] VS Code (version 1.41.1)
    • VS Code at /Applications/Visual Studio Code.app/Contents
    • Flutter extension version 3.4.1

[✓] Connected device (1 available)
    • iPhone 8 • AD7A90EB-5E73-427E-B9B7-DD3B07E2FEF1 • ios • com.apple.CoreSimulator.SimRuntime.iOS-13-3 (simulator)

• No issues found!