Modify test_and_fix to avoid traversing into .dart_tool directories (#568)

Author: gspencergoog

.github/workflows/flutter_packages.yaml

@@ -44,8 +44,8 @@ jobs:
         env:
           GH_TOKEN: ${{ github.token }}
         run: |
-          # Find all directories containing pubspec.yaml in packages and examples.
-          ALL_DIRS=$(find packages examples -name pubspec.yaml -not -path "*/.dart_tool/*" -exec dirname {} \;)
+          # Find all directories containing pubspec.yaml in packages, tools, and examples.
+          ALL_DIRS=$(find packages examples tool -name pubspec.yaml -not -path "*/.dart_tool/*" -exec dirname {} \;)
 
           # Get the list of changed files. The method depends on the event type.
           if [[ "${{ github.event_name }}" == "pull_request" ]]; then

tool/test_and_fix/lib/test_and_fix.dart

@@ -121,31 +121,56 @@ class TestAndFix {
     bool all = false,
   }) async {
     final projects = <Directory>[];
-    await for (final FileSystemEntity entity in root.list(recursive: true)) {
-      if (entity is! File || path.basename(entity.path) != 'pubspec.yaml') {
-        continue;
-      }
-      final File pubspec = entity;
-      final Directory projectDir = pubspec.parent;
-      if (isProjectAllowed(projectDir, all: all)) {
-        projects.add(projectDir);
+    await _findProjectsRecursive(root, projects, all: all);
+    return projects;
+  }
+
+  Future<void> _findProjectsRecursive(
+    Directory dir,
+    List<Directory> projects, {
+    required bool all,
+  }) async {
+    final Set<String> excludedDirs = _getExcludedDirectories(all: all);
+    try {
+      await for (final FileSystemEntity entity in dir.list(
+        followLinks: false,
+      )) {
+        if (entity is File && fs.path.basename(entity.path) == 'pubspec.yaml') {
+          final Directory projectDir = entity.parent;
+          if (isProjectAllowed(projectDir, all: all)) {
+            projects.add(projectDir);
+          }
+        } else if (entity is Directory) {
+          if (!excludedDirs.contains(fs.path.basename(entity.path))) {
+            await _findProjectsRecursive(entity, projects, all: all);
+          }
+        }
       }
+    } on FileSystemException catch (exception) {
+      print(
+        'Warning: Failed to list directory contents while searching for '
+        'projects: $exception',
+      );
     }
-    return projects;
   }
 
-  bool isProjectAllowed(Directory projectPath, {bool all = false}) {
-    // Skip the things that we really don't ever want to traverse, but skip the
-    // non-essential packages unless --all is specified.
-    final excluded = [
+  Set<String> _getExcludedDirectories({required bool all}) {
+    return {
       '.dart_tool',
       'ephemeral',
       'firebase_core',
       'build',
       if (!all) 'spikes',
       if (!all) 'fix_copyright',
+      if (!all) 'release',
       if (!all) 'test_and_fix',
-    ];
+    };
+  }
+
+  bool isProjectAllowed(Directory projectPath, {bool all = false}) {
+    // Skip the things that we really don't ever want to traverse, but skip the
+    // non-essential packages unless --all is specified.
+    final Set<String> excluded = _getExcludedDirectories(all: all);
     final List<String> components = fs.path.split(projectPath.path);
     for (final exclude in excluded) {
       if (components.contains(exclude)) {

tool/test_and_fix/test/project_discovery_test.dart

@@ -64,6 +64,23 @@ void main() {
       expect(projects, isEmpty);
     });
 
+    test('ignores nested projects in excluded directories', () async {
+      final excluded = ['.dart_tool', 'build', 'ephemeral', 'firebase_core'];
+
+      for (final exclude in excluded) {
+        final Directory project = fs.directory(
+          path.join(root.path, exclude, 'nested_project'),
+        )..createSync(recursive: true);
+        fs
+            .file(path.join(project.path, 'pubspec.yaml'))
+            .writeAsStringSync('sdk: flutter');
+      }
+
+      final List<Directory> projects = await testAndFix.findProjects(root);
+
+      expect(projects, isEmpty);
+    });
+
     test('ignores some excluded directories with --all', () async {
       final excluded = ['.dart_tool', 'ephemeral', 'firebase_core', 'build'];