Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/VeryGoodOpenSource/very_good_performance
Utility on top of the Flutter Driver API that facilitates measuring the performance of your app in an automated way created by Very Good Ventures 🦄
https://github.com/VeryGoodOpenSource/very_good_performance
automation dart e2e flutter performance test
Last synced: about 2 months ago
JSON representation
Utility on top of the Flutter Driver API that facilitates measuring the performance of your app in an automated way created by Very Good Ventures 🦄
- Host: GitHub
- URL: https://github.com/VeryGoodOpenSource/very_good_performance
- Owner: VeryGoodOpenSource
- License: mit
- Archived: true
- Created: 2021-05-19T19:03:35.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-10T18:04:35.000Z (almost 2 years ago)
- Last Synced: 2024-09-19T20:47:57.311Z (3 months ago)
- Topics: automation, dart, e2e, flutter, performance, test
- Language: C++
- Homepage: https://pub.dev/packages/very_good_performance
- Size: 899 KB
- Stars: 81
- Watchers: 4
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
⚠️ Attention: This repository has been archived and is now read-only!
# Very Good Performance
[![Very Good Ventures][logo_white]][very_good_ventures_link_dark]
[![Very Good Ventures][logo_black]][very_good_ventures_link_light]
Developed with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄
[![ci][ci_badge]][ci_link]
[![coverage][coverage_badge]][ci_link]
[![pub package][pub_badge]][pub_link]
[![License: MIT][license_badge]][license_link]
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_badge_link]
---
Utility on top of the [Flutter Driver API](https://api.flutter.dev/flutter/flutter_driver/flutter_driver-library.html) that facilitates measuring the performance of your app in an automated way
## Usage
#### `very_good_performance.yaml`
Add a new file at root of your project named `very_good_performance.yaml` with the following fields.
You can modify these values to match your own performance expectations.
```yaml
performance_report:
directory: performance/reports
integration_test_expectations:
should_fail_build_on_warning: true
should_fail_build_on_error: true
performance_metrics:
missed_frames_threshold:
warning: 5
error: 10
average_frame_build_rate_threshold:
warning_time_in_milliseconds: 14.0
error_time_in_milliseconds: 16.0
worst_frame_build_rate_threshold:
warning_time_in_milliseconds: 14.0
error_time_in_milliseconds: 16.0
```
#### Running tests with `FlutterDriver`
Simply wrap your `FlutterDriver` tests with the method `capturePerformanceReport` to start collecting performance information
```dart
test('tapping on the Increment button updates the counter', () async {
await driver.capturePerformanceReport(
reportName: 'counter_performance',
action: () async {
await driver.tap(find.byType(FloatingActionButton));
expect(await driver.getText(find.text('1')), '1');
await driver.tap(find.byType(FloatingActionButton));
expect(await driver.getText(find.text('2')), '2');
},
);
});
```
At the end of the execution, you will see a similar report to this one:
#### Running the example project
You can find an `example` project that showcases how to use this library.
```bash
$> cd example
$> flutter drive --target=e2e/e2e.dart --driver=e2e/counter_test.dart -d macos --profile
```
You should see the Counter app running and, at the end of the execution, it will print the performance overview in the console, and will generate the performance reports under `e2e/performance/reports`.
[ci_badge]: https://github.com/VeryGoodOpenSource/very_good_performance/workflows/ci/badge.svg
[ci_link]: https://github.com/VeryGoodOpenSource/very_good_performance/actions
[coverage_badge]: https://raw.githubusercontent.com/VeryGoodOpenSource/very_good_performance/main/coverage_badge.svg
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
[license_link]: https://opensource.org/licenses/MIT
[logo_black]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_black.png#gh-light-mode-only
[logo_white]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_white.png#gh-dark-mode-only
[pub_badge]: https://img.shields.io/pub/v/very_good_performance.svg
[pub_link]: https://pub.dartlang.org/packages/very_good_performance
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
[very_good_analysis_badge_link]: https://pub.dev/packages/very_good_analysis
[very_good_ventures_link]: https://verygood.ventures
[very_good_ventures_link_dark]: https://verygood.ventures#gh-dark-mode-only
[very_good_ventures_link_light]: https://verygood.ventures#gh-light-mode-only