[tool] Get dependencies in package examples before publish check. (#6596)

Author: ditman

script/tool/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.12.1
+
+* Modifies `publish_check_command.dart` to do a `dart pub get` in all examples
+  of the package being checked. Workaround for [dart-lang/pub#3618](https://github.com/dart-lang/pub/issues/3618).
+
 ## 0.12.0
 
 * Changes the behavior of `--packages-for-branch` on main/master to run for

script/tool/lib/src/publish_check_command.dart

@@ -130,7 +130,23 @@ class PublishCheckCommand extends PackageLoopingCommand {
     }
   }
 
+  // Run `dart pub get` on the examples of [package].
+  Future<void> _fetchExampleDeps(RepositoryPackage package) async {
+    for (final RepositoryPackage example in package.getExamples()) {
+      await processRunner.runAndStream(
+        'dart',
+        <String>['pub', 'get'],
+        workingDir: example.directory,
+      );
+    }
+  }
+
   Future<bool> _hasValidPublishCheckRun(RepositoryPackage package) async {
+    // `pub publish` does not do `dart pub get` inside `example` directories
+    // of a package (but they're part of the analysis output!).
+    // Issue: https://github.com/flutter/flutter/issues/113788
+    await _fetchExampleDeps(package);
+
     print('Running pub publish --dry-run:');
     final io.Process process = await processRunner.start(
       flutterCommand,

script/tool/pubspec.yaml

@@ -1,7 +1,7 @@
 name: flutter_plugin_tools
 description: Productivity utils for flutter/plugins and flutter/packages
 repository: https://github.com/flutter/plugins/tree/main/script/tool
-version: 0.12.0
+version: 0.12.1
 
 dependencies:
   args: ^2.1.0

script/tool/test/publish_check_command_test.dart

@@ -44,10 +44,16 @@ void main() {
     });
 
     test('publish check all packages', () async {
-      final RepositoryPackage plugin1 =
-          createFakePlugin('plugin_tools_test_package_a', packagesDir);
-      final RepositoryPackage plugin2 =
-          createFakePlugin('plugin_tools_test_package_b', packagesDir);
+      final RepositoryPackage plugin1 = createFakePlugin(
+        'plugin_tools_test_package_a',
+        packagesDir,
+        examples: <String>[],
+      );
+      final RepositoryPackage plugin2 = createFakePlugin(
+        'plugin_tools_test_package_b',
+        packagesDir,
+        examples: <String>[],
+      );
 
       await runCapturingPrint(runner, <String>['publish-check']);
 
@@ -65,6 +71,49 @@ void main() {
           ]));
     });
 
+    test('publish prepares dependencies of examples (when present)', () async {
+      final RepositoryPackage plugin1 = createFakePlugin(
+        'plugin_tools_test_package_a',
+        packagesDir,
+        examples: <String>['example1', 'example2'],
+      );
+      final RepositoryPackage plugin2 = createFakePlugin(
+        'plugin_tools_test_package_b',
+        packagesDir,
+        examples: <String>[],
+      );
+
+      await runCapturingPrint(runner, <String>['publish-check']);
+
+      // For plugin1, these are the expected pub get calls that will happen
+      final Iterable<ProcessCall> pubGetCalls =
+          plugin1.getExamples().map((RepositoryPackage example) {
+        return ProcessCall(
+          'dart',
+          const <String>['pub', 'get'],
+          example.path,
+        );
+      });
+
+      expect(pubGetCalls, hasLength(2));
+      expect(
+        processRunner.recordedCalls,
+        orderedEquals(<ProcessCall>[
+          // plugin1 has 2 examples, so there's some 'dart pub get' calls.
+          ...pubGetCalls,
+          ProcessCall(
+              'flutter',
+              const <String>['pub', 'publish', '--', '--dry-run'],
+              plugin1.path),
+          // plugin2 has no examples, so there's no extra 'dart pub get' calls.
+          ProcessCall(
+              'flutter',
+              const <String>['pub', 'publish', '--', '--dry-run'],
+              plugin2.path),
+        ]),
+      );
+    });
+
     test('fail on negative test', () async {
       createFakePlugin('plugin_tools_test_package_a', packagesDir);