Add infrastructure to write tests for Swift macros #1367
Conversation
|
@swift-ci Please test |
ahoppen
force-pushed
the
macro-test-project
branch
from
d2c1488 to
d8ecc21
Compare
| var objectFiles: [String] = [] | ||
| for moduleName in swiftSyntaxModulesToLink { | ||
| let dir = buildDirectory.appendingPathComponent("\(moduleName).build") | ||
| let enumerator = FileManager.default.enumerator(at: dir, includingPropertiesForKeys: nil) | ||
| while let file = enumerator?.nextObject() as? URL { | ||
| if file.pathExtension == "o" { | ||
| objectFiles.append(file.path) | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Instead of a directory traversal, I suppose you could consult SourceKitLSPPackageTests.product/Objects.LinkFileList. Not sure if that's a significant improvement though.
There was a problem hiding this comment.
That would also link in all sorts of other object files that we don’t need, so I don’t really prefer it. Also it has been causing some undefined symbol issues for me (_del_curterm) that I didn’t debug any further. We’d probably need to link it some more system libraries if we wanted to go the Objects.LinkedFileList idea.
There was a problem hiding this comment.
To be clear, I meant still keeping the logic to only use the object files for the syntax modules we want. But not to worry if that misses object files
There was a problem hiding this comment.
Oh, I see. Let’s leave it as-is for now. If we read object files, we need to deal with un-quoting lines in there and the added complexity of that doesn’t seem worth it.
| // Never skip tests in CI. Toolchain should be up-to-date | ||
| checkResult = .featureSupported | ||
| } else { | ||
| return try await skipUnlessSupported(file: file, line: line) { |
There was a problem hiding this comment.
Did you mean to pass through featureName?
There was a problem hiding this comment.
Oh yes. Thanks for noticing. This would have been a fun failure mode to debug.
| let swiftSyntaxSearchPaths = [ | ||
| buildDirectory | ||
| .deletingLastPathComponent() // arm64-apple-macosx | ||
| .deletingLastPathComponent() // debug | ||
| .appendingPathComponent("checkouts"), | ||
| URL(fileURLWithPath: #filePath) | ||
| .deletingLastPathComponent() // SwiftPMTestProject.swift | ||
| .deletingLastPathComponent() // SKTestSupport | ||
| .deletingLastPathComponent() // Sources | ||
| .deletingLastPathComponent(), // sourcekit-lsp | ||
| ] | ||
|
|
||
| let swiftSyntaxCShimsModulemap = | ||
| swiftSyntaxSearchPaths.map { swiftSyntaxSearchPath in | ||
| swiftSyntaxSearchPath | ||
| .appendingPathComponent("swift-syntax") | ||
| .appendingPathComponent("Sources") | ||
| .appendingPathComponent("_SwiftSyntaxCShims") | ||
| .appendingPathComponent("include") | ||
| .appendingPathComponent("module.modulemap") | ||
| } | ||
| .first { FileManager.default.fileExists(atPath: $0.path) } | ||
|
|
||
| guard let swiftSyntaxCShimsModulemap else { | ||
| throw SwiftSyntaxCShimsModulemapNotFoundError() | ||
| } |
There was a problem hiding this comment.
Hrm, unfortunate this is needed, shame we don't have a non-deprecated way of using @_implementationOnly in a non-resilient module
ahoppen
force-pushed
the
macro-test-project
branch
from
d8ecc21 to
f466568
Compare
ahoppen
changed the title
|
@swift-ci Please test |
|
@swift-ci Please test Windows |
Add a default package manifest that defines two targets: - A macro target named `MyMacro` - And executable target named `MyMacroClient` It builds the macro using the swift-syntax that was already built as part of the SourceKit-LSP build. Re-using the SwiftSyntax modules that are already built is significantly faster than building swift-syntax in each test case run and does not require internet access.
ahoppen
force-pushed
the
macro-test-project
branch
from
f466568 to
6599292
Compare
|
@swift-ci Please test |
|
@swift-ci Please test Windows |
|
@swift-ci Please test macOS |
Add a default package manifest that defines two targets:
MyMacroMyMacroClientIt builds the macro using the swift-syntax that was already built as part of the SourceKit-LSP build.
Re-using the SwiftSyntax modules that are already built is significantly faster than building swift-syntax in each test case run and does not require internet access.