Add fixed source to assertMacroExpansion

Author: kimdv

Sources/SwiftSyntaxMacrosTestSupport/Assertions.swift

@@ -254,16 +254,24 @@ func assertDiagnostic(
 ///   - macros: The macros that should be expanded, provided as a dictionary
 ///     mapping macro names (e.g., `"stringify"`) to implementation types
 ///     (e.g., `StringifyMacro.self`).
+///   - applyFixIts: Applies only the fix-its with these messages.
+///     Ohterwise all Fix-Its from diagnostics will be applied.
+///   - fixedSource: Asserts that the source after applying fix-its matches
 ///   - testModuleName: The name of the test module to use.
 ///   - testFileName: The name of the test file name to use.
+///   - indentationWidth: The indentation width used in the expansion.
+///   - options: Options for asserting fixed source.
 public func assertMacroExpansion(
   _ originalSource: String,
   expandedSource expectedExpandedSource: String,
   diagnostics: [DiagnosticSpec] = [],
   macros: [String: Macro.Type],
+  applyFixIts: [String]? = nil,
+  fixedSource expectedFixedSource: String? = nil,
   testModuleName: String = "TestModule",
   testFileName: String = "test.swift",
   indentationWidth: Trivia = .spaces(4),
+  options: AssertParseOptions = [],
   file: StaticString = #file,
   line: UInt = #line
 ) {
@@ -316,4 +324,22 @@ public func assertMacroExpansion(
       assertDiagnostic(actualDiag, in: context, expected: expectedDiag)
     }
   }
+
+  // Applying Fix-Its
+  if let expectedFixedSource = expectedFixedSource {
+    let fixedTree = FixItApplier.applyFixes(in: diags, withMessages: applyFixIts, to: expandedSourceFile)
+    var fixedTreeDescription = fixedTree.description
+    if options.contains(.normalizeNewlinesInFixedSource) {
+      fixedTreeDescription =
+        fixedTreeDescription
+        .replacingOccurrences(of: "\r\n", with: "\n")
+        .replacingOccurrences(of: "\r", with: "\n")
+    }
+    assertStringsEqualWithDiff(
+      fixedTreeDescription.trimmingTrailingWhitespace(),
+      expectedFixedSource.trimmingTrailingWhitespace(),
+      file: file,
+      line: line
+    )
+  }
 }

Sources/_SwiftSyntaxTestSupport/AssertParseOptions.swift

@@ -0,0 +1,27 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2023 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+public struct AssertParseOptions: OptionSet {
+  public var rawValue: UInt8
+
+  public init(rawValue: UInt8) {
+    self.rawValue = rawValue
+  }
+
+  /// Trivia mismatches in the substructure should cause failures
+  public static let substructureCheckTrivia = AssertParseOptions(rawValue: 1 << 0)
+
+  /// Replace all `\r` and `\r\n` in the fixed source by `\n`.
+  /// Useful to match source code that contains other line endings to expected
+  /// fixed source that has `\n` line endings.
+  public static let normalizeNewlinesInFixedSource = AssertParseOptions(rawValue: 1 << 1)
+}

Sources/_SwiftSyntaxTestSupport/FixItApplier.swift

@@ -0,0 +1,66 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2023 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import SwiftSyntax
+import SwiftDiagnostics
+
+public class FixItApplier: SyntaxRewriter {
+  var changes: [FixIt.Change]
+
+  init(diagnostics: [Diagnostic], withMessages messages: [String]?) {
+    let messages = messages ?? diagnostics.compactMap { $0.fixIts.first?.message.message }
+
+    self.changes =
+      diagnostics
+      .flatMap { $0.fixIts }
+      .filter {
+        return messages.contains($0.message.message)
+      }
+      .flatMap { $0.changes }
+
+    super.init(viewMode: .all)
+  }
+
+  public override func visitAny(_ node: Syntax) -> Syntax? {
+    for change in changes {
+      switch change {
+      case .replace(oldNode: let oldNode, newNode: let newNode) where oldNode.id == node.id:
+        return newNode
+      default:
+        break
+      }
+    }
+    return nil
+  }
+
+  public override func visit(_ node: TokenSyntax) -> TokenSyntax {
+    var modifiedNode = node
+    for change in changes {
+      switch change {
+      case .replaceLeadingTrivia(token: let changedNode, newTrivia: let newTrivia) where changedNode.id == node.id:
+        modifiedNode = node.with(\.leadingTrivia, newTrivia)
+      case .replaceTrailingTrivia(token: let changedNode, newTrivia: let newTrivia) where changedNode.id == node.id:
+        modifiedNode = node.with(\.trailingTrivia, newTrivia)
+      default:
+        break
+      }
+    }
+    return modifiedNode
+  }
+
+  /// If `messages` is `nil`, applies all Fix-Its in `diagnostics` to `tree` and returns the fixed syntax tree.
+  /// If `messages` is not `nil`, applies only Fix-Its whose message is in `messages`.
+  public static func applyFixes<T: SyntaxProtocol>(in diagnostics: [Diagnostic], withMessages messages: [String]?, to tree: T) -> Syntax {
+    let applier = FixItApplier(diagnostics: diagnostics, withMessages: messages)
+    return applier.rewrite(tree)
+  }
+}

Tests/SwiftParserTest/Assertions.swift

@@ -276,58 +276,6 @@ struct DiagnosticSpec {
   }
 }
 
-class FixItApplier: SyntaxRewriter {
-  var changes: [FixIt.Change]
-
-  init(diagnostics: [Diagnostic], withMessages messages: [String]?) {
-    let messages = messages ?? diagnostics.compactMap { $0.fixIts.first?.message.message }
-
-    self.changes =
-      diagnostics
-      .flatMap { $0.fixIts }
-      .filter {
-        return messages.contains($0.message.message)
-      }
-      .flatMap { $0.changes }
-
-    super.init(viewMode: .all)
-  }
-
-  public override func visitAny(_ node: Syntax) -> Syntax? {
-    for change in changes {
-      switch change {
-      case .replace(oldNode: let oldNode, newNode: let newNode) where oldNode.id == node.id:
-        return newNode
-      default:
-        break
-      }
-    }
-    return nil
-  }
-
-  override func visit(_ node: TokenSyntax) -> TokenSyntax {
-    var modifiedNode = node
-    for change in changes {
-      switch change {
-      case .replaceLeadingTrivia(token: let changedNode, newTrivia: let newTrivia) where changedNode.id == node.id:
-        modifiedNode = node.with(\.leadingTrivia, newTrivia)
-      case .replaceTrailingTrivia(token: let changedNode, newTrivia: let newTrivia) where changedNode.id == node.id:
-        modifiedNode = node.with(\.trailingTrivia, newTrivia)
-      default:
-        break
-      }
-    }
-    return modifiedNode
-  }
-
-  /// If `messages` is `nil`, applies all Fix-Its in `diagnostics` to `tree` and returns the fixed syntax tree.
-  /// If `messages` is not `nil`, applies only Fix-Its whose message is in `messages`.
-  public static func applyFixes<T: SyntaxProtocol>(in diagnostics: [Diagnostic], withMessages messages: [String]?, to tree: T) -> Syntax {
-    let applier = FixItApplier(diagnostics: diagnostics, withMessages: messages)
-    return applier.rewrite(tree)
-  }
-}
-
 /// Assert that `location` is the same as that of `locationMarker` in `tree`.
 func assertLocation<T: SyntaxProtocol>(
   _ location: SourceLocation,
@@ -511,22 +459,6 @@ class TokenPresenceFlipper: SyntaxRewriter {
   }
 }
 
-public struct AssertParseOptions: OptionSet {
-  public var rawValue: UInt8
-
-  public init(rawValue: UInt8) {
-    self.rawValue = rawValue
-  }
-
-  /// Trivia mismatches in the substructure should cause failures
-  public static let substructureCheckTrivia = AssertParseOptions(rawValue: 1 << 0)
-
-  /// Replace all `\r` and `\r\n` in the fixed source by `\n`.
-  /// Useful to match source code that contains other line endings to expected
-  /// fixed source that has `\n` line endings.
-  public static let normalizeNewlinesInFixedSource = AssertParseOptions(rawValue: 1 << 1)
-}
-
 /// Same as `assertParse` overload with a `(String) -> S` `parse`,
 /// parsing the resulting `String` as a ``SourceFileSyntax``.
 func assertParse(