Something went wrong. Try again.
An auto tiler for macOS
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364import Foundationimport Testing
@testable import ParcelDev
@Suite struct ScriptTestToolTests { private struct Fixture { let work: URL let root: URL let buildLog: URL var environment: [String: String]
init() throws { work = FileManager.default.temporaryDirectory.appendingPathComponent("script tool tests \(UUID())") .resolvingSymlinksInPath() root = work.appendingPathComponent("project", isDirectory: true) buildLog = work.appendingPathComponent("builds") for path in [ "project/Scripts", "project/Sources/ParcelDev", "project/Sources/parcel-dev", "bin", "sdk", "other-sdk", ] { try FileManager.default.createDirectory( at: work.appendingPathComponent(path), withIntermediateDirectories: true) } for script in ["parcel-dev.sh", "swift-build.sh"] { try FileManager.default.copyItem( at: ScriptTestTool.root.appendingPathComponent("Scripts/\(script)"), to: root.appendingPathComponent("Scripts/\(script)")) } environment = ProcessInfo.processInfo.environment environment.removeValue(forKey: "PARCEL_DEV_BINARY") environment.removeValue(forKey: "SDKROOT") environment["DEFAULT_SDK"] = work.appendingPathComponent("sdk").path environment["PATH"] = "\(work.appendingPathComponent("bin").path):/usr/bin:/bin" environment["BUILD_LOG"] = buildLog.path environment["PROJECT"] = root.path try write("project/Package.swift", "fixture package\n") try write("project/Sources/ParcelDev/Value.swift", "fixture source\n") try write("project/Sources/parcel-dev/main.swift", "fixture entrypoint\n") try write( "bin/swift", """ #!/bin/bash set -euo pipefail if [[ $1 == --version ]]; then printf 'fixture Swift %s\\n' "${COMPILER_VERSION:-1}" exit 0 fi printf '%s\\n' "$*" >> "$BUILD_LOG" [[ $1 == build && $2 == --scratch-path && $3 == "$PROJECT/.build/parcel-dev" ]] [[ $4 == -c && $5 == release && $6 == --product && $7 == parcel-dev ]] if [[ ${BUILD_FAIL:-0} != 0 ]]; then printf 'fixture compiler failure\\n' >&2 exit "$BUILD_FAIL" fi if [[ ${BUILD_DELAY:-0} != 0 ]]; then sleep "$BUILD_DELAY"; fi if [[ ${BUILD_NO_OUTPUT:-0} == 1 ]]; then exit 0; fi mkdir -p "$3/release" printf '#!/bin/sh\\nprintf "fixture executable\\\\n"\\n' > "$3/release/parcel-dev" chmod +x "$3/release/parcel-dev" """, executable: true) try write( "bin/xcrun", """ #!/bin/sh set -eu case "$*" in '--find swift') printf '%s\\n' "$PROJECT/compiler/${COMPILER_PATH:-swift}" ;; '--show-sdk-path') case "${SDKROOT:-}" in ''|macosx) printf '%s\\n' "$DEFAULT_SDK" ;; *) printf '%s\\n' "$SDKROOT" ;; esac ;; *) exit 2 ;; esac """, executable: true) try write( "bin/xcodebuild", """ #!/bin/sh set -eu [ "$*" = -version ] printf 'Xcode fixture\\n' """, executable: true) }
func write(_ path: String, _ text: String, executable: Bool = false) throws { let url = work.appendingPathComponent(path) try Data(text.utf8).write(to: url) try FileManager.default.setAttributes( [.posixPermissions: executable ? 0o755 : 0o644], ofItemAtPath: url.path) }
func clean() throws { try FileManager.default.removeItem(at: work) }
var builds: Int { get throws { guard FileManager.default.fileExists(atPath: buildLog.path) else { return 0 } return try String(contentsOf: buildLog, encoding: .utf8).split(separator: "\n").count } } }
@Test func bootstrapsTheIsolatedCacheAndResolvesOnce() async throws { let fixture = try Fixture() defer { #expect(throws: Never.self) { try fixture.clean() } } let tool = ScriptTestTool(root: fixture.root, environment: fixture.environment) let expected = fixture.root.appendingPathComponent(".build/parcel-dev/release/parcel-dev") #expect(try tool.binary == expected) #expect(try fixture.builds == 1) #expect(!FileManager.default.fileExists(atPath: fixture.root.appendingPathComponent(".build/debug").path)) let result = try DevProcess.run(try tool.binary.path, []) #expect(result.status == 0) #expect(result.output == "fixture executable\n") try FileManager.default.setAttributes( [.modificationDate: Date().addingTimeInterval(60)], ofItemAtPath: fixture.root.appendingPathComponent("Package.swift").path) try await withThrowingTaskGroup(of: URL.self) { group in for _ in 0..<8 { group.addTask { try tool.binary } } for try await binary in group { #expect(binary == expected) } } #expect(try fixture.builds == 1) #expect(try ScriptTestTool(root: fixture.root, environment: fixture.environment).binary == expected) #expect(try fixture.builds == 1) try fixture.write("project/Package.swift", "changed package\n") #expect(try ScriptTestTool(root: fixture.root, environment: fixture.environment).binary == expected) #expect(try fixture.builds == 2) }
@Test(arguments: [ "source", "added", "removed", "resolved", "wrapper", "buildWrapper", "compiler", "compilerPath", "sdk", ]) func contentAndCompilerChangesInvalidateTheCache(kind: String) throws { var fixture = try Fixture() defer { #expect(throws: Never.self) { try fixture.clean() } } _ = try ScriptTestTool(root: fixture.root, environment: fixture.environment).binary switch kind { case "source": try fixture.write("project/Sources/ParcelDev/Value.swift", "changed source\n") try FileManager.default.setAttributes( [.modificationDate: Date(timeIntervalSince1970: 1)], ofItemAtPath: fixture.root.appendingPathComponent("Sources/ParcelDev/Value.swift").path) case "added": try fixture.write("project/Sources/ParcelDev/New.swift", "new source\n") case "removed": try FileManager.default.removeItem(at: fixture.root.appendingPathComponent("Sources/ParcelDev/Value.swift")) case "resolved": try fixture.write("project/Package.resolved", "changed resolution\n") case "wrapper", "buildWrapper": let script = kind == "wrapper" ? "parcel-dev.sh" : "swift-build.sh" let wrapper = fixture.root.appendingPathComponent("Scripts/\(script)") let contents = try String(contentsOf: wrapper, encoding: .utf8) try fixture.write("project/Scripts/\(script)", contents + "\n", executable: true) case "compiler": fixture.environment["COMPILER_VERSION"] = "2" case "compilerPath": fixture.environment["COMPILER_PATH"] = "other-swift" case "sdk": fixture.environment["SDKROOT"] = fixture.work.appendingPathComponent("other-sdk").path default: throw DevError("Unknown cache fixture: \(kind)") } _ = try ScriptTestTool(root: fixture.root, environment: fixture.environment).binary _ = try ScriptTestTool(root: fixture.root, environment: fixture.environment).binary #expect(try fixture.builds == 2) }
@Test func implicitExplicitAndSymlinkedSDKSelectionsShareTheCache() throws { var fixture = try Fixture() defer { #expect(throws: Never.self) { try fixture.clean() } } let sdk = fixture.work.appendingPathComponent("sdk") let link = fixture.work.appendingPathComponent("sdk-link") try FileManager.default.createSymbolicLink(at: link, withDestinationURL: sdk) for selection in [nil, sdk.path, link.path, "macosx", nil, sdk.path] { fixture.environment["SDKROOT"] = selection _ = try ScriptTestTool(root: fixture.root, environment: fixture.environment).binary } #expect(try fixture.builds == 1) }
@Test func unrelatedSourcesAndIdenticalRewritesDoNotRebuild() throws { let fixture = try Fixture() defer { #expect(throws: Never.self) { try fixture.clean() } } _ = try ScriptTestTool(root: fixture.root, environment: fixture.environment).binary try fixture.write("project/Sources/Unrelated.swift", "app source\n") try fixture.write("project/Sources/ParcelDev/Value.swift", "fixture source\n") _ = try ScriptTestTool(root: fixture.root, environment: fixture.environment).binary _ = try ScriptTestTool(root: fixture.root, environment: fixture.environment).binary #expect(try fixture.builds == 1) }
@Test func concurrentResolversShareOneBootstrap() async throws { var fixture = try Fixture() defer { #expect(throws: Never.self) { try fixture.clean() } } fixture.environment["BUILD_DELAY"] = "0.1" let root = fixture.root let environment = fixture.environment try await withThrowingTaskGroup(of: URL.self) { group in for index in 0..<8 { var selected = environment if index.isMultiple(of: 2) { selected["SDKROOT"] = environment["DEFAULT_SDK"] } let context = selected group.addTask { try ScriptTestTool(root: root, environment: context).binary } } for try await binary in group { #expect(binary.path.hasSuffix("/release/parcel-dev")) } } #expect(try fixture.builds == 1) #expect( !FileManager.default.fileExists(atPath: root.appendingPathComponent(".build/parcel-dev/build.lock").path)) }
@Test func anAbandonedBootstrapLockIsRecovered() throws { let fixture = try Fixture() defer { #expect(throws: Never.self) { try fixture.clean() } } try FileManager.default.createDirectory( at: fixture.root.appendingPathComponent(".build/parcel-dev"), withIntermediateDirectories: true) try fixture.write("project/.build/parcel-dev/build.lock", "99999999\n") _ = try ScriptTestTool(root: fixture.root, environment: fixture.environment).binary #expect(try fixture.builds == 1) }
@Test func failedRebuildsDoNotRunOrCertifyTheOldExecutable() throws { var fixture = try Fixture() defer { #expect(throws: Never.self) { try fixture.clean() } } _ = try ScriptTestTool(root: fixture.root, environment: fixture.environment).binary try fixture.write("project/Sources/ParcelDev/Value.swift", "changed source\n") fixture.environment["BUILD_FAIL"] = "17" #expect(throws: (any Error).self) { try ScriptTestTool(root: fixture.root, environment: fixture.environment).binary } #expect( !FileManager.default.fileExists( atPath: fixture.root.appendingPathComponent(".build/parcel-dev/inputs").path)) #expect( !FileManager.default.fileExists( atPath: fixture.root.appendingPathComponent(".build/parcel-dev/build.lock").path)) fixture.environment.removeValue(forKey: "BUILD_FAIL") _ = try ScriptTestTool(root: fixture.root, environment: fixture.environment).binary #expect(try fixture.builds == 3) }
@Test func aSuccessfulBuildMustProduceAnExecutable() throws { var fixture = try Fixture() defer { #expect(throws: Never.self) { try fixture.clean() } } fixture.environment["BUILD_NO_OUTPUT"] = "1" #expect { try ScriptTestTool(root: fixture.root, environment: fixture.environment).binary } throws: { error in String(describing: error).contains("build did not produce an executable") } #expect(try fixture.builds == 1) #expect( !FileManager.default.fileExists( atPath: fixture.root.appendingPathComponent(".build/parcel-dev/inputs").path)) }
@Test(arguments: ["absolute", "relative", "symlink"]) func honorsOverridesAndReturnsAPhysicalAbsolutePath(kind: String) throws { var fixture = try Fixture() defer { #expect(throws: Never.self) { try fixture.clean() } } try fixture.write("project/tool with spaces", "#!/bin/sh\nexit 0\n", executable: true) let expected = fixture.root.appendingPathComponent("tool with spaces") if kind == "symlink" { let link = fixture.root.appendingPathComponent("tool-link") try FileManager.default.createSymbolicLink(at: link, withDestinationURL: expected) fixture.environment["PARCEL_DEV_BINARY"] = link.path } else { fixture.environment["PARCEL_DEV_BINARY"] = kind == "relative" ? "./tool with spaces" : expected.path } fixture.environment["PARCEL_DEV_ROOT"] = fixture.work.appendingPathComponent("untrusted download").path let tool = ScriptTestTool(root: fixture.root, environment: fixture.environment) #expect(try tool.binary == expected) #expect(try fixture.builds == 0) }
@Test(arguments: ["empty", "missing", "nonexecutable", "directory"]) func invalidOverridesFailWithoutBootstrapping(kind: String) throws { var fixture = try Fixture() defer { #expect(throws: Never.self) { try fixture.clean() } } let path = fixture.root.appendingPathComponent("override") if kind == "nonexecutable" { try fixture.write("project/override", "not executable\n") } if kind == "directory" { try FileManager.default.createDirectory(at: path, withIntermediateDirectories: false) } fixture.environment["PARCEL_DEV_BINARY"] = kind == "empty" ? "" : path.path let tool = ScriptTestTool(root: fixture.root, environment: fixture.environment) #expect(throws: (any Error).self) { try tool.binary } #expect(throws: (any Error).self) { try tool.binary } #expect(try fixture.builds == 0) #expect(!FileManager.default.fileExists(atPath: fixture.root.appendingPathComponent(".build").path)) }
@Test func failedBuildsPreserveDiagnosticsAndDoNotRetry() throws { var fixture = try Fixture() defer { #expect(throws: Never.self) { try fixture.clean() } } fixture.environment["BUILD_FAIL"] = "17" let tool = ScriptTestTool(root: fixture.root, environment: fixture.environment) for _ in 0..<2 { #expect { try tool.binary } throws: { error in let message = String(describing: error) return message.contains("resolution failed (17)") && message.contains("fixture compiler failure") && message.contains(fixture.root.appendingPathComponent("Scripts/parcel-dev.sh").path) } } #expect(try fixture.builds == 1) }
@Test(arguments: ["empty", "relative", "multiple", "unterminated", "invalidUTF8", "carriageReturn", "nullByte"]) func rejectsMalformedResolverOutput(kind: String) throws { let fixture = try Fixture() defer { #expect(throws: Never.self) { try fixture.clean() } } let output = switch kind { case "empty": "printf '\\n'" case "relative": "printf 'relative-tool\\n'" case "multiple": "printf '/first\\n/second\\n'" case "unterminated": "printf '/path'" case "invalidUTF8": "printf '\\377\\n'" case "carriageReturn": "printf '/path\\r\\n'" case "nullByte": "printf '/path\\000\\n'" default: throw DevError("Unknown resolver fixture: \(kind)") } try fixture.write("project/Scripts/parcel-dev.sh", "#!/bin/sh\n\(output)\n", executable: true) let tool = ScriptTestTool(root: fixture.root, environment: fixture.environment) #expect(throws: DevError.self) { try tool.binary } #expect(try fixture.builds == 0) }
@Test(arguments: ["missing", "nonexecutable", "directory"]) func aSuccessfulResolverMustStillReturnAnExecutableFile(kind: String) throws { let fixture = try Fixture() defer { #expect(throws: Never.self) { try fixture.clean() } } let binary = fixture.root.appendingPathComponent("resolved-tool") if kind == "nonexecutable" { try fixture.write("project/resolved-tool", "not executable\n") } if kind == "directory" { try FileManager.default.createDirectory(at: binary, withIntermediateDirectories: false) } try fixture.write( "project/Scripts/parcel-dev.sh", "#!/bin/sh\nprintf '%s\\n' '\(binary.path)'\n", executable: true) let tool = ScriptTestTool(root: fixture.root, environment: fixture.environment) #expect(throws: (any Error).self) { try tool.binary } #expect(try fixture.builds == 0) }
@Test func aMissingResolverSurfacesTheShellFailure() throws { let fixture = try Fixture() defer { #expect(throws: Never.self) { try fixture.clean() } } let wrapper = fixture.root.appendingPathComponent("Scripts/parcel-dev.sh") try FileManager.default.removeItem(at: wrapper) let tool = ScriptTestTool(root: fixture.root, environment: fixture.environment) #expect { try tool.binary } throws: { error in let message = String(describing: error) return message.contains("resolution failed") && message.contains(wrapper.path) } #expect(try fixture.builds == 0) }
@Test func allParcelDevFixturesUseTheSameResolvedTool() throws { let measurement = try MeasurementFixture() defer { measurement.cleanup() } #expect(try PolicyTestSupport.binary == ScriptTestTool.current.binary) #expect(try ReleaseTestSupport.binary == ScriptTestTool.current.binary.path) #expect(try measurement.environment["PARCEL_DEV_BINARY"] == ScriptTestTool.current.binary.path) }}