packages/flutter_tools/lib/src/commands/test.dart - external/github.com/flutter/flutter - Git at Google

 // 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:math' as math;

 import 'package:meta/meta.dart';

 import '../asset.dart';
 import '../base/common.dart';
 import '../base/file_system.dart';
 import '../build_info.dart';
 import '../bundle_builder.dart';
 import '../devfs.dart';
 import '../device.dart';
 import '../globals.dart' as globals;
 import '../project.dart';
 import '../runner/flutter_command.dart';
 import '../test/coverage_collector.dart';
 import '../test/event_printer.dart';
 import '../test/runner.dart';
 import '../test/test_wrapper.dart';
 import '../test/watcher.dart';

 /// The name of the directory where Integration Tests are placed.
 ///
 /// When there are test files specified for the test command that are part of
 /// this directory, *relative to the package root*, the files will be executed
 /// as Integration Tests.
 const String _kIntegrationTestDirectory = 'integration_test';

 /// A command to run tests.
 ///
 /// This command has two modes of execution:
 ///
 /// ## Unit / Widget Tests
 ///
 /// These tests run in the Flutter Tester, which is a desktop-based Flutter
 /// embedder. In this mode, tests are quick to compile and run.
 ///
 /// By default, if no flags are passed to the `flutter test` command, the Tool
 /// will recursively find all files within the `test/` directory that end with
 /// the `*_test.dart` suffix, and run them in a single invocation.
 ///
 /// See:
 /// - https://flutter.dev/docs/cookbook/testing/unit/introduction
 /// - https://flutter.dev/docs/cookbook/testing/widget/introduction
 ///
 /// ## Integration Tests
 ///
 /// These tests run in a connected Flutter Device, similar to `flutter run`. As
 /// a result, iteration is slower because device-based artifacts have to be
 /// built.
 ///
 /// Integration tests should be placed in the `integration_test/` directory of
 /// your package. To run these tests, use `flutter test integration_test`.
 ///
 /// See:
 /// - https://flutter.dev/docs/testing/integration-tests
 class TestCommand extends FlutterCommand with DeviceBasedDevelopmentArtifacts {
   TestCommand({
     bool verboseHelp = false,
     this.testWrapper = const TestWrapper(),
     this.testRunner = const FlutterTestRunner(),
   }) : assert(testWrapper != null) {
     requiresPubspecYaml();
     usesPubOption();
     addNullSafetyModeOptions(hide: !verboseHelp);
     usesTrackWidgetCreation(verboseHelp: verboseHelp);
     addEnableExperimentation(hide: !verboseHelp);
     usesDartDefineOption();
     usesWebRendererOption();
     usesDeviceUserOption();
     usesFlavorOption();

     argParser
       ..addMultiOption('name',
         help: 'A regular expression matching substrings of the names of tests to run.',
         valueHelp: 'regexp',
         splitCommas: false,
       )
       ..addMultiOption('plain-name',
         help: 'A plain-text substring of the names of tests to run.',
         valueHelp: 'substring',
         splitCommas: false,
       )
       ..addOption('tags',
         abbr: 't',
         help: 'Run only tests associated with the specified tags. See: https://pub.dev/packages/test#tagging-tests',
       )
       ..addOption('exclude-tags',
         abbr: 'x',
         help: 'Run only tests that do not have the specified tags. See: https://pub.dev/packages/test#tagging-tests',
       )
       ..addFlag('start-paused',
         negatable: false,
         help: 'Start in a paused mode and wait for a debugger to connect.\n'
               'You must specify a single test file to run, explicitly.\n'
               'Instructions for connecting with a debugger are printed to the '
               'console once the test has started.',
       )
       ..addFlag('run-skipped',
         help: 'Run skipped tests instead of skipping them.',
       )
       ..addFlag('disable-service-auth-codes',
         negatable: false,
         hide: !verboseHelp,
         help: '(deprecated) Allow connections to the VM service without using authentication codes. '
               '(Not recommended! This can open your device to remote code execution attacks!)'
       )
       ..addFlag('coverage',
         negatable: false,
         help: 'Whether to collect coverage information.',
       )
       ..addFlag('merge-coverage',
         negatable: false,
         help: 'Whether to merge coverage data with "coverage/lcov.base.info".\n'
               'Implies collecting coverage data. (Requires lcov.)',
       )
       ..addFlag('ipv6',
         negatable: false,
         hide: !verboseHelp,
         help: 'Whether to use IPv6 for the test harness server socket.',
       )
       ..addOption('coverage-path',
         defaultsTo: 'coverage/lcov.info',
         help: 'Where to store coverage information (if coverage is enabled).',
       )
       ..addFlag('machine',
         hide: !verboseHelp,
         negatable: false,
         help: 'Handle machine structured JSON command input '
               'and provide output and progress in machine friendly format.',
       )
       ..addFlag('update-goldens',
         negatable: false,
         help: 'Whether "matchesGoldenFile()" calls within your test methods should ' // flutter_ignore: golden_tag (see analyze.dart)
               'update the golden files rather than test for an existing match.',
       )
       ..addOption('concurrency',
         abbr: 'j',
         defaultsTo: math.max<int>(1, globals.platform.numberOfProcessors - 2).toString(),
         help: 'The number of concurrent test processes to run. This will be ignored '
               'when running integration tests.',
         valueHelp: 'jobs',
       )
       ..addFlag('test-assets',
         defaultsTo: true,
         help: 'Whether to build the assets bundle for testing. '
               'This takes additional time before running the tests. '
               'Consider using "--no-test-assets" if assets are not required.',
       )
       // --platform is not supported to be used by Flutter developers. It only
       // exists to test the Flutter framework itself and may be removed entirely
       // in the future. Developers should either use plain `flutter test`, or
       // `package:integration_test` instead.
       ..addOption('platform',
         allowed: const <String>['tester', 'chrome'],
         hide: !verboseHelp,
         defaultsTo: 'tester',
         help: 'Selects the test backend.',
         allowedHelp: <String, String>{
           'tester': 'Run tests using the VM-based test environment.',
           'chrome': '(deprecated) Run tests using the Google Chrome web browser. '
                     'This value is intended for testing the Flutter framework '
                     'itself and may be removed at any time.',
         },
       )
       ..addOption('test-randomize-ordering-seed',
         help: 'The seed to randomize the execution order of test cases within test files. '
               'Must be a 32bit unsigned integer or the string "random", '
               'which indicates that a seed should be selected randomly. '
               'By default, tests run in the order they are declared.',
       )
       ..addOption('total-shards',
         help: 'Tests can be sharded with the "--total-shards" and "--shard-index" '
               'arguments, allowing you to split up your test suites and run '
               'them separately.'
       )
       ..addOption('shard-index',
           help: 'Tests can be sharded with the "--total-shards" and "--shard-index" '
               'arguments, allowing you to split up your test suites and run '
               'them separately.'
       )
       ..addFlag('enable-vmservice',
         hide: !verboseHelp,
         help: 'Enables the VM service without "--start-paused". This flag is '
               'intended for use with tests that will use "dart:developer" to '
               'interact with the VM service at runtime.\n'
               'This flag is ignored if "--start-paused" or coverage are requested, as '
               'the VM service will be enabled in those cases regardless.'
       )
       ..addOption('reporter',
         abbr: 'r',
         defaultsTo: 'compact',
         help: 'Set how to print test results.',
         allowed: <String>['compact', 'expanded', 'json'],
         allowedHelp: <String, String>{
           'compact':  'A single line that updates dynamically.',
           'expanded': 'A separate line for each update. May be preferred when logging to a file or in continuous integration.',
           'json':     'A machine-readable format. See: https://dart.dev/go/test-docs/json_reporter.md',
         },
       )
       ..addOption('timeout',
         help: 'The default test timeout, specified either '
               'in seconds (e.g. "60s"), '
               'as a multiplier of the default timeout (e.g. "2x"), '
               'or as the string "none" to disable the timeout entirely.',
         defaultsTo: '30s',
       );
     addDdsOptions(verboseHelp: verboseHelp);
     usesFatalWarningsOption(verboseHelp: verboseHelp);
   }

   /// The interface for starting and configuring the tester.
   final TestWrapper testWrapper;

   /// Interface for running the tester process.
   final FlutterTestRunner testRunner;

   @visibleForTesting
   bool get isIntegrationTest => _isIntegrationTest;
   bool _isIntegrationTest = false;

   List<String> _testFiles = <String>[];

   @override
   Future<Set<DevelopmentArtifact>> get requiredArtifacts async {
     final Set<DevelopmentArtifact> results = _isIntegrationTest
         // Use [DeviceBasedDevelopmentArtifacts].
         ? await super.requiredArtifacts
         : <DevelopmentArtifact>{};
     if (stringArgDeprecated('platform') == 'chrome') {
       results.add(DevelopmentArtifact.web);
     }
     return results;
   }

   @override
   String get name => 'test';

   @override
   String get description => 'Run Flutter unit tests for the current project.';

   @override
   String get category => FlutterCommandCategory.project;

   @override
   Future<FlutterCommandResult> verifyThenRunCommand(String? commandPath) {
     _testFiles = argResults!.rest.map<String>(globals.fs.path.absolute).toList();
     if (_testFiles.isEmpty) {
       // We don't scan the entire package, only the test/ subdirectory, so that
       // files with names like "hit_test.dart" don't get run.
       final Directory testDir = globals.fs.directory('test');
       if (!testDir.existsSync()) {
         throwToolExit('Test directory "${testDir.path}" not found.');
       }
       _testFiles = _findTests(testDir).toList();
       if (_testFiles.isEmpty) {
         throwToolExit(
           'Test directory "${testDir.path}" does not appear to contain any test files.\n'
           'Test files must be in that directory and end with the pattern "_test.dart".'
         );
       }
     } else {
       _testFiles = <String>[
         for (String path in _testFiles)
           if (globals.fs.isDirectorySync(path))
             ..._findTests(globals.fs.directory(path))
           else
             globals.fs.path.normalize(globals.fs.path.absolute(path)),
       ];
     }

     // This needs to be set before [super.verifyThenRunCommand] so that the
     // correct [requiredArtifacts] can be identified before [run] takes place.
     _isIntegrationTest = _shouldRunAsIntegrationTests(globals.fs.currentDirectory.absolute.path, _testFiles);

     globals.printTrace(
       'Found ${_testFiles.length} files which will be executed as '
       '${_isIntegrationTest ? 'Integration' : 'Widget'} Tests.',
     );
     return super.verifyThenRunCommand(commandPath);
   }

   @override
   Future<FlutterCommandResult> runCommand() async {
     if (!globals.fs.isFileSync('pubspec.yaml')) {
       throwToolExit(
         'Error: No pubspec.yaml file found in the current working directory.\n'
         'Run this command from the root of your project. Test files must be '
         "called *_test.dart and must reside in the package's 'test' "
         'directory (or one of its subdirectories).');
     }
     final FlutterProject flutterProject = FlutterProject.current();
     final bool buildTestAssets = boolArgDeprecated('test-assets');
     final List<String> names = stringsArg('name');
     final List<String> plainNames = stringsArg('plain-name');
     final String? tags = stringArgDeprecated('tags');
     final String? excludeTags = stringArgDeprecated('exclude-tags');
     final BuildInfo buildInfo = await getBuildInfo(forcedBuildMode: BuildMode.debug);

     if (buildInfo.packageConfig['test_api'] == null) {
       throwToolExit(
         'Error: cannot run without a dependency on either "package:flutter_test" or "package:test". '
         'Ensure the following lines are present in your pubspec.yaml:'
         '\n\n'
         'dev_dependencies:\n'
         '  flutter_test:\n'
         '    sdk: flutter\n',
       );
     }

     String? testAssetDirectory;
     if (buildTestAssets) {
       await _buildTestAsset();
       testAssetDirectory = globals.fs.path.
         join(flutterProject.directory.path, 'build', 'unit_test_assets');
     }

     final bool startPaused = boolArgDeprecated('start-paused');
     if (startPaused && _testFiles.length != 1) {
       throwToolExit(
         'When using --start-paused, you must specify a single test file to run.',
         exitCode: 1,
       );
     }

     int? jobs = int.tryParse(stringArgDeprecated('concurrency')!);
     if (jobs == null || jobs <= 0 || !jobs.isFinite) {
       throwToolExit(
         'Could not parse -j/--concurrency argument. It must be an integer greater than zero.'
       );
     }
     if (_isIntegrationTest) {
       if (argResults!.wasParsed('concurrency')) {
         globals.printStatus(
           '-j/--concurrency was parsed but will be ignored, this option is not '
           'supported when running Integration Tests.',
         );
       }
       // Running with concurrency will result in deploying multiple test apps
       // on the connected device concurrently, which is not supported.
       jobs = 1;
     }

     final int? shardIndex = int.tryParse(stringArgDeprecated('shard-index') ?? '');
     if (shardIndex != null && (shardIndex < 0 || !shardIndex.isFinite)) {
       throwToolExit(
           'Could not parse --shard-index=$shardIndex argument. It must be an integer greater than -1.');
     }

     final int? totalShards = int.tryParse(stringArgDeprecated('total-shards') ?? '');
     if (totalShards != null && (totalShards <= 0 || !totalShards.isFinite)) {
       throwToolExit(
           'Could not parse --total-shards=$totalShards argument. It must be an integer greater than zero.');
     }

     if (totalShards != null && shardIndex == null) {
       throwToolExit(
           'If you set --total-shards you need to also set --shard-index.');
     }
     if (shardIndex != null && totalShards == null) {
       throwToolExit(
           'If you set --shard-index you need to also set --total-shards.');
     }

     final bool machine = boolArgDeprecated('machine');
     CoverageCollector? collector;
     if (boolArgDeprecated('coverage') || boolArgDeprecated('merge-coverage')) {
       final String projectName = flutterProject.manifest.appName;
       collector = CoverageCollector(
         verbose: !machine,
         libraryNames: <String>{projectName},
         packagesPath: buildInfo.packagesPath
       );
     }

     TestWatcher? watcher;
     if (machine) {
       watcher = EventPrinter(parent: collector, out: globals.stdio.stdout);
     } else if (collector != null) {
       watcher = collector;
     }

     final DebuggingOptions debuggingOptions = DebuggingOptions.enabled(
       buildInfo,
       startPaused: startPaused,
       disableServiceAuthCodes: boolArgDeprecated('disable-service-auth-codes'),
       // On iOS >=14, keeping this enabled will leave a prompt on the screen.
       disablePortPublication: true,
       enableDds: enableDds,
       nullAssertions: boolArgDeprecated(FlutterOptions.kNullAssertions),
     );

     Device? integrationTestDevice;
     if (_isIntegrationTest) {
       integrationTestDevice = await findTargetDevice();

       // Disable reporting of test results to native test frameworks. This isn't
       // needed as the Flutter Tool will be responsible for reporting results.
       buildInfo.dartDefines.add('INTEGRATION_TEST_SHOULD_REPORT_RESULTS_TO_NATIVE=false');

       if (integrationTestDevice == null) {
         throwToolExit(
           'No devices are connected. '
           'Ensure that `flutter doctor` shows at least one connected device',
         );
       }
       if (integrationTestDevice.platformType == PlatformType.web) {
         // TODO(jiahaog): Support web. https://github.com/flutter/flutter/issues/66264
         throwToolExit('Web devices are not supported for integration tests yet.');
       }

       if (buildInfo.packageConfig['integration_test'] == null) {
         throwToolExit(
           'Error: cannot run without a dependency on "package:integration_test". '
           'Ensure the following lines are present in your pubspec.yaml:'
           '\n\n'
           'dev_dependencies:\n'
           '  integration_test:\n'
           '    sdk: flutter\n',
         );
       }
     }

     final int result = await testRunner.runTests(
       testWrapper,
       _testFiles,
       debuggingOptions: debuggingOptions,
       names: names,
       plainNames: plainNames,
       tags: tags,
       excludeTags: excludeTags,
       watcher: watcher,
       enableObservatory: collector != null || startPaused || boolArgDeprecated('enable-vmservice'),
       ipv6: boolArgDeprecated('ipv6'),
       machine: machine,
       updateGoldens: boolArgDeprecated('update-goldens'),
       concurrency: jobs,
       testAssetDirectory: testAssetDirectory,
       flutterProject: flutterProject,
       web: stringArgDeprecated('platform') == 'chrome',
       randomSeed: stringArgDeprecated('test-randomize-ordering-seed'),
       reporter: stringArgDeprecated('reporter'),
       timeout: stringArgDeprecated('timeout'),
       runSkipped: boolArgDeprecated('run-skipped'),
       shardIndex: shardIndex,
       totalShards: totalShards,
       integrationTestDevice: integrationTestDevice,
       integrationTestUserIdentifier: stringArgDeprecated(FlutterOptions.kDeviceUser),
     );

     if (collector != null) {
       final bool collectionResult = await collector.collectCoverageData(
         stringArgDeprecated('coverage-path'),
         mergeCoverageData: boolArgDeprecated('merge-coverage'),
       );
       if (!collectionResult) {
         throwToolExit(null);
       }
     }

     if (result != 0) {
       throwToolExit(null);
     }
     return FlutterCommandResult.success();
   }

   Future<void> _buildTestAsset() async {
     final AssetBundle assetBundle = AssetBundleFactory.instance.createBundle();
     final int build = await assetBundle.build(packagesPath: '.packages');
     if (build != 0) {
       throwToolExit('Error: Failed to build asset bundle');
     }
     if (_needRebuild(assetBundle.entries)) {
       await writeBundle(globals.fs.directory(globals.fs.path.join('build', 'unit_test_assets')),
           assetBundle.entries, assetBundle.entryKinds);
     }
   }

   bool _needRebuild(Map<String, DevFSContent> entries) {
     final File manifest = globals.fs.file(globals.fs.path.join('build', 'unit_test_assets', 'AssetManifest.json'));
     if (!manifest.existsSync()) {
       return true;
     }
     final DateTime lastModified = manifest.lastModifiedSync();
     final File pub = globals.fs.file('pubspec.yaml');
     if (pub.lastModifiedSync().isAfter(lastModified)) {
       return true;
     }

     for (final DevFSFileContent entry in entries.values.whereType<DevFSFileContent>()) {
       // Calling isModified to access file stats first in order for isModifiedAfter
       // to work.
       if (entry.isModified && entry.isModifiedAfter(lastModified)) {
         return true;
       }
     }
     return false;
   }
 }

 /// Searches [directory] and returns files that end with `_test.dart` as
 /// absolute paths.
 Iterable<String> _findTests(Directory directory) {
   return directory.listSync(recursive: true, followLinks: false)
       .where((FileSystemEntity entity) => entity.path.endsWith('_test.dart') &&
       globals.fs.isFileSync(entity.path))
       .map((FileSystemEntity entity) => globals.fs.path.absolute(entity.path));
 }

 /// Returns true if there are files that are Integration Tests.
 ///
 /// The [currentDirectory] and [testFiles] parameters here must be provided as
 /// absolute paths.
 ///
 /// Throws an exception if there are both Integration Tests and Widget Tests
 /// found in [testFiles].
 bool _shouldRunAsIntegrationTests(String currentDirectory, List<String> testFiles) {
   final String integrationTestDirectory = globals.fs.path.join(currentDirectory, _kIntegrationTestDirectory);

   if (testFiles.every((String absolutePath) => !absolutePath.startsWith(integrationTestDirectory))) {
     return false;
   }

   if (testFiles.every((String absolutePath) => absolutePath.startsWith(integrationTestDirectory))) {
     return true;
   }

   throwToolExit(
     'Integration tests and unit tests cannot be run in a single invocation.'
     ' Use separate invocations of `flutter test` to run integration tests'
     ' and unit tests.'
   );
 }
	// 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:math' as math;

	import 'package:meta/meta.dart';

	import '../asset.dart';
	import '../base/common.dart';
	import '../base/file_system.dart';
	import '../build_info.dart';
	import '../bundle_builder.dart';
	import '../devfs.dart';
	import '../device.dart';
	import '../globals.dart' as globals;
	import '../project.dart';
	import '../runner/flutter_command.dart';
	import '../test/coverage_collector.dart';
	import '../test/event_printer.dart';
	import '../test/runner.dart';
	import '../test/test_wrapper.dart';
	import '../test/watcher.dart';

	/// The name of the directory where Integration Tests are placed.
	///
	/// When there are test files specified for the test command that are part of
	/// this directory, relative to the package root, the files will be executed
	/// as Integration Tests.
	const String _kIntegrationTestDirectory = 'integration_test';

	/// A command to run tests.
	///
	/// This command has two modes of execution:
	///
	/// ## Unit / Widget Tests
	///
	/// These tests run in the Flutter Tester, which is a desktop-based Flutter
	/// embedder. In this mode, tests are quick to compile and run.
	///
	/// By default, if no flags are passed to the `flutter test` command, the Tool
	/// will recursively find all files within the `test/` directory that end with
	/// the `*_test.dart` suffix, and run them in a single invocation.
	///
	/// See:
	/// - https://flutter.dev/docs/cookbook/testing/unit/introduction
	/// - https://flutter.dev/docs/cookbook/testing/widget/introduction
	///
	/// ## Integration Tests
	///
	/// These tests run in a connected Flutter Device, similar to `flutter run`. As
	/// a result, iteration is slower because device-based artifacts have to be
	/// built.
	///
	/// Integration tests should be placed in the `integration_test/` directory of
	/// your package. To run these tests, use `flutter test integration_test`.
	///
	/// See:
	/// - https://flutter.dev/docs/testing/integration-tests
	class TestCommand extends FlutterCommand with DeviceBasedDevelopmentArtifacts {
	TestCommand({
	bool verboseHelp = false,
	this.testWrapper = const TestWrapper(),
	this.testRunner = const FlutterTestRunner(),
	}) : assert(testWrapper != null) {
	requiresPubspecYaml();
	usesPubOption();
	addNullSafetyModeOptions(hide: !verboseHelp);
	usesTrackWidgetCreation(verboseHelp: verboseHelp);
	addEnableExperimentation(hide: !verboseHelp);
	usesDartDefineOption();
	usesWebRendererOption();
	usesDeviceUserOption();
	usesFlavorOption();

	argParser
	..addMultiOption('name',
	help: 'A regular expression matching substrings of the names of tests to run.',
	valueHelp: 'regexp',
	splitCommas: false,
	)
	..addMultiOption('plain-name',
	help: 'A plain-text substring of the names of tests to run.',
	valueHelp: 'substring',
	splitCommas: false,
	)
	..addOption('tags',
	abbr: 't',
	help: 'Run only tests associated with the specified tags. See: https://pub.dev/packages/test#tagging-tests',
	)
	..addOption('exclude-tags',
	abbr: 'x',
	help: 'Run only tests that do not have the specified tags. See: https://pub.dev/packages/test#tagging-tests',
	)
	..addFlag('start-paused',
	negatable: false,
	help: 'Start in a paused mode and wait for a debugger to connect.\n'
	'You must specify a single test file to run, explicitly.\n'
	'Instructions for connecting with a debugger are printed to the '
	'console once the test has started.',
	)
	..addFlag('run-skipped',
	help: 'Run skipped tests instead of skipping them.',
	)
	..addFlag('disable-service-auth-codes',
	negatable: false,
	hide: !verboseHelp,
	help: '(deprecated) Allow connections to the VM service without using authentication codes. '
	'(Not recommended! This can open your device to remote code execution attacks!)'
	)
	..addFlag('coverage',
	negatable: false,
	help: 'Whether to collect coverage information.',
	)
	..addFlag('merge-coverage',
	negatable: false,
	help: 'Whether to merge coverage data with "coverage/lcov.base.info".\n'
	'Implies collecting coverage data. (Requires lcov.)',
	)
	..addFlag('ipv6',
	negatable: false,
	hide: !verboseHelp,
	help: 'Whether to use IPv6 for the test harness server socket.',
	)
	..addOption('coverage-path',
	defaultsTo: 'coverage/lcov.info',
	help: 'Where to store coverage information (if coverage is enabled).',
	)
	..addFlag('machine',
	hide: !verboseHelp,
	negatable: false,
	help: 'Handle machine structured JSON command input '
	'and provide output and progress in machine friendly format.',
	)
	..addFlag('update-goldens',
	negatable: false,
	help: 'Whether "matchesGoldenFile()" calls within your test methods should ' // flutter_ignore: golden_tag (see analyze.dart)
	'update the golden files rather than test for an existing match.',
	)
	..addOption('concurrency',
	abbr: 'j',
	defaultsTo: math.max<int>(1, globals.platform.numberOfProcessors - 2).toString(),
	help: 'The number of concurrent test processes to run. This will be ignored '
	'when running integration tests.',
	valueHelp: 'jobs',
	)
	..addFlag('test-assets',
	defaultsTo: true,
	help: 'Whether to build the assets bundle for testing. '
	'This takes additional time before running the tests. '
	'Consider using "--no-test-assets" if assets are not required.',
	)
	// --platform is not supported to be used by Flutter developers. It only
	// exists to test the Flutter framework itself and may be removed entirely
	// in the future. Developers should either use plain `flutter test`, or
	// `package:integration_test` instead.
	..addOption('platform',
	allowed: const <String>['tester', 'chrome'],
	hide: !verboseHelp,
	defaultsTo: 'tester',
	help: 'Selects the test backend.',
	allowedHelp: <String, String>{
	'tester': 'Run tests using the VM-based test environment.',
	'chrome': '(deprecated) Run tests using the Google Chrome web browser. '
	'This value is intended for testing the Flutter framework '
	'itself and may be removed at any time.',
	},
	)
	..addOption('test-randomize-ordering-seed',
	help: 'The seed to randomize the execution order of test cases within test files. '
	'Must be a 32bit unsigned integer or the string "random", '
	'which indicates that a seed should be selected randomly. '
	'By default, tests run in the order they are declared.',
	)
	..addOption('total-shards',
	help: 'Tests can be sharded with the "--total-shards" and "--shard-index" '
	'arguments, allowing you to split up your test suites and run '
	'them separately.'
	)
	..addOption('shard-index',
	help: 'Tests can be sharded with the "--total-shards" and "--shard-index" '
	'arguments, allowing you to split up your test suites and run '
	'them separately.'
	)
	..addFlag('enable-vmservice',
	hide: !verboseHelp,
	help: 'Enables the VM service without "--start-paused". This flag is '
	'intended for use with tests that will use "dart:developer" to '
	'interact with the VM service at runtime.\n'
	'This flag is ignored if "--start-paused" or coverage are requested, as '
	'the VM service will be enabled in those cases regardless.'
	)
	..addOption('reporter',
	abbr: 'r',
	defaultsTo: 'compact',
	help: 'Set how to print test results.',
	allowed: <String>['compact', 'expanded', 'json'],
	allowedHelp: <String, String>{
	'compact': 'A single line that updates dynamically.',
	'expanded': 'A separate line for each update. May be preferred when logging to a file or in continuous integration.',
	'json': 'A machine-readable format. See: https://dart.dev/go/test-docs/json_reporter.md',
	},
	)
	..addOption('timeout',
	help: 'The default test timeout, specified either '
	'in seconds (e.g. "60s"), '
	'as a multiplier of the default timeout (e.g. "2x"), '
	'or as the string "none" to disable the timeout entirely.',
	defaultsTo: '30s',
	);
	addDdsOptions(verboseHelp: verboseHelp);
	usesFatalWarningsOption(verboseHelp: verboseHelp);
	}

	/// The interface for starting and configuring the tester.
	final TestWrapper testWrapper;

	/// Interface for running the tester process.
	final FlutterTestRunner testRunner;

	@visibleForTesting
	bool get isIntegrationTest => _isIntegrationTest;
	bool _isIntegrationTest = false;

	List<String> _testFiles = <String>[];

	@override
	Future<Set<DevelopmentArtifact>> get requiredArtifacts async {
	final Set<DevelopmentArtifact> results = _isIntegrationTest
	// Use [DeviceBasedDevelopmentArtifacts].
	? await super.requiredArtifacts
	: <DevelopmentArtifact>{};
	if (stringArgDeprecated('platform') == 'chrome') {
	results.add(DevelopmentArtifact.web);
	}
	return results;
	}

	@override
	String get name => 'test';

	@override
	String get description => 'Run Flutter unit tests for the current project.';

	@override
	String get category => FlutterCommandCategory.project;

	@override
	Future<FlutterCommandResult> verifyThenRunCommand(String? commandPath) {
	_testFiles = argResults!.rest.map<String>(globals.fs.path.absolute).toList();
	if (_testFiles.isEmpty) {
	// We don't scan the entire package, only the test/ subdirectory, so that
	// files with names like "hit_test.dart" don't get run.
	final Directory testDir = globals.fs.directory('test');
	if (!testDir.existsSync()) {
	throwToolExit('Test directory "${testDir.path}" not found.');
	}
	_testFiles = _findTests(testDir).toList();
	if (_testFiles.isEmpty) {
	throwToolExit(
	'Test directory "${testDir.path}" does not appear to contain any test files.\n'
	'Test files must be in that directory and end with the pattern "_test.dart".'
	);
	}
	} else {
	_testFiles = <String>[
	for (String path in _testFiles)
	if (globals.fs.isDirectorySync(path))
	..._findTests(globals.fs.directory(path))
	else
	globals.fs.path.normalize(globals.fs.path.absolute(path)),
	];
	}

	// This needs to be set before [super.verifyThenRunCommand] so that the
	// correct [requiredArtifacts] can be identified before [run] takes place.
	_isIntegrationTest = _shouldRunAsIntegrationTests(globals.fs.currentDirectory.absolute.path, _testFiles);

	globals.printTrace(
	'Found ${_testFiles.length} files which will be executed as '
	'${_isIntegrationTest ? 'Integration' : 'Widget'} Tests.',
	);
	return super.verifyThenRunCommand(commandPath);
	}

	@override
	Future<FlutterCommandResult> runCommand() async {
	if (!globals.fs.isFileSync('pubspec.yaml')) {
	throwToolExit(
	'Error: No pubspec.yaml file found in the current working directory.\n'
	'Run this command from the root of your project. Test files must be '
	"called *_test.dart and must reside in the package's 'test' "
	'directory (or one of its subdirectories).');
	}
	final FlutterProject flutterProject = FlutterProject.current();
	final bool buildTestAssets = boolArgDeprecated('test-assets');
	final List<String> names = stringsArg('name');
	final List<String> plainNames = stringsArg('plain-name');
	final String? tags = stringArgDeprecated('tags');
	final String? excludeTags = stringArgDeprecated('exclude-tags');
	final BuildInfo buildInfo = await getBuildInfo(forcedBuildMode: BuildMode.debug);

	if (buildInfo.packageConfig['test_api'] == null) {
	throwToolExit(
	'Error: cannot run without a dependency on either "package:flutter_test" or "package:test". '
	'Ensure the following lines are present in your pubspec.yaml:'
	'\n\n'
	'dev_dependencies:\n'
	' flutter_test:\n'
	' sdk: flutter\n',
	);
	}

	String? testAssetDirectory;
	if (buildTestAssets) {
	await _buildTestAsset();
	testAssetDirectory = globals.fs.path.
	join(flutterProject.directory.path, 'build', 'unit_test_assets');
	}

	final bool startPaused = boolArgDeprecated('start-paused');
	if (startPaused && _testFiles.length != 1) {
	throwToolExit(
	'When using --start-paused, you must specify a single test file to run.',
	exitCode: 1,
	);
	}

	int? jobs = int.tryParse(stringArgDeprecated('concurrency')!);
	if (jobs == null \|\| jobs <= 0 \|\| !jobs.isFinite) {
	throwToolExit(
	'Could not parse -j/--concurrency argument. It must be an integer greater than zero.'
	);
	}
	if (_isIntegrationTest) {
	if (argResults!.wasParsed('concurrency')) {
	globals.printStatus(
	'-j/--concurrency was parsed but will be ignored, this option is not '
	'supported when running Integration Tests.',
	);
	}
	// Running with concurrency will result in deploying multiple test apps
	// on the connected device concurrently, which is not supported.
	jobs = 1;
	}

	final int? shardIndex = int.tryParse(stringArgDeprecated('shard-index') ?? '');
	if (shardIndex != null && (shardIndex < 0 \|\| !shardIndex.isFinite)) {
	throwToolExit(
	'Could not parse --shard-index=$shardIndex argument. It must be an integer greater than -1.');
	}

	final int? totalShards = int.tryParse(stringArgDeprecated('total-shards') ?? '');
	if (totalShards != null && (totalShards <= 0 \|\| !totalShards.isFinite)) {
	throwToolExit(
	'Could not parse --total-shards=$totalShards argument. It must be an integer greater than zero.');
	}

	if (totalShards != null && shardIndex == null) {
	throwToolExit(
	'If you set --total-shards you need to also set --shard-index.');
	}
	if (shardIndex != null && totalShards == null) {
	throwToolExit(
	'If you set --shard-index you need to also set --total-shards.');
	}

	final bool machine = boolArgDeprecated('machine');
	CoverageCollector? collector;
	if (boolArgDeprecated('coverage') \|\| boolArgDeprecated('merge-coverage')) {
	final String projectName = flutterProject.manifest.appName;
	collector = CoverageCollector(
	verbose: !machine,
	libraryNames: <String>{projectName},
	packagesPath: buildInfo.packagesPath
	);
	}

	TestWatcher? watcher;
	if (machine) {
	watcher = EventPrinter(parent: collector, out: globals.stdio.stdout);
	} else if (collector != null) {
	watcher = collector;
	}

	final DebuggingOptions debuggingOptions = DebuggingOptions.enabled(
	buildInfo,
	startPaused: startPaused,
	disableServiceAuthCodes: boolArgDeprecated('disable-service-auth-codes'),
	// On iOS >=14, keeping this enabled will leave a prompt on the screen.
	disablePortPublication: true,
	enableDds: enableDds,
	nullAssertions: boolArgDeprecated(FlutterOptions.kNullAssertions),
	);

	Device? integrationTestDevice;
	if (_isIntegrationTest) {
	integrationTestDevice = await findTargetDevice();

	// Disable reporting of test results to native test frameworks. This isn't
	// needed as the Flutter Tool will be responsible for reporting results.
	buildInfo.dartDefines.add('INTEGRATION_TEST_SHOULD_REPORT_RESULTS_TO_NATIVE=false');

	if (integrationTestDevice == null) {
	throwToolExit(
	'No devices are connected. '
	'Ensure that `flutter doctor` shows at least one connected device',
	);
	}
	if (integrationTestDevice.platformType == PlatformType.web) {
	// TODO(jiahaog): Support web. https://github.com/flutter/flutter/issues/66264
	throwToolExit('Web devices are not supported for integration tests yet.');
	}

	if (buildInfo.packageConfig['integration_test'] == null) {
	throwToolExit(
	'Error: cannot run without a dependency on "package:integration_test". '
	'Ensure the following lines are present in your pubspec.yaml:'
	'\n\n'
	'dev_dependencies:\n'
	' integration_test:\n'
	' sdk: flutter\n',
	);
	}
	}

	final int result = await testRunner.runTests(
	testWrapper,
	_testFiles,
	debuggingOptions: debuggingOptions,
	names: names,
	plainNames: plainNames,
	tags: tags,
	excludeTags: excludeTags,
	watcher: watcher,
	enableObservatory: collector != null \|\| startPaused \|\| boolArgDeprecated('enable-vmservice'),
	ipv6: boolArgDeprecated('ipv6'),
	machine: machine,
	updateGoldens: boolArgDeprecated('update-goldens'),
	concurrency: jobs,
	testAssetDirectory: testAssetDirectory,
	flutterProject: flutterProject,
	web: stringArgDeprecated('platform') == 'chrome',
	randomSeed: stringArgDeprecated('test-randomize-ordering-seed'),
	reporter: stringArgDeprecated('reporter'),
	timeout: stringArgDeprecated('timeout'),
	runSkipped: boolArgDeprecated('run-skipped'),
	shardIndex: shardIndex,
	totalShards: totalShards,
	integrationTestDevice: integrationTestDevice,
	integrationTestUserIdentifier: stringArgDeprecated(FlutterOptions.kDeviceUser),
	);

	if (collector != null) {
	final bool collectionResult = await collector.collectCoverageData(
	stringArgDeprecated('coverage-path'),
	mergeCoverageData: boolArgDeprecated('merge-coverage'),
	);
	if (!collectionResult) {
	throwToolExit(null);
	}
	}

	if (result != 0) {
	throwToolExit(null);
	}
	return FlutterCommandResult.success();
	}

	Future<void> _buildTestAsset() async {
	final AssetBundle assetBundle = AssetBundleFactory.instance.createBundle();
	final int build = await assetBundle.build(packagesPath: '.packages');
	if (build != 0) {
	throwToolExit('Error: Failed to build asset bundle');
	}
	if (_needRebuild(assetBundle.entries)) {
	await writeBundle(globals.fs.directory(globals.fs.path.join('build', 'unit_test_assets')),
	assetBundle.entries, assetBundle.entryKinds);
	}
	}

	bool _needRebuild(Map<String, DevFSContent> entries) {
	final File manifest = globals.fs.file(globals.fs.path.join('build', 'unit_test_assets', 'AssetManifest.json'));
	if (!manifest.existsSync()) {
	return true;
	}
	final DateTime lastModified = manifest.lastModifiedSync();
	final File pub = globals.fs.file('pubspec.yaml');
	if (pub.lastModifiedSync().isAfter(lastModified)) {
	return true;
	}

	for (final DevFSFileContent entry in entries.values.whereType<DevFSFileContent>()) {
	// Calling isModified to access file stats first in order for isModifiedAfter
	// to work.
	if (entry.isModified && entry.isModifiedAfter(lastModified)) {
	return true;
	}
	}
	return false;
	}
	}

	/// Searches [directory] and returns files that end with `_test.dart` as
	/// absolute paths.
	Iterable<String> _findTests(Directory directory) {
	return directory.listSync(recursive: true, followLinks: false)
	.where((FileSystemEntity entity) => entity.path.endsWith('_test.dart') &&
	globals.fs.isFileSync(entity.path))
	.map((FileSystemEntity entity) => globals.fs.path.absolute(entity.path));
	}

	/// Returns true if there are files that are Integration Tests.
	///
	/// The [currentDirectory] and [testFiles] parameters here must be provided as
	/// absolute paths.
	///
	/// Throws an exception if there are both Integration Tests and Widget Tests
	/// found in [testFiles].
	bool _shouldRunAsIntegrationTests(String currentDirectory, List<String> testFiles) {
	final String integrationTestDirectory = globals.fs.path.join(currentDirectory, _kIntegrationTestDirectory);

	if (testFiles.every((String absolutePath) => !absolutePath.startsWith(integrationTestDirectory))) {
	return false;
	}

	if (testFiles.every((String absolutePath) => absolutePath.startsWith(integrationTestDirectory))) {
	return true;
	}

	throwToolExit(
	'Integration tests and unit tests cannot be run in a single invocation.'
	' Use separate invocations of `flutter test` to run integration tests'
	' and unit tests.'
	);
	}