Flutter测试工具插件flutter_test_utils的使用

Flutter测试工具插件flutter_test_utils的使用

flutter_test_utils 是一组用于在 Flutter 框架中测试小部件的帮助方法。

安装

在你的 pubspec.yaml 文件中添加以下依赖项：

dependencies: 
    flutter_test_utils: ^1.0.0

然后运行 flutter pub get 来安装该包。

使用

在你的测试文件中导入该包：

import 'package:flutter_test_utils/flutter_test_utils.dart';

然后，你可以在测试用例中使用任何可用的帮助方法。以下是当前可用的帮助方法：

waitForWidget

此方法会在运行测试之前等待小部件出现在小部件树中。这对于测试异步操作（如网络调用或动画）非常有用。

示例用法：

testWidgets('Test widget with future', (WidgetTester tester) async { 
  final widget = MyWidgetWithFuture(); 
  await FlutterTestUtils.waitForWidget(find.byType(MyWidget), tester);  
  expect(find.byType(MyWidgetWithFuture), findsOneWidget); 
});  

pumpWidgetWithAnimation

这是一个用于测试小部件动画的方法。该方法包装了 tester.pumpWidget 方法，并包含一个循环，允许随着时间推移测试小部件动画。

示例用法：

testWidgets('Test widget animation', (WidgetTester tester) async { 
  final widget = MyWidget(); 
  await FlutterTestUtils.pumpWidgetWithAnimation(widget, tester); 
  expect(find.byType(MyWidget), findsOneWidget); 
});  

testWidgetState

此方法在一段时间后测试小部件的状态。该方法包装了 tester.pumpAndSettle 方法，并包含一个循环，允许随着时间推移测试小部件状态。

示例用法：

testWidgets('Test widget state', (WidgetTester tester) async { 
  final widget = MyWidget(); 
  await  FlutterTestUtils.testWidgetState(widget, tester); 
  expect(find.byType(MyWidget), findsOneWidget); 
});  

testWidgetTap

此方法测试当某个项目被点击时小部件的行为。

示例用法：

testWidgets('Test widget tap', (WidgetTester tester) async { 
  final widget = MyWidget(); 
  await  FlutterTestUtils.testWidgetTap(widget, tester); 
  expect(find.byType(MyOtherWidget), findsOneWidget); 
});  

testWidgetLongPress

此方法测试当某个项目被长按压时小部件的行为。

示例用法：

testWidgets('Test widget long press', (WidgetTester tester) async { 
  final widget = MyWidget(); 
  await  FlutterTestUtils.testWidgetLongPress(widget, tester); 
  expect(find.byType(MyOtherWidget), findsOneWidget); 
});  

testWidgetScroll

此方法测试当某个项目被滚动时小部件的行为。

示例用法：

testWidgets('Test widget scroll', (WidgetTester tester) async { 
  final widget = MyWidget(); 
  await  FlutterTestUtils.testWidgetScroll(widget, tester, 100.0); 
  expect(find.byType(MyOtherWidget), findsOneWidget); 
});  

testWidgetDialog

此方法测试小部件树中是否存在对话框。

示例用法：

await FlutterTestUtils.testWidgetDialog(tester, find.byType(Dialog));  
expect(find.byType(Dialog), findsOneWidget);  

testWidgetSnackbar

此方法测试小部件树中是否存在通知栏。

示例用法：

final snackbarText = 'Snackbar text';  
await FlutterTestUtils.testWidgetSnackbar(tester, snackbarText);  
expect(find.text(snackbarText), findsOneWidget);  

testWidgetAbsence

此方法测试小部件树中是否不存在某个小部件。

示例用法：

final widget = MyWidget();  
await tester.pumpWidget(widget);  
await FlutterTestUtils.testWidgetAbsence(tester, find.byType(SnackBar));  
expect(find.byType(SnackBar), findsNothing);  

示例代码

以下是完整的示例代码：

import 'package:flutter/material.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:flutter_test_utils/flutter_test_utils.dart';

void main() {
  testWidgets('Test widget animation', (WidgetTester tester) async {
    final widget = MyWidget();
    await FlutterTestUtils.pumpWidgetWithAnimation(widget, tester);
    expect(find.byType(MyWidget), findsOneWidget);
  });

  testWidgets('Test widget with future', (WidgetTester tester) async {
    await FlutterTestUtils.waitForWidget(
        find.byType(MyWidgetWithFuture), tester);
    expect(find.byType(MyWidgetWithFuture), findsOneWidget);
  });

  testWidgets('Test widget state', (WidgetTester tester) async {
    final widget = MyWidget();
    await FlutterTestUtils.testWidgetState(widget, tester);
    expect(find.byType(MyWidget), findsOneWidget);
  });

  testWidgets('Test widget tap', (WidgetTester tester) async {
    final widget = MyWidget();
    await FlutterTestUtils.testWidgetTap(widget, tester);
    expect(find.byType(MyOtherWidget), findsOneWidget);
  });

  testWidgets('Test widget long press', (WidgetTester tester) async {
    final widget = MyWidget();
    await FlutterTestUtils.testWidgetLongPress(widget, tester);
    expect(find.byType(MyOtherWidget), findsOneWidget);
  });

  testWidgets('Test widget scroll', (WidgetTester tester) async {
    final widget = MyWidget();
    await FlutterTestUtils.testWidgetScroll(widget, tester, 100.0);
    expect(find.byType(MyOtherWidget), findsOneWidget);
  });

  testWidgets('Test widget dialog', (WidgetTester tester) async {
    final widget = MyWidget();
    await tester.pumpWidget(widget);
    await FlutterTestUtils.testWidgetDialog(tester, find.byType(Dialog));
    expect(find.byType(Dialog), findsOneWidget);
  });

  testWidgets('Test widget snackbar', (WidgetTester tester) async {
    final snackbarText = 'Snackbar text';
    await FlutterTestUtils.testWidgetSnackbar(tester, snackbarText);
    expect(find.text(snackbarText), findsOneWidget);
  });

  testWidgets('Test widget absence', (WidgetTester tester) async {
    final widget = MyWidget();
    await tester.pumpWidget(widget);
    await FlutterTestUtils.testWidgetAbsence(tester, find.byType(SnackBar));
    expect(find.byType(SnackBar), findsNothing);
  });
}

class MyWidget extends StatelessWidget {
  const MyWidget({Key key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const Placeholder();
  }
}

class MyOtherWidget extends StatelessWidget {
  const MyOtherWidget({Key key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const SingleChildScrollView(
      child: SizedBox(
        height: 500.0,
      ),
    );
  }
}

class MyWidgetWithFuture extends StatefulWidget {
  const MyWidgetWithFuture({Key key}) : super(key: key);

  [@override](/user/override)
  State<MyWidgetWithFuture> createState() => _MyWidgetWithFutureState();
}

class _MyWidgetWithFutureState extends State<MyWidgetWithFuture> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return FutureBuilder(builder: (c, _) {
      return SizedBox.shrink();
    });
  }
}