[flutter_plugin_tests] Split analyze out of xctest (#4161)

To prep for making a combined command to run native tests across different platforms, rework `xctest`: - Split analyze out into a new `xcode-analyze` command: - Since the analyze step runs a new build over everything with different flags, this is only a small amount slower than the combined version - This makes the logic easier to follow - This allows us to meaningfully report skips, to better notice missing tests. - Add the ability to target specific test bundles (RunnerTests or RunnerUITests) To share code between the commands, this extracts a new `Xcode` helper class. Part of https://github.com/flutter/flutter/issues/84392 and https://github.com/flutter/flutter/issues/86489
2025-08-24 11:39:26 +08:00 · 2021-07-20 18:17:20 -07:00
parent a206782759
commit ff8cb52f8e
8 changed files with 1440 additions and 296 deletions
--- a/script/tool/lib/src/xcode_analyze_command.dart
+++ b/script/tool/lib/src/xcode_analyze_command.dart
@ -0,0 +1,111 @@
+// Copyright 2013 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 'package:file/file.dart';
+import 'package:platform/platform.dart';
+
+import 'common/core.dart';
+import 'common/package_looping_command.dart';
+import 'common/plugin_utils.dart';
+import 'common/process_runner.dart';
+import 'common/xcode.dart';
+
+/// The command to run Xcode's static analyzer on plugins.
+class XcodeAnalyzeCommand extends PackageLoopingCommand {
+  /// Creates an instance of the test command.
+  XcodeAnalyzeCommand(
+    Directory packagesDir, {
+    ProcessRunner processRunner = const ProcessRunner(),
+    Platform platform = const LocalPlatform(),
+  })  : _xcode = Xcode(processRunner: processRunner, log: true),
+        super(packagesDir, processRunner: processRunner, platform: platform) {
+    argParser.addFlag(kPlatformIos, help: 'Analyze iOS');
+    argParser.addFlag(kPlatformMacos, help: 'Analyze macOS');
+  }
+
+  final Xcode _xcode;
+
+  @override
+  final String name = 'xcode-analyze';
+
+  @override
+  final String description =
+      'Runs Xcode analysis on the iOS and/or macOS example apps.';
+
+  @override
+  Future<void> initializeRun() async {
+    if (!(getBoolArg(kPlatformIos) || getBoolArg(kPlatformMacos))) {
+      printError('At least one platform flag must be provided.');
+      throw ToolExit(exitInvalidArguments);
+    }
+  }
+
+  @override
+  Future<PackageResult> runForPackage(Directory package) async {
+    final bool testIos = getBoolArg(kPlatformIos) &&
+        pluginSupportsPlatform(kPlatformIos, package,
+            requiredMode: PlatformSupport.inline);
+    final bool testMacos = getBoolArg(kPlatformMacos) &&
+        pluginSupportsPlatform(kPlatformMacos, package,
+            requiredMode: PlatformSupport.inline);
+
+    final bool multiplePlatformsRequested =
+        getBoolArg(kPlatformIos) && getBoolArg(kPlatformMacos);
+    if (!(testIos || testMacos)) {
+      return PackageResult.skip('Not implemented for target platform(s).');
+    }
+
+    final List<String> failures = <String>[];
+    if (testIos &&
+        !await _analyzePlugin(package, 'iOS', extraFlags: <String>[
+          '-destination',
+          'generic/platform=iOS Simulator'
+        ])) {
+      failures.add('iOS');
+    }
+    if (testMacos && !await _analyzePlugin(package, 'macOS')) {
+      failures.add('macOS');
+    }
+
+    // Only provide the failing platform in the failure details if testing
+    // multiple platforms, otherwise it's just noise.
+    return failures.isEmpty
+        ? PackageResult.success()
+        : PackageResult.fail(
+            multiplePlatformsRequested ? failures : <String>[]);
+  }
+
+  /// Analyzes [plugin] for [platform], returning true if it passed analysis.
+  Future<bool> _analyzePlugin(
+    Directory plugin,
+    String platform, {
+    List<String> extraFlags = const <String>[],
+  }) async {
+    bool passing = true;
+    for (final Directory example in getExamplesForPlugin(plugin)) {
+      // Running tests and static analyzer.
+      final String examplePath =
+          getRelativePosixPath(example, from: plugin.parent);
+      print('Running $platform tests and analyzer for $examplePath...');
+      final int exitCode = await _xcode.runXcodeBuild(
+        example,
+        actions: <String>['analyze'],
+        workspace: '${platform.toLowerCase()}/Runner.xcworkspace',
+        scheme: 'Runner',
+        configuration: 'Debug',
+        extraFlags: <String>[
+          ...extraFlags,
+          'GCC_TREAT_WARNINGS_AS_ERRORS=YES',
+        ],
+      );
+      if (exitCode == 0) {
+        printSuccess('$examplePath ($platform) passed analysis.');
+      } else {
+        printError('$examplePath ($platform) failed analysis.');
+        passing = false;
+      }
+    }
+    return passing;
+  }
+}