Reland [flutter_tools] show only supported sub commands (flutter#86153)

Author: asashour

packages/flutter_tools/lib/src/commands/build.dart

@@ -24,25 +24,31 @@ import 'build_winuwp.dart';
 
 class BuildCommand extends FlutterCommand {
   BuildCommand({ bool verboseHelp = false }) {
-    addSubcommand(BuildAarCommand(verboseHelp: verboseHelp));
-    addSubcommand(BuildApkCommand(verboseHelp: verboseHelp));
-    addSubcommand(BuildAppBundleCommand(verboseHelp: verboseHelp));
-    addSubcommand(BuildIOSCommand(verboseHelp: verboseHelp));
-    addSubcommand(BuildIOSFrameworkCommand(
+    _addSubcommand(BuildAarCommand(verboseHelp: verboseHelp));
+    _addSubcommand(BuildApkCommand(verboseHelp: verboseHelp));
+    _addSubcommand(BuildAppBundleCommand(verboseHelp: verboseHelp));
+    _addSubcommand(BuildIOSCommand(verboseHelp: verboseHelp));
+    _addSubcommand(BuildIOSFrameworkCommand(
       buildSystem: globals.buildSystem,
       verboseHelp: verboseHelp,
     ));
-    addSubcommand(BuildIOSArchiveCommand(verboseHelp: verboseHelp));
-    addSubcommand(BuildBundleCommand(verboseHelp: verboseHelp));
-    addSubcommand(BuildWebCommand(verboseHelp: verboseHelp));
-    addSubcommand(BuildMacosCommand(verboseHelp: verboseHelp));
-    addSubcommand(BuildLinuxCommand(
+    _addSubcommand(BuildIOSArchiveCommand(verboseHelp: verboseHelp));
+    _addSubcommand(BuildBundleCommand(verboseHelp: verboseHelp));
+    _addSubcommand(BuildWebCommand(verboseHelp: verboseHelp));
+    _addSubcommand(BuildMacosCommand(verboseHelp: verboseHelp));
+    _addSubcommand(BuildLinuxCommand(
       operatingSystemUtils: globals.os,
       verboseHelp: verboseHelp
     ));
-    addSubcommand(BuildWindowsCommand(verboseHelp: verboseHelp));
-    addSubcommand(BuildWindowsUwpCommand(verboseHelp: verboseHelp));
-    addSubcommand(BuildFuchsiaCommand(verboseHelp: verboseHelp));
+    _addSubcommand(BuildWindowsCommand(verboseHelp: verboseHelp));
+    _addSubcommand(BuildWindowsUwpCommand(verboseHelp: verboseHelp));
+    _addSubcommand(BuildFuchsiaCommand(verboseHelp: verboseHelp));
+  }
+
+  void _addSubcommand(BuildSubCommand command) {
+    if (command.supported) {
+      addSubcommand(command);
+    }
   }
 
   @override
@@ -63,6 +69,8 @@ abstract class BuildSubCommand extends FlutterCommand {
   @override
   bool get reportNullSafety => true;
 
+  bool get supported => true;
+
   /// Display a message describing the current null safety runtime mode
   /// that was selected.
   ///

packages/flutter_tools/lib/src/commands/build_fuchsia.dart

@@ -58,6 +58,9 @@ class BuildFuchsiaCommand extends BuildSubCommand {
   @override
   String get description => 'Build the Fuchsia target (Experimental).';
 
+  @override
+  bool get supported => globals.platform.isLinux || globals.platform.isMacOS;
+
   @override
   Future<FlutterCommandResult> runCommand() async {
     if (!featureFlags.isFuchsiaEnabled) {
@@ -68,7 +71,7 @@ class BuildFuchsiaCommand extends BuildSubCommand {
     }
     final BuildInfo buildInfo = await getBuildInfo();
     final FlutterProject flutterProject = FlutterProject.current();
-    if (!globals.platform.isLinux && !globals.platform.isMacOS) {
+    if (!supported) {
       throwToolExit('"build fuchsia" is only supported on Linux and MacOS hosts.');
     }
     if (!flutterProject.fuchsia.existsSync()) {

packages/flutter_tools/lib/src/commands/build_ios.dart

@@ -224,12 +224,15 @@ abstract class _BuildIOSSubCommand extends BuildSubCommand {
 
   Directory _outputAppDirectory(String xcodeResultOutput);
 
+  @override
+  bool get supported => globals.platform.isMacOS;
+
   @override
   Future<FlutterCommandResult> runCommand() async {
     defaultBuildMode = forSimulator ? BuildMode.debug : BuildMode.release;
     final BuildInfo buildInfo = await getBuildInfo();
 
-    if (!globals.platform.isMacOS) {
+    if (!supported) {
       throwToolExit('Building for iOS is only supported on macOS.');
     }
     if (forSimulator && !buildInfo.supportsSimulator) {

packages/flutter_tools/lib/src/commands/build_ios_framework.dart

@@ -141,11 +141,14 @@ class BuildIOSFrameworkCommand extends BuildSubCommand {
     return buildInfos;
   }
 
+  @override
+  bool get supported => _platform.isMacOS;
+
   @override
   Future<void> validateCommand() async {
     await super.validateCommand();
     _project = FlutterProject.current();
-    if (!_platform.isMacOS) {
+    if (!supported) {
       throwToolExit('Building frameworks for iOS is only supported on the Mac.');
     }
 

packages/flutter_tools/lib/src/commands/build_macos.dart

@@ -39,14 +39,17 @@ class BuildMacosCommand extends BuildSubCommand {
   @override
   String get description => 'Build a macOS desktop application.';
 
+  @override
+  bool get supported => globals.platform.isMacOS;
+
   @override
   Future<FlutterCommandResult> runCommand() async {
     final BuildInfo buildInfo = await getBuildInfo();
     final FlutterProject flutterProject = FlutterProject.current();
     if (!featureFlags.isMacOSEnabled) {
       throwToolExit('"build macos" is not currently supported. To enable, run "flutter config --enable-macos-desktop".');
     }
-    if (!globals.platform.isMacOS) {
+    if (!supported) {
       throwToolExit('"build macos" only supported on macOS hosts.');
     }
     displayNullSafetyMode(buildInfo);

packages/flutter_tools/test/commands.shard/hermetic/build_fuchsia_test.dart

@@ -4,13 +4,15 @@
 
 // @dart = 2.8
 
+import 'package:args/command_runner.dart';
 import 'package:file/memory.dart';
 import 'package:file_testing/file_testing.dart';
 import 'package:flutter_tools/src/base/file_system.dart';
 import 'package:flutter_tools/src/base/platform.dart';
 import 'package:flutter_tools/src/build_info.dart';
 import 'package:flutter_tools/src/cache.dart';
 import 'package:flutter_tools/src/commands/build.dart';
+import 'package:flutter_tools/src/commands/build_fuchsia.dart';
 import 'package:flutter_tools/src/features.dart';
 import 'package:flutter_tools/src/fuchsia/fuchsia_kernel_compiler.dart';
 import 'package:flutter_tools/src/fuchsia/fuchsia_pm.dart';
@@ -109,9 +111,10 @@ void main() {
       final File pubspecFile = fileSystem.file('pubspec.yaml')..createSync();
       pubspecFile.writeAsStringSync('name: $appName');
 
+      final bool supported = BuildFuchsiaCommand(verboseHelp: false).supported;
       expect(
         createTestCommandRunner(command).run(const <String>['build', 'fuchsia']),
-        throwsToolExit(),
+        supported ? throwsToolExit() : throwsA(isA<UsageException>()),
       );
     }, overrides: <Type, Generator>{
       Platform: () => windowsPlatform,

packages/flutter_tools/test/commands.shard/hermetic/build_ios_test.dart

@@ -4,11 +4,13 @@
 
 // @dart = 2.8
 
+import 'package:args/command_runner.dart';
 import 'package:file/memory.dart';
 import 'package:flutter_tools/src/base/file_system.dart';
 import 'package:flutter_tools/src/base/platform.dart';
 import 'package:flutter_tools/src/cache.dart';
 import 'package:flutter_tools/src/commands/build.dart';
+import 'package:flutter_tools/src/commands/build_ios.dart';
 import 'package:flutter_tools/src/ios/xcodeproj.dart';
 import 'package:flutter_tools/src/reporting/reporting.dart';
 
@@ -160,9 +162,10 @@ void main() {
     fileSystem.file(fileSystem.path.join('lib', 'main.dart'))
       .createSync(recursive: true);
 
+    final bool supported = BuildIOSCommand(verboseHelp: false).supported;
     expect(createTestCommandRunner(command).run(
       const <String>['build', 'ios', '--no-pub']
-    ), throwsToolExit());
+    ), supported ? throwsToolExit() : throwsA(isA<UsageException>()));
   }, overrides: <Type, Generator>{
     Platform: () => notMacosPlatform,
     FileSystem: () => fileSystem,

packages/flutter_tools/test/commands.shard/hermetic/build_ipa_test.dart

@@ -4,12 +4,14 @@
 
 // @dart = 2.8
 
+import 'package:args/command_runner.dart';
 import 'package:file/memory.dart';
 import 'package:flutter_tools/src/base/file_system.dart';
 import 'package:flutter_tools/src/base/logger.dart';
 import 'package:flutter_tools/src/base/platform.dart';
 import 'package:flutter_tools/src/cache.dart';
 import 'package:flutter_tools/src/commands/build.dart';
+import 'package:flutter_tools/src/commands/build_ios.dart';
 import 'package:flutter_tools/src/ios/xcodeproj.dart';
 import 'package:flutter_tools/src/reporting/reporting.dart';
 
@@ -155,9 +157,10 @@ void main() {
     fileSystem.file(fileSystem.path.join('lib', 'main.dart'))
       .createSync(recursive: true);
 
+    final bool supported = BuildIOSArchiveCommand(verboseHelp: false).supported;
     expect(createTestCommandRunner(command).run(
       const <String>['build', 'ipa', '--no-pub']
-    ), throwsToolExit());
+    ), supported ? throwsToolExit() : throwsA(isA<UsageException>()));
   }, overrides: <Type, Generator>{
     Platform: () => notMacosPlatform,
     FileSystem: () => fileSystem,

packages/flutter_tools/test/commands.shard/hermetic/build_macos_test.dart

@@ -149,7 +149,7 @@ void main() {
 
     expect(createTestCommandRunner(command).run(
       const <String>['build', 'macos', '--no-pub']
-    ), throwsToolExit(message: '"build macos" only supported on macOS hosts.'));
+    ), throwsA(isA<UsageException>()));
   }, overrides: <Type, Generator>{
     Platform: () => notMacosPlatform,
     FileSystem: () => fileSystem,
@@ -390,8 +390,9 @@ void main() {
   testUsingContext('Refuses to build for macOS when feature is disabled', () {
     final CommandRunner<void> runner = createTestCommandRunner(BuildCommand());
 
+    final bool supported = BuildMacosCommand(verboseHelp: false).supported;
     expect(() => runner.run(<String>['build', 'macos', '--no-pub']),
-      throwsToolExit());
+      supported ? throwsToolExit() : throwsA(isA<UsageException>()));
   }, overrides: <Type, Generator>{
     FeatureFlags: () => TestFeatureFlags(isMacOSEnabled: false),
   });

packages/flutter_tools/test/general.shard/commands/build_test.dart

@@ -5,6 +5,7 @@
 // @dart = 2.8
 
 import 'package:args/args.dart';
+import 'package:args/command_runner.dart';
 import 'package:flutter_tools/src/build_info.dart';
 import 'package:flutter_tools/src/commands/attach.dart';
 import 'package:flutter_tools/src/commands/build.dart';
@@ -75,6 +76,13 @@ void main() {
     FakeBuildSubCommand().test(sound);
     expect(testLogger.statusText, contains('💪 Building with sound null safety 💪'));
   });
+
+  testUsingContext('Include only supported sub commands', () {
+    final BuildCommand command = BuildCommand();
+    for (final Command<void> x in command.subcommands.values) {
+      expect((x as BuildSubCommand).supported, isTrue);
+    }
+  });
 }
 
 class FakeBuildSubCommand extends BuildSubCommand {