firka/flutter
firka/flutter
5
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add validator execution times to flutter doctor --verbose (#158124)

Browse Source 
Should help provide more information for `flutter doctor` timeouts like
we've seen in https://github.com/flutter/flutter/issues/157513
This commit is contained in:
Ben Konyi 2025-01-13 16:01:44 -05:00 committed by GitHub
parent 5f06c091b9
commit b3e65358d7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
17 changed files with 804 additions and 545 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
packages/flutter_tools/lib/src/android/android_studio_validator.dart
View File

@ -52,7 +52,7 @@ class AndroidStudioValidator extends DoctorValidator {
} }
@override @override
Future<ValidationResult> validate() async { Future<ValidationResult> validateImpl() async {
final List<ValidationMessage> messages = <ValidationMessage>[]; final List<ValidationMessage> messages = <ValidationMessage>[];
ValidationType type = ValidationType.missing; ValidationType type = ValidationType.missing;
@ -125,7 +125,7 @@ class NoAndroidStudioValidator extends DoctorValidator {
final UserMessages _userMessages; final UserMessages _userMessages;
@override @override
Future<ValidationResult> validate() async { Future<ValidationResult> validateImpl() async {
final List<ValidationMessage> messages = <ValidationMessage>[]; final List<ValidationMessage> messages = <ValidationMessage>[];
final String? cfgAndroidStudio = _config.getValue('android-studio-dir') as String?; final String? cfgAndroidStudio = _config.getValue('android-studio-dir') as String?;

4
packages/flutter_tools/lib/src/android/android_workflow.dart
View File

@ -134,7 +134,7 @@ class AndroidValidator extends DoctorValidator {
} }
@override @override
Future<ValidationResult> validate() async { Future<ValidationResult> validateImpl() async {
final List<ValidationMessage> messages = <ValidationMessage>[]; final List<ValidationMessage> messages = <ValidationMessage>[];
final AndroidSdk? androidSdk = _androidSdk; final AndroidSdk? androidSdk = _androidSdk;
if (androidSdk == null) { if (androidSdk == null) {
@ -267,7 +267,7 @@ class AndroidLicenseValidator extends DoctorValidator {
String get slowWarning => 'Checking Android licenses is taking an unexpectedly long time...'; String get slowWarning => 'Checking Android licenses is taking an unexpectedly long time...';
@override @override
Future<ValidationResult> validate() async { Future<ValidationResult> validateImpl() async {
final List<ValidationMessage> messages = <ValidationMessage>[]; final List<ValidationMessage> messages = <ValidationMessage>[];
// Match pre-existing early termination behavior // Match pre-existing early termination behavior

290
packages/flutter_tools/lib/src/doctor.dart
View File

@ -63,9 +63,11 @@ abstract class DoctorValidatorsProvider {
} }
/// The singleton instance, pulled from the [AppContext]. /// The singleton instance, pulled from the [AppContext].
static DoctorValidatorsProvider get _instance => context.get<DoctorValidatorsProvider>()!; static DoctorValidatorsProvider get _instance =>
context.get<DoctorValidatorsProvider>()!;
static final DoctorValidatorsProvider defaultInstance = _DefaultDoctorValidatorsProvider( static final DoctorValidatorsProvider defaultInstance =
_DefaultDoctorValidatorsProvider(
logger: globals.logger, logger: globals.logger,
platform: globals.platform, platform: globals.platform,
featureFlags: featureFlags, featureFlags: featureFlags,
@ -93,7 +95,8 @@ class _DefaultDoctorValidatorsProvider implements DoctorValidatorsProvider {
featureFlags: featureFlags, featureFlags: featureFlags,
); );
late final WebWorkflow webWorkflow = WebWorkflow(platform: platform, featureFlags: featureFlags); late final WebWorkflow webWorkflow =
WebWorkflow(platform: platform, featureFlags: featureFlags);
late final MacOSWorkflow macOSWorkflow = MacOSWorkflow( late final MacOSWorkflow macOSWorkflow = MacOSWorkflow(
platform: platform, platform: platform,
@ -126,15 +129,16 @@ class _DefaultDoctorValidatorsProvider implements DoctorValidatorsProvider {
processManager: globals.processManager, processManager: globals.processManager,
logger: _logger, logger: _logger,
), ),
...VsCodeValidator.installedValidators(globals.fs, platform, globals.processManager), ...VsCodeValidator.installedValidators(
globals.fs, platform, globals.processManager),
]; ];
final ProxyValidator proxyValidator = ProxyValidator(platform: platform); final ProxyValidator proxyValidator = ProxyValidator(platform: platform);
_validators = <DoctorValidator>[ _validators = <DoctorValidator>[
FlutterValidator( FlutterValidator(
fileSystem: globals.fs, fileSystem: globals.fs,
platform: globals.platform, platform: globals.platform,
flutterVersion: flutterVersion: () => globals.flutterVersion
() => globals.flutterVersion.fetchTagsAndGetVersion(clock: globals.systemClock), .fetchTagsAndGetVersion(clock: globals.systemClock),
devToolsVersion: () => globals.cache.devToolsVersion, devToolsVersion: () => globals.cache.devToolsVersion,
processManager: globals.processManager, processManager: globals.processManager,
userMessages: globals.userMessages, userMessages: globals.userMessages,
@ -152,8 +156,10 @@ class _DefaultDoctorValidatorsProvider implements DoctorValidatorsProvider {
), ),
), ),
if (androidWorkflow!.appliesToHostPlatform) if (androidWorkflow!.appliesToHostPlatform)
GroupedValidator(<DoctorValidator>[androidValidator!, androidLicenseValidator!]), GroupedValidator(
if (globals.iosWorkflow!.appliesToHostPlatform || macOSWorkflow.appliesToHostPlatform) <DoctorValidator>[androidValidator!, androidLicenseValidator!]),
if (globals.iosWorkflow!.appliesToHostPlatform ||
macOSWorkflow.appliesToHostPlatform)
GroupedValidator(<DoctorValidator>[ GroupedValidator(<DoctorValidator>[
XcodeValidator( XcodeValidator(
xcode: globals.xcode!, xcode: globals.xcode!,
@ -183,7 +189,9 @@ class _DefaultDoctorValidatorsProvider implements DoctorValidatorsProvider {
if (ideValidators.isNotEmpty) ...ideValidators else NoIdeValidator(), if (ideValidators.isNotEmpty) ...ideValidators else NoIdeValidator(),
if (proxyValidator.shouldShow) proxyValidator, if (proxyValidator.shouldShow) proxyValidator,
if (globals.deviceManager?.canListAnything ?? false) if (globals.deviceManager?.canListAnything ?? false)
DeviceValidator(deviceManager: globals.deviceManager, userMessages: globals.userMessages), DeviceValidator(
deviceManager: globals.deviceManager,
userMessages: globals.userMessages),
HttpHostValidator( HttpHostValidator(
platform: globals.platform, platform: globals.platform,
featureFlags: featureFlags, featureFlags: featureFlags,
@ -208,10 +216,13 @@ class _DefaultDoctorValidatorsProvider implements DoctorValidatorsProvider {
} }
class Doctor { class Doctor {
Doctor({required Logger logger, required SystemClock clock, Analytics? analytics}) Doctor(
: _logger = logger, {required Logger logger,
_clock = clock, required SystemClock clock,
_analytics = analytics ?? globals.analytics; Analytics? analytics})
: _logger = logger,
_clock = clock,
_analytics = analytics ?? globals.analytics;
final Logger _logger; final Logger _logger;
final SystemClock _clock; final SystemClock _clock;
@ -224,39 +235,41 @@ class Doctor {
/// Return a list of [ValidatorTask] objects and starts validation on all /// Return a list of [ValidatorTask] objects and starts validation on all
/// objects in [validators]. /// objects in [validators].
List<ValidatorTask> startValidatorTasks() => <ValidatorTask>[ List<ValidatorTask> startValidatorTasks() => <ValidatorTask>[
for (final DoctorValidator validator in validators) for (final DoctorValidator validator in validators)
ValidatorTask( ValidatorTask(
validator, validator,
// We use an asyncGuard() here to be absolutely certain that // We use an asyncGuard() here to be absolutely certain that
// DoctorValidators do not result in an uncaught exception. Since the // DoctorValidators do not result in an uncaught exception. Since the
// Future returned by the asyncGuard() is not awaited, we pass an // Future returned by the asyncGuard() is not awaited, we pass an
// onError callback to it and translate errors into ValidationResults. // onError callback to it and translate errors into ValidationResults.
asyncGuard<ValidationResult>( asyncGuard<ValidationResult>(
() { () {
final Completer<ValidationResult> timeoutCompleter = Completer<ValidationResult>(); final Completer<ValidationResult> timeoutCompleter =
final Timer timer = Timer(doctorDuration, () { Completer<ValidationResult>();
timeoutCompleter.completeError( final Timer timer = Timer(doctorDuration, () {
Exception( timeoutCompleter.completeError(
'${validator.title} exceeded maximum allowed duration of $doctorDuration', Exception(
), '${validator.title} exceeded maximum allowed duration of $doctorDuration',
); ),
}); );
final Future<ValidationResult> validatorFuture = validator.validate(); });
return Future.any<ValidationResult>(<Future<ValidationResult>>[ final Future<ValidationResult> validatorFuture =
validatorFuture, validator.validate();
// This future can only complete with an error return Future.any<ValidationResult>(<Future<ValidationResult>>[
timeoutCompleter.future, validatorFuture,
]).then((ValidationResult result) async { // This future can only complete with an error
timer.cancel(); timeoutCompleter.future,
return result; ]).then((ValidationResult result) async {
}); timer.cancel();
}, return result;
onError: (Object exception, StackTrace stackTrace) { });
return ValidationResult.crash(exception, stackTrace); },
}, onError: (Object exception, StackTrace stackTrace) {
), return ValidationResult.crash(exception, stackTrace);
), },
]; ),
),
];
List<Workflow> get workflows { List<Workflow> get workflows {
return DoctorValidatorsProvider._instance.workflows; return DoctorValidatorsProvider._instance.workflows;
@ -277,7 +290,8 @@ class Doctor {
final StringBuffer lineBuffer = StringBuffer(); final StringBuffer lineBuffer = StringBuffer();
ValidationResult result; ValidationResult result;
try { try {
result = await asyncGuard<ValidationResult>(() => validator.validate()); result =
await asyncGuard<ValidationResult>(() => validator.validateImpl());
} on Exception catch (exception) { } on Exception catch (exception) {
// We're generating a summary, so drop the stack trace. // We're generating a summary, so drop the stack trace.
result = ValidationResult.crash(exception); result = ValidationResult.crash(exception);
@ -290,7 +304,8 @@ class Doctor {
case ValidationType.missing: case ValidationType.missing:
lineBuffer.write('is not installed.'); lineBuffer.write('is not installed.');
case ValidationType.partial: case ValidationType.partial:
lineBuffer.write('is partially installed; more components are available.'); lineBuffer
.write('is partially installed; more components are available.');
case ValidationType.notAvailable: case ValidationType.notAvailable:
lineBuffer.write('is not available.'); lineBuffer.write('is not available.');
case ValidationType.success: case ValidationType.success:
@ -318,7 +333,8 @@ class Doctor {
if (sawACrash) { if (sawACrash) {
buffer.writeln(); buffer.writeln();
buffer.writeln('Run "flutter doctor" for information about why a doctor check crashed.'); buffer.writeln(
'Run "flutter doctor" for information about why a doctor check crashed.');
} }
if (missingComponent) { if (missingComponent) {
@ -332,7 +348,8 @@ class Doctor {
} }
Future<bool> checkRemoteArtifacts(String engineRevision) async { Future<bool> checkRemoteArtifacts(String engineRevision) async {
return globals.cache.areRemoteArtifactsAvailable(engineVersion: engineRevision); return globals.cache
.areRemoteArtifactsAvailable(engineVersion: engineRevision);
} }
/// Maximum allowed duration for an entire validator to take. /// Maximum allowed duration for an entire validator to take.
@ -360,7 +377,8 @@ class Doctor {
} }
if (!verbose) { if (!verbose) {
_logger.printStatus('Doctor summary (to see all details, run flutter doctor -v):'); _logger.printStatus(
'Doctor summary (to see all details, run flutter doctor -v):');
} }
bool doctorResult = true; bool doctorResult = true;
int issues = 0; int issues = 0;
@ -369,7 +387,8 @@ class Doctor {
// were sent for each doctor validator and its result // were sent for each doctor validator and its result
final int analyticsTimestamp = _clock.now().millisecondsSinceEpoch; final int analyticsTimestamp = _clock.now().millisecondsSinceEpoch;
for (final ValidatorTask validatorTask in startedValidatorTasks ?? startValidatorTasks()) { for (final ValidatorTask validatorTask
in startedValidatorTasks ?? startValidatorTasks()) {
final DoctorValidator validator = validatorTask.validator; final DoctorValidator validator = validatorTask.validator;
final Status status = _logger.startSpinner( final Status status = _logger.startSpinner(
timeout: validator.slowWarningDuration, timeout: validator.slowWarningDuration,
@ -437,29 +456,41 @@ class Doctor {
DoctorResultEvent(validator: validator, result: result).send(); DoctorResultEvent(validator: validator, result: result).send();
} }
final String leadingBox = showColor ? result.coloredLeadingBox : result.leadingBox; final String executionDuration = () {
final Duration? executionTime = result.executionTime;
if (!verbose || executionTime == null) {
return '';
}
final String formatted = executionTime.inSeconds < 2
? getElapsedAsMilliseconds(executionTime)
: getElapsedAsSeconds(executionTime);
return ' [$formatted]';
}();
final String leadingBox =
showColor ? result.coloredLeadingBox : result.leadingBox;
if (result.statusInfo != null) { if (result.statusInfo != null) {
_logger.printStatus( _logger.printStatus(
'$leadingBox ${validator.title} (${result.statusInfo})', '$leadingBox ${validator.title} (${result.statusInfo})$executionDuration',
hangingIndent: result.leadingBox.length + 1, hangingIndent: result.leadingBox.length + 1);
);
} else { } else {
_logger.printStatus( _logger.printStatus('$leadingBox ${validator.title}$executionDuration',
'$leadingBox ${validator.title}', hangingIndent: result.leadingBox.length + 1);
hangingIndent: result.leadingBox.length + 1,
);
} }
for (final ValidationMessage message in result.messages) { for (final ValidationMessage message in result.messages) {
if (!message.isInformation || verbose) { if (!message.isInformation || verbose) {
int hangingIndent = 2; int hangingIndent = 2;
int indent = 4; int indent = 4;
final String indicator = showColor ? message.coloredIndicator : message.indicator; final String indicator =
showColor ? message.coloredIndicator : message.indicator;
for (final String line for (final String line
in '$indicator ${showPii ? message.message : message.piiStrippedMessage}'.split( in '$indicator ${showPii ? message.message : message.piiStrippedMessage}'
'\n', .split(
)) { '\n',
_logger.printStatus(line, hangingIndent: hangingIndent, indent: indent, emphasis: true); )) {
_logger.printStatus(line,
hangingIndent: hangingIndent, indent: indent, emphasis: true);
// Only do hanging indent for the first line. // Only do hanging indent for the first line.
hangingIndent = 0; hangingIndent = 0;
indent = 6; indent = 6;
@ -501,7 +532,8 @@ class Doctor {
return doctorResult; return doctorResult;
} }
bool get canListAnything => workflows.any((Workflow workflow) => workflow.canListDevices); bool get canListAnything =>
workflows.any((Workflow workflow) => workflow.canListDevices);
bool get canLaunchAnything { bool get canLaunchAnything {
if (FlutterTesterDevices.showFlutterTesterDevice) { if (FlutterTesterDevices.showFlutterTesterDevice) {
@ -527,16 +559,16 @@ class FlutterValidator extends DoctorValidator {
required ProcessManager processManager, required ProcessManager processManager,
required String Function() flutterRoot, required String Function() flutterRoot,
required OperatingSystemUtils operatingSystemUtils, required OperatingSystemUtils operatingSystemUtils,
}) : _flutterVersion = flutterVersion, }) : _flutterVersion = flutterVersion,
_devToolsVersion = devToolsVersion, _devToolsVersion = devToolsVersion,
_platform = platform, _platform = platform,
_userMessages = userMessages, _userMessages = userMessages,
_fileSystem = fileSystem, _fileSystem = fileSystem,
_artifacts = artifacts, _artifacts = artifacts,
_processManager = processManager, _processManager = processManager,
_flutterRoot = flutterRoot, _flutterRoot = flutterRoot,
_operatingSystemUtils = operatingSystemUtils, _operatingSystemUtils = operatingSystemUtils,
super('Flutter'); super('Flutter');
final Platform _platform; final Platform _platform;
final FlutterVersion Function() _flutterVersion; final FlutterVersion Function() _flutterVersion;
@ -549,7 +581,7 @@ class FlutterValidator extends DoctorValidator {
final OperatingSystemUtils _operatingSystemUtils; final OperatingSystemUtils _operatingSystemUtils;
@override @override
Future<ValidationResult> validate() async { Future<ValidationResult> validateImpl() async {
final List<ValidationMessage> messages = <ValidationMessage>[]; final List<ValidationMessage> messages = <ValidationMessage>[];
String? versionChannel; String? versionChannel;
String? frameworkVersion; String? frameworkVersion;
@ -561,7 +593,8 @@ class FlutterValidator extends DoctorValidator {
frameworkVersion = version.frameworkVersion; frameworkVersion = version.frameworkVersion;
final String flutterRoot = _flutterRoot(); final String flutterRoot = _flutterRoot();
messages.add(_getFlutterVersionMessage(frameworkVersion, versionChannel, flutterRoot)); messages.add(_getFlutterVersionMessage(
frameworkVersion, versionChannel, flutterRoot));
_validateRequiredBinaries(flutterRoot).forEach(messages.add); _validateRequiredBinaries(flutterRoot).forEach(messages.add);
messages.add(_getFlutterUpstreamMessage(version)); messages.add(_getFlutterUpstreamMessage(version));
@ -577,16 +610,21 @@ class FlutterValidator extends DoctorValidator {
), ),
), ),
); );
messages.add(ValidationMessage(_userMessages.engineRevision(version.engineRevisionShort))); messages.add(ValidationMessage(
messages.add(ValidationMessage(_userMessages.dartRevision(version.dartSdkVersion))); _userMessages.engineRevision(version.engineRevisionShort)));
messages.add(ValidationMessage(_userMessages.devToolsVersion(_devToolsVersion()))); messages.add(ValidationMessage(
_userMessages.dartRevision(version.dartSdkVersion)));
messages.add(
ValidationMessage(_userMessages.devToolsVersion(_devToolsVersion())));
final String? pubUrl = _platform.environment[kPubDevOverride]; final String? pubUrl = _platform.environment[kPubDevOverride];
if (pubUrl != null) { if (pubUrl != null) {
messages.add(ValidationMessage(_userMessages.pubMirrorURL(pubUrl))); messages.add(ValidationMessage(_userMessages.pubMirrorURL(pubUrl)));
} }
final String? storageBaseUrl = _platform.environment[kFlutterStorageBaseUrl]; final String? storageBaseUrl =
_platform.environment[kFlutterStorageBaseUrl];
if (storageBaseUrl != null) { if (storageBaseUrl != null) {
messages.add(ValidationMessage(_userMessages.flutterMirrorURL(storageBaseUrl))); messages.add(
ValidationMessage(_userMessages.flutterMirrorURL(storageBaseUrl)));
} }
} on VersionCheckError catch (e) { } on VersionCheckError catch (e) {
messages.add(ValidationMessage.error(e.message)); messages.add(ValidationMessage.error(e.message));
@ -595,8 +633,10 @@ class FlutterValidator extends DoctorValidator {
// Check that the binaries we downloaded for this platform actually run on it. // Check that the binaries we downloaded for this platform actually run on it.
// If the binaries are not downloaded (because android is not enabled), then do // If the binaries are not downloaded (because android is not enabled), then do
// not run this check. // not run this check.
final String genSnapshotPath = _artifacts.getArtifactPath(Artifact.genSnapshot); final String genSnapshotPath =
if (_fileSystem.file(genSnapshotPath).existsSync() && !_genSnapshotRuns(genSnapshotPath)) { _artifacts.getArtifactPath(Artifact.genSnapshot);
if (_fileSystem.file(genSnapshotPath).existsSync() &&
!_genSnapshotRuns(genSnapshotPath)) {
final StringBuffer buffer = StringBuffer(); final StringBuffer buffer = StringBuffer();
buffer.writeln(_userMessages.flutterBinariesDoNotRun); buffer.writeln(_userMessages.flutterBinariesDoNotRun);
if (_platform.isLinux) { if (_platform.isLinux) {
@ -606,7 +646,8 @@ class FlutterValidator extends DoctorValidator {
buffer.writeln( buffer.writeln(
'Flutter requires the Rosetta translation environment on ARM Macs. Try running:', 'Flutter requires the Rosetta translation environment on ARM Macs. Try running:',
); );
buffer.writeln(' sudo softwareupdate --install-rosetta --agree-to-license'); buffer.writeln(
' sudo softwareupdate --install-rosetta --agree-to-license');
} }
messages.add(ValidationMessage.error(buffer.toString())); messages.add(ValidationMessage.error(buffer.toString()));
} }
@ -619,7 +660,8 @@ class FlutterValidator extends DoctorValidator {
// in that case, make it clear that it is fine to continue, but freshness check/upgrades // in that case, make it clear that it is fine to continue, but freshness check/upgrades
// won't be supported. // won't be supported.
valid = ValidationType.partial; valid = ValidationType.partial;
messages.add(ValidationMessage(_userMessages.flutterValidatorErrorIntentional)); messages.add(
ValidationMessage(_userMessages.flutterValidatorErrorIntentional));
} }
return ValidationResult( return ValidationResult(
@ -653,17 +695,21 @@ class FlutterValidator extends DoctorValidator {
return ValidationMessage(flutterVersionMessage); return ValidationMessage(flutterVersionMessage);
} }
if (versionChannel == kUserBranch) { if (versionChannel == kUserBranch) {
flutterVersionMessage = '$flutterVersionMessage\n${_userMessages.flutterUnknownChannel}'; flutterVersionMessage =
'$flutterVersionMessage\n${_userMessages.flutterUnknownChannel}';
} }
if (frameworkVersion == '0.0.0-unknown') { if (frameworkVersion == '0.0.0-unknown') {
flutterVersionMessage = '$flutterVersionMessage\n${_userMessages.flutterUnknownVersion}'; flutterVersionMessage =
'$flutterVersionMessage\n${_userMessages.flutterUnknownVersion}';
} }
return ValidationMessage.hint(flutterVersionMessage); return ValidationMessage.hint(flutterVersionMessage);
} }
List<ValidationMessage> _validateRequiredBinaries(String flutterRoot) { List<ValidationMessage> _validateRequiredBinaries(String flutterRoot) {
final ValidationMessage? flutterWarning = _validateSdkBinary('flutter', flutterRoot); final ValidationMessage? flutterWarning =
final ValidationMessage? dartWarning = _validateSdkBinary('dart', flutterRoot); _validateSdkBinary('flutter', flutterRoot);
final ValidationMessage? dartWarning =
_validateSdkBinary('dart', flutterRoot);
return <ValidationMessage>[ return <ValidationMessage>[
if (flutterWarning != null) flutterWarning, if (flutterWarning != null) flutterWarning,
if (dartWarning != null) dartWarning, if (dartWarning != null) dartWarning,
@ -684,8 +730,7 @@ class FlutterValidator extends DoctorValidator {
} }
final String resolvedFlutterPath = flutterBin.resolveSymbolicLinksSync(); final String resolvedFlutterPath = flutterBin.resolveSymbolicLinksSync();
if (!_filePathContainsDirPath(flutterRoot, resolvedFlutterPath)) { if (!_filePathContainsDirPath(flutterRoot, resolvedFlutterPath)) {
final String hint = final String hint = 'Warning: `$binary` on your path resolves to '
'Warning: `$binary` on your path resolves to '
'$resolvedFlutterPath, which is not inside your current Flutter ' '$resolvedFlutterPath, which is not inside your current Flutter '
'SDK checkout at $flutterRoot. Consider adding $flutterBinDir to ' 'SDK checkout at $flutterRoot. Consider adding $flutterBinDir to '
'the front of your path.'; 'the front of your path.';
@ -697,9 +742,8 @@ class FlutterValidator extends DoctorValidator {
bool _filePathContainsDirPath(String directory, String file) { bool _filePathContainsDirPath(String directory, String file) {
// calling .canonicalize() will normalize for alphabetic case and path // calling .canonicalize() will normalize for alphabetic case and path
// separators // separators
return _fileSystem.path return _fileSystem.path.canonicalize(file).startsWith(
.canonicalize(file) _fileSystem.path.canonicalize(directory) + _fileSystem.path.separator);
.startsWith(_fileSystem.path.canonicalize(directory) + _fileSystem.path.separator);
} }
ValidationMessage _getFlutterUpstreamMessage(FlutterVersion version) { ValidationMessage _getFlutterUpstreamMessage(FlutterVersion version) {
@ -710,11 +754,14 @@ class FlutterValidator extends DoctorValidator {
// VersionUpstreamValidator can produce an error if repositoryUrl is null // VersionUpstreamValidator can produce an error if repositoryUrl is null
if (upstreamValidationError != null) { if (upstreamValidationError != null) {
final String errorMessage = upstreamValidationError.message; final String errorMessage = upstreamValidationError.message;
if (errorMessage.contains('could not determine the remote upstream which is being tracked')) { if (errorMessage.contains(
return ValidationMessage.hint(_userMessages.flutterUpstreamRepositoryUnknown); 'could not determine the remote upstream which is being tracked')) {
return ValidationMessage.hint(
_userMessages.flutterUpstreamRepositoryUnknown);
} }
// At this point, repositoryUrl must not be null // At this point, repositoryUrl must not be null
if (errorMessage.contains('Flutter SDK is tracking a non-standard remote')) { if (errorMessage
.contains('Flutter SDK is tracking a non-standard remote')) {
return ValidationMessage.hint( return ValidationMessage.hint(
_userMessages.flutterUpstreamRepositoryUrlNonStandard(repositoryUrl!), _userMessages.flutterUpstreamRepositoryUrlNonStandard(repositoryUrl!),
); );
@ -727,13 +774,15 @@ class FlutterValidator extends DoctorValidator {
); );
} }
} }
return ValidationMessage(_userMessages.flutterUpstreamRepositoryUrl(repositoryUrl!)); return ValidationMessage(
_userMessages.flutterUpstreamRepositoryUrl(repositoryUrl!));
} }
bool _genSnapshotRuns(String genSnapshotPath) { bool _genSnapshotRuns(String genSnapshotPath) {
const int kExpectedExitCode = 255; const int kExpectedExitCode = 255;
try { try {
return _processManager.runSync(<String>[genSnapshotPath]).exitCode == kExpectedExitCode; return _processManager.runSync(<String>[genSnapshotPath]).exitCode ==
kExpectedExitCode;
} on Exception { } on Exception {
return false; return false;
} }
@ -743,9 +792,9 @@ class FlutterValidator extends DoctorValidator {
class DeviceValidator extends DoctorValidator { class DeviceValidator extends DoctorValidator {
// TODO(jmagman): Make required once g3 rolls and is updated. // TODO(jmagman): Make required once g3 rolls and is updated.
DeviceValidator({DeviceManager? deviceManager, UserMessages? userMessages}) DeviceValidator({DeviceManager? deviceManager, UserMessages? userMessages})
: _deviceManager = deviceManager ?? globals.deviceManager!, : _deviceManager = deviceManager ?? globals.deviceManager!,
_userMessages = userMessages ?? globals.userMessages, _userMessages = userMessages ?? globals.userMessages,
super('Connected device'); super('Connected device');
final DeviceManager _deviceManager; final DeviceManager _deviceManager;
final UserMessages _userMessages; final UserMessages _userMessages;
@ -754,25 +803,27 @@ class DeviceValidator extends DoctorValidator {
String get slowWarning => 'Scanning for devices is taking a long time...'; String get slowWarning => 'Scanning for devices is taking a long time...';
@override @override
Future<ValidationResult> validate() async { Future<ValidationResult> validateImpl() async {
final List<Device> devices = await _deviceManager.refreshAllDevices( final List<Device> devices = await _deviceManager.refreshAllDevices(
timeout: DeviceManager.minimumWirelessDeviceDiscoveryTimeout, timeout: DeviceManager.minimumWirelessDeviceDiscoveryTimeout,
); );
List<ValidationMessage> installedMessages = <ValidationMessage>[]; List<ValidationMessage> installedMessages = <ValidationMessage>[];
if (devices.isNotEmpty) { if (devices.isNotEmpty) {
installedMessages = installedMessages = (await Device.descriptions(
(await Device.descriptions( devices,
devices, ))
)).map<ValidationMessage>((String msg) => ValidationMessage(msg)).toList(); .map<ValidationMessage>((String msg) => ValidationMessage(msg))
.toList();
} }
List<ValidationMessage> diagnosticMessages = <ValidationMessage>[]; List<ValidationMessage> diagnosticMessages = <ValidationMessage>[];
final List<String> diagnostics = await _deviceManager.getDeviceDiagnostics(); final List<String> diagnostics =
await _deviceManager.getDeviceDiagnostics();
if (diagnostics.isNotEmpty) { if (diagnostics.isNotEmpty) {
diagnosticMessages = diagnosticMessages = diagnostics
diagnostics .map<ValidationMessage>(
.map<ValidationMessage>((String message) => ValidationMessage.hint(message)) (String message) => ValidationMessage.hint(message))
.toList(); .toList();
} else if (devices.isEmpty) { } else if (devices.isEmpty) {
diagnosticMessages = <ValidationMessage>[ diagnosticMessages = <ValidationMessage>[
ValidationMessage.hint(_userMessages.devicesMissing), ValidationMessage.hint(_userMessages.devicesMissing),
@ -800,9 +851,11 @@ class DeviceValidator extends DoctorValidator {
/// Wrapper for doctor to run multiple times with PII and without, running the validators only once. /// Wrapper for doctor to run multiple times with PII and without, running the validators only once.
class DoctorText { class DoctorText {
DoctorText(BufferLogger logger, {SystemClock? clock, @visibleForTesting Doctor? doctor}) DoctorText(BufferLogger logger,
: _doctor = doctor ?? Doctor(logger: logger, clock: clock ?? globals.systemClock), {SystemClock? clock, @visibleForTesting Doctor? doctor})
_logger = logger; : _doctor = doctor ??
Doctor(logger: logger, clock: clock ?? globals.systemClock),
_logger = logger;
final BufferLogger _logger; final BufferLogger _logger;
final Doctor _doctor; final Doctor _doctor;
@ -812,7 +865,8 @@ class DoctorText {
late final Future<String> piiStrippedText = _runDiagnosis(false); late final Future<String> piiStrippedText = _runDiagnosis(false);
// Start the validator tasks only once. // Start the validator tasks only once.
late final List<ValidatorTask> _validatorTasks = _doctor.startValidatorTasks(); late final List<ValidatorTask> _validatorTasks =
_doctor.startValidatorTasks();
Future<String> _runDiagnosis(bool showPii) async { Future<String> _runDiagnosis(bool showPii) async {
try { try {

134
packages/flutter_tools/lib/src/doctor_validator.dart
View File

@ -2,6 +2,8 @@
// Use of this source code is governed by a BSD-style license that can be // Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file. // found in the LICENSE file.
import 'dart:async';
import 'package:meta/meta.dart'; import 'package:meta/meta.dart';
import 'base/async_guard.dart'; import 'base/async_guard.dart';
@ -36,7 +38,7 @@ enum ValidationType { crash, missing, partial, notAvailable, success }
enum ValidationMessageType { error, hint, information } enum ValidationMessageType { error, hint, information }
abstract class DoctorValidator { abstract class DoctorValidator {
const DoctorValidator(this.title); DoctorValidator(this.title);
/// This is displayed in the CLI. /// This is displayed in the CLI.
final String title; final String title;
@ -48,7 +50,19 @@ abstract class DoctorValidator {
/// Duration before the spinner should display [slowWarning]. /// Duration before the spinner should display [slowWarning].
Duration get slowWarningDuration => _slowWarningDuration; Duration get slowWarningDuration => _slowWarningDuration;
Future<ValidationResult> validate(); /// Performs validation by invoking [validateImpl].
///
/// Tracks time taken to execute the validation step.
Future<ValidationResult> validate() async {
final Stopwatch stopwatch = Stopwatch()..start();
final ValidationResult result = await validateImpl();
stopwatch.stop();
result._executionTime = stopwatch.elapsed;
return result;
}
/// Validation implementation.
Future<ValidationResult> validateImpl();
} }
/// A validator that runs other [DoctorValidator]s and combines their output /// A validator that runs other [DoctorValidator]s and combines their output
@ -74,10 +88,11 @@ class GroupedValidator extends DoctorValidator {
String _currentSlowWarning = 'Initializing...'; String _currentSlowWarning = 'Initializing...';
@override @override
Future<ValidationResult> validate() async { Future<ValidationResult> validateImpl() async {
final List<ValidatorTask> tasks = <ValidatorTask>[ final List<ValidatorTask> tasks = <ValidatorTask>[
for (final DoctorValidator validator in subValidators) for (final DoctorValidator validator in subValidators)
ValidatorTask(validator, asyncGuard<ValidationResult>(() => validator.validate())), ValidatorTask(validator,
asyncGuard<ValidationResult>(() => validator.validate())),
]; ];
final List<ValidationResult> results = <ValidationResult>[]; final List<ValidationResult> results = <ValidationResult>[];
@ -123,24 +138,26 @@ class GroupedValidator extends DoctorValidator {
} }
} }
@immutable
class ValidationResult { class ValidationResult {
/// [ValidationResult.type] should only equal [ValidationResult.success] /// [ValidationResult.type] should only equal [ValidationResult.success]
/// if no [messages] are hints or errors. /// if no [messages] are hints or errors.
const ValidationResult(this.type, this.messages, {this.statusInfo}); ValidationResult(this.type, this.messages, {this.statusInfo});
factory ValidationResult.crash(Object error, [StackTrace? stackTrace]) { factory ValidationResult.crash(Object error, [StackTrace? stackTrace]) {
return ValidationResult(ValidationType.crash, <ValidationMessage>[ return ValidationResult(
const ValidationMessage.error( ValidationType.crash,
'Due to an error, the doctor check did not complete. ' <ValidationMessage>[
'If the error message below is not helpful, ' const ValidationMessage.error(
'please let us know about this issue at https://github.com/flutter/flutter/issues.', 'Due to an error, the doctor check did not complete. '
), 'If the error message below is not helpful, '
ValidationMessage.error('$error'), 'please let us know about this issue at https://github.com/flutter/flutter/issues.',
if (stackTrace != null) ),
// Stacktrace is informational. Printed in verbose mode only. ValidationMessage.error('$error'),
ValidationMessage('$stackTrace'), if (stackTrace != null)
], statusInfo: 'the doctor check crashed'); // Stacktrace is informational. Printed in verbose mode only.
ValidationMessage('$stackTrace'),
],
statusInfo: 'the doctor check crashed');
} }
final ValidationType type; final ValidationType type;
@ -149,28 +166,36 @@ class ValidationResult {
final List<ValidationMessage> messages; final List<ValidationMessage> messages;
String get leadingBox => switch (type) { String get leadingBox => switch (type) {
ValidationType.crash => '[☠]', ValidationType.crash => '[☠]',
ValidationType.missing => '[✗]', ValidationType.missing => '[✗]',
ValidationType.success => '[✓]', ValidationType.success => '[✓]',
ValidationType.notAvailable || ValidationType.partial => '[!]', ValidationType.notAvailable || ValidationType.partial => '[!]',
}; };
/// The time taken to perform the validation, set by [DoctorValidator.validate].
Duration? get executionTime => _executionTime;
Duration? _executionTime;
String get coloredLeadingBox { String get coloredLeadingBox {
return globals.terminal.color(leadingBox, switch (type) { return globals.terminal.color(
ValidationType.success => TerminalColor.green, leadingBox,
ValidationType.crash || ValidationType.missing => TerminalColor.red, switch (type) {
ValidationType.notAvailable || ValidationType.partial => TerminalColor.yellow, ValidationType.success => TerminalColor.green,
}); ValidationType.crash || ValidationType.missing => TerminalColor.red,
ValidationType.notAvailable ||
ValidationType.partial =>
TerminalColor.yellow,
});
} }
/// The string representation of the type. /// The string representation of the type.
String get typeStr => switch (type) { String get typeStr => switch (type) {
ValidationType.crash => 'crash', ValidationType.crash => 'crash',
ValidationType.missing => 'missing', ValidationType.missing => 'missing',
ValidationType.success => 'installed', ValidationType.success => 'installed',
ValidationType.notAvailable => 'notAvailable', ValidationType.notAvailable => 'notAvailable',
ValidationType.partial => 'partial', ValidationType.partial => 'partial',
}; };
@override @override
String toString() { String toString() {
@ -192,22 +217,23 @@ class ValidationMessage {
/// ///
/// The [contextUrl] may be supplied to link to external resources. This /// The [contextUrl] may be supplied to link to external resources. This
/// is displayed after the informative message in verbose modes. /// is displayed after the informative message in verbose modes.
const ValidationMessage(this.message, {this.contextUrl, String? piiStrippedMessage}) const ValidationMessage(this.message,
: type = ValidationMessageType.information, {this.contextUrl, String? piiStrippedMessage})
piiStrippedMessage = piiStrippedMessage ?? message; : type = ValidationMessageType.information,
piiStrippedMessage = piiStrippedMessage ?? message;
/// Create a validation message with information for a failing validator. /// Create a validation message with information for a failing validator.
const ValidationMessage.error(this.message, {String? piiStrippedMessage}) const ValidationMessage.error(this.message, {String? piiStrippedMessage})
: type = ValidationMessageType.error, : type = ValidationMessageType.error,
piiStrippedMessage = piiStrippedMessage ?? message, piiStrippedMessage = piiStrippedMessage ?? message,
contextUrl = null; contextUrl = null;
/// Create a validation message with information for a partially failing /// Create a validation message with information for a partially failing
/// validator. /// validator.
const ValidationMessage.hint(this.message, {String? piiStrippedMessage}) const ValidationMessage.hint(this.message, {String? piiStrippedMessage})
: type = ValidationMessageType.hint, : type = ValidationMessageType.hint,
piiStrippedMessage = piiStrippedMessage ?? message, piiStrippedMessage = piiStrippedMessage ?? message,
contextUrl = null; contextUrl = null;
final ValidationMessageType type; final ValidationMessageType type;
final String? contextUrl; final String? contextUrl;
@ -223,17 +249,19 @@ class ValidationMessage {
bool get isInformation => type == ValidationMessageType.information; bool get isInformation => type == ValidationMessageType.information;
String get indicator => switch (type) { String get indicator => switch (type) {
ValidationMessageType.error => '✗', ValidationMessageType.error => '✗',
ValidationMessageType.hint => '!', ValidationMessageType.hint => '!',
ValidationMessageType.information => '•', ValidationMessageType.information => '•',
}; };
String get coloredIndicator { String get coloredIndicator {
return globals.terminal.color(indicator, switch (type) { return globals.terminal.color(
ValidationMessageType.error => TerminalColor.red, indicator,
ValidationMessageType.hint => TerminalColor.yellow, switch (type) {
ValidationMessageType.information => TerminalColor.green, ValidationMessageType.error => TerminalColor.red,
}); ValidationMessageType.hint => TerminalColor.yellow,
ValidationMessageType.information => TerminalColor.green,
});
} }
@override @override
@ -255,7 +283,7 @@ class NoIdeValidator extends DoctorValidator {
NoIdeValidator() : super('Flutter IDE Support'); NoIdeValidator() : super('Flutter IDE Support');
@override @override
Future<ValidationResult> validate() async { Future<ValidationResult> validateImpl() async {
return ValidationResult( return ValidationResult(
// Info hint to user they do not have a supported IDE installed // Info hint to user they do not have a supported IDE installed
ValidationType.notAvailable, ValidationType.notAvailable,
@ -273,5 +301,5 @@ class ValidatorWithResult extends DoctorValidator {
final ValidationResult result; final ValidationResult result;
@override @override
Future<ValidationResult> validate() async => result; Future<ValidationResult> validateImpl() async => result;
} }

25
packages/flutter_tools/lib/src/http_host_validator.dart
View File

@ -18,7 +18,8 @@ const String kMaven = 'https://maven.google.com/';
const String kPubDev = 'https://pub.dev/'; const String kPubDev = 'https://pub.dev/';
// Overridable environment variables. // Overridable environment variables.
const String kPubDevOverride = 'PUB_HOSTED_URL'; // https://dart.dev/tools/pub/environment-variables const String kPubDevOverride =
'PUB_HOSTED_URL'; // https://dart.dev/tools/pub/environment-variables
// Validator that checks all provided hosts are reachable and responsive // Validator that checks all provided hosts are reachable and responsive
class HttpHostValidator extends DoctorValidator { class HttpHostValidator extends DoctorValidator {
@ -26,10 +27,10 @@ class HttpHostValidator extends DoctorValidator {
required Platform platform, required Platform platform,
required FeatureFlags featureFlags, required FeatureFlags featureFlags,
required HttpClient httpClient, required HttpClient httpClient,
}) : _platform = platform, }) : _platform = platform,
_featureFlags = featureFlags, _featureFlags = featureFlags,
_httpClient = httpClient, _httpClient = httpClient,
super('Network resources'); super('Network resources');
final Platform _platform; final Platform _platform;
final FeatureFlags _featureFlags; final FeatureFlags _featureFlags;
@ -82,7 +83,7 @@ class HttpHostValidator extends DoctorValidator {
} }
@override @override
Future<ValidationResult> validate() async { Future<ValidationResult> validateImpl() async {
final List<String?> availabilityResults = <String?>[]; final List<String?> availabilityResults = <String?>[];
final List<Uri> requiredHosts = <Uri>[]; final List<Uri> requiredHosts = <Uri>[];
@ -100,7 +101,8 @@ class HttpHostValidator extends DoctorValidator {
requiredHosts.add(Uri.parse(kPubDev)); requiredHosts.add(Uri.parse(kPubDev));
} }
if (_platform.environment.containsKey(kFlutterStorageBaseUrl)) { if (_platform.environment.containsKey(kFlutterStorageBaseUrl)) {
final Uri? url = _parseUrl(_platform.environment[kFlutterStorageBaseUrl]!); final Uri? url =
_parseUrl(_platform.environment[kFlutterStorageBaseUrl]!);
if (url == null) { if (url == null) {
availabilityResults.add( availabilityResults.add(
'Environment variable $kFlutterStorageBaseUrl does not specify a valid URL: "${_platform.environment[kFlutterStorageBaseUrl]}"\n' 'Environment variable $kFlutterStorageBaseUrl does not specify a valid URL: "${_platform.environment[kFlutterStorageBaseUrl]}"\n'
@ -141,9 +143,12 @@ class HttpHostValidator extends DoctorValidator {
if (failures == 0) { if (failures == 0) {
assert(successes > 0); assert(successes > 0);
assert(messages.isEmpty); assert(messages.isEmpty);
return const ValidationResult(ValidationType.success, <ValidationMessage>[ return ValidationResult(
ValidationMessage('All expected network resources are available.'), ValidationType.success,
]); const <ValidationMessage>[
ValidationMessage('All expected network resources are available.')
],
);
} }
assert(messages.isNotEmpty); assert(messages.isNotEmpty);
return ValidationResult( return ValidationResult(

2
packages/flutter_tools/lib/src/intellij/intellij_validator.dart
View File

@ -91,7 +91,7 @@ abstract class IntelliJValidator extends DoctorValidator {
} }
@override @override
Future<ValidationResult> validate() async { Future<ValidationResult> validateImpl() async {
final List<ValidationMessage> messages = <ValidationMessage>[]; final List<ValidationMessage> messages = <ValidationMessage>[];
if (pluginsPath == null) { if (pluginsPath == null) {

2
packages/flutter_tools/lib/src/linux/linux_doctor.dart
View File

@ -54,7 +54,7 @@ class LinuxDoctorValidator extends DoctorValidator {
final List<String> _requiredGtkLibraries = <String>['gtk+-3.0', 'glib-2.0', 'gio-2.0']; final List<String> _requiredGtkLibraries = <String>['gtk+-3.0', 'glib-2.0', 'gio-2.0'];
@override @override
Future<ValidationResult> validate() async { Future<ValidationResult> validateImpl() async {
ValidationType validationType = ValidationType.success; ValidationType validationType = ValidationType.success;
final List<ValidationMessage> messages = <ValidationMessage>[]; final List<ValidationMessage> messages = <ValidationMessage>[];

2
packages/flutter_tools/lib/src/macos/cocoapods_validator.dart
View File

@ -20,7 +20,7 @@ class CocoaPodsValidator extends DoctorValidator {
final UserMessages _userMessages; final UserMessages _userMessages;
@override @override
Future<ValidationResult> validate() async { Future<ValidationResult> validateImpl() async {
final List<ValidationMessage> messages = <ValidationMessage>[]; final List<ValidationMessage> messages = <ValidationMessage>[];
final CocoaPodsStatus cocoaPodsStatus = await _cocoaPods.evaluateCocoaPodsInstallation; final CocoaPodsStatus cocoaPodsStatus = await _cocoaPods.evaluateCocoaPodsInstallation;

2
packages/flutter_tools/lib/src/macos/xcode_validator.dart
View File

@ -32,7 +32,7 @@ class XcodeValidator extends DoctorValidator {
final UserMessages _userMessages; final UserMessages _userMessages;
@override @override
Future<ValidationResult> validate() async { Future<ValidationResult> validateImpl() async {
final List<ValidationMessage> messages = <ValidationMessage>[]; final List<ValidationMessage> messages = <ValidationMessage>[];
ValidationType xcodeStatus = ValidationType.missing; ValidationType xcodeStatus = ValidationType.missing;
String? xcodeVersionInfo; String? xcodeVersionInfo;

25
packages/flutter_tools/lib/src/proxy_validator.dart
View File

@ -12,10 +12,10 @@ import 'doctor_validator.dart';
/// validated along with `NO_PROXY`. /// validated along with `NO_PROXY`.
class ProxyValidator extends DoctorValidator { class ProxyValidator extends DoctorValidator {
ProxyValidator({required Platform platform}) ProxyValidator({required Platform platform})
: shouldShow = _getEnv('HTTP_PROXY', platform).isNotEmpty, : shouldShow = _getEnv('HTTP_PROXY', platform).isNotEmpty,
_httpProxy = _getEnv('HTTP_PROXY', platform), _httpProxy = _getEnv('HTTP_PROXY', platform),
_noProxy = _getEnv('NO_PROXY', platform), _noProxy = _getEnv('NO_PROXY', platform),
super('Proxy Configuration'); super('Proxy Configuration');
final bool shouldShow; final bool shouldShow;
final String _httpProxy; final String _httpProxy;
@ -30,9 +30,10 @@ class ProxyValidator extends DoctorValidator {
''; '';
@override @override
Future<ValidationResult> validate() async { Future<ValidationResult> validateImpl() async {
if (_httpProxy.isEmpty) { if (_httpProxy.isEmpty) {
return const ValidationResult(ValidationType.success, <ValidationMessage>[]); return ValidationResult(
ValidationType.success, const <ValidationMessage>[]);
} }
final List<ValidationMessage> messages = <ValidationMessage>[ final List<ValidationMessage> messages = <ValidationMessage>[
@ -49,13 +50,16 @@ class ProxyValidator extends DoctorValidator {
], ],
]; ];
final bool hasIssues = messages.any((ValidationMessage msg) => msg.isHint || msg.isError); final bool hasIssues =
messages.any((ValidationMessage msg) => msg.isHint || msg.isError);
return ValidationResult(hasIssues ? ValidationType.partial : ValidationType.success, messages); return ValidationResult(
hasIssues ? ValidationType.partial : ValidationType.success, messages);
} }
Future<List<String>> _getLoopbackAddresses() async { Future<List<String>> _getLoopbackAddresses() async {
final List<NetworkInterface> networkInterfaces = await listNetworkInterfaces( final List<NetworkInterface> networkInterfaces =
await listNetworkInterfaces(
includeLinkLocal: true, includeLinkLocal: true,
includeLoopback: true, includeLoopback: true,
); );
@ -63,7 +67,8 @@ class ProxyValidator extends DoctorValidator {
return <String>[ return <String>[
'localhost', 'localhost',
for (final NetworkInterface networkInterface in networkInterfaces) for (final NetworkInterface networkInterface in networkInterfaces)
for (final InternetAddress internetAddress in networkInterface.addresses) for (final InternetAddress internetAddress
in networkInterface.addresses)
if (internetAddress.isLoopback) internetAddress.address, if (internetAddress.isLoopback) internetAddress.address,
]; ];
} }

15
packages/flutter_tools/lib/src/vscode/vscode_validator.dart
View File

@ -27,16 +27,17 @@ class VsCodeValidator extends DoctorValidator {
} }
@override @override
Future<ValidationResult> validate() async { Future<ValidationResult> validateImpl() async {
final List<ValidationMessage> validationMessages = List<ValidationMessage>.from( final List<ValidationMessage> validationMessages =
_vsCode.validationMessages, List<ValidationMessage>.from(_vsCode.validationMessages);
);
final String vsCodeVersionText = final String vsCodeVersionText = _vsCode.version == null
_vsCode.version == null ? 'version unknown' : 'version ${_vsCode.version}'; ? 'version unknown'
: 'version ${_vsCode.version}';
if (_vsCode.version == null) { if (_vsCode.version == null) {
validationMessages.add(const ValidationMessage.error('Unable to determine VS Code version.')); validationMessages.add(const ValidationMessage.error(
'Unable to determine VS Code version.'));
} }
return ValidationResult( return ValidationResult(

24
packages/flutter_tools/lib/src/web/web_validator.dart
View File

@ -8,14 +8,14 @@ import 'chrome.dart';
/// A validator for Chromium-based browsers. /// A validator for Chromium-based browsers.
abstract class ChromiumValidator extends DoctorValidator { abstract class ChromiumValidator extends DoctorValidator {
const ChromiumValidator(super.title); ChromiumValidator(super.title);
Platform get _platform; Platform get _platform;
ChromiumLauncher get _chromiumLauncher; ChromiumLauncher get _chromiumLauncher;
String get _name; String get _name;
@override @override
Future<ValidationResult> validate() async { Future<ValidationResult> validateImpl() async {
final bool canRunChromium = _chromiumLauncher.canFindExecutable(); final bool canRunChromium = _chromiumLauncher.canFindExecutable();
final String chromiumSearchLocation = _chromiumLauncher.findExecutable(); final String chromiumSearchLocation = _chromiumLauncher.findExecutable();
final List<ValidationMessage> messages = <ValidationMessage>[ final List<ValidationMessage> messages = <ValidationMessage>[
@ -45,10 +45,12 @@ abstract class ChromiumValidator extends DoctorValidator {
/// A validator that checks whether Chrome is installed and can run. /// A validator that checks whether Chrome is installed and can run.
class ChromeValidator extends ChromiumValidator { class ChromeValidator extends ChromiumValidator {
const ChromeValidator({required Platform platform, required ChromiumLauncher chromiumLauncher}) ChromeValidator({
: _platform = platform, required Platform platform,
_chromiumLauncher = chromiumLauncher, required ChromiumLauncher chromiumLauncher,
super('Chrome - develop for the web'); }) : _platform = platform,
_chromiumLauncher = chromiumLauncher,
super('Chrome - develop for the web');
@override @override
final Platform _platform; final Platform _platform;
@ -62,10 +64,12 @@ class ChromeValidator extends ChromiumValidator {
/// A validator that checks whether Edge is installed and can run. /// A validator that checks whether Edge is installed and can run.
class EdgeValidator extends ChromiumValidator { class EdgeValidator extends ChromiumValidator {
const EdgeValidator({required Platform platform, required ChromiumLauncher chromiumLauncher}) EdgeValidator({
: _platform = platform, required Platform platform,
_chromiumLauncher = chromiumLauncher, required ChromiumLauncher chromiumLauncher,
super('Edge - develop for the web'); }) : _platform = platform,
_chromiumLauncher = chromiumLauncher,
super('Edge - develop for the web');
@override @override
final Platform _platform; final Platform _platform;

4
packages/flutter_tools/lib/src/windows/visual_studio_validator.dart
View File

@ -10,7 +10,7 @@ import 'visual_studio.dart';
VisualStudioValidator? get visualStudioValidator => context.get<VisualStudioValidator>(); VisualStudioValidator? get visualStudioValidator => context.get<VisualStudioValidator>();
class VisualStudioValidator extends DoctorValidator { class VisualStudioValidator extends DoctorValidator {
const VisualStudioValidator({ VisualStudioValidator({
required VisualStudio visualStudio, required VisualStudio visualStudio,
required UserMessages userMessages, required UserMessages userMessages,
}) : _visualStudio = visualStudio, }) : _visualStudio = visualStudio,
@ -21,7 +21,7 @@ class VisualStudioValidator extends DoctorValidator {
final UserMessages _userMessages; final UserMessages _userMessages;
@override @override
Future<ValidationResult> validate() async { Future<ValidationResult> validateImpl() async {
final List<ValidationMessage> messages = <ValidationMessage>[]; final List<ValidationMessage> messages = <ValidationMessage>[];
ValidationType status = ValidationType.missing; ValidationType status = ValidationType.missing;
String? versionInfo; String? versionInfo;

112
packages/flutter_tools/lib/src/windows/windows_version_validator.dart
View File

@ -14,7 +14,8 @@ const List<String> kUnsupportedVersions = <String>['6', '7', '8'];
/// Regex pattern for identifying line from systeminfo stdout with windows version /// Regex pattern for identifying line from systeminfo stdout with windows version
/// (ie. 10.0.22631.4037) /// (ie. 10.0.22631.4037)
const String kWindowsOSVersionSemVerPattern = r'([0-9]+)\.([0-9]+)\.([0-9]+)\.?([0-9\.]+)?'; const String kWindowsOSVersionSemVerPattern =
r'([0-9]+)\.([0-9]+)\.([0-9]+)\.?([0-9\.]+)?';
/// Regex pattern for identifying a running instance of the Topaz OFD process. /// Regex pattern for identifying a running instance of the Topaz OFD process.
/// This is a known process that interferes with the build toolchain. /// This is a known process that interferes with the build toolchain.
@ -23,14 +24,14 @@ const String kCoreProcessPattern = r'Topaz\s+OFD\\Warsaw\\core\.exe';
/// Validator for supported Windows host machine operating system version. /// Validator for supported Windows host machine operating system version.
class WindowsVersionValidator extends DoctorValidator { class WindowsVersionValidator extends DoctorValidator {
const WindowsVersionValidator({ WindowsVersionValidator({
required OperatingSystemUtils operatingSystemUtils, required OperatingSystemUtils operatingSystemUtils,
required ProcessLister processLister, required ProcessLister processLister,
required WindowsVersionExtractor versionExtractor, required WindowsVersionExtractor versionExtractor,
}) : _operatingSystemUtils = operatingSystemUtils, }) : _operatingSystemUtils = operatingSystemUtils,
_processLister = processLister, _processLister = processLister,
_versionExtractor = versionExtractor, _versionExtractor = versionExtractor,
super('Windows Version'); super('Windows Version');
// See https://learn.microsoft.com/en-us/windows/release-health/windows11-release-information // See https://learn.microsoft.com/en-us/windows/release-health/windows11-release-information
static const int _lowestWindows11BuildNumber = 22000; static const int _lowestWindows11BuildNumber = 22000;
@ -41,35 +42,47 @@ class WindowsVersionValidator extends DoctorValidator {
Future<ValidationResult> _topazScan() async { Future<ValidationResult> _topazScan() async {
if (!_processLister.canRunPowershell()) { if (!_processLister.canRunPowershell()) {
return const ValidationResult(ValidationType.missing, <ValidationMessage>[ return ValidationResult(
ValidationMessage.hint( ValidationType.missing,
'Failed to find ${ProcessLister.powershell} or ${ProcessLister.pwsh} on PATH', const <ValidationMessage>[
), ValidationMessage.hint(
]); 'Failed to find ${ProcessLister.powershell} or ${ProcessLister.pwsh} on PATH'),
],
);
} }
final ProcessResult getProcessesResult = await _processLister.getProcessesWithPath(); final ProcessResult getProcessesResult =
await _processLister.getProcessesWithPath();
if (getProcessesResult.exitCode != 0) { if (getProcessesResult.exitCode != 0) {
return const ValidationResult(ValidationType.missing, <ValidationMessage>[ return ValidationResult(
ValidationMessage.hint('Get-Process failed to complete'), ValidationType.missing,
]); const <ValidationMessage>[
ValidationMessage.hint('Get-Process failed to complete'),
],
);
} }
final RegExp topazRegex = RegExp(kCoreProcessPattern, caseSensitive: false, multiLine: true); final RegExp topazRegex =
RegExp(kCoreProcessPattern, caseSensitive: false, multiLine: true);
final String processes = getProcessesResult.stdout as String; final String processes = getProcessesResult.stdout as String;
final bool topazFound = topazRegex.hasMatch(processes); final bool topazFound = topazRegex.hasMatch(processes);
if (topazFound) { if (topazFound) {
return const ValidationResult(ValidationType.missing, <ValidationMessage>[ return ValidationResult(
ValidationMessage.hint( ValidationType.missing,
'The Topaz OFD Security Module was detected on your machine. ' const <ValidationMessage>[
'You may need to disable it to build Flutter applications.', ValidationMessage.hint(
), 'The Topaz OFD Security Module was detected on your machine. '
]); 'You may need to disable it to build Flutter applications.',
),
],
);
} }
return const ValidationResult(ValidationType.success, <ValidationMessage>[]); return ValidationResult(
ValidationType.success, const <ValidationMessage>[]);
} }
@override @override
Future<ValidationResult> validate() async { Future<ValidationResult> validateImpl() async {
final RegExp regex = RegExp(kWindowsOSVersionSemVerPattern, multiLine: true); final RegExp regex =
RegExp(kWindowsOSVersionSemVerPattern, multiLine: true);
final String commandResult = _operatingSystemUtils.name; final String commandResult = _operatingSystemUtils.name;
final Iterable<RegExpMatch> matches = regex.allMatches(commandResult); final Iterable<RegExpMatch> matches = regex.allMatches(commandResult);
@ -78,13 +91,15 @@ class WindowsVersionValidator extends DoctorValidator {
ValidationType windowsVersionStatus; ValidationType windowsVersionStatus;
final List<ValidationMessage> messages = <ValidationMessage>[]; final List<ValidationMessage> messages = <ValidationMessage>[];
String statusInfo; String statusInfo;
if (matches.length == 1 && !kUnsupportedVersions.contains(matches.elementAt(0).group(1))) { if (matches.length == 1 &&
!kUnsupportedVersions.contains(matches.elementAt(0).group(1))) {
windowsVersionStatus = ValidationType.success; windowsVersionStatus = ValidationType.success;
final WindowsVersionExtractionResult details = await _versionExtractor.getDetails(); final WindowsVersionExtractionResult details =
await _versionExtractor.getDetails();
String? caption = details.caption; String? caption = details.caption;
if (caption == null || caption.isEmpty) { if (caption == null || caption.isEmpty) {
final bool isWindows11 = final bool isWindows11 = int.parse(matches.elementAt(0).group(3)!) >
int.parse(matches.elementAt(0).group(3)!) > _lowestWindows11BuildNumber; _lowestWindows11BuildNumber;
if (isWindows11) { if (isWindows11) {
caption = 'Windows 11 or higher'; caption = 'Windows 11 or higher';
} else { } else {
@ -99,7 +114,9 @@ class WindowsVersionValidator extends DoctorValidator {
// Check if the Topaz OFD security module is running, and warn the user if it is. // Check if the Topaz OFD security module is running, and warn the user if it is.
// See https://github.com/flutter/flutter/issues/121366 // See https://github.com/flutter/flutter/issues/121366
final List<ValidationResult> subResults = <ValidationResult>[await _topazScan()]; final List<ValidationResult> subResults = <ValidationResult>[
await _topazScan()
];
for (final ValidationResult subResult in subResults) { for (final ValidationResult subResult in subResults) {
if (subResult.type != ValidationType.success) { if (subResult.type != ValidationType.success) {
statusInfo = 'Problem detected with Windows installation'; statusInfo = 'Problem detected with Windows installation';
@ -109,10 +126,12 @@ class WindowsVersionValidator extends DoctorValidator {
} }
} else { } else {
windowsVersionStatus = ValidationType.missing; windowsVersionStatus = ValidationType.missing;
statusInfo = 'Unable to determine Windows version (command `ver` returned $commandResult)'; statusInfo =
'Unable to determine Windows version (command `ver` returned $commandResult)';
} }
return ValidationResult(windowsVersionStatus, messages, statusInfo: statusInfo); return ValidationResult(windowsVersionStatus, messages,
statusInfo: statusInfo);
} }
} }
@ -147,9 +166,10 @@ class ProcessLister {
/// the edition and the processor architecture), releaseId and displayVersion and are returned via the /// the edition and the processor architecture), releaseId and displayVersion and are returned via the
/// [WindowsVersionExtractionResult] class. /// [WindowsVersionExtractionResult] class.
class WindowsVersionExtractor { class WindowsVersionExtractor {
WindowsVersionExtractor({required ProcessManager processManager, required Logger logger}) WindowsVersionExtractor(
: _logger = logger, {required ProcessManager processManager, required Logger logger})
_processManager = processManager; : _logger = logger,
_processManager = processManager;
final ProcessManager _processManager; final ProcessManager _processManager;
final Logger _logger; final Logger _logger;
@ -169,12 +189,16 @@ class WindowsVersionExtractor {
if (output != null) { if (output != null) {
final List<String> parts = output.split('\n'); final List<String> parts = output.split('\n');
if (parts.length >= 2) { if (parts.length >= 2) {
caption = parts[1].replaceAll('Microsoft Windows', '').replaceAll(' ', ' ').trim(); caption = parts[1]
.replaceAll('Microsoft Windows', '')
.replaceAll(' ', ' ')
.trim();
} }
} }
} }
} on ProcessException catch (e) { } on ProcessException catch (e) {
_logger.printTrace('Failed to get Caption and OSArchitecture from WMI: $e'); _logger
.printTrace('Failed to get Caption and OSArchitecture from WMI: $e');
} }
try { try {
@ -190,9 +214,13 @@ class WindowsVersionExtractor {
final String? output = osDetails.stdout as String?; final String? output = osDetails.stdout as String?;
if (output != null) { if (output != null) {
final Map<String, String> data = Map<String, String>.fromEntries( final Map<String, String> data = Map<String, String>.fromEntries(
output.split('\n').where((String line) => line.contains('REG_SZ')).map((String line) { output
.split('\n')
.where((String line) => line.contains('REG_SZ'))
.map((String line) {
final List<String> parts = line.split('REG_SZ'); final List<String> parts = line.split('REG_SZ');
return MapEntry<String, String>(parts.first.trim(), parts.last.trim()); return MapEntry<String, String>(
parts.first.trim(), parts.last.trim());
}), }),
); );
releaseId = data['ReleaseId']; releaseId = data['ReleaseId'];
@ -200,7 +228,8 @@ class WindowsVersionExtractor {
} }
} }
} on ProcessException catch (e) { } on ProcessException catch (e) {
_logger.printTrace('Failed to get ReleaseId and DisplayVersion from registry: $e'); _logger.printTrace(
'Failed to get ReleaseId and DisplayVersion from registry: $e');
} }
return WindowsVersionExtractionResult( return WindowsVersionExtractionResult(
@ -221,7 +250,8 @@ final class WindowsVersionExtractionResult {
}); });
factory WindowsVersionExtractionResult.empty() { factory WindowsVersionExtractionResult.empty() {
return WindowsVersionExtractionResult(caption: null, releaseId: null, displayVersion: null); return WindowsVersionExtractionResult(
caption: null, releaseId: null, displayVersion: null);
} }
final String? caption; final String? caption;

544
packages/flutter_tools/test/commands.shard/hermetic/doctor_test.dart
View File

File diff suppressed because it is too large Load Diff

2
packages/flutter_tools/test/general.shard/reporting/events_test.dart
View File

@ -162,7 +162,7 @@ class FakeDoctorValidator extends DoctorValidator {
FakeDoctorValidator(super.title); FakeDoctorValidator(super.title);
@override @override
Future<ValidationResult> validate() async { Future<ValidationResult> validateImpl() async {
return ValidationResult.crash(Object()); return ValidationResult.crash(Object());
} }
} }

158
packages/flutter_tools/test/general.shard/windows_version_validator_test.dart
View File

@ -14,15 +14,20 @@ import '../src/context.dart';
import '../src/fake_process_manager.dart'; import '../src/fake_process_manager.dart';
/// Fake [_WindowsUtils] to use for testing /// Fake [_WindowsUtils] to use for testing
class FakeValidOperatingSystemUtils extends Fake implements OperatingSystemUtils { class FakeValidOperatingSystemUtils extends Fake
FakeValidOperatingSystemUtils([this.name = 'Microsoft Windows [Version 11.0.22621.963]']); implements OperatingSystemUtils {
FakeValidOperatingSystemUtils(
[this.name = 'Microsoft Windows [Version 11.0.22621.963]']);
@override @override
final String name; final String name;
} }
class FakeProcessLister extends Fake implements ProcessLister { class FakeProcessLister extends Fake implements ProcessLister {
FakeProcessLister({required this.result, this.exitCode = 0, this.powershellAvailable = true}); FakeProcessLister(
{required this.result,
this.exitCode = 0,
this.powershellAvailable = true});
final String result; final String result;
final int exitCode; final int exitCode;
final bool powershellAvailable; final bool powershellAvailable;
@ -37,11 +42,13 @@ class FakeProcessLister extends Fake implements ProcessLister {
} }
FakeProcessLister ofdRunning() { FakeProcessLister ofdRunning() {
return FakeProcessLister(result: r'Path: "C:\Program Files\Topaz OFD\Warsaw\core.exe"'); return FakeProcessLister(
result: r'Path: "C:\Program Files\Topaz OFD\Warsaw\core.exe"');
} }
FakeProcessLister ofdNotRunning() { FakeProcessLister ofdNotRunning() {
return FakeProcessLister(result: r'Path: "C:\Program Files\Google\Chrome\Application\chrome.exe'); return FakeProcessLister(
result: r'Path: "C:\Program Files\Google\Chrome\Application\chrome.exe');
} }
FakeProcessLister failure() { FakeProcessLister failure() {
@ -57,51 +64,58 @@ FakeProcessLister powershellUnavailable() {
/// The expected validation result object for /// The expected validation result object for
/// a passing windows version test /// a passing windows version test
const ValidationResult validWindows11ValidationResult = ValidationResult( ValidationResult validWindows11ValidationResult = ValidationResult(
ValidationType.success, ValidationType.success,
<ValidationMessage>[], const <ValidationMessage>[],
statusInfo: '11 Pro 64-bit, 23H2, 2009', statusInfo: '11 Pro 64-bit, 23H2, 2009',
); );
/// The expected validation result object for /// The expected validation result object for
/// a passing windows version test /// a passing windows version test
const ValidationResult invalidWindowsValidationResult = ValidationResult( ValidationResult invalidWindowsValidationResult = ValidationResult(
ValidationType.missing, ValidationType.missing,
<ValidationMessage>[], const <ValidationMessage>[],
statusInfo: 'Unable to confirm if installed Windows version is 10 or greater', statusInfo: 'Unable to confirm if installed Windows version is 10 or greater',
); );
const ValidationResult ofdFoundRunning = ValidationResult ofdFoundRunning = ValidationResult(
ValidationResult(ValidationType.partial, <ValidationMessage>[
ValidationMessage.hint(
'The Topaz OFD Security Module was detected on your machine. '
'You may need to disable it to build Flutter applications.',
),
], statusInfo: 'Problem detected with Windows installation');
const ValidationResult powershellUnavailableResult =
ValidationResult(ValidationType.partial, <ValidationMessage>[
ValidationMessage.hint(
'Failed to find ${ProcessLister.powershell} or ${ProcessLister.pwsh} on PATH',
),
], statusInfo: 'Problem detected with Windows installation');
const ValidationResult getProcessFailed = ValidationResult(
ValidationType.partial, ValidationType.partial,
<ValidationMessage>[ValidationMessage.hint('Get-Process failed to complete')], const <ValidationMessage>[
ValidationMessage.hint(
'The Topaz OFD Security Module was detected on your machine. '
'You may need to disable it to build Flutter applications.',
),
],
statusInfo: 'Problem detected with Windows installation',
);
ValidationResult powershellUnavailableResult = ValidationResult(
ValidationType.partial,
const <ValidationMessage>[
ValidationMessage.hint(
'Failed to find ${ProcessLister.powershell} or ${ProcessLister.pwsh} on PATH'),
],
statusInfo: 'Problem detected with Windows installation',
);
ValidationResult getProcessFailed = ValidationResult(
ValidationType.partial,
const <ValidationMessage>[
ValidationMessage.hint('Get-Process failed to complete'),
],
statusInfo: 'Problem detected with Windows installation', statusInfo: 'Problem detected with Windows installation',
); );
class FakeVersionExtractor extends Fake implements WindowsVersionExtractor { class FakeVersionExtractor extends Fake implements WindowsVersionExtractor {
FakeVersionExtractor({required this.mockData}); FakeVersionExtractor({required this.mockData});
FakeVersionExtractor.win11ProX64() FakeVersionExtractor.win11ProX64()
: this( : this(
mockData: WindowsVersionExtractionResult( mockData: WindowsVersionExtractionResult(
caption: '11 Pro 64-bit', caption: '11 Pro 64-bit',
releaseId: '2009', releaseId: '2009',
displayVersion: '23H2', displayVersion: '23H2',
), ),
); );
final WindowsVersionExtractionResult mockData; final WindowsVersionExtractionResult mockData;
@override @override
@ -111,8 +125,10 @@ class FakeVersionExtractor extends Fake implements WindowsVersionExtractor {
} }
void main() { void main() {
testWithoutContext('Successfully running windows version check on windows 10', () async { testWithoutContext('Successfully running windows version check on windows 10',
final WindowsVersionValidator windowsVersionValidator = WindowsVersionValidator( () async {
final WindowsVersionValidator windowsVersionValidator =
WindowsVersionValidator(
operatingSystemUtils: FakeValidOperatingSystemUtils(), operatingSystemUtils: FakeValidOperatingSystemUtils(),
processLister: ofdNotRunning(), processLister: ofdNotRunning(),
versionExtractor: FakeVersionExtractor.win11ProX64(), versionExtractor: FakeVersionExtractor.win11ProX64(),
@ -132,8 +148,11 @@ void main() {
); );
}); });
testWithoutContext('Successfully running windows version check on windows 10 for BR', () async { testWithoutContext(
final WindowsVersionValidator windowsVersionValidator = WindowsVersionValidator( 'Successfully running windows version check on windows 10 for BR',
() async {
final WindowsVersionValidator windowsVersionValidator =
WindowsVersionValidator(
operatingSystemUtils: FakeValidOperatingSystemUtils( operatingSystemUtils: FakeValidOperatingSystemUtils(
'Microsoft Windows [versão 10.0.22621.1105]', 'Microsoft Windows [versão 10.0.22621.1105]',
), ),
@ -156,7 +175,8 @@ void main() {
}); });
testWithoutContext('Identifying a windows version before 10', () async { testWithoutContext('Identifying a windows version before 10', () async {
final WindowsVersionValidator windowsVersionValidator = WindowsVersionValidator( final WindowsVersionValidator windowsVersionValidator =
WindowsVersionValidator(
operatingSystemUtils: FakeValidOperatingSystemUtils( operatingSystemUtils: FakeValidOperatingSystemUtils(
'Microsoft Windows [Version 8.0.22621.1105]', 'Microsoft Windows [Version 8.0.22621.1105]',
), ),
@ -185,13 +205,16 @@ OS Version: .0.19044 N/A Build 19044
OS 版本: 10.0.22621 暂缺 Build 22621 OS 版本: 10.0.22621 暂缺 Build 22621
'''; ''';
final RegExp regex = RegExp(kWindowsOSVersionSemVerPattern, multiLine: true); final RegExp regex =
RegExp(kWindowsOSVersionSemVerPattern, multiLine: true);
final Iterable<RegExpMatch> matches = regex.allMatches(testStr); final Iterable<RegExpMatch> matches = regex.allMatches(testStr);
expect(matches.length, 5, reason: 'There should be only 5 matches for the pattern provided'); expect(matches.length, 5,
reason: 'There should be only 5 matches for the pattern provided');
}); });
testWithoutContext('Successfully checks for Topaz OFD when it is running', () async { testWithoutContext('Successfully checks for Topaz OFD when it is running',
() async {
final WindowsVersionValidator validator = WindowsVersionValidator( final WindowsVersionValidator validator = WindowsVersionValidator(
operatingSystemUtils: FakeValidOperatingSystemUtils(), operatingSystemUtils: FakeValidOperatingSystemUtils(),
processLister: ofdRunning(), processLister: ofdRunning(),
@ -253,7 +276,8 @@ OS 版本: 10.0.22621 暂缺 Build 22621
final WindowsVersionValidator validator = WindowsVersionValidator( final WindowsVersionValidator validator = WindowsVersionValidator(
operatingSystemUtils: FakeValidOperatingSystemUtils(), operatingSystemUtils: FakeValidOperatingSystemUtils(),
processLister: failure(), processLister: failure(),
versionExtractor: FakeVersionExtractor(mockData: WindowsVersionExtractionResult.empty()), versionExtractor: FakeVersionExtractor(
mockData: WindowsVersionExtractionResult.empty()),
); );
final ValidationResult result = await validator.validate(); final ValidationResult result = await validator.validate();
expect( expect(
@ -278,14 +302,20 @@ OS 版本: 10.0.22621 暂缺 Build 22621
); );
}); });
testWithoutContext('getProcessesWithPath successfully runs with powershell', () async { testWithoutContext('getProcessesWithPath successfully runs with powershell',
() async {
final ProcessLister processLister = ProcessLister( final ProcessLister processLister = ProcessLister(
FakeProcessManager.list(<FakeCommand>[ FakeProcessManager.list(<FakeCommand>[
const FakeCommand( const FakeCommand(
command: <String>[ProcessLister.powershell, '-command', 'Get-Process | Format-List Path'], command: <String>[
ProcessLister.powershell,
'-command',
'Get-Process | Format-List Path'
],
stdout: ProcessLister.powershell, stdout: ProcessLister.powershell,
), ),
])..excludedExecutables.add(ProcessLister.pwsh), ])
..excludedExecutables.add(ProcessLister.pwsh),
); );
try { try {
@ -303,10 +333,15 @@ OS 版本: 10.0.22621 暂缺 Build 22621
final ProcessLister processLister = ProcessLister( final ProcessLister processLister = ProcessLister(
FakeProcessManager.list(<FakeCommand>[ FakeProcessManager.list(<FakeCommand>[
const FakeCommand( const FakeCommand(
command: <String>[ProcessLister.pwsh, '-command', 'Get-Process | Format-List Path'], command: <String>[
ProcessLister.pwsh,
'-command',
'Get-Process | Format-List Path'
],
stdout: ProcessLister.pwsh, stdout: ProcessLister.pwsh,
), ),
])..excludedExecutables.add(ProcessLister.powershell), ])
..excludedExecutables.add(ProcessLister.powershell),
); );
try { try {
@ -324,7 +359,8 @@ OS 版本: 10.0.22621 暂缺 Build 22621
() async { () async {
final ProcessLister processLister = ProcessLister( final ProcessLister processLister = ProcessLister(
FakeProcessManager.empty() FakeProcessManager.empty()
..excludedExecutables.addAll(<String>[ProcessLister.powershell, ProcessLister.pwsh]), ..excludedExecutables
.addAll(<String>[ProcessLister.powershell, ProcessLister.pwsh]),
); );
try { try {
@ -342,7 +378,8 @@ OS 版本: 10.0.22621 暂缺 Build 22621
testWithoutContext( testWithoutContext(
'Parses Caption, OSArchitecture, releaseId, and CurrentVersion from the OS', 'Parses Caption, OSArchitecture, releaseId, and CurrentVersion from the OS',
() async { () async {
final FakeProcessManager processManager = FakeProcessManager.list(<FakeCommand>[ final FakeProcessManager processManager =
FakeProcessManager.list(<FakeCommand>[
const FakeCommand( const FakeCommand(
command: <Pattern>['wmic', 'os', 'get', 'Caption,OSArchitecture'], command: <Pattern>['wmic', 'os', 'get', 'Caption,OSArchitecture'],
stdout: ''' stdout: '''
@ -402,7 +439,8 @@ End of search: 22 match(es) found.
}, },
); );
testWithoutContext('Differentiates Windows 11 from 10 when wmic call fails', () async { testWithoutContext('Differentiates Windows 11 from 10 when wmic call fails',
() async {
const String windows10RegQueryOutput = r''' const String windows10RegQueryOutput = r'''
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion
SystemRoot REG_SZ C:\WINDOWS SystemRoot REG_SZ C:\WINDOWS
@ -430,8 +468,14 @@ HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion
End of search: 21 match(es) found. End of search: 21 match(es) found.
'''; ''';
const List<String> wmicCommand = <String>['wmic', 'os', 'get', 'Caption,OSArchitecture']; const List<String> wmicCommand = <String>[
final FakeProcessManager processManager = FakeProcessManager.list(<FakeCommand>[ 'wmic',
'os',
'get',
'Caption,OSArchitecture'
];
final FakeProcessManager processManager =
FakeProcessManager.list(<FakeCommand>[
FakeCommand( FakeCommand(
command: wmicCommand, command: wmicCommand,
exception: ProcessException(wmicCommand[0], wmicCommand.sublist(1)), exception: ProcessException(wmicCommand[0], wmicCommand.sublist(1)),
@ -462,7 +506,12 @@ End of search: 21 match(es) found.
}); });
testWithoutContext('Handles reg call failing', () async { testWithoutContext('Handles reg call failing', () async {
const List<String> wmicCommand = <String>['wmic', 'os', 'get', 'Caption,OSArchitecture']; const List<String> wmicCommand = <String>[
'wmic',
'os',
'get',
'Caption,OSArchitecture'
];
const List<String> regCommand = <String>[ const List<String> regCommand = <String>[
'reg', 'reg',
'query', 'query',
@ -470,7 +519,8 @@ End of search: 21 match(es) found.
'/t', '/t',
'REG_SZ', 'REG_SZ',
]; ];
final FakeProcessManager processManager = FakeProcessManager.list(<FakeCommand>[ final FakeProcessManager processManager =
FakeProcessManager.list(<FakeCommand>[
const FakeCommand( const FakeCommand(
command: wmicCommand, command: wmicCommand,
stdout: r''' stdout: r'''