testfairy 1.0.0

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • new50

testfairy #

TestFairy integration for Flutter, bundles with the native SDK.

Installation #

See details...

Quick Start #

Include the library and run your main app like this.

# inside pubspec.yaml

dependencies:
  testfairy: any
// inside you main.dart

import 'package:testfairy/testfairy.dart';

void main() {
  runZoned(
    () async {
      try {
        FlutterError.onError = (details) => TestFairy.logError(details.exception);

        // Do any other SDK setup here
        await TestFairy.begin('TOKEN');

        runApp(TestfairyExampleApp());
      } catch (error) {
        TestFairy.logError(error);
      }
    },
    onError: TestFairy.logError,
    zoneSpecification: new ZoneSpecification(
      print: (self, parent, zone, message) => TestFairy.log(message)
    )
  );
}

Docs #

Go to docs...

Development #

  1. Install Flutter.
  2. Connect an Android device.
  3. Run flutter packages get in both root and example folder.
  4. Run ./test.sh in the main folder and wait for tests to complete.
  5. (Optional) Run ./run.sh and tap buttons to see what happens.
  6. (Optional) Run ./profile.sh in the main folder and tap around to benchmark.
  7. Edit example/lib/main.dart and example/test_driver/app_test.dart to add a test case.
  8. Edit lib/testfairy_flutter.dart to add more SDK integration.
  9. Run ./docs.sh to generate documentation for offline usage.

TODO #

  1. Add iOS support.
  2. Add video support on Android.
  3. Add network logging.

1.0.0 #

  • Initial release.

example/README.md

Example SDK App (also includes test cases) #

Demonstrates how to use the TestFairy plugin. Execute flutter run in this folder to see it in action.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  testfairy: ^1.0.0

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter packages get

Alternatively, your editor might support flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:testfairy/testfairy.dart';
  
Version Uploaded Documentation Archive
1.0.0 Mar 13, 2019 Go to the documentation of testfairy 1.0.0 Download testfairy 1.0.0 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
50
Learn more about scoring.

We analyzed this package on Mar 13, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.2.0
  • pana: 0.12.14
  • Flutter: 1.3.3

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health issues and suggestions

Document public APIs. (-1 points)

53 out of 53 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Format lib/testfairy.dart.

Run flutter format to format lib/testfairy.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.68.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11
meta 1.1.6 1.1.7
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8