packages/flutter_test/test/flutter_test_config.dart

// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:async';
import 'dart:io';

import 'package:flutter/foundation.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:leak_tracker_flutter_testing/leak_tracker_flutter_testing.dart';

/// If true, leak tracking is enabled for all `test`.
///
/// By default it is false.
/// To enable the leak tracking, either pass the compilation flag
/// `--dart-define LEAK_TRACKING=true` or invoke `export LEAK_TRACKING=true`.
///
/// See documentation for [testWidgets] on how to except individual tests.
bool _isLeakTrackingEnabled() {
  if (kIsWeb) {
    return false;
  }
  // The values can be different, one is compile time, another is run time.
  return const bool.fromEnvironment('LEAK_TRACKING') ||
      (bool.tryParse(Platform.environment['LEAK_TRACKING'] ?? '') ?? false);
}

/// Test configuration for each test library in this directory.
///
/// See https://api.flutter.dev/flutter/flutter_test/flutter_test-library.html.
Future<void> testExecutable(FutureOr<void> Function() testMain) async {
  if (_isLeakTrackingEnabled()) {
    LeakTesting.enable();
    LeakTracking.warnForUnsupportedPlatforms = false;
    // Customized link to documentation on how to troubleshoot leaks,
    // to print in the error message.
    LeakTracking.troubleshootingDocumentationLink =
        'https://github.com/flutter/flutter/blob/main/docs/contributing/testing/Leak-tracking.md';
    // Do not ignore createdByTestHelpers here, as this is a test of the test
    // helper itself.
  }

  return testMain();
}