Only make input paths absolute when -working-directory is passed #1708
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -45,12 +45,15 @@ private var testInputsPath: AbsolutePath { | |
| } | ||
| } | ||
|
|
||
| func toPath(_ path: String, isRelative: Bool = true) throws -> VirtualPath { | ||
|
There was a problem hiding this comment. I am slightly prefer leaving the tests in the new state but add Also, would be nice to add a test to check the behavior of path arguments with/without There was a problem hiding this comment.
For the changed tests? For
I added |
||
| if isRelative { | ||
| return VirtualPath.relative(try .init(validating: path)) | ||
| } | ||
| return try VirtualPath(path: path).resolvedRelativePath(base: localFileSystem.currentWorkingDirectory!) | ||
| } | ||
|
|
||
| func toPathOption(_ path: String, isRelative: Bool = true) throws -> Job.ArgTemplate { | ||
| return .path(try toPath(path, isRelative: isRelative)) | ||
| } | ||
|
|
||
| final class SwiftDriverTests: XCTestCase { | ||
|
|
@@ -351,7 +354,7 @@ final class SwiftDriverTests: XCTestCase { | |
| ]) | ||
| XCTAssertEqual(driver.recordedInputModificationDates, [ | ||
| .init(file: VirtualPath.absolute(main).intern(), type: .swift) : mainMDate, | ||
| .init(file: VirtualPath.relative(utilRelative).intern(), type: .swift) : utilMDate, | ||
| ]) | ||
| } | ||
| } | ||
|
|
@@ -1295,12 +1298,11 @@ final class SwiftDriverTests: XCTestCase { | |
| let plannedJobs = try driver.planBuild().removingAutolinkExtractJobs() | ||
| XCTAssertEqual(plannedJobs.count, 3) | ||
| XCTAssertEqual(plannedJobs[0].kind, .compile) | ||
| XCTAssertTrue(plannedJobs[0].primaryInputs.map{ $0.file.description }.elementsEqual(["foo.swift", "bar.swift"])) | ||
| XCTAssertTrue(plannedJobs[0].commandLine.contains("-emit-const-values-path")) | ||
| XCTAssertEqual(plannedJobs[0].outputs.filter({ $0.type == .swiftConstValues }).count, 2) | ||
| XCTAssertEqual(plannedJobs[1].kind, .compile) | ||
| XCTAssertTrue(plannedJobs[1].primaryInputs.map{ $0.file.description }.elementsEqual(["baz.swift"])) | ||
| XCTAssertTrue(plannedJobs[1].commandLine.contains("-emit-const-values-path")) | ||
| XCTAssertEqual(plannedJobs[1].outputs.filter({ $0.type == .swiftConstValues }).count, 1) | ||
| XCTAssertEqual(plannedJobs[2].kind, .link) | ||
|
|
@@ -1331,13 +1333,12 @@ final class SwiftDriverTests: XCTestCase { | |
| let plannedJobs = try driver.planBuild().removingAutolinkExtractJobs() | ||
| XCTAssertEqual(plannedJobs.count, 3) | ||
| XCTAssertEqual(plannedJobs[0].kind, .compile) | ||
| XCTAssertTrue(plannedJobs[0].primaryInputs.map{ $0.file.description }.elementsEqual(["foo.swift", "bar.swift"])) | ||
| XCTAssertTrue(plannedJobs[0].commandLine.contains(subsequence: [.flag("-emit-const-values-path"), .path(.absolute(try .init(validating: "/tmp/foo.build/foo.swiftconstvalues")))])) | ||
| XCTAssertTrue(plannedJobs[0].commandLine.contains(subsequence: [.flag("-emit-const-values-path"), .path(.absolute(try .init(validating: "/tmp/foo.build/bar.swiftconstvalues")))])) | ||
| XCTAssertEqual(plannedJobs[0].outputs.filter({ $0.type == .swiftConstValues }).count, 2) | ||
| XCTAssertEqual(plannedJobs[1].kind, .compile) | ||
| XCTAssertTrue(plannedJobs[1].primaryInputs.map{ $0.file.description }.elementsEqual(["baz.swift"])) | ||
| XCTAssertTrue(plannedJobs[1].commandLine.contains("-emit-const-values-path")) | ||
| XCTAssertEqual(plannedJobs[1].outputs.filter({ $0.type == .swiftConstValues }).count, 1) | ||
| XCTAssertTrue(plannedJobs[1].commandLine.contains(subsequence: [.flag("-emit-const-values-path"), .path(.absolute(try .init(validating: "/tmp/foo.build/baz.swiftconstvalues")))])) | ||
|
|
@@ -3039,10 +3040,10 @@ final class SwiftDriverTests: XCTestCase { | |
| XCTAssertEqual(emitModuleJob.outputs[0].file, try toPath("Test.swiftmodule")) | ||
| XCTAssertEqual(emitModuleJob.outputs[1].file, try toPath("Test.swiftdoc")) | ||
| XCTAssertEqual(emitModuleJob.outputs[2].file, try toPath("Test.swiftsourceinfo")) | ||
| XCTAssertEqual(emitModuleJob.outputs[3].file, try VirtualPath(path: "./Test.swiftinterface")) | ||
| XCTAssertEqual(emitModuleJob.outputs[4].file, try toPath("Test.private.swiftinterface")) | ||
| XCTAssertEqual(emitModuleJob.outputs[5].file, try toPath("Test-Swift.h")) | ||
| XCTAssertEqual(emitModuleJob.outputs[6].file, try VirtualPath(path: "./Test.tbd")) | ||
|
There was a problem hiding this comment. @rmaz do you recall why this change was needed for only these specific outputs? There was a problem hiding this comment. I don't, but changing it to So somewhere a CWD of There was a problem hiding this comment. After some code wandering, it is because the path is unspecified in the compiler args, so falls back to this codepath to determine it: swift-driver/Sources/SwiftDriver/Driver/Driver.swift Lines 3623 to 3626 in eba1952 This ends up calling This ends up calculating the parent as |
||
| if driver1.targetTriple.isDarwin { | ||
| XCTAssertEqual(emitModuleJob.outputs[7].file, try toPath("Test.abi.json")) | ||
| } | ||
|
|
@@ -5188,7 +5189,7 @@ final class SwiftDriverTests: XCTestCase { | |
| // Reset the temporary store to ensure predictable results. | ||
| VirtualPath.resetTemporaryFileStore() | ||
| var driver = try Driver(args: [ | ||
| "swiftc", "-emit-executable", "test.swift", "-emit-module", "-avoid-emit-module-source-info", "-experimental-emit-module-separately", "-working-directory", localFileSystem.currentWorkingDirectory!.description | ||
| ]) | ||
| let plannedJobs = try driver.planBuild() | ||
|
|
||
|
|
@@ -7234,6 +7235,83 @@ final class SwiftDriverTests: XCTestCase { | |
| }) | ||
| } | ||
| } | ||
|
|
||
| func testRelativeInputs() throws { | ||
| do { | ||
| // Inputs with relative paths with no -working-directory flag should remain relative | ||
| var driver = try Driver(args: ["swiftc", | ||
| "-target", "arm64-apple-ios13.1", | ||
| "foo.swift"]) | ||
| let plannedJobs = try driver.planBuild() | ||
| let compileJob = plannedJobs[0] | ||
| XCTAssertEqual(compileJob.kind, .compile) | ||
| XCTAssertTrue(compileJob.commandLine.contains(subsequence: ["-primary-file", try toPathOption("foo.swift", isRelative: true)])) | ||
| } | ||
|
|
||
| do { | ||
| // Inputs with relative paths with -working-directory flag should prefix all inputs | ||
| var driver = try Driver(args: ["swiftc", | ||
| "-target", "arm64-apple-ios13.1", | ||
| "foo.swift", | ||
| "-working-directory", "/foo/bar"]) | ||
| let plannedJobs = try driver.planBuild() | ||
| let compileJob = plannedJobs[0] | ||
| XCTAssertEqual(compileJob.kind, .compile) | ||
| XCTAssertTrue(compileJob.commandLine.contains(subsequence: ["-primary-file", try toPathOption("/foo/bar/foo.swift", isRelative: false)])) | ||
| } | ||
|
|
||
| try withTemporaryFile { fileMapFile in | ||
| let outputMapContents: ByteString = """ | ||
| { | ||
| "": { | ||
| "diagnostics": "/tmp/foo/.build/x86_64-apple-macosx/debug/foo.build/master.dia", | ||
| "emit-module-diagnostics": "/tmp/foo/.build/x86_64-apple-macosx/debug/foo.build/master.emit-module.dia" | ||
| }, | ||
| "foo.swift": { | ||
| "object": "/tmp/foo/.build/x86_64-apple-macosx/debug/foo.build/foo.o" | ||
| } | ||
| } | ||
| """ | ||
| try localFileSystem.writeFileContents(fileMapFile.path, bytes: outputMapContents) | ||
|
|
||
| // Inputs with relative paths should be found in output file maps | ||
| var driver = try Driver(args: ["swiftc", | ||
| "-target", "arm64-apple-ios13.1", | ||
| "foo.swift", | ||
| "-output-file-map", fileMapFile.path.description]) | ||
| let plannedJobs = try driver.planBuild() | ||
| let compileJob = plannedJobs[0] | ||
| XCTAssertEqual(compileJob.kind, .compile) | ||
| XCTAssertTrue(compileJob.commandLine.contains(subsequence: ["-o", try toPathOption("/tmp/foo/.build/x86_64-apple-macosx/debug/foo.build/foo.o", isRelative: false)])) | ||
| } | ||
|
|
||
| try withTemporaryFile { fileMapFile in | ||
| let outputMapContents: ByteString = """ | ||
| { | ||
| "": { | ||
| "diagnostics": "/tmp/foo/.build/x86_64-apple-macosx/debug/foo.build/master.dia", | ||
| "emit-module-diagnostics": "/tmp/foo/.build/x86_64-apple-macosx/debug/foo.build/master.emit-module.dia" | ||
| }, | ||
| "/some/workingdir/foo.swift": { | ||
| "object": "/tmp/foo/.build/x86_64-apple-macosx/debug/foo.build/foo.o" | ||
| } | ||
| } | ||
| """ | ||
| try localFileSystem.writeFileContents(fileMapFile.path, bytes: outputMapContents) | ||
|
|
||
| // Inputs with relative paths and working-dir should use absolute paths in output file maps | ||
| var driver = try Driver(args: ["swiftc", | ||
| "-target", "arm64-apple-ios13.1", | ||
| "foo.swift", | ||
| "-working-directory", "/some/workingdir", | ||
| "-output-file-map", fileMapFile.path.description]) | ||
| let plannedJobs = try driver.planBuild() | ||
| let compileJob = plannedJobs[0] | ||
| XCTAssertEqual(compileJob.kind, .compile) | ||
| XCTAssertTrue(compileJob.commandLine.contains(subsequence: ["-o", try toPathOption("/tmp/foo/.build/x86_64-apple-macosx/debug/foo.build/foo.o", isRelative: false)])) | ||
| } | ||
|
|
||
| } | ||
|
|
||
| func testRelativeResourceDir() throws { | ||
| do { | ||
|
|
@@ -7274,7 +7352,7 @@ final class SwiftDriverTests: XCTestCase { | |
| XCTAssertEqual(compileJob.kind, .compile) | ||
| let linkJob = plannedJobs[1] | ||
| XCTAssertEqual(linkJob.kind, .link) | ||
| XCTAssertTrue(linkJob.commandLine.contains(try toPathOption(sdkRoot.pathString + "/usr/lib/swift/linux/x86_64/swiftrt.o", isRelative: false))) | ||
| } | ||
| } | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe the code will be cleaner (save all the
?? fileSystem.currentWorkingDirectory) ifself.workingDirectoryis always set regardless of if-working-directoryis passed but only callsapplyWorkingDirectoryif the option is passed.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried that initially, but then the output paths (and profile data paths) end up absolute. I didn't track down where that was happening, but there seems to be multiple places in the code that would end up prefixing paths if
workingDirectorywas set.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe driver will think that working-directory is passed via command-line so it is passing working directory (in abs path) frontend flag plus some other flags derived from working directory?
Sounds fine with me.