如何测试在 Flutter 中使用 DateTime.now 的代码？

Question

我有这个 class:

import 'package:flutter/material.dart';

class AgeText extends StatelessWidget {
  final String dateOfBirth;

  const AgeText({Key key, @required this.dateOfBirth}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    final age = _calculateAge();
    return Text(age.toString());
  }

  int _calculateAge() {
    final dateOfBirthDate = DateTime.parse(dateOfBirth);
    final difference = DateTime.now().difference(dateOfBirthDate);
    final age = difference.inDays / 365;

    return age.floor();
  }
}

我想测试它在将出生日期传递给它时是否生成正确的年龄。在 Flutter 中执行此操作的最佳方法是什么？

解决方案：对于那些感兴趣的人，这里是使用@Günter Zöchbauer 对 clock 包的建议的解决方案。

我的插件class:

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

class AgeText extends StatelessWidget {
  final String dateOfBirth;
  final Clock clock;

  const AgeText({Key key, @required this.dateOfBirth, this.clock = const Clock()}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    final age = _calculateAge();
    return Text(age.toString());
  }

  int _calculateAge() {
    final dateOfBirthDate = DateTime.parse(dateOfBirth);
    final difference = clock.now().difference(dateOfBirthDate);
    final age = difference.inDays / 365;

    return age.floor();
  }
}

和我的测试 class:

import 'package:clock/clock.dart';
import 'package:flutter/material.dart';
import 'package:flutter_app/age.dart';
import 'package:flutter_test/flutter_test.dart';

void main() {
  testWidgets("shows age 30 when date of birth is 30 years ago", (WidgetTester tester) async {
    final mockClock = Clock.fixed(DateTime(2000, 01, 01));
    final testableWidget = MaterialApp(
      home: AgeText(
        dateOfBirth: "1970-01-01T00:00:00",
        clock: mockClock,
      ),
    );

    await tester.pumpWidget(testableWidget);

    expect(find.text("30"), findsOneWidget);
  });
}

Answer 1

如果您使用 clock 包作为依赖于 DateTime.now() 的代码，您可以轻松地模拟它。

我不认为没有围绕 DateTime.now() 的包装器的好方法就像 clock 包提供的那样。

Answer 2

如此处所述：在 DateTime 上实施扩展。

extension CustomizableDateTime on DateTime {
  static DateTime _customTime;
  static DateTime get current {
    return _customTime ?? DateTime.now();
  }

  static set customTime(DateTime customTime) {
    _customTime = customTime;
  }
}

然后在生产代码中使用CustomizableDateTime.current。您可以像这样修改测试中的返回值：CustomizableDateTime.customTime = DateTime.parse("1969-07-20 20:18:04");。无需使用第三方库。

Answer 3

正如 Günter 所说，the clock package，由 Dart 团队维护，提供了一种非常巧妙的方法来实现这一目标。

正常使用：

import 'package:clock/clock.dart';

void main() {
  // prints current date and time
  print(clock.now());
}

覆盖当前时间：

import 'package:clock/clock.dart';

void main() {
  withClock(
    Clock.fixed(DateTime(2000)),
    () {
      // always prints 2000-01-01 00:00:00.
      print(clock.now());
    },
  );
}

我写的更详细了on my blog。

对于小部件测试，您需要将 pumpWidget、pump 和 expect 包装在 withClock 回调中。

如何测试在 Flutter 中使用 DateTime.now 的代码？

How to test code that uses DateTime.now in Flutter?

flutter

flutter-test