[DAS] Starts refactoring tests migration to TestCode markers

Continuing the work to normalize all our tests to use the TestCode markers.

Bug: #60234
Change-Id: I687bc35409b1e37938c60206d07155fcc7ac2ac9
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/433800
Reviewed-by: Brian Wilkerson <[email protected]>
Auto-Submit: Felipe Morschel <[email protected]>
Commit-Queue: Brian Wilkerson <[email protected]>
Reviewed-by: Samuel Rawlins <[email protected]>

Author: FMorschel

pkg/analysis_server/test/selection_mixin.dart

@@ -0,0 +1,40 @@
+// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'abstract_single_unit.dart';
+
+mixin SelectionMixin on AbstractSingleUnitTest {
+  late int offset;
+  late int length;
+
+  void setPosition(int index) {
+    if (index < 0 || index >= parsedTestCode.positions.length) {
+      throw ArgumentError('Index out of bounds for positions.');
+    }
+    offset = parsedTestCode.positions[index].offset;
+    length = 0;
+  }
+
+  void setPositionOrRange(int index) {
+    if (index < 0) {
+      throw ArgumentError('Index must be non-negative.');
+    }
+    if (parsedTestCode.positions.isNotEmpty) {
+      setPosition(index);
+    } else if (parsedTestCode.ranges.isNotEmpty) {
+      setRange(index);
+    } else {
+      throw ArgumentError('Test code must contain a position or range marker.');
+    }
+  }
+
+  void setRange(int index) {
+    if (index < 0 || index >= parsedTestCode.ranges.length) {
+      throw ArgumentError('Index out of bounds for ranges.');
+    }
+    var range = parsedTestCode.ranges[index].sourceRange;
+    offset = range.offset;
+    length = range.length;
+  }
+}

pkg/analysis_server/test/services/refactoring/legacy/abstract_refactoring.dart

@@ -12,6 +12,7 @@ import 'package:analyzer_plugin/protocol/protocol_common.dart'
 import 'package:test/test.dart';
 
 import '../../../abstract_single_unit.dart';
+import '../../../selection_mixin.dart';
 
 int findIdentifierLength(String search) {
   var length = 0;
@@ -28,7 +29,8 @@ int findIdentifierLength(String search) {
 }
 
 /// The base class for all [Refactoring] tests.
-abstract class RefactoringTest extends AbstractSingleUnitTest {
+abstract class RefactoringTest extends AbstractSingleUnitTest
+    with SelectionMixin {
   late RefactoringWorkspace refactoringWorkspace;
   late SearchEngine searchEngine;
 
@@ -80,6 +82,7 @@ abstract class RefactoringTest extends AbstractSingleUnitTest {
     String? expectedMessage,
     SourceRange? expectedContextRange,
     String? expectedContextSearch,
+    int? rangeIndex,
   }) {
     expect(status.severity, expectedSeverity, reason: status.toString());
     if (expectedSeverity != null) {
@@ -99,6 +102,11 @@ abstract class RefactoringTest extends AbstractSingleUnitTest {
         var expectedLength = findIdentifierLength(expectedContextSearch);
         expect(location.offset, expectedOffset);
         expect(location.length, expectedLength);
+      } else if (rangeIndex != null) {
+        var location = problem.location!;
+        setRange(rangeIndex);
+        expect(location.offset, offset);
+        expect(location.length, length);
       }
     }
   }

pkg/analysis_server/test/services/refactoring/legacy/abstract_rename.dart

@@ -4,11 +4,13 @@
 
 import 'package:analysis_server/src/services/correction/namespace.dart';
 import 'package:analysis_server/src/services/refactoring/legacy/refactoring.dart';
+import 'package:analysis_server_plugin/src/utilities/selection.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/src/dart/ast/element_locator.dart';
 import 'package:analyzer/src/utilities/extensions/element.dart';
 import 'package:analyzer_plugin/protocol/protocol_common.dart' hide Element;
+import 'package:collection/collection.dart';
 import 'package:test/test.dart';
 
 import 'abstract_refactoring.dart';
@@ -20,11 +22,30 @@ class RenameRefactoringTest extends RefactoringTest {
 
   /// Asserts that [refactoring] has potential edits in [testFile] at offset
   /// of the given [searches].
-  void assertPotentialEdits(List<String> searches) {
+  ///
+  /// If [searches] is `null`, it will use the positions/ranges marked in
+  /// [parsedTestCode] to determine the offsets.
+  void assertPotentialEdits({List<String>? searches, List<int>? indexes}) {
     var expectedOffsets = <int>{};
-    for (var search in searches) {
-      var offset = findOffset(search);
-      expectedOffsets.add(offset);
+    if (searches != null) {
+      for (var search in searches) {
+        var offset = findOffset(search);
+        expectedOffsets.add(offset);
+      }
+    } else if (parsedTestCode.positions.isNotEmpty) {
+      for (var position in parsedTestCode.positions.whereIndexed(
+        (index, _) => indexes?.contains(index) ?? true,
+      )) {
+        expectedOffsets.add(position.offset);
+      }
+    } else if (parsedTestCode.ranges.isNotEmpty) {
+      for (var range in parsedTestCode.ranges.whereIndexed(
+        (index, _) => indexes?.contains(index) ?? true,
+      )) {
+        expectedOffsets.add(range.sourceRange.offset);
+      }
+    } else {
+      fail('No searches or positions provided for potential edits.');
     }
     // remove offset marked as potential
     for (var potentialId in refactoring.potentialEditIds) {
@@ -36,24 +57,35 @@ class RenameRefactoringTest extends RefactoringTest {
     expect(expectedOffsets, isEmpty);
   }
 
+  /// Creates a refactoring and sets the offset and length from the
+  /// [parsedTestCode] position/range at the given [index].
+  void createRenameRefactoring([int index = 0]) {
+    setPositionOrRange(index);
+    var unit = testAnalysisResult.unit;
+    var node = unit.select(length: length, offset: offset)?.coveringNode;
+    if (node == null) {
+      fail('No node found at offset $offset with length $length.');
+    }
+    createRenameRefactoringForNode(node);
+  }
+
   /// Creates a new [RenameRefactoring] in [refactoring] for the element of
   /// the [SimpleIdentifier] at the given [search] pattern.
   void createRenameRefactoringAtString(String search) {
     var node = findNode.any(search);
 
-    Element? element;
-    switch (node) {
-      case ImportDirective():
-        element = MockLibraryImportElement(node.libraryImport!);
-      default:
-        element = ElementLocator.locate(node);
+    if (node is ImportDirective) {
+      return createRenameRefactoringForElement2(
+        MockLibraryImportElement(node.libraryImport!),
+      );
     }
-
-    if (node is SimpleIdentifier && element is PrefixElement) {
-      element = MockLibraryImportElement(getImportElement(node)!);
+    var element = ElementLocator.locate(node);
+    if (node is! SimpleIdentifier || element is! PrefixElement) {
+      return createRenameRefactoringForElement2(element);
     }
-
-    createRenameRefactoringForElement2(element);
+    createRenameRefactoringForElement2(
+      MockLibraryImportElement(getImportElement(node)!),
+    );
   }
 
   /// Creates a new [RenameRefactoring] in [refactoring] for [element].
@@ -71,7 +103,23 @@ class RenameRefactoringTest extends RefactoringTest {
     this.refactoring = refactoring;
   }
 
-  /// Returns the [Edit] with the given [id], maybe `null`.
+  void createRenameRefactoringForNode(AstNode node) {
+    Element? element;
+    switch (node) {
+      case ImportDirective():
+        element = MockLibraryImportElement(node.libraryImport!);
+      default:
+        element = ElementLocator.locate(node);
+    }
+
+    if (node is SimpleIdentifier && element is PrefixElement) {
+      element = MockLibraryImportElement(getImportElement(node)!);
+    }
+
+    createRenameRefactoringForElement2(element);
+  }
+
+  /// Returns the [SourceEdit] with the given [id], maybe `null`.
   SourceEdit findEditById(String id) {
     for (var fileEdit in refactoringChange.edits) {
       for (var edit in fileEdit.edits) {