analyzer_testing: convert all modifyFile users to modifyFile2

This also involves tidying up blaze_watcher_test, in order to
easily get back a File object from a helper method.

Change-Id: If9dc812dc3a97a205dee600b89c3e8490e9efcba
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/429201
Commit-Queue: Samuel Rawlins <[email protected]>
Reviewed-by: Konstantin Shcheglov <[email protected]>

Author: srawlins

pkg/analysis_server/test/analysis/notification_errors_test.dart

@@ -170,15 +170,15 @@ analyzer:
       '.dart_tool/package_config.json',
     );
     var generatedProject = join(testPackageRootPath, '.dart_tool/foo');
-    var generatedFile = join(generatedProject, 'lib', 'foo.dart');
+    var generatedFilePath = join(generatedProject, 'lib', 'foo.dart');
 
     // Add the generated project into package_config.json.
     var config = PackageConfigFileBuilder();
     config.add(name: 'foo', rootPath: generatedProject);
     newFile(configPath, config.toContent(toUriStr: toUriStr));
 
     // Set up project that references the class prior to initial analysis.
-    newFile(generatedFile, 'class A {}');
+    var generatedFile = newFile(generatedFilePath, 'class A {}');
     addTestFile('''
 import 'package:foo/foo.dart';
 A? a;
@@ -191,7 +191,7 @@ A? a;
 
     // Remove the class, which should cause the main project to have an analysis
     // error.
-    modifyFile(generatedFile, '');
+    modifyFile2(generatedFile, '');
 
     await waitForTasksFinished();
     await pumpEventQueue(times: 5000);

pkg/analysis_server/test/analysis_server_base.dart

@@ -300,7 +300,7 @@ class PubPackageAnalysisServerTest extends ContextResolutionTest
   }
 
   void modifyTestFile(String content) {
-    modifyFile(testFilePath, content);
+    modifyFile2(testFile, content);
   }
 
   /// Returns the offset of [search] in [file].

pkg/analysis_server/test/lsp/completion_yaml_test.dart

@@ -516,7 +516,7 @@ version: 1.0.0
 dependencies:
   one: ^2.3.4''';
 
-    newFile(pubspecFilePath, content);
+    var pubspecFile = newFile(pubspecFilePath, content);
     await initialize();
     await openFile(pubspecFileUri, code.code);
     await pumpEventQueue(times: 500);
@@ -525,7 +525,7 @@ dependencies:
     // cached data.
     processRunner.startHandler =
         (executable, args, {dir, env}) => MockProcess(1, 0, updatedJson, '');
-    modifyFile(pubspecFilePath, '$content# trailing comment');
+    modifyFile2(pubspecFile, '$content# trailing comment');
     await pumpEventQueue(times: 500);
 
     await verifyCompletions(

pkg/analysis_server/test/lsp/temporary_overlay_operation_test.dart

@@ -68,13 +68,13 @@ class TemporaryOverlayOperationTest extends AbstractLspAnalysisServerTest {
   }
 
   Future<void> test_pausesWatcherEvents() async {
-    newFile(mainFilePath, '// ORIGINAL');
+    var mainFile = newFile(mainFilePath, '// ORIGINAL');
     await initialize();
     await initialAnalysis;
 
     await _TestTemporaryOverlayOperation(server, () async {
       // Modify the file to trigger watcher events
-      modifyFile(mainFilePath, '// CHANGED');
+      modifyFile2(mainFile, '// CHANGED');
 
       // Ensure we still have the original content.
       await pumpEventQueue(times: 5000);

pkg/analyzer/test/src/workspace/blaze_watcher_test.dart

@@ -5,6 +5,7 @@
 import 'dart:async';
 import 'dart:isolate';
 
+import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/src/util/file_paths.dart' as file_paths;
 import 'package:analyzer/src/workspace/blaze.dart';
 import 'package:analyzer/src/workspace/blaze_watcher.dart';
@@ -25,22 +26,22 @@ class BlazeWatcherTest with ResourceProviderMixin {
   late final BlazeWorkspace workspace;
 
   void test_blazeFileWatcher() {
-    _addResources(['/workspace/${file_paths.blazeWorkspaceMarker}']);
+    _addResource('/workspace/${file_paths.blazeWorkspaceMarker}');
     var candidates = [
       convertPath('/workspace/blaze-bin/my/module/test1.dart'),
       convertPath('/workspace/blaze-genfiles/my/module/test1.dart'),
     ];
     var watcher = BlazeFilePoller(resourceProvider, candidates);
 
     // First do some tests with the first candidate path.
-    _addResources([candidates[0]]);
+    var firstCandidate = _addResource(candidates[0]) as File;
 
     var event = watcher.poll()!;
 
     expect(event.type, ChangeType.ADD);
     expect(event.path, candidates[0]);
 
-    modifyFile(candidates[0], 'const foo = 42;');
+    modifyFile2(firstCandidate, 'const foo = 42;');
 
     event = watcher.poll()!;
 
@@ -56,7 +57,7 @@ class BlazeWatcherTest with ResourceProviderMixin {
 
     // Now check that if we add the *second* candidate, we'll get the
     // notification for it.
-    _addResources([candidates[1]]);
+    _addResource(candidates[1]);
 
     event = watcher.poll()!;
 
@@ -68,7 +69,7 @@ class BlazeWatcherTest with ResourceProviderMixin {
   }
 
   void test_blazeFileWatcherIsolate() async {
-    _addResources(['/workspace/${file_paths.blazeWorkspaceMarker}']);
+    _addResource('/workspace/${file_paths.blazeWorkspaceMarker}');
     var candidates1 = [
       convertPath('/workspace/blaze-bin/my/module/test1.dart'),
       convertPath('/workspace/blaze-genfiles/my/module/test1.dart'),
@@ -113,7 +114,7 @@ class BlazeWatcherTest with ResourceProviderMixin {
     );
 
     // First do some tests with the first candidate path.
-    _addResources([candidates1[0]]);
+    _addResource(candidates1[0]);
 
     trigger.controller.add('');
     var events = (await queue.next as BlazeWatcherEvents).events;
@@ -123,7 +124,7 @@ class BlazeWatcherTest with ResourceProviderMixin {
     expect(events[0].type, ChangeType.ADD);
 
     // Now let's take a look at the second file.
-    _addResources([candidates2[1]]);
+    _addResource(candidates2[1]);
 
     trigger.controller.add('');
     events = (await queue.next as BlazeWatcherEvents).events;
@@ -162,10 +163,8 @@ class BlazeWatcherTest with ResourceProviderMixin {
   }
 
   void test_blazeFileWatcherIsolate_multipleWorkspaces() async {
-    _addResources([
-      '/workspace1/${file_paths.blazeWorkspaceMarker}',
-      '/workspace2/${file_paths.blazeWorkspaceMarker}',
-    ]);
+    _addResource('/workspace1/${file_paths.blazeWorkspaceMarker}');
+    _addResource('/workspace2/${file_paths.blazeWorkspaceMarker}');
     var candidates1 = [
       convertPath('/workspace1/blaze-bin/my/module/test1.dart'),
       convertPath('/workspace1/blaze-genfiles/my/module/test1.dart'),
@@ -223,7 +222,7 @@ class BlazeWatcherTest with ResourceProviderMixin {
     );
 
     // First do some tests with the first candidate path.
-    _addResources([candidates1[0]]);
+    _addResource(candidates1[0]);
 
     trigger1!.controller.add('');
     var events = (await queue.next as BlazeWatcherEvents).events;
@@ -233,7 +232,7 @@ class BlazeWatcherTest with ResourceProviderMixin {
     expect(events[0].type, ChangeType.ADD);
 
     // Now let's take a look at the second file.
-    _addResources([candidates2[1]]);
+    _addResource(candidates2[1]);
 
     trigger2!.controller.add('');
     events = (await queue.next as BlazeWatcherEvents).events;
@@ -272,11 +271,11 @@ class BlazeWatcherTest with ResourceProviderMixin {
   }
 
   void test_blazeFileWatcherWithFolder() {
-    _addResources(['/workspace/${file_paths.blazeWorkspaceMarker}']);
+    _addResource('/workspace/${file_paths.blazeWorkspaceMarker}');
 
     // The `_addResources`/`_deleteResources` functions recognize a folder by a
     // trailing `/`, but everywhere else we need to use normalized paths.
-    void addFolder(path) => _addResources(['$path/']);
+    void addFolder(path) => _addResource('$path/');
     void deleteFolder(path) => _deleteResources(['$path/']);
 
     var candidates = [
@@ -310,14 +309,12 @@ class BlazeWatcherTest with ResourceProviderMixin {
     expect(watcher.poll(), isNull);
   }
 
-  /// Create new files and directories from [paths].
-  void _addResources(List<String> paths) {
-    for (String path in paths) {
-      if (path.endsWith('/')) {
-        newFolder(path.substring(0, path.length - 1));
-      } else {
-        newFile(path, '');
-      }
+  /// Creates a new file or directory from [resourcePath].
+  Resource _addResource(String resourcePath) {
+    if (resourcePath.endsWith('/')) {
+      return newFolder(resourcePath.substring(0, resourcePath.length - 1));
+    } else {
+      return newFile(resourcePath, '');
     }
   }
 

pkg/analyzer_testing/api.txt

@@ -35,7 +35,6 @@ package:analyzer_testing/resource_provider_mixin.dart:
     getFile (method: File Function(String))
     getFolder (method: Folder Function(String))
     join (method: String Function(String, [String?, String?, String?, String?, String?, String?, String?]))
-    modifyFile (method: void Function(String, String))
     modifyFile2 (method: void Function(File, String))
     newAnalysisOptionsYamlFile (method: File Function(String, String))
     newBazelBuildFile (method: File Function(String, String))

pkg/analyzer_testing/lib/resource_provider_mixin.dart

@@ -83,15 +83,10 @@ mixin ResourceProviderMixin {
     part8,
   );
 
-  /// Writes [content] to the file at [path].
-  void modifyFile(String path, String content) {
-    String convertedPath = convertPath(path);
-    resourceProvider.getFile(convertedPath).writeAsStringSync(content);
-  }
-
   /// Writes [content] to [file].
   void modifyFile2(File file, String content) {
-    modifyFile(file.path, content);
+    String convertedPath = convertPath(file.path);
+    resourceProvider.getFile(convertedPath).writeAsStringSync(content);
   }
 
   /// Writes a new `analysis_options.yaml` file at [directoryPath] with