[analysis_server] Normalize test sources in base class

This adds code to normalize file contents in `PubPackageAnalysisServerTest.newFile()` so all tests using this base class normalize their source newlines by default (this ensures we run with \r\n on Windows, regardless of the git settings always using \n in this repo).

A flag `useLineEndingsForPlatform` allows option out of this, and any tests that currently fail in this mode set this in their setUp - with the exception of a few that were just trivial fixes.

This will make it easier to fix the remaining tests (by looking at code that does `useLineEndingsForPlatform = false`, deleting it, then fixing those tests).

See #60234

Change-Id: If05bc5f7fe3007151c1290831157b6a62d6bf651
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/449880
Commit-Queue: Brian Wilkerson <[email protected]>
Reviewed-by: Samuel Rawlins <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>

Author: DanTup

pkg/analysis_server/test/analysis/notification_closing_labels_test.dart

@@ -7,6 +7,7 @@ import 'dart:async';
 import 'package:analysis_server/protocol/protocol.dart';
 import 'package:analysis_server/protocol/protocol_constants.dart';
 import 'package:analysis_server/protocol/protocol_generated.dart';
+import 'package:analyzer/src/test_utilities/test_code_format.dart';
 import 'package:test/test.dart';
 import 'package:test_reflective_loader/test_reflective_loader.dart';
 
@@ -21,21 +22,21 @@ void main() {
 @reflectiveTest
 class AnalysisNotificationClosingLabelsTest
     extends PubPackageAnalysisServerTest {
-  static const sampleCode = '''
+  late final expectedResults = [
+    _label(sampleCode.ranges[0], 'Row'),
+    _label(sampleCode.ranges[1], '<Widget>[]'),
+  ];
+
+  final sampleCode = TestCode.parseNormalized('''
 Widget build(BuildContext context) {
-  return new Row(
-    children: <Widget>[
+  return /*[0*/new Row(
+    children: /*[1*/<Widget>[
       Text('a'),
       Text('b'),
-    ],
-  );
+    ]/*1]*/,
+  )/*0]*/;
 }
-''';
-
-  static final expectedResults = [
-    ClosingLabel(46, 77, 'Row'),
-    ClosingLabel(69, 49, '<Widget>[]'),
-  ];
+''');
 
   List<ClosingLabel>? lastLabels;
 
@@ -72,7 +73,7 @@ Widget build(BuildContext context) {
   }
 
   Future<void> test_afterAnalysis() async {
-    addTestFile(sampleCode);
+    addTestFile(sampleCode.code);
     await waitForTasksFinished();
     expect(lastLabels, isNull);
 
@@ -95,7 +96,7 @@ Widget build(BuildContext context) {
     expect(lastLabels, hasLength(0));
 
     // With sample code there will be labels.
-    await waitForLabels(() async => modifyTestFile(sampleCode));
+    await waitForLabels(() async => modifyTestFile(sampleCode.code));
 
     expect(lastLabels, expectedResults);
   }
@@ -105,4 +106,12 @@ Widget build(BuildContext context) {
     await action();
     return _labelsReceived.future;
   }
+
+  ClosingLabel _label(TestCodeRange range, String text) {
+    return ClosingLabel(
+      range.sourceRange.offset,
+      range.sourceRange.length,
+      text,
+    );
+  }
 }

pkg/analysis_server/test/analysis/notification_folding_test.dart

@@ -6,6 +6,7 @@ import 'dart:async';
 
 import 'package:analysis_server/protocol/protocol_constants.dart';
 import 'package:analysis_server/src/protocol_server.dart';
+import 'package:analyzer/src/test_utilities/test_code_format.dart';
 import 'package:test/test.dart';
 import 'package:test_reflective_loader/test_reflective_loader.dart';
 
@@ -19,17 +20,21 @@ void main() {
 
 @reflectiveTest
 class AnalysisNotificationFoldingTest extends PubPackageAnalysisServerTest {
-  static const sampleCode = '''
-import 'dart:async';
-import 'dart:core';
+  final sampleCode = TestCode.parseNormalized('''
+import[! 'dart:async';
+import 'dart:core';!]
 
 main async() {}
-''';
+''');
 
-  static final expectedResults = [
+  late final expectedResults = [
     // We don't include the first "import" in the region because
     // we want that to remain visible (not collapse).
-    FoldingRegion(FoldingKind.DIRECTIVES, 6, 34),
+    FoldingRegion(
+      FoldingKind.DIRECTIVES,
+      sampleCode.range.sourceRange.offset,
+      sampleCode.range.sourceRange.length,
+    ),
   ];
 
   List<FoldingRegion>? lastRegions;
@@ -67,7 +72,7 @@ main async() {}
   }
 
   Future<void> test_afterAnalysis() async {
-    addTestFile(sampleCode);
+    addTestFile(sampleCode.code);
     await waitForTasksFinished();
     expect(lastRegions, isNull);
 
@@ -90,7 +95,7 @@ main async() {}
     expect(lastRegions, hasLength(0));
 
     // With sample code there will be folding regions.
-    await waitForFolding(() async => modifyTestFile(sampleCode));
+    await waitForFolding(() async => modifyTestFile(sampleCode.code));
 
     expect(lastRegions, expectedResults);
   }

pkg/analysis_server/test/analysis/notification_highlights2_test.dart

@@ -2768,6 +2768,8 @@ class HighlightsTestSupport extends PubPackageAnalysisServerTest {
 
   @override
   Future<void> setUp() async {
+    useLineEndingsForPlatform = false;
+
     super.setUp();
     await setRoots(included: [workspaceRootPath], excluded: []);
   }

pkg/analysis_server/test/analysis/notification_navigation_test.dart

@@ -455,7 +455,7 @@ augment class A {
      bar();
    }
 
-  void bar(){}
+  void [!bar!](){}
 }
 ''');
     newFile(augmentFilePath, '''
@@ -470,7 +470,11 @@ void f() {
 
     await prepareNavigation();
     assertHasRegion('bar');
-    assertHasFileTarget(convertPath(testFilePath), 76, 3);
+    assertHasFileTarget(
+      convertPath(testFilePath),
+      parsedSourceRange.offset,
+      parsedSourceRange.length,
+    );
   }
 
   @SkippedTest() // TODO(scheglov): implement augmentation

pkg/analysis_server/test/analysis/notification_occurrences_test.dart

@@ -32,7 +32,7 @@ class AnalysisNotificationOccurrencesTest extends PubPackageAnalysisServerTest {
     required ElementKind? kind,
     String? elementName,
   }) async {
-    var code = TestCode.parse(content);
+    var code = TestCode.parseNormalized(content);
     addTestFile(code.code);
 
     await prepareOccurrences();

pkg/analysis_server/test/analysis_server_base.dart

@@ -17,6 +17,7 @@ import 'package:analyzer/source/source_range.dart';
 import 'package:analyzer/src/dart/analysis/byte_store.dart';
 import 'package:analyzer/src/generated/sdk.dart';
 import 'package:analyzer/src/test_utilities/mock_sdk.dart';
+import 'package:analyzer/src/test_utilities/platform.dart';
 import 'package:analyzer/src/test_utilities/test_code_format.dart';
 import 'package:analyzer/src/util/file_paths.dart' as file_paths;
 import 'package:analyzer_testing/experiments/experiments.dart';
@@ -218,6 +219,9 @@ class PubPackageAnalysisServerTest extends ContextResolutionTest
 
   final String testPackageName = 'test';
 
+  /// Whether to automatically normalize line endings for the current platform.
+  bool useLineEndingsForPlatform = true;
+
   /// Return a list of the experiments that are to be enabled for tests in this
   /// class, an empty list if there are no experiments that should be enabled.
   List<String> get experiments => experimentsForTests;
@@ -226,6 +230,8 @@ class PubPackageAnalysisServerTest extends ContextResolutionTest
   @override
   String get packagesRootPath => resourceProvider.convertPath('/packages');
 
+  List<TestCodePosition> get parsedPositions => parsedTestCode.positions;
+
   TestCodeRange get parsedRange => parsedTestCode.range;
 
   List<TestCodeRange> get parsedRanges => parsedTestCode.ranges;
@@ -269,7 +275,9 @@ class PubPackageAnalysisServerTest extends ContextResolutionTest
 
   // TODO(scheglov): rename
   void addTestFile(String content) {
-    parsedTestCode = TestCode.parse(content);
+    parsedTestCode = useLineEndingsForPlatform
+        ? TestCode.parseNormalized(content)
+        : TestCode.parse(content);
     newFile(testFilePath, parsedTestCode.code);
   }
 
@@ -310,6 +318,14 @@ class PubPackageAnalysisServerTest extends ContextResolutionTest
     modifyFile2(testFile, content);
   }
 
+  @override
+  File newFile(String path, String content) {
+    if (useLineEndingsForPlatform) {
+      content = normalizeNewlinesForPlatform(content);
+    }
+    return super.newFile(path, content);
+  }
+
   /// Returns the offset of [search] in [file].
   /// Fails if not found.
   int offsetInFile(File file, String search) {

pkg/analysis_server/test/client/completion_driver_test.dart

@@ -191,6 +191,8 @@ To accept the current state change the expectation to
 
   @override
   Future<void> setUp() async {
+    useLineEndingsForPlatform = false;
+
     super.setUp();
 
     writeTestPackagePubspecYamlFile(r'''

pkg/analysis_server/test/domain_completion_test.dart

@@ -6,6 +6,7 @@ import 'dart:async';
 
 import 'package:analysis_server/src/protocol_server.dart';
 import 'package:analyzer/file_system/file_system.dart';
+import 'package:analyzer/src/test_utilities/platform.dart';
 import 'package:analyzer/src/test_utilities/test_code_format.dart';
 import 'package:analyzer/utilities/package_config_file_builder.dart';
 import 'package:test/test.dart';
@@ -27,6 +28,9 @@ void main() {
 @reflectiveTest
 class CompletionDomainHandlerGetSuggestionDetails2Test
     extends PubPackageAnalysisServerTest {
+  String get testEolEscaped =>
+      testEol.replaceAll('\r', r'\r').replaceAll('\n', r'\n');
+
   void assertDetailsText(
     CompletionGetSuggestionDetails2Result result,
     String expected, {
@@ -83,13 +87,13 @@ void f() {
       libraryUri: 'dart:math',
     );
 
-    assertDetailsText(details, r'''
+    assertDetailsText(details, '''
 completion: Random
   change
     testFile
       offset: 0
       length: 0
-      replacement: import 'dart:math';\n\n
+      replacement: import 'dart:math';$testEolEscaped$testEolEscaped
 ''');
   }
 
@@ -122,13 +126,13 @@ void f() {
       libraryUri: 'package:aaa/a.dart',
     );
 
-    assertDetailsText(details, r'''
+    assertDetailsText(details, '''
 completion: Test
   change
     testFile
       offset: 0
       length: 0
-      replacement: import 'package:aaa/a.dart';\n\n
+      replacement: import 'package:aaa/a.dart';$testEolEscaped$testEolEscaped
 ''');
   }
 
@@ -149,13 +153,13 @@ void f() {
       libraryUri: 'package:test/a.dart',
     );
 
-    assertDetailsText(details, r'''
+    assertDetailsText(details, '''
 completion: Test
   change
     testFile
       offset: 0
       length: 0
-      replacement: import 'package:test/a.dart';\n\n
+      replacement: import 'package:test/a.dart';$testEolEscaped$testEolEscaped
 ''');
   }
 
@@ -2168,7 +2172,7 @@ suggestions
     required String content,
     int maxResults = 1 << 10,
   }) async {
-    var code = TestCode.parse(content);
+    var code = TestCode.parseNormalized(content);
     var completionOffset = code.position.offset;
 
     newFile(path, code.code);
@@ -2306,7 +2310,9 @@ class _SuggestionDetailsPrinter {
     _writelnWithIndent('offset: ${edit.offset}');
     _writelnWithIndent('length: ${edit.length}');
 
-    var replacementStr = edit.replacement.replaceAll('\n', r'\n');
+    var replacementStr = edit.replacement
+        .replaceAll('\n', r'\n')
+        .replaceAll('\r', r'\r');
     _writelnWithIndent('replacement: $replacementStr');
   }
 

pkg/analysis_server/test/domain_completion_util.dart

@@ -129,6 +129,8 @@ class AbstractCompletionDomainTest extends PubPackageAnalysisServerTest {
 
   @override
   Future<void> setUp() async {
+    useLineEndingsForPlatform = false;
+
     super.setUp();
     await setRoots(included: [workspaceRootPath], excluded: []);
   }

pkg/analysis_server/test/edit/assists_test.dart

@@ -6,6 +6,7 @@ import 'package:analysis_server/protocol/protocol_generated.dart';
 import 'package:analysis_server/src/plugin/plugin_isolate.dart';
 import 'package:analysis_server/src/services/correction/assist_internal.dart';
 import 'package:analyzer/instrumentation/service.dart';
+import 'package:analyzer/src/test_utilities/platform.dart';
 import 'package:analyzer_plugin/protocol/protocol_common.dart';
 import 'package:analyzer_plugin/protocol/protocol_generated.dart' as plugin;
 import 'package:test/test.dart';
@@ -169,7 +170,7 @@ void f() {
           testFileContent,
           change.edits[0].edits,
         );
-        expect(resultCode, expectedCode);
+        expect(resultCode, normalizeNewlinesForPlatform(expectedCode));
         return;
       }
     }