[pigeon] Support other hosts in generated file CI checks

packages/pigeon/tool/run_tests.dart

@@ -13,6 +13,7 @@ library;
 
 import 'dart:io';
 
+import 'package:collection/collection.dart';
 import 'package:path/path.dart' as p;
 
 import 'shared/generation.dart';
@@ -35,62 +36,56 @@ void _validateTestCoverage(List<List<String>> shards) {
 }
 
 Future<void> _validateGeneratedTestFiles() async {
-  final String baseDir = p.dirname(p.dirname(Platform.script.toFilePath()));
-  final String repositoryRoot = p.dirname(p.dirname(baseDir));
-  final String relativePigeonPath = p.relative(baseDir, from: repositoryRoot);
-
-  print('Validating generated files:');
-  print('  Generating test output...');
-  final int generateExitCode = await generateTestPigeons(baseDir: baseDir);
-  if (generateExitCode != 0) {
-    print('Generation failed; see above for errors.');
-    exit(generateExitCode);
-  }
-
-  print('  Formatting output...');
-  final int formatExitCode =
-      await formatAllFiles(repositoryRoot: repositoryRoot);
-  if (formatExitCode != 0) {
-    print('Formatting failed; see above for errors.');
-    exit(formatExitCode);
-  }
+  await _validateGeneratedFiles(
+    (String baseDir) => generateTestPigeons(baseDir: baseDir),
+    generationMessage: 'Generating test output',
+    incorrectFilesMessage:
+        'The following files are not updated, or not formatted correctly:',
+  );
+}
 
-  print('  Checking for changes...');
-  final List<String> modifiedFiles = await _modifiedFiles(
-      repositoryRoot: repositoryRoot, relativePigeonPath: relativePigeonPath);
+Future<void> _validateGeneratedExampleFiles() async {
+  await _validateGeneratedFiles(
+    (String _) => generateExamplePigeons(),
+    generationMessage: 'Generating example output',
+    incorrectFilesMessage:
+        'Either messages.dart and messages_test.dart have non-matching definitions or\n'
+        'the following files are not updated, or not formatted correctly:',
+  );
+}
 
-  if (modifiedFiles.isEmpty) {
+Future<void> _validateGeneratedFiles(
+  Future<int> Function(String baseDirectory) generator, {
+  required String generationMessage,
+  required String incorrectFilesMessage,
+}) async {
+  // Generated file validation is split by platform, both to avoid duplication
+  // of work, and to avoid issues if different CI configurations have different
+  // setups (e.g., different clang-format versions or no clang-format at all).
+  final Set<GeneratorLanguage> languagesToValidate;
+  if (Platform.isLinux) {
+    languagesToValidate = <GeneratorLanguage>{
+      GeneratorLanguage.cpp,
+      GeneratorLanguage.dart,
+      GeneratorLanguage.java,
+      GeneratorLanguage.kotlin,
+      GeneratorLanguage.objc,
+    };
+  } else if (Platform.isMacOS) {
+    languagesToValidate = <GeneratorLanguage>{
+      // TODO(stuartmorgan): Enable this in or after https://github.com/flutter/packages/pull/5928
+      // GeneratorLanguage.swift,
+    };
+  } else {
     return;
   }
 
-  print('The following files are not updated, or not formatted correctly:');
-  modifiedFiles.map((String line) => '  $line').forEach(print);
-
-  print('\nTo fix run "dart run tool/generate.dart --format" from the pigeon/ '
-      'directory, or apply the diff with the command below.\n');
-
-  final ProcessResult diffResult = await Process.run(
-    'git',
-    <String>['diff', relativePigeonPath],
-    workingDirectory: repositoryRoot,
-  );
-  if (diffResult.exitCode != 0) {
-    print('Unable to determine diff.');
-    exit(1);
-  }
-  print('patch -p1 <<DONE');
-  print(diffResult.stdout);
-  print('DONE');
-  exit(1);
-}
-
-Future<void> _validateGeneratedExampleFiles() async {
   final String baseDir = p.dirname(p.dirname(Platform.script.toFilePath()));
   final String repositoryRoot = p.dirname(p.dirname(baseDir));
   final String relativePigeonPath = p.relative(baseDir, from: repositoryRoot);
 
   print('Validating generated files:');
-  print('  Generating example output...');
+  print('  $generationMessage...');
 
   final int generateExitCode = await generateExamplePigeons();
 
@@ -100,8 +95,8 @@ Future<void> _validateGeneratedExampleFiles() async {
   }
 
   print('  Formatting output...');
-  final int formatExitCode =
-      await formatAllFiles(repositoryRoot: repositoryRoot);
+  final int formatExitCode = await formatAllFiles(
+      repositoryRoot: repositoryRoot, languages: languagesToValidate);
   if (formatExitCode != 0) {
     print('Formatting failed; see above for errors.');
     exit(formatExitCode);
@@ -110,22 +105,26 @@ Future<void> _validateGeneratedExampleFiles() async {
   print('  Checking for changes...');
   final List<String> modifiedFiles = await _modifiedFiles(
       repositoryRoot: repositoryRoot, relativePigeonPath: relativePigeonPath);
-
-  if (modifiedFiles.isEmpty) {
+  final Set<String> extensions = languagesToValidate
+      .map((GeneratorLanguage lang) => _extensionsForLanguage(lang))
+      .flattened
+      .toSet();
+  final Iterable<String> filteredFiles = modifiedFiles.where((String path) =>
+      extensions.contains(p.extension(path).replaceFirst('.', '')));
+
+  if (filteredFiles.isEmpty) {
     return;
   }
 
-  print(
-      'Either messages.dart and messages_test.dart have non-matching definitions or');
-  print('the following files are not updated, or not formatted correctly:');
-  modifiedFiles.map((String line) => '  $line').forEach(print);
+  print(incorrectFilesMessage);
+  filteredFiles.map((String line) => '  $line').forEach(print);
 
   print('\nTo fix run "dart run tool/generate.dart --format" from the pigeon/ '
       'directory, or apply the diff with the command below.\n');
 
   final ProcessResult diffResult = await Process.run(
     'git',
-    <String>['diff', relativePigeonPath],
+    <String>['diff', ...filteredFiles],
     workingDirectory: repositoryRoot,
   );
   if (diffResult.exitCode != 0) {
@@ -138,6 +137,17 @@ Future<void> _validateGeneratedExampleFiles() async {
   exit(1);
 }
 
+Set<String> _extensionsForLanguage(GeneratorLanguage language) {
+  return switch (language) {
+    GeneratorLanguage.cpp => <String>{'cc', 'cpp', 'h'},
+    GeneratorLanguage.dart => <String>{'dart'},
+    GeneratorLanguage.java => <String>{'java'},
+    GeneratorLanguage.kotlin => <String>{'kt'},
+    GeneratorLanguage.swift => <String>{'swift'},
+    GeneratorLanguage.objc => <String>{'m', 'mm'},
+  };
+}
+
 Future<List<String>> _modifiedFiles(
     {required String repositoryRoot,
     required String relativePigeonPath}) async {
@@ -204,20 +214,13 @@ Future<void> main(List<String> args) async {
     ],
   ]);
 
-  // Ensure that all generated files are up to date. This is run only on Linux
-  // both to avoid duplication of work, and to avoid issues if different CI
-  // configurations have different setups (e.g., different clang-format versions
-  // or no clang-format at all).
-  if (Platform.isLinux) {
-    // Only run on master, since Dart format can change between versions.
-    // TODO(stuartmorgan): Make a more generic way to run this check only on
-    // master; this currently won't work for anything but Cirrus.
-    if (Platform.environment['CHANNEL'] == 'stable') {
-      print('Skipping generated file validation on stable.');
-    } else {
-      await _validateGeneratedTestFiles();
-      await _validateGeneratedExampleFiles();
-    }
+  // Ensure that all generated files are up to date.
+  // Only run on master, since Dart format can change between versions.
+  if (Platform.environment['CHANNEL'] == 'stable') {
+    print('Skipping generated file validation on stable.');
+  } else {
+    await _validateGeneratedTestFiles();
+    await _validateGeneratedExampleFiles();
   }
 
   final List<String> testsToRun;

packages/pigeon/tool/shared/generation.dart

@@ -10,8 +10,9 @@ import 'package:pigeon/pigeon.dart';
 
 import 'process_utils.dart';
 
-enum GeneratorLanguages {
+enum GeneratorLanguage {
   cpp,
+  dart,
   java,
   kotlin,
   objc,
@@ -20,8 +21,8 @@ enum GeneratorLanguages {
 
 // A map of pigeons/ files to the languages that they can't yet be generated
 // for due to limitations of that generator.
-const Map<String, Set<GeneratorLanguages>> _unsupportedFiles =
-    <String, Set<GeneratorLanguages>>{};
+const Map<String, Set<GeneratorLanguage>> _unsupportedFiles =
+    <String, Set<GeneratorLanguage>>{};
 
 String _snakeToPascalCase(String snake) {
   final List<String> parts = snake.split('_');
@@ -77,28 +78,28 @@ Future<int> generateTestPigeons({required String baseDir}) async {
 
   for (final String input in inputs) {
     final String pascalCaseName = _snakeToPascalCase(input);
-    final Set<GeneratorLanguages> skipLanguages =
-        _unsupportedFiles[input] ?? <GeneratorLanguages>{};
+    final Set<GeneratorLanguage> skipLanguages =
+        _unsupportedFiles[input] ?? <GeneratorLanguage>{};
 
     // Generate the default language test plugin output.
     int generateCode = await runPigeon(
       input: './pigeons/$input.dart',
       dartOut: '$sharedDartOutputBase/lib/src/generated/$input.gen.dart',
       // Android
-      kotlinOut: skipLanguages.contains(GeneratorLanguages.kotlin)
+      kotlinOut: skipLanguages.contains(GeneratorLanguage.kotlin)
           ? null
           : '$outputBase/android/src/main/kotlin/com/example/test_plugin/$pascalCaseName.gen.kt',
       kotlinPackage: 'com.example.test_plugin',
       kotlinErrorClassName: '${pascalCaseName}Error',
       // iOS
-      swiftOut: skipLanguages.contains(GeneratorLanguages.swift)
+      swiftOut: skipLanguages.contains(GeneratorLanguage.swift)
           ? null
           : '$outputBase/ios/Classes/$pascalCaseName.gen.swift',
       // Windows
-      cppHeaderOut: skipLanguages.contains(GeneratorLanguages.cpp)
+      cppHeaderOut: skipLanguages.contains(GeneratorLanguage.cpp)
           ? null
           : '$outputBase/windows/pigeon/$input.gen.h',
-      cppSourceOut: skipLanguages.contains(GeneratorLanguages.cpp)
+      cppSourceOut: skipLanguages.contains(GeneratorLanguage.cpp)
           ? null
           : '$outputBase/windows/pigeon/$input.gen.cpp',
       cppNamespace: '${input}_pigeontest',
@@ -114,7 +115,7 @@ Future<int> generateTestPigeons({required String baseDir}) async {
     // single invocation.
     generateCode = await runPigeon(
       input: './pigeons/$input.dart',
-      swiftOut: skipLanguages.contains(GeneratorLanguages.swift)
+      swiftOut: skipLanguages.contains(GeneratorLanguage.swift)
           ? null
           : '$outputBase/macos/Classes/$pascalCaseName.gen.swift',
       suppressVersion: true,
@@ -130,16 +131,16 @@ Future<int> generateTestPigeons({required String baseDir}) async {
       // Android
       // This doesn't use the '.gen' suffix since Java has strict file naming
       // rules.
-      javaOut: skipLanguages.contains(GeneratorLanguages.java)
+      javaOut: skipLanguages.contains(GeneratorLanguage.java)
           ? null
           : '$alternateOutputBase/android/src/main/java/com/example/'
               'alternate_language_test_plugin/${_javaFilenameForName(input)}.java',
       javaPackage: 'com.example.alternate_language_test_plugin',
       // iOS
-      objcHeaderOut: skipLanguages.contains(GeneratorLanguages.objc)
+      objcHeaderOut: skipLanguages.contains(GeneratorLanguage.objc)
           ? null
           : '$alternateOutputBase/ios/Classes/$pascalCaseName.gen.h',
-      objcSourceOut: skipLanguages.contains(GeneratorLanguages.objc)
+      objcSourceOut: skipLanguages.contains(GeneratorLanguage.objc)
           ? null
           : '$alternateOutputBase/ios/Classes/$pascalCaseName.gen.m',
       suppressVersion: true,
@@ -154,10 +155,10 @@ Future<int> generateTestPigeons({required String baseDir}) async {
     // single invocation.
     generateCode = await runPigeon(
       input: './pigeons/$input.dart',
-      objcHeaderOut: skipLanguages.contains(GeneratorLanguages.objc)
+      objcHeaderOut: skipLanguages.contains(GeneratorLanguage.objc)
           ? null
           : '$alternateOutputBase/macos/Classes/$pascalCaseName.gen.h',
-      objcSourceOut: skipLanguages.contains(GeneratorLanguages.objc)
+      objcSourceOut: skipLanguages.contains(GeneratorLanguage.objc)
           ? null
           : '$alternateOutputBase/macos/Classes/$pascalCaseName.gen.m',
       suppressVersion: true,
@@ -234,7 +235,17 @@ Future<int> runPigeon({
 /// This is intended for formatting generated output, but since there's no
 /// way to filter to specific files in with the repo tooling it runs over the
 /// entire package.
-Future<int> formatAllFiles({required String repositoryRoot}) {
+Future<int> formatAllFiles({
+  required String repositoryRoot,
+  Set<GeneratorLanguage> languages = const <GeneratorLanguage>{
+    GeneratorLanguage.cpp,
+    GeneratorLanguage.dart,
+    GeneratorLanguage.java,
+    GeneratorLanguage.kotlin,
+    GeneratorLanguage.objc,
+    GeneratorLanguage.swift,
+  },
+}) {
   final String dartCommand = Platform.isWindows ? 'dart.exe' : 'dart';
   return runProcess(
       dartCommand,
@@ -243,6 +254,27 @@ Future<int> formatAllFiles({required String repositoryRoot}) {
         'script/tool/bin/flutter_plugin_tools.dart',
         'format',
         '--packages=pigeon',
+        if (languages.contains(GeneratorLanguage.cpp) ||
+            languages.contains(GeneratorLanguage.objc))
+          '--clang-format'
+        else
+          '--no-clang-format',
+        if (languages.contains(GeneratorLanguage.java))
+          '--java'
+        else
+          '--no-java',
+        if (languages.contains(GeneratorLanguage.dart))
+          '--dart'
+        else
+          '--no-dart',
+        if (languages.contains(GeneratorLanguage.kotlin))
+          '--kotlin'
+        else
+          '--no-kotlin',
+        if (languages.contains(GeneratorLanguage.swift))
+          '--swift'
+        else
+          '--no-swift',
       ],
       workingDirectory: repositoryRoot,
       streamOutput: false,