Files
VCCPlusOSS/platforms/macos/Tests/CMOCProjectInputTests.swift
T

134 lines
9.3 KiB
Swift

// SPDX-License-Identifier: GPL-3.0-or-later
import XCTest
import Foundation
final class CMOCProjectInputTests: XCTestCase {
private func fixture() throws -> URL {
let root = FileManager.default.temporaryDirectory.appendingPathComponent("VCCInputs-" + UUID().uuidString)
try FileManager.default.createDirectory(at: root, withIntermediateDirectories: true)
try write("int main(void) { return 0; }\n", "main.c", at: root)
try write("all:\n\t@true\n", "Makefile", at: root)
return root
}
private func write(_ value: String, _ path: String, at root: URL) throws {
let url = root.appendingPathComponent(path)
try FileManager.default.createDirectory(at: url.deletingLastPathComponent(), withIntermediateDirectories: true)
try Data(value.utf8).write(to: url)
}
func testNestedHeadersAndExplicitGeneratedInputsShareOneManifest() throws {
let root = try fixture(); defer { try? FileManager.default.removeItem(at: root) }
try write("#define VALUE 7\n", "include/game/detail/value.h", at: root)
try write("#define GENERATED 9\n", ".build/value.h", at: root)
try write("incidental sibling", ".build/receipt.json", at: root)
try write("incidental nested sibling", ".build/screens/picture.png", at: root)
try write("payload", "out/keep.dat", at: root)
try write("generated output", "out/capture.json", at: root)
var config = CMOCProjectConfiguration()
config.generatedInputs = [".build/value.h"]
config.resourceInputs = ["out/keep.dat"]
config.outputDirectories = ["out"]
let project = CMOCProject(directory: root, configuration: config)
let manifest = try CMOCProjectInputManifest.capture(project: project)
XCTAssertTrue(manifest.sharedPaths.contains("include/game/detail/value.h"))
XCTAssertEqual(manifest.files[".build/value.h"], Data("#define GENERATED 9\n".utf8))
XCTAssertNil(manifest.files[".build/receipt.json"])
XCTAssertNil(manifest.files[".build/screens/picture.png"])
XCTAssertNotNil(manifest.files["out/keep.dat"])
XCTAssertNil(manifest.files["out/capture.json"])
XCTAssertEqual(manifest.entries.first { $0.path == ".build/value.h" }?.role, "generated_input")
let scope = try MCPCMOCProject(project: project, files: manifest.sharedPaths, customMake: true)
XCTAssertTrue(scope.paths.contains("include/game/detail/value.h"))
XCTAssertEqual(Set(try project.fileEntries().map(\.relativePath)), Set(manifest.files.keys))
try write("new evidence", ".build/receipt.json", at: root)
try write("more evidence", ".build/extra.json", at: root)
XCTAssertEqual(try CMOCProjectInputManifest.capture(project: project), manifest,
"An explicit exception must not re-include excluded siblings")
}
func testEvidenceGrowthAndTimestampChangesDoNotChangeIdentity() throws {
let root = try fixture(); defer { try? FileManager.default.removeItem(at: root) }
let project = CMOCProject(directory: root)
let original = try CMOCProjectInputManifest.capture(project: project)
try write("receipt", "evidence/run.json", at: root)
try write("log", "captures/session.log", at: root)
try write("receipt", "trial-receipt.json", at: root)
try FileManager.default.setAttributes([.modificationDate: Date(timeIntervalSince1970: 1)], ofItemAtPath: root.appendingPathComponent("main.c").path)
let touched = try CMOCProjectInputManifest.capture(project: project)
XCTAssertEqual(original, touched)
XCTAssertTrue(touched.changes(from: original).isEmpty)
XCTAssertNil(touched.files["evidence/run.json"])
XCTAssertTrue(touched.entries.contains { $0.path == "evidence" && !$0.included && !$0.affectsRevision })
try write("int main(void) { return 1; }\n", "main.c", at: root)
try FileManager.default.setAttributes([.modificationDate: Date(timeIntervalSince1970: 1)], ofItemAtPath: root.appendingPathComponent("main.c").path)
let edited = try CMOCProjectInputManifest.capture(project: project)
XCTAssertNotEqual(edited, touched)
XCTAssertEqual(edited.changes(from: touched).map(\.path), ["main.c"])
XCTAssertFalse(try XCTUnwrap(edited.changes(from: touched).first).requiresReview)
}
func testNewScopeAndRecipeChangesRequireReviewButContentEditsDoNot() throws {
let root = try fixture(); defer { try? FileManager.default.removeItem(at: root) }
let project = CMOCProject(directory: root)
let before = try CMOCProjectInputManifest.capture(project: project)
try write("#define NEW 1\n", "include/new.h", at: root)
var after = try CMOCProjectInputManifest.capture(project: project)
XCTAssertTrue(try XCTUnwrap(after.changes(from: before).first).requiresReview)
let shared = after
try write("#define NEW 2\n", "include/new.h", at: root)
after = try CMOCProjectInputManifest.capture(project: project)
XCTAssertFalse(try XCTUnwrap(after.changes(from: shared).first).requiresReview)
let edited = after
try write("all:\n\t@echo changed\n", "Makefile", at: root)
after = try CMOCProjectInputManifest.capture(project: project)
XCTAssertTrue(try XCTUnwrap(after.changes(from: edited).first).requiresReview)
XCTAssertFalse(after.entries.contains { $0.path.hasPrefix(root.path) })
}
func testSymlinkInputsAreRejectedEvenWhenExplicit() throws {
let root = try fixture(); defer { try? FileManager.default.removeItem(at: root) }
try FileManager.default.createSymbolicLink(atPath: root.appendingPathComponent("linked.h").path, withDestinationPath: "/etc/hosts")
var config = CMOCProjectConfiguration(); config.generatedInputs = ["linked.h"]
XCTAssertThrowsError(try CMOCProjectInputManifest.capture(project: CMOCProject(directory: root, configuration: config)))
}
func testRestrictedRecipeDoesNotAcquireUnsharedMakeResources() throws {
let root = try fixture(); defer { try? FileManager.default.removeItem(at: root) }
try write("private project notes", "README.md", at: root)
let project = CMOCProject(directory: root)
let before = try CMOCProjectInputManifest.capture(project: project).restricting(to: ["main.c"])
try write("changed notes", "README.md", at: root)
try write("all:\n\t@echo changed personal recipe\n", "Makefile", at: root)
let after = try CMOCProjectInputManifest.capture(project: project).restricting(to: ["main.c"])
XCTAssertEqual(before, after)
XCTAssertEqual(after.sharedPaths, ["main.c"])
XCTAssertNil(after.files["Makefile"])
XCTAssertNil(after.entries.first { $0.path == "README.md" }?.sha256)
}
func testUnapprovedSupportRootIsNotReadOrHashedBeforeNativeApproval() throws {
let root = try fixture(); defer { try? FileManager.default.removeItem(at: root) }
let name = "VCCSupport-" + UUID().uuidString
let sibling = root.deletingLastPathComponent().appendingPathComponent(name)
try FileManager.default.createDirectory(at: sibling, withIntermediateDirectories: true)
defer { try? FileManager.default.removeItem(at: sibling) }
try write("authored private fixture", "unapproved.txt", at: sibling)
try FileManager.default.createSymbolicLink(atPath: sibling.appendingPathComponent("link").path, withDestinationPath: "/etc/hosts")
var config = CMOCProjectConfiguration(); config.buildSupportDirectories = ["../" + name]
let project = CMOCProject(directory: root, configuration: config)
let pending = try CMOCProjectInputManifest.capture(project: project, approvedSupportDirectories: [])
XCTAssertTrue(pending.support.files.isEmpty)
let row = try XCTUnwrap(pending.entries.first { $0.role == "pending_support_root" })
XCTAssertEqual(row.path, "../" + name); XCTAssertNil(row.sha256)
XCTAssertFalse(pending.entries.contains { $0.path.hasSuffix("unapproved.txt") })
try write("changed outside the approved scope", "unapproved.txt", at: sibling)
XCTAssertEqual(try CMOCProjectInputManifest.capture(project: project, approvedSupportDirectories: []), pending)
XCTAssertThrowsError(try CMOCProjectInputManifest.capture(project: project), "Only approval may enumerate the root and discover its unsafe member")
try FileManager.default.removeItem(at: sibling.appendingPathComponent("link"))
XCTAssertNotNil(try CMOCProjectInputManifest.capture(project: project).support.files["../" + name + "/unapproved.txt"])
}
func testHardVersionControlExclusionsAreCaseInsensitiveAndOutputLinksRefused() throws {
let root = try fixture(); defer { try? FileManager.default.removeItem(at: root) }
try write("must not be shared", ".HG/store/data.c", at: root)
try write("must not be shared", ".GIT/config", at: root)
let before = try CMOCProjectInputManifest.capture(project: CMOCProject(directory: root))
XCTAssertFalse(before.files.keys.contains { $0.lowercased().hasPrefix(".hg/") || $0.lowercased().hasPrefix(".git/") })
try FileManager.default.createSymbolicLink(atPath: root.appendingPathComponent("captures").path, withDestinationPath: "/etc")
XCTAssertThrowsError(try CMOCProjectInputManifest.capture(project: CMOCProject(directory: root)))
}
}