Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions Tests/SysDataMenuTests/ProbeTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,27 @@ import Foundation
import Testing
@testable import SysDataMenu

/// The scan measures whatever the machine happens to hold, so a full run costs
/// minutes on a developer Mac (20+ with Xcode, simulators and node_modules
/// around) and its result changes with what is installed. That is worth having,
/// but not on every `swift test`, so the two tests that walk the disk are
/// opt-in:
///
/// SYSDATA_SCAN_TESTS=1 swift test
///
/// CI enables them, where the runner starts nearly empty and the walk is quick.
/// Everything else here runs in milliseconds.
enum MachineScan {
static let isEnabled = ProcessInfo.processInfo.environment["SYSDATA_SCAN_TESTS"] != nil
}

/// Every probe runs against the real machine, so only invariants are checked:
/// probes must not throw or hang, and what they return must be well-formed.
@Suite struct ProbeTests {
private let probes: [(String, any StorageProbe)] = ProbeRegistry.all.map { (String(describing: type(of: $0)), $0) }

@Test func itemsAreWellFormed() async {
@Test(.enabled(if: MachineScan.isEnabled), .timeLimit(.minutes(30)))
func itemsAreWellFormed() async {
var seen: Set<String> = []
var all: [StorageItem] = []
for (label, probe) in probes {
Expand Down Expand Up @@ -85,7 +100,8 @@ import Testing
return english.first { $0.value == title }?.key ?? title
}

@Test func jsonInventoryIsWellFormed() async throws {
@Test(.enabled(if: MachineScan.isEnabled), .timeLimit(.minutes(30)))
func jsonInventoryIsWellFormed() async throws {
let pipe = Pipe()
await JSONInventory.write(to: pipe.fileHandleForWriting)
try pipe.fileHandleForWriting.close()
Expand Down
138 changes: 138 additions & 0 deletions Tests/SysDataMenuTests/ReclaimerTests.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
import Foundation
import Testing
@testable import SysDataMenu

/// `Reclaimer` is the only code in the app that deletes anything, so its
/// behaviour is pinned here against a scratch tree. Nothing outside the
/// temporary directory this suite creates is ever touched.
@Suite struct ReclaimerTests {
/// A disposable directory tree, removed when the test ends.
private struct Scratch: ~Copyable {
let root: URL

init() throws {
root = FileManager.default.temporaryDirectory
.appending(path: "sysdata-reclaim-\(UUID().uuidString)")
try FileManager.default.createDirectory(at: root, withIntermediateDirectories: true)
}

@discardableResult
func file(_ name: String, bytes: Int = 32, modified: Date? = nil) throws -> URL {
let url = root.appending(path: name)
try FileManager.default.createDirectory(
at: url.deletingLastPathComponent(), withIntermediateDirectories: true
)
try Data(count: bytes).write(to: url)
if let modified {
try FileManager.default.setAttributes([.modificationDate: modified], ofItemAtPath: url.path)
}
return url
}

func url(_ name: String) -> URL { root.appending(path: name) }

deinit { try? FileManager.default.removeItem(at: root) }
}

@Test func removePathsDeletesFilesAndDirectories() async throws {
let scratch = try Scratch()
let file = try scratch.file("loose.bin")
try scratch.file("tree/nested/deep.bin")
let tree = scratch.url("tree")

try await Reclaimer.perform(.removePaths([file, tree]))

#expect(!file.exists)
#expect(!tree.exists)
}

@Test func removePathsIgnoresPathsThatAreAlreadyGone() async throws {
let scratch = try Scratch()
let missing = scratch.url("never-existed")

// A second delete of an item the user removed by hand must not throw,
// otherwise a batch stops halfway on a no-op.
try await Reclaimer.perform(.removePaths([missing]))
}

@Test func emptyDirectoriesClearsContentsButKeepsTheDirectory() async throws {
let scratch = try Scratch()
try scratch.file("cache/a.bin")
try scratch.file("cache/.hidden")
try scratch.file("cache/sub/b.bin")
let cache = scratch.url("cache")

try await Reclaimer.perform(.emptyDirectories([cache]))

#expect(cache.exists, "the directory itself must survive; tools expect it to be there")
#expect(cache.children(includeHidden: true).isEmpty, "hidden entries must go too")
}

@Test func pruneRemovesOldFilesAndKeepsRecentOnes() async throws {
let scratch = try Scratch()
let old = try scratch.file("logs/old.log", modified: .now.addingTimeInterval(-40 * 86_400))
let recent = try scratch.file("logs/recent.log", modified: .now.addingTimeInterval(-2 * 86_400))

try await Reclaimer.perform(.pruneOlderThan(scratch.url("logs"), days: 30))

#expect(!old.exists)
#expect(recent.exists)
}

@Test func pruneRemovesDirectoriesLeftEmptyButKeepsPopulatedOnes() async throws {
let scratch = try Scratch()
try scratch.file("logs/stale/only.log", modified: .now.addingTimeInterval(-40 * 86_400))
try scratch.file("logs/live/kept.log", modified: .now)

try await Reclaimer.perform(.pruneOlderThan(scratch.url("logs"), days: 30))

#expect(!scratch.url("logs/stale").exists)
#expect(scratch.url("logs/live").exists)
}

@Test func stepsStopAtTheFirstFailure() async throws {
let scratch = try Scratch()
let second = try scratch.file("second.bin")

await #expect(throws: CommandError.self) {
try await Reclaimer.perform(.steps([
.command(executable: "/usr/bin/false", arguments: []),
.removePaths([second]),
]))
}

#expect(second.exists, "a step after a failed one must not run")
}

@Test func stepsRunInOrderWhenNothingFails() async throws {
let scratch = try Scratch()
let file = try scratch.file("box/thing.bin")
let box = scratch.url("box")

try await Reclaimer.perform(.steps([
.command(executable: "/usr/bin/true", arguments: []),
.removePaths([file]),
]))

#expect(!file.exists)
#expect(box.exists)
}

@Test func failingCommandReportsTheCommandItRan() async throws {
let error = await #expect(throws: CommandError.self) {
try await Reclaimer.perform(.command(executable: "/bin/sh", arguments: ["-c", "exit 3"]))
}

#expect(error?.result.status == 3)
#expect(error?.command.contains("/bin/sh") == true)
}

@Test func manualActionDoesNothing() async throws {
let scratch = try Scratch()
let file = try scratch.file("kept.bin")

try await Reclaimer.perform(.manual("Open System Settings"))

#expect(file.exists)
}
}