Unverified Commit 59242b75 authored by Polina Cherkasova's avatar Polina Cherkasova Committed by GitHub

Add command line parameter that turns on leak tracking. (#138653)

parent c56bea32
......@@ -11,6 +11,17 @@ import 'package:leak_tracker_flutter_testing/leak_tracker_flutter_testing.dart';
import '_goldens_io.dart'
if (dart.library.html) '_goldens_web.dart' as flutter_goldens;
/// If true, leak tracking will be enabled for all tests `testWidgetsWithLeakTracking`.
///
/// By default, the constant is false.
/// To enable the leak tracking for all tests, either pass the compilation flag
/// `--dart-define=flutter_test_config.leak_tracking=true` or
/// temporarily pass `defaultValue = true` to `fromEnvironment` in the constant definition.
///
/// To enable leak tracking for an individual test file, add the line to the test `main`:
/// `LeakTesting.settings = LeakTesting.settings.withTrackedAll()`.
const bool _kLeakTracking = bool.fromEnvironment('LEAK_TRACKING');
/// Test configuration for each test library in this directory.
///
/// See https://api.flutter.dev/flutter/flutter_test/flutter_test-library.html.
......@@ -25,11 +36,10 @@ Future<void> testExecutable(FutureOr<void> Function() testMain) {
LeakTracking.warnForUnsupportedPlatforms = false;
// TODO(polina-c): clean up leaks and stop ignoring them.
// https://github.com/flutter/flutter/issues/137311
// Leak tracking is off by default. To temporary enable it add `.withTrackedAll()` after `settings`.
LeakTesting.settings = LeakTesting
.settings
// TODO(polina-c): clean up leaks and stop ignoring them.
// https://github.com/flutter/flutter/issues/137311
.withIgnored(
allNotGCed: true,
notDisposed: <String, int?>{
......@@ -37,6 +47,12 @@ Future<void> testExecutable(FutureOr<void> Function() testMain) {
},
);
// Leak tracking is off by default.
// To enable it, follow doc for [_kLeakTracking].
if (_kLeakTracking) {
LeakTesting.settings = LeakTesting.settings.withTrackedAll();
}
// Enable golden file testing using Skia Gold.
return flutter_goldens.testExecutable(testMain);
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment