Flutter应用测试与反馈插件testfairy_flutter的使用

TestFairy Flutter集成

这是Flutter的TestFairy集成，包含原生SDK。

安装

阅读安装文档：pub.dartlang.org

快速开始

在您的项目中引入库并运行主应用程序如下：

确保您的项目是AndroidX兼容的。最低支持的iOS目标版本为11.0。

pubspec.yaml文件配置

dependencies:
  testfairy_flutter: any

main.dart文件示例

// [@dart](/user/dart) = 2.18 
import 'dart:async';
import 'dart:io';
import 'package:testfairy_flutter/testfairy_flutter.dart';

void main() {
  HttpOverrides.global = TestFairy.httpOverrides();

  runZonedGuarded(
    () async {
      try {
        FlutterError.onError = (details) => TestFairy.logError(details.exception);

        // 调用 `await TestFairy.begin()` 或其他设置代码
        await TestFairy.begin('YOUR_APP_TOKEN');

        runApp(TestFairyGestureDetector(child: TestfairyExampleApp()));
      } catch (error) {
        TestFairy.logError(error);
      }
    },
    (e, s) {
      TestFairy.logError(e);
    },
    zoneSpecification: new ZoneSpecification(
      print: (self, parent, zone, message) {
        TestFairy.log(message);
      },
    )
  );
}

如何使用最新版的Flutter和Null-safe Dart编译？

为了使用最新的稳定版Flutter通道中的TestFairy，您必须将插件的最低版本设置为2.1.0。

对于最新的不稳定版Flutter通道，请克隆此仓库，并将其作为离线依赖项使用，而不是在pub上发布的版本。

1. 克隆repo。
2. 使用以下代码将克隆作为离线依赖项（假设两个项目位于同一目录下作为兄弟目录）：

dependencies:
  testfairy_flutter:
    path: ../testfairy-flutter # 或 "./testfairy-flutter" 如果你在主项目内克隆它作为一个子目录

1. 将testfairy-flutter添加到你的VCS，但不包括其.git目录。
2. 当此仓库有更新时，删除testfairy-flutter并重试上述步骤。

故障排除

• 我看到warning: None of the architectures in ARCHS (x86_64) are valid错误。

启动Runner工作区，并在Build Settings中将VALID_ARCHS添加x86_64。

• 我看到Specs satisfying the TestFairy dependency were found, but they required a higher minimum deployment target.错误。

您需要更新本地SDK以及CocoaPods仓库。

运行pod repo update并在pubspec.yaml中更新插件。然后运行cd ios; pod update TestFairy; cd ..。

更多详细信息请参见完整文档和示例代码。

示例Demo

以下是完整的示例Demo，演示如何使用TestFairy Flutter插件进行各种测试和功能调用。

// [@dart](/user/dart) = 2.18
import 'dart:async';
import 'dart:core';
import 'dart:io';
import 'package:flutter/material.dart';
import 'package:http/http.dart' as http;
import 'package:testfairy_flutter/testfairy_flutter.dart';

const String APP_TOKEN = 'SDK-gLeZiE9i';

void main() {
  HttpOverrides.global = TestFairy.httpOverrides();

  runZonedGuarded(() async {
    try {
      FlutterError.onError = (FlutterErrorDetails? details) =>
          TestFairy.logError(details?.exception ?? 'Unknown error');
      await TestFairy.begin(APP_TOKEN);
      runApp(TestFairyGestureDetector(child: TestfairyExampleApp()));
    } catch (error) {
      TestFairy.logError(error);
    }
  }, (Object e, StackTrace s) {
    TestFairy.logError(e);
  }, zoneSpecification: ZoneSpecification(
    print: (Zone self, ZoneDelegate parent, Zone zone, String message) {
      TestFairy.log(message);
    },
  ));
}

class TestfairyExampleApp extends StatefulWidget {
  [@override](/user/override)
  _TestfairyExampleAppState createState() => _TestfairyExampleAppState();
}

class _TestfairyExampleAppState extends State<TestfairyExampleApp> {
  String errorMessage = 'No error yet.';
  String testName = '';
  bool testing = false;

  GlobalKey hiddenWidgetKey = GlobalKey();

  [@override](/user/override)
  void initState() {
    super.initState();
    TestFairy.hideWidget(hiddenWidgetKey);
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      showPerformanceOverlay: true,
      home: Scaffold(
        appBar: AppBar(title: const Text('Testfairy Plugin Example App')),
        body: Center(
          child: SingleChildScrollView(
            child: Column(
              children: [
                ElevatedButton(
                  onPressed: onCoolButton,
                  child: const Text('Cool Button'),
                ),
                ElevatedButton(
                  onPressed: onLifecycleTests,
                  child: const Text('Lifecycle Tests'),
                ),
                ElevatedButton(
                  onPressed: onServerEndpointTest,
                  child: const Text('Server Endpoint Test'),
                ),
                ElevatedButton(
                  onPressed: onFeedbackTests,
                  child: const Text('Feedback Tests'),
                ),
                Text('HIDE ME FROM SCREENSHOTS', key: hiddenWidgetKey),
              ],
            ),
          ),
        ),
      ),
    );
  }

  void beginTest(String name) {
    setState(() {
      testing = true;
      testName = name;
    });
  }

  void endTest() {
    setState(() {
      testing = false;
      testName = '';
    });
  }

  void setError(dynamic error) {
    setState(() {
      errorMessage = error != null ? error.toString() : 'Unknown error';
    });
  }

  void onCoolButton() async {
    if (testing) return;
    beginTest('Cool Button');
    try {
      await TestFairy.begin(APP_TOKEN);
      await Future<void>.delayed(const Duration(seconds: 20));
      await TestFairy.stop();
    } catch (e) {
      setError(e);
    }
    endTest();
  }

  void onLifecycleTests() async {
    if (testing) return;
    beginTest('Lifecycle');
    try {
      await TestFairy.begin(APP_TOKEN);
      await Future<void>.delayed(const Duration(seconds: 2));
      await TestFairy.pause();
      await Future<void>.delayed(const Duration(seconds: 2));
      await TestFairy.resume();
      await Future<void>.delayed(const Duration(seconds: 2));
      await TestFairy.stop();
    } catch (e) {
      setError(e);
    }
    endTest();
  }

  void onServerEndpointTest() async {
    if (testing) return;
    beginTest('Server Endpoint');
    try {
      await TestFairy.setServerEndpoint('http://example.com');
      await TestFairy.begin(APP_TOKEN);
      await Future<void>.delayed(const Duration(seconds: 1));
      await TestFairy.stop();
    } catch (e) {
      setError(e);
    }
    endTest();
  }

  void onFeedbackTests() async {
    if (testing) return;
    beginTest('Feedbacks');
    try {
      await TestFairy.begin(APP_TOKEN);
      await Future<void>.delayed(const Duration(seconds: 2));
      await TestFairy.sendUserFeedback('Dummy feedback from Flutter');
      await TestFairy.showFeedbackForm();
    } catch (e) {
      setError(e);
    }
    endTest();
  }
}