Implement my suggested changes atop Tim's branch

Author: stmontgomery

Sources/SwiftSyntaxMacrosTestSupport/Assertions.swift

@@ -17,7 +17,7 @@ public import SwiftSyntaxMacroExpansion
 public import SwiftSyntaxMacros
 @_spi(XCTestFailureLocation) public import SwiftSyntaxMacrosGenericTestSupport
 private import XCTest
-#if canImport(Testing)
+#if compiler(>=6)
 private import Testing
 #endif
 #else
@@ -37,10 +37,6 @@ public typealias DiagnosticSpec = SwiftSyntaxMacrosGenericTestSupport.Diagnostic
 /// Assert that expanding the given macros in the original source produces
 /// the given expanded source code.
 ///
-/// - Warning: If you call this function inside a Swift Testing test case,
-/// the test will report no assertion failures even if the test fails.
-/// Use ``expectMacroExpansion(_:expandedSource:diagnostics:macroSpecs:applyFixIts:fixedSource:testModuleName:testFileName:indentationWidth:buildConfiguration:fileID:file:line:column:)`` instead.
-///
 /// - Parameters:
 ///   - originalSource: The original source code, which is expected to contain
 ///     macros in various places (e.g., `#stringify(x + y)`).
@@ -55,7 +51,7 @@ public typealias DiagnosticSpec = SwiftSyntaxMacrosGenericTestSupport.Diagnostic
 ///   - indentationWidth: The indentation width used in the expansion.
 ///   - buildConfiguration: a build configuration that will be made available
 ///     to the macro implementation
-/// - SeeAlso: ``assertMacroExpansion(_:expandedSource:diagnostics:macroSpecs:applyFixIts:fixedSource:testModuleName:testFileName:indentationWidth:buildConfiguration:file:line:)``
+/// - SeeAlso: ``assertMacroExpansion(_:expandedSource:diagnostics:macroSpecs:applyFixIts:fixedSource:testModuleName:testFileName:indentationWidth:buildConfiguration:fileID:file:line:column:)``
 ///   to also specify the list of conformances passed to the macro expansion.
 public func assertMacroExpansion(
   _ originalSource: String,
@@ -68,8 +64,10 @@ public func assertMacroExpansion(
   testFileName: String = "test.swift",
   indentationWidth: Trivia = .spaces(4),
   buildConfiguration: (any BuildConfiguration)? = nil,
+  fileID: StaticString = #fileID,
   file: StaticString = #filePath,
-  line: UInt = #line
+  line: UInt = #line,
+  column: UInt = #column
 ) {
   let specs = macros.mapValues { MacroSpec(type: $0) }
   assertMacroExpansion(
@@ -83,18 +81,16 @@ public func assertMacroExpansion(
     testFileName: testFileName,
     indentationWidth: indentationWidth,
     buildConfiguration: buildConfiguration,
+    fileID: fileID,
     file: file,
-    line: line
+    line: line,
+    column: column
   )
 }
 
 /// Assert that expanding the given macros in the original source produces
 /// the given expanded source code.
 ///
-/// - Warning: If you call this function inside a Swift Testing test case,
-/// the test will report no assertion failures even if the test fails.
-/// Use ``expectMacroExpansion(_:expandedSource:diagnostics:macroSpecs:applyFixIts:fixedSource:testModuleName:testFileName:indentationWidth:buildConfiguration:fileID:file:line:column:)`` instead.
-///
 /// - Parameters:
 ///   - originalSource: The original source code, which is expected to contain
 ///     macros in various places (e.g., `#stringify(x + y)`).
@@ -110,62 +106,9 @@ public func assertMacroExpansion(
 ///   - 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.
+///   - buildConfiguration: a build configuration that will be made available
+///     to the macro implementation
 public func assertMacroExpansion(
-  _ originalSource: String,
-  expandedSource expectedExpandedSource: String,
-  diagnostics: [DiagnosticSpec] = [],
-  macroSpecs: [String: MacroSpec],
-  applyFixIts: [String]? = nil,
-  fixedSource expectedFixedSource: String? = nil,
-  testModuleName: String = "TestModule",
-  testFileName: String = "test.swift",
-  indentationWidth: Trivia = .spaces(4),
-  buildConfiguration: (any BuildConfiguration)? = nil,
-  file: StaticString = #filePath,
-  line: UInt = #line
-) {
-  SwiftSyntaxMacrosGenericTestSupport.assertMacroExpansion(
-    originalSource,
-    expandedSource: expectedExpandedSource,
-    diagnostics: diagnostics,
-    macroSpecs: macroSpecs,
-    applyFixIts: applyFixIts,
-    fixedSource: expectedFixedSource,
-    testModuleName: testModuleName,
-    testFileName: testFileName,
-    indentationWidth: indentationWidth,
-    buildConfiguration: buildConfiguration,
-    failureHandler: {
-      XCTFail($0.message, file: $0.location.staticFilePath, line: $0.location.unsignedLine)
-    },
-    fileID: "",  // Not used in the failure handler
-    filePath: file,
-    line: line,
-    column: 0  // Not used in the failure handler
-  )
-}
-
-#if canImport(Testing)
-/// Expect that expanding the given macros in the original source produces
-/// the given expanded source code.
-/// This function is the Swift Testing equivalent of ``assertMacroExpansion(_:expandedSource:diagnostics:macroSpecs:applyFixIts:fixedSource:testModuleName:testFileName:indentationWidth:buildConfiguration:file:line:)``
-///
-/// - Parameters:
-///   - originalSource: The original source code, which is expected to contain
-///     macros in various places (e.g., `#stringify(x + y)`).
-///   - expectedExpandedSource: The source code that we expect to see after
-///     performing macro expansion on the original source.
-///   - diagnostics: The diagnostics when expanding any macro
-///   - macroSpecs: The macros that should be expanded, provided as a dictionary
-///     mapping macro names (e.g., `"CodableMacro"`) to specification with macro type
-///     (e.g., `CodableMacro.self`) and a list of conformances macro provides
-///     (e.g., `["Decodable", "Encodable"]`).
-///   - applyFixIts: If specified, filters the Fix-Its that are applied to generate `fixedSource` to only those whose message occurs in this array. If `nil`, all Fix-Its from the diagnostics are applied.
-///   - fixedSource: If specified, asserts that the source code after applying Fix-Its matches this string.
-///   - 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.
-public func expectMacroExpansion(
   _ originalSource: String,
   expandedSource expectedExpandedSource: String,
   diagnostics: [DiagnosticSpec] = [],
@@ -192,74 +135,34 @@ public func expectMacroExpansion(
     testFileName: testFileName,
     indentationWidth: indentationWidth,
     buildConfiguration: buildConfiguration,
-    failureHandler: {
+    failureHandler: { testFailure in
+      // Record a Swift Testing issue.
+      //
+      // (Note: If/when Swift Testing gains interoperability with XCTest, this
+      // will be translated into an XCTest failure if called while an XCTest is
+      // running.)
       Issue.record(
-        Comment(rawValue: $0.message),
+        Comment(rawValue: testFailure.message),
         sourceLocation: .init(
-          fileID: fileID.description,
-          filePath: file.description,
-          line: Int(line),
-          column: Int(column)
+          fileID: testFailure.location.fileID,
+          filePath: testFailure.location.filePath,
+          line: testFailure.location.line,
+          column: testFailure.location.column
         )
       )
-    },
-    fileID: "",  // Not used in the failure handler
-    filePath: file,
-    line: line,
-    column: 0  // Not used in the failure handler
-  )
-}
 
-/// Expect that expanding the given macros in the original source produces
-/// the given expanded source code.
-/// This function is the Swift Testing equivalent of ``assertMacroExpansion(_:expandedSource:diagnostics:macroSpecs:applyFixIts:fixedSource:testModuleName:testFileName:indentationWidth:buildConfiguration:file:line:)``
-///
-/// - Parameters:
-///   - originalSource: The original source code, which is expected to contain
-///     macros in various places (e.g., `#stringify(x + y)`).
-///   - expectedExpandedSource: The source code that we expect to see after
-///     performing macro expansion on the original source.
-///   - diagnostics: The diagnostics when expanding any macro
-///   - 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: If specified, filters the Fix-Its that are applied to generate `fixedSource` to only those whose message occurs in this array. If `nil`, all Fix-Its from the diagnostics are applied.
-///   - fixedSource: If specified, asserts that the source code after applying Fix-Its matches this string.
-///   - 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.
-public func expectMacroExpansion(
-  _ 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),
-  buildConfiguration: (any BuildConfiguration)? = nil,
-  fileID: StaticString = #fileID,
-  file: StaticString = #filePath,
-  line: UInt = #line,
-  column: UInt = #column
-) {
-  let specs = macros.mapValues { MacroSpec(type: $0) }
-  expectMacroExpansion(
-    originalSource,
-    expandedSource: expectedExpandedSource,
-    diagnostics: diagnostics,
-    macroSpecs: specs,
-    applyFixIts: applyFixIts,
-    fixedSource: expectedFixedSource,
-    testModuleName: testModuleName,
-    testFileName: testFileName,
-    indentationWidth: indentationWidth,
-    buildConfiguration: buildConfiguration,
+      // Record an XCTest failure.
+      //
+      // FIXME: If/when Swift Testing gains interoperability with XCTest, this
+      // will become redundant with the above -- at least, when this library is
+      // compiled and run using a Swift version which supports interoperability.
+      // At that point, this should be adjusted so that it's only called when
+      // using older Swift versions.
+      XCTFail(testFailure.message, file: testFailure.location.staticFilePath, line: testFailure.location.unsignedLine)
+    },
     fileID: fileID,
-    file: file,
+    filePath: file,
     line: line,
     column: column
   )
 }
-#endif

Tests/SwiftSyntaxMacroExpansionTest/SwiftTestingTests.swift

@@ -10,15 +10,15 @@
 //
 //===----------------------------------------------------------------------===//
 
-#if canImport(Testing)
+#if compiler(>=6)
 import Testing
 import SwiftSyntaxMacrosTestSupport
 
 @Suite("Swift Testing Macro Expansion Tests")
 struct SwiftTestingMacroExpansionTests {
   @Test("Test Happy Path")
   func testHappyPathWorks() {
-    expectMacroExpansion(
+    assertMacroExpansion(
       """
       @constantOne
       var x: Int /*1*/ // hello
@@ -38,7 +38,7 @@ struct SwiftTestingMacroExpansionTests {
   @Test("Test Failure")
   func failureReportedCorrectly() {
     withKnownIssue {
-      expectMacroExpansion(
+      assertMacroExpansion(
         """
         @constantOne
         var x: Int /*1*/ // hello
@@ -51,10 +51,25 @@ struct SwiftTestingMacroExpansionTests {
           }
           """,
         macros: ["constantOne": ConstantOneGetter.self],
-        indentationWidth: .spaces(4)
+        indentationWidth: .spaces(4),
+        fileID: "ExampleModule/ExampleTest.swift",
+        file: "path/to/ExampleTest.swift",
+        line: 9999,
+        column: 8888
       )
     } matching: { issue in
-      issue.description.contains("Macro expansion did not produce the expected expanded source")
+      guard issue.description.contains("Macro expansion did not produce the expected expanded source") else {
+        return false
+      }
+
+      #expect(issue.sourceLocation == .init(
+        fileID: "ExampleModule/ExampleTest.swift",
+        filePath: "path/to/ExampleTest.swift",
+        line: 9999,
+        column: 8888
+      ))
+
+      return true
     }
   }
 }