From fd1c02d3015ec036e925d45af99a378ee0cafdbe Mon Sep 17 00:00:00 2001
From: Matan Lurey <matanlurey@users.noreply.github.com>
Date: Tue, 14 Jan 2025 19:00:59 -0800
Subject: [PATCH] Exclude the top-level `engine` directory from
 `generate_gradle_lockfiles`. (#161635)

For local development workflows, this would find directories we don't
want included in the script.

Added a simple test.
---
 dev/tools/bin/generate_gradle_lockfiles.dart  |  8 ++-
 .../test/generate_gradle_lockfiles_test.dart  | 61 +++++++++++++++++++
 2 files changed, 68 insertions(+), 1 deletion(-)
 create mode 100644 dev/tools/test/generate_gradle_lockfiles_test.dart

diff --git a/dev/tools/bin/generate_gradle_lockfiles.dart b/dev/tools/bin/generate_gradle_lockfiles.dart
index efcb0c73e5..90346dcd63 100644
--- a/dev/tools/bin/generate_gradle_lockfiles.dart
+++ b/dev/tools/bin/generate_gradle_lockfiles.dart
@@ -304,7 +304,13 @@ distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-all.zip
 
 Iterable<Directory> discoverAndroidDirectories(Directory repoRoot) {
   return repoRoot
-      .listSync(recursive: true)
+      .listSync()
       .whereType<Directory>()
+      // Exclude the top-level "engine/" directory, which is not covered by the the tool.
+      .where((Directory directory) => directory.basename != 'engine')
+      // ... and then recurse into every directory (other than the excluded directory).
+      .expand((Directory d) => d.listSync(recursive: true))
+      .whereType<Directory>()
+      // ... where the directory ultimately is named "android".
       .where((FileSystemEntity entity) => entity.basename == 'android');
 }
diff --git a/dev/tools/test/generate_gradle_lockfiles_test.dart b/dev/tools/test/generate_gradle_lockfiles_test.dart
new file mode 100644
index 0000000000..7b4a9c605f
--- /dev/null
+++ b/dev/tools/test/generate_gradle_lockfiles_test.dart
@@ -0,0 +1,61 @@
+// Copyright 2014 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:file/local.dart';
+import 'package:path/path.dart' as p;
+import 'package:test/test.dart';
+
+import '../bin/generate_gradle_lockfiles.dart' as bin;
+
+void main() {
+  const FileSystem localFs = LocalFileSystem();
+  late Directory tmpFlutterRoot;
+
+  setUp(() {
+    tmpFlutterRoot = localFs.systemTempDirectory.createTempSync('generate_gradle_lockfiles_test.');
+
+    // Simulate a version of the top-level directory structure.
+    // It's not critical that it is a "real" structure, as long as it includes:
+    // - At least one top-level directory that is "engine"
+    // - At least one top-level directory that is not "engine"
+    // - At least one nested directory (in not "engine") that is "engine"
+    final List<String> directoriesToCreate = <String>[
+      p.join('dev', 'integration_tests', 'android_test', 'android'),
+      p.join('engine', 'src', 'flutter', 'third_party', 'some_package', 'android'),
+      p.join('packages', 'flutter_tools', 'test', 'fixtures', 'engine', 'android'),
+    ];
+
+    for (final String path in directoriesToCreate) {
+      localFs.directory(p.join(tmpFlutterRoot.path, path)).createSync(recursive: true);
+    }
+  });
+
+  tearDown(() {
+    tmpFlutterRoot.deleteSync(recursive: true);
+  });
+
+  test('discoverAndroidDirectories resolves a total of 2 directories of the possible 3', () {
+    expect(bin.discoverAndroidDirectories(tmpFlutterRoot), hasLength(2));
+  });
+
+  test('discoverAndroidDirectories does not traverse into the top-level "engine" directory', () {
+    for (final Directory directory in bin.discoverAndroidDirectories(tmpFlutterRoot)) {
+      if (directory.path.contains(p.join('engine', 'src', 'flutter'))) {
+        fail('Unexpected: ${directory.path} should be excluded (top-level engine directory)');
+      }
+    }
+  });
+
+  test('discoverAndroidDirectories does traverse into a non top-level "engine" directory', () {
+    final Iterable<String> paths = bin
+        .discoverAndroidDirectories(tmpFlutterRoot)
+        .map((Directory r) => r.path);
+    expect(
+      paths,
+      containsAll(<Matcher>[contains(p.join('test', 'fixtures', 'engine', 'android'))]),
+      reason: 'A directory named "engine" that is not a root directory should be traversed',
+    );
+  });
+}