Flutter未知功能插件elementary_test的探索使用

描述

Elementary-test 是一个为基于 Elementary 构建的应用程序提供便捷测试功能的库。它主要针对 Elementary 包中的 WidgetModel 提供了一些实用的测试工具。

主要特性

• testWidgetModel 方法：用于执行对 WidgetModel 的测试，包括准备 WidgetModel 和定义测试逻辑。
• Mock 对象：通过模拟对象来控制和验证 WidgetModel 的行为。
• 生命周期管理：可以模拟 WidgetModel 的生命周期事件（如 didChangeDependencies），以测试不同阶段的行为。

使用示例

1. 创建测试用的 Model 和 WidgetModel

首先，我们需要创建一个简单的计数器应用，包含增加和减少操作，并且在操作时显示加载状态。

import 'package:elementary/elementary.dart';
import 'package:flutter/material.dart';

class TestPageModel extends ElementaryModel {
  var _value = 0;
  int get value => _value;

  Future<int> increment() async {
    await Future<void>.delayed(const Duration(seconds: 1));
    return ++_value;
  }

  Future<int> decrement() async {
    await Future<void>.delayed(const Duration(seconds: 1));
    if (_value > 0) {
      _value--;
    }
    return _value;
  }
}

class TestPageWidgetModel extends WidgetModel<TestPageWidget, TestPageModel> {
  late ValueNotifier<String> _valueController;
  final _calculatingController = ValueNotifier<bool>(false);

  ValueListenable<String> get valueState => _valueController;
  ValueListenable<bool> get calculatingState => _calculatingController;

  TestPageWidgetModel(TestPageModel model) : super(model);

  Future<void> increment() async {
    _calculatingController.value = true;
    final newVal = await model.increment();
    _valueController.value = newVal.toString();
    _calculatingController.value = false;
  }

  Future<void> decrement() async {
    _calculatingController.value = true;
    final newVal = await model.decrement();
    _valueController.value = newVal.toString();
    _calculatingController.value = false;
  }

  @override
  void initWidgetModel() {
    super.initWidgetModel();
    _valueController = ValueNotifier<String>(model.value.toString());
  }

  @override
  void dispose() {
    _valueController.dispose();
    _calculatingController.dispose();
    super.dispose();
  }
}

2. 编写测试代码

接下来，我们将编写一些测试用例来验证 TestPageWidgetModel 的行为。

import 'package:elementary_test/elementary_test.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:mockito/mockito.dart';

void main() {
  late TestPageModelMock model;

  TestPageWidgetModel setUpWm() {
    model = TestPageModelMock();
    when(() => model.value).thenReturn(0);
    when(() => model.increment()).thenAnswer((invocation) => Future.value(1));

    return TestPageWidgetModel(model);
  }

  testWidgetModel<TestPageWidgetModel, TestPageWidget>(
    'calculatingState should return true while incrementing before the answer was received',
    setUpWm,
    (wm, tester, context) async {
      tester.init();

      when(() => model.increment()).thenAnswer(
        (invocation) => Future.delayed(
          const Duration(milliseconds: 30),
          () => 1,
        ),
      );

      unawaited(wm.increment());

      await Future<void>.delayed(
        const Duration(milliseconds: 10),
      );

      expect(wm.calculatingState.value, isTrue);
    },
  );

  testWidgetModel<TestPageWidgetModel, TestPageWidget>(
    'calculatingState should return false after getting the answer of incrementing',
    setUpWm,
    (wm, tester, context) async {
      tester.init();

      when(() => model.increment()).thenAnswer(
        (invocation) => Future.delayed(
          const Duration(milliseconds: 30),
          () => 1,
        ),
      );

      unawaited(wm.increment());

      await Future<void>.delayed(
        const Duration(milliseconds: 31),
      );

      expect(wm.calculatingState.value, isFalse);
    },
  );

  testWidgetModel<TestPageWidgetModel, TestPageWidget>(
    'should happen something depending on lifecycle',
    setUpWm,
    (wm, tester, context) async {
      tester.init();

      // Emulate didChangeDependencies happened.
      tester.didChangeDependencies();

      // Test what ever we expect happened in didChangeDependencies;
      // ...
    },
  );
}

class TestPageModelMock extends Mock with MockElementaryModelMixin implements TestPageModel {}

3. 运行测试

确保你已经安装了必要的依赖项，并运行以下命令来执行测试：

flutter pub get
flutter test

这将运行所有编写的测试用例，并验证 TestPageWidgetModel 在不同情况下的行为是否符合预期。

总结

通过 elementary_test 插件，我们可以轻松地对基于 Elementary 构建的应用程序进行单元测试。这个插件提供了强大的工具来模拟 WidgetModel 的行为，并验证其在不同生命周期阶段的表现。希望这篇教程能帮助你在 Flutter 开发中更好地利用 elementary_test 进行测试。