How do I test generated syntax against expected string in swift-syntax version 600?

DJBen · October 18, 2024, 9:09am

I have CLI that codegen using swift-syntax. In swift-syntax 509 version, one can import the internal testing helper library and do this - it ought to generated a pretty-printed diff, nicer to compare large amount of string. I am not using swift-syntax with Swift Macros, so I feel I am out of option in version 600?

github.com

swiftlang/swift-syntax/blob/4db7cb20e63f4dba0b030068687996723e352874/Tests/SwiftSyntaxBuilderTest/Assertions.swift#L19


      
          // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
          //
          //===----------------------------------------------------------------------===//
          
          import SwiftSyntax
          import SwiftSyntaxBuilder
          import _SwiftSyntaxTestSupport
          
          import XCTest
          
          func assertBuildResult<T: SyntaxProtocol>(
            _ buildable: T,
            _ expectedResult: String,
            trimTrailingWhitespace: Bool = true,
            file: StaticString = #file,
            line: UInt = #line
          ) {
            var buildableDescription = buildable.formatted().description
            var expectedResult = expectedResult
            if trimTrailingWhitespace {
              buildableDescription = buildableDescription.trimmingTrailingWhitespace()

ahoppen · October 18, 2024, 5:33pm

I am not sure what you refer to. assertBuildResult has never been public API.

Jon_Shier · October 18, 2024, 7:21pm

I recommend the fantastic swift-macro-testing library by PointFree.

DJBen · October 25, 2024, 6:49pm

@Jon_Shier @ahoppen

Thank you both! I am not working with Swift Macros but a CLI tools that codegens using SwiftSyntax. After investigation and thanks to the pointer to PointFree tools, I opt in to use GitHub - pointfreeco/swift-custom-dump: A collection of tools for debugging, diffing, and testing your application's data structures. expectNoDifference. Turns out all I need is diffing XCAssert.

Topic		Replies	Views
assertMacroExpansion doing string compare or syntax tree compare? Using Swift macros	7	1111	June 21, 2023
Announcing SwiftSyntaxBuilder Source Tooling swift-syntax	12	3515	May 30, 2024
Update on the new Swift Parser Source Tooling	7	3934	October 31, 2022
October Update on the new Swift Parser Source Tooling	3	2938	November 2, 2022
[Solved] assertMacroExpansion() reports my macro has invalid syntax but it works in Xcode Using Swift	5	773	July 10, 2023

How do I test generated syntax against expected string in swift-syntax version 600?

Related Topics