Flutter蛋糕展示或制作插件cake的使用

Flutter蛋糕展示或制作插件cake的使用

在本教程中，我们将详细介绍如何使用cake插件来展示或制作蛋糕。cake插件是一个轻量级且灵活的单元测试框架，现在支持Flutter。通过这个插件，你可以轻松地编写和运行测试用例，确保你的蛋糕展示或制作功能按预期工作。

特性

• 轻量级与灵活性：易于设置，快速运行，并且可以无缝集成到Dart和Flutter项目中。
• 清晰的测试组织：通过分组和结构化测试来提高可读性。使用灵活的上下文选项可以在多个级别之间共享可重用数据。
• 内置模拟：包含一个可选的轻量级模拟框架，具有调用跟踪、参数历史记录和灵活匹配器。
• 结构化的测试流程：通过定义设置、操作、断言和清理阶段来编写干净、原子的测试，以便进行有针对性、可维护的测试。
• IDE集成：原生支持Cake VSCode扩展，可以在编辑器内执行测试、调试、测试覆盖率可视化等，增强开发体验。

开始使用

安装

Dart

1. 全局安装Cake测试运行器：

   dart pub global activate cake
   

2. （可选）安装VSCode扩展：
3. 在pubspec.yaml文件中添加cake包作为开发依赖：

   dart pub add dev:cake
   

Flutter

1. 全局安装Cake测试运行器：

   dart pub global activate cake
   

2. （可选）安装VSCode扩展：
3. 在pubspec.yaml文件中添加cake_flutter包作为开发依赖（这也会包括cake包）：

   flutter pub add dev:cake_flutter
   

运行测试

1. Cake会搜索以.cake.dart为后缀的文件。
2. 命令行运行测试：

   dart run cake
   

   你也可以通过添加标志来运行特定测试或查看特定测试的输出。
3. 使用VS Code运行测试：
   • 在测试浏览器或直接在文件中运行或调试测试。（详情参见Marketplace页面）

编写单元测试

让我们从一个简单的例子开始：

import 'package:cake/cake.dart';

TestRunnerOf<String>('API Service Test', [
  Group('Get Hello World', [
    Test(
      'Response payload should return "Hello world" if successful',
      action: (test) async => APIService.getHelloWorld(),
      assertions: (test) => [
        Expect.equals(actual: test.actual, expected: 'Hello world'),
      ],
    ),
  ]),
]);

完整的例子可以在examples/test/api.cake.dart中找到。

测试组织

Cake依赖于层次结构来组织测试。所有测试都必须包裹在一个TestRunner中。可以从那里直接列出测试，或者进一步嵌套到组中。建议每个文件只有一个TestRunner。

import 'package:cake/cake.dart';

void main() {
  TestRunnerDefault('Example Test Runner', [
    Group('Example Group', [
      Test(
        'Test inside a group',
        assertions: (test) => [Expect.isTrue(true)],
      ),
      Group('Nested Group', []),
    ]),
    Test(
        'Test directly under TestRunner',
        assertions: (test) => [Expect.isTrue(true)],
      ),
  ]);
}

测试阶段

Cake鼓励开发者通过定义不同的阶段来编写干净、简单的原子测试。你可以将这些阶段类比为“安排-行动-断言”或“给定-当-然后”风格的单元测试。这里，你可以将其类比为“设置-行动-断言”（如果需要，还可以包括清理阶段）。

所有阶段都可以编写为异步函数。

Test(
  'Stages Example',
  setup: (test) {
    // 设置阶段通常用于创建任何模拟，准备环境，
    // 或者在一般情况下，任何不是动作步骤的东西。
    test.value = 'setup';
  },
  action: (test) {
    // 动作阶段应该包括为了测试断言而需要改变的部分。
    // 这个函数允许返回一个值，该值会被分配给测试的"实际"值，尽管这不是必需的。
    return test.value == 'setup';
  },
  assertions: (test) => [
    // 断言必须返回一个Expect的集合。
    Expect<String>.isType(test.value),
    Expect.isTrue(test.actual),
  ],
  teardown: (test) => test.value = 'teardown',
),

上下文

上下文是如何信息从一个阶段传递到另一个阶段的方式，它是一个可继承的对象，从父节点传递到子节点。这可以通过每个阶段的参数传递。默认情况下，测试有一个实际值，一个期望值，以及一个额外的映射表来通过临时传递信息。

TestRunnerDefault('Simple Test with Default Context', [
    Test('True is true', assertions: (test) => [Expect.isTrue(true)]),
    Test('Foo is bar', action: (test) => test['foo'] = 'bar', assertions: (test) => [
      Expect.equals(actual: test['foo'], expected: 'bar')
    ]),
  ],
);

示例代码

以下是一个完整的示例代码，展示了如何使用cake插件来编写和运行测试：

import 'package:cake/cake.dart';

void main() {
  TestRunnerDefault('Cake Example', [
    Group('Setup and Teardown', [
      Test(
        'This test should have the parent context included',
        assertions: (test) => [
          Expect.equals(actual: test.value, expected: 'Test Runner Setup'),
        ],
      ),
      Group(
        'Can override and pass down context',
        [
          Test(
            'Child has parent context',
            assertions: (test) => [
              Expect.equals(actual: test.value, expected: 'Group Setup'),
            ],
          ),
        ],
        setup: (test) {
          test.value = 'Group Setup';
        },
        teardown: (test) {
          test.value = 'Test Runner Setup';
        }
      ),
    ]),
    Test(
      'Test directly under TestRunner',
      assertions: (test) => [Expect.isTrue(true)],
    ),
    setup: (test) {
      test.value = 'Test Runner Setup';
    },
    teardown: (test) {
      test.value = 'Tests have run';
    }
  ]);
}