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

简介

Honey 是一个用于 Flutter 应用的端到端测试框架。它设计得非常易于设置和使用。HoneyTalk 测试语言自然易读，功能强大，可以轻松编写复杂的测试。

安装与配置

添加依赖

在 pubspec.yaml 文件中添加 Honey 依赖：

dependencies:
  honey: ^0.1.0

然后运行以下命令安装包：

flutter pub get

初始化 Honey

在 main() 函数中初始化 HoneyWidgetsBinding。我们建议使用 --dart-defines 只在测试构建中启用 Honey：

const kIsHoney = bool.fromEnvironment('HONEY');

void main() {
  if (kIsHoney) {
    HoneyWidgetsBinding.ensureInitialized();
  }

  runApp(MyApp());
}

配置 VSCode

你可以在 launch.json 中添加一个启动配置来运行带有 Honey 的应用：

{
  "name": "Honey Mode",
  "request": "launch",
  "type": "dart",
  "program": "lib/main.dart",
  "args": ["--dart-define", "HONEY=true"]
}

始终通过 VSCode 运行你的应用，以便使用 VSCode 扩展。

编写测试

简单示例

Honey 使用可访问性树来查找屏幕上的小部件，这使得测试设计师无需担心应用的实现细节或了解 Flutter 即可编写测试。以下是一个简单的测试示例：

// sample-counter-app.honey
tap on "Increment"
expect text "Counter: 1"

复杂示例

HoneyTalk 是一种全功能编程语言，默认情况下是异步的，因此你无需使用 delay 或 wait 来等待动画完成。以下是一个更复杂的示例：

// sample-clickup-login.honey
tap on "Email"
enter "simon@clickup.com"
tap on "Password"
enter "notMyPassword"
tap on "Log In"
expect text "Welcome, Simon!"

引用和上下文

Honey 理解引用和上下文，这使得在复杂应用中查找小部件变得容易。以下是一些示例：

// sample-references.honey
tap on "List Item 1"
expect text "Details for List Item 1"

条件

Honey 允许你在测试中使用条件（尽管我们建议保持测试尽可能简单）：

// sample-conditions.honey
if exists "Log In" {
  tap on "Log In"
} else {
  expect text "Already Logged In"
}

可访问性覆盖层

Honey 依赖于可访问性树来查找屏幕上的小部件。为了使测试可靠且有趣，你应该确保你的应用是可访问的。Honey 带有一个“Honey 覆盖层”，可以帮助你实现这一点。你无需进行任何配置，只需启用 Honey 运行应用即可看到覆盖层。

Honey VSCode 扩展

Honey 提供了一个 VSCode 扩展，允许你直接从编辑器中运行测试。它还提供了语法高亮显示。

安装 VSCode 扩展后，创建一个 your_test.honey 文件并以测试模式运行 Flutter 应用。你可以从“Run and Debug”面板或“Testing”树中运行测试。

扩展 HoneyTalk

在某些情况下，你可能希望从 HoneyTalk 测试中调用 Dart 函数，例如注入登录令牌或验证 API 响应。HoneyTalk 是完全模块化的，允许你重写或扩展语言中的每个函数。以下是一个定义自定义登录函数的示例：

import 'package:honey/honey.dart';

Future<EvaluatedExpr> honeyLogin(HoneyContext ctx, Map<String, Expr> params) async {
  final email = await ctx.eval(params['email']);
  final password = await ctx.eval(params['password']);

  // 执行登录逻辑
  // 例如：
  // final response = await http.post(Uri.parse('https://api.example.com/login'), body: {'email': email, 'password': password});
  // if (response.statusCode == 200) {
  //   return val(true);
  // } else {
  //   return val(false);
  // }

  return val(true);
}

在 HoneyTalk 中调用该函数：

login with email "simon@clickup.com" and password "notMyPassword"

你还可以重写内置的 Honey 函数。例如，你可以重写 F.add 函数来修改加法的实现方式。

示例代码

以下是一个完整的示例项目，展示了如何在 Flutter 应用中使用 Honey：

pubspec.yaml

name: honey_example
description: A new Flutter project.

publish_to: 'none' # Remove this line if you wish to publish to pub.dev

version: 1.0.0+1

environment:
  sdk: ">=2.17.0 <3.0.0"

dependencies:
  flutter:
    sdk: flutter
  honey: ^0.1.0

dev_dependencies:
  flutter_test:
    sdk: flutter
  flutter_lints: ^2.0.0

flutter:
  uses-material-design: true

main.dart

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

const kIsHoney = bool.fromEnvironment('HONEY');

void main() {
  if (kIsHoney) {
    HoneyWidgetsBinding.ensureInitialized();
  }

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Honey Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Honey Example Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline4,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}

sample-counter-app.honey

tap on "Increment"
expect text "1"

launch.json

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Honey Mode",
      "request": "launch",
      "type": "dart",
      "program": "lib/main.dart",
      "args": ["--dart-define", "HONEY=true"]
    }
  ]
}

通过以上步骤，你可以在 Flutter 应用中成功集成和使用 Honey 进行端到端测试。希望这些信息对你有所帮助！