Skip to content

armgit / peel

Public Imported from GitHub
0

Uninstall Mac apps with every file they leave behind, and see why each belongs. Free up space, fine-tune macOS, and set up Terminal.

Take away the folder each test makes

Țugui Dragoș1d4cc361194f
diff --git a/AGENTS.md b/AGENTS.md
index 3ce483d0..880b5b21 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -192,7 +192,10 @@ If you are unsure whether something belongs in the helper, it doesn't.
priority rather than the default. A test that reads this Mac through a tool (`pluginkit`, `mdfind`) waits for the
tool's whole answer, never the time limit the page gives it: a runner with three processors takes longer.
- The files a test scans sit in a temporary home, never in yours, and nothing is registered with Launch Services
- from a test. An app a test expects Peel to act on is a made-up one, named under a domain kept for examples
+ from a test. In the package's tests that home is a `TemporaryDirectory`, which takes it away when the test ends,
+ and no other test there names the temporary folder (`TemporaryDirectoryTests`); a test of the app removes the
+ folder it made before it returns. An app a test expects Peel to act on is a made-up one, named under a domain kept
+ for examples
(`org.example`, `com.example`, `net.example`). A program a test starts from a folder of its own is a copy of
`/bin/cat` signed ad hoc (`TemporaryDirectory.runningProgram`, or `runningPrograms` for several): macOS kills a
plain copy of one of its own programs started from anywhere else, usually within a second, for breaking its launch
diff --git a/Packages/PeelCore/Tests/PeelCoreTests/GitSettingsTests.swift b/Packages/PeelCore/Tests/PeelCoreTests/GitSettingsTests.swift
index 0de5e726..0f6ab1e9 100644
--- a/Packages/PeelCore/Tests/PeelCoreTests/GitSettingsTests.swift
+++ b/Packages/PeelCore/Tests/PeelCoreTests/GitSettingsTests.swift
@@ -2,14 +2,17 @@ import Foundation
@testable import PeelCore
import Testing
-private struct GitHome {
+private struct GitHome: ~Copyable {
let home: URL
let config: GitConfig
+ private let directory: TemporaryDirectory
init() async throws {
- home = FileManager.default.temporaryDirectory.appending(path: "GitSettingsTests-\(UUID().uuidString)", directoryHint: .isDirectory)
- try FileManager.default.createDirectory(at: home, withIntermediateDirectories: true)
- config = try #require(await GitConfig.find(home: home))
+ let directory = try TemporaryDirectory()
+ let config = try #require(await GitConfig.find(home: directory.url))
+ home = directory.url
+ self.config = config
+ self.directory = directory
}
var file: String {
@@ -240,7 +243,8 @@ struct GitSettingsTests {
}
@Test func gitIsTheOneTheDeveloperToolsOrHomebrewInstalledAndNeverTheShim() throws {
- let folder = FileManager.default.temporaryDirectory.appending(path: "GitSettingsTests-\(UUID().uuidString)", directoryHint: .isDirectory)
+ let directory = try TemporaryDirectory()
+ let folder = directory.url
let developer = folder.appending(path: "Developer", directoryHint: .isDirectory)
let homebrew = folder.appending(path: "homebrew", directoryHint: .isDirectory)
for git in [developer.appending(path: "usr/bin/git"), homebrew.appending(path: "bin/git")] {
diff --git a/Packages/PeelCore/Tests/PeelCoreTests/HushLoginTests.swift b/Packages/PeelCore/Tests/PeelCoreTests/HushLoginTests.swift
index 03920bdb..44b71ff9 100644
--- a/Packages/PeelCore/Tests/PeelCoreTests/HushLoginTests.swift
+++ b/Packages/PeelCore/Tests/PeelCoreTests/HushLoginTests.swift
@@ -3,15 +3,9 @@ import Foundation
import Testing
struct HushLoginTests {
- private func home() throws -> URL {
- let home = FileManager.default.temporaryDirectory.appending(path: "HushLoginTests-\(UUID().uuidString)", directoryHint: .isDirectory)
- try FileManager.default.createDirectory(at: home, withIntermediateDirectories: true)
- return home
- }
-
@Test func isOnExactlyWhenLoginFindsTheFile() throws {
- let home = try home()
- defer { try? FileManager.default.removeItem(at: home) }
+ let directory = try TemporaryDirectory()
+ let home = directory.url
let file = HushLogin.url(in: home)
#expect(!HushLogin.isOn(in: home))
@@ -33,8 +27,8 @@ struct HushLoginTests {
}
@Test func turningOnLeavesAnEmptyFileOnlyTheAccountWrites() throws {
- let home = try home()
- defer { try? FileManager.default.removeItem(at: home) }
+ let directory = try TemporaryDirectory()
+ let home = directory.url
#expect(HushLogin.turnOn(in: home))
let attributes = try FileManager.default.attributesOfItem(
@@ -48,8 +42,8 @@ struct HushLoginTests {
}
@Test func turningOnKeepsTheFileThatIsThere() throws {
- let home = try home()
- defer { try? FileManager.default.removeItem(at: home) }
+ let directory = try TemporaryDirectory()
+ let home = directory.url
let file = HushLogin.url(in: home)
try Data("kept".utf8).write(to: file)
let before =
@@ -65,8 +59,8 @@ struct HushLoginTests {
}
@Test func turningOnNeverWritesThroughALink() throws {
- let home = try home()
- defer { try? FileManager.default.removeItem(at: home) }
+ let directory = try TemporaryDirectory()
+ let home = directory.url
let target = home.appending(path: "elsewhere")
try FileManager.default.createSymbolicLink(at: HushLogin.url(in: home), withDestinationURL: target)
diff --git a/Packages/PeelCore/Tests/PeelCoreTests/SSHFileTests.swift b/Packages/PeelCore/Tests/PeelCoreTests/SSHFileTests.swift
index 375a3043..5f82ee19 100644
--- a/Packages/PeelCore/Tests/PeelCoreTests/SSHFileTests.swift
+++ b/Packages/PeelCore/Tests/PeelCoreTests/SSHFileTests.swift
@@ -3,18 +3,22 @@ import Foundation
import PeelPrivileged
import Testing
-private struct SSHHome {
+private struct SSHHome: ~Copyable {
let folder: URL
let peelFile: URL
let config: URL
+ private let directory: TemporaryDirectory
init(before lines: [String] = []) throws {
- folder = FileManager.default.temporaryDirectory.appending(path: "SSHFileTests-\(UUID().uuidString)", directoryHint: .isDirectory)
- peelFile = SSHFile.url(in: folder.appending(path: "Library/Application Support/Peel", directoryHint: .isDirectory))
- config = folder.appending(path: "config")
- try FileManager.default.createDirectory(at: folder, withIntermediateDirectories: true)
+ let directory = try TemporaryDirectory()
+ let peelFile = SSHFile.url(in: directory.url.appending(path: "Library/Application Support/Peel", directoryHint: .isDirectory))
+ let config = directory.url.appending(path: "config")
let including = SSHFile.lines(including: peelFile, home: URL(filePath: "/var/empty", directoryHint: .isDirectory))
try (lines + including).joined(separator: "\n").appending("\n").write(to: config, atomically: true, encoding: .utf8)
+ folder = directory.url
+ self.peelFile = peelFile
+ self.config = config
+ self.directory = directory
}
/// The options ssh would use for `host`, by their names in lowercase, as `ssh -G` prints them.
@@ -142,8 +146,8 @@ struct SSHFileTests {
}
@Test func aMissingFileHasNothingOnAndOneThatCannotBeReadIsNotKnown() throws {
- let folder = FileManager.default.temporaryDirectory.appending(path: "SSHFileTests-\(UUID().uuidString)", directoryHint: .isDirectory)
- let file = SSHFile.url(in: folder)
+ let directory = try TemporaryDirectory()
+ let file = SSHFile.url(in: directory.url)
#expect(SSHFile.read(file) == [])
try FileManager.default.createDirectory(at: file, withIntermediateDirectories: true)
#expect(SSHFile.read(file) == nil)
diff --git a/Packages/PeelCore/Tests/PeelCoreTests/ShellFileTests.swift b/Packages/PeelCore/Tests/PeelCoreTests/ShellFileTests.swift
index 6d275676..32e3b265 100644
--- a/Packages/PeelCore/Tests/PeelCoreTests/ShellFileTests.swift
+++ b/Packages/PeelCore/Tests/PeelCoreTests/ShellFileTests.swift
@@ -88,17 +88,17 @@ struct ShellFileTests {
}
@Test func aMissingFileHasNothingOnAndOneThatCannotBeReadIsNotKnown() throws {
- let folder = FileManager.default.temporaryDirectory.appending(path: "ShellFileTests-\(UUID().uuidString)", directoryHint: .isDirectory)
- let file = ShellFile.url(in: folder)
+ let directory = try TemporaryDirectory()
+ let file = ShellFile.url(in: directory.url)
#expect(ShellFile.read(file) == .init())
try FileManager.default.createDirectory(at: file, withIntermediateDirectories: true)
#expect(ShellFile.read(file) == nil)
}
@Test func writingReplacesALinkInsteadOfWritingWhereItLeads() throws {
- let folder = FileManager.default.temporaryDirectory.appending(path: "ShellFileTests-\(UUID().uuidString)", directoryHint: .isDirectory)
- let file = ShellFile.url(in: folder)
- let theirs = folder.appending(path: "theirs")
+ let directory = try TemporaryDirectory()
+ let file = ShellFile.url(in: directory.url)
+ let theirs = directory.url.appending(path: "theirs")
try FileManager.default.createDirectory(at: file.deletingLastPathComponent(), withIntermediateDirectories: true)
try "theirs\n".write(to: theirs, atomically: true, encoding: .utf8)
try FileManager.default.createSymbolicLink(at: file, withDestinationURL: theirs)
@@ -175,14 +175,9 @@ struct PeelLinesCommandTests {
return output.status
}
- private func madeUpHome() throws -> URL {
- let home = FileManager.default.temporaryDirectory.appending(path: "PeelLines-\(UUID().uuidString)", directoryHint: .isDirectory)
- try FileManager.default.createDirectory(at: home, withIntermediateDirectories: true)
- return home
- }
-
@Test func theShellsCommandAddsTheLineAtTheEndOfZshrcAndPeelFindsIt() async throws {
- let home = try madeUpHome()
+ let directory = try TemporaryDirectory()
+ let home = directory.url
let file = ShellFile.url(in: home.appending(path: "Library/Application Support/Peel", directoryHint: .isDirectory))
let zshrc = home.appending(path: ".zshrc")
let line = ShellFile.line(sourcing: file, home: home)
@@ -197,7 +192,8 @@ struct PeelLinesCommandTests {
}
@Test func theShellsCommandKeepsTheLastLineOfAZshrcThatEndsWithoutANewline() async throws {
- let home = try madeUpHome()
+ let directory = try TemporaryDirectory()
+ let home = directory.url
let file = ShellFile.url(in: home.appending(path: "Library/Application Support/Peel", directoryHint: .isDirectory))
let zshrc = home.appending(path: ".zshrc")
#expect(ShellFile.write(.init(settings: [.autoCD]), to: file))
@@ -217,7 +213,8 @@ struct PeelLinesCommandTests {
}
@Test func theSSHCommandMakesAClosedFolderAndAddsTheLinesPeelFinds() async throws {
- let home = try madeUpHome()
+ let directory = try TemporaryDirectory()
+ let home = directory.url
let file = SSHFile.url(in: home.appending(path: "Library/Application Support/Peel", directoryHint: .isDirectory))
let config = home.appending(path: ".ssh/config")
let lines = SSHFile.lines(including: file, home: home)
diff --git a/Packages/PeelCore/Tests/PeelCoreTests/StringCatalogTests.swift b/Packages/PeelCore/Tests/PeelCoreTests/StringCatalogTests.swift
index 645fe81b..5dfefe70 100644
--- a/Packages/PeelCore/Tests/PeelCoreTests/StringCatalogTests.swift
+++ b/Packages/PeelCore/Tests/PeelCoreTests/StringCatalogTests.swift
@@ -191,8 +191,8 @@ import Testing
/// With no language declared, the checks above would have nothing to look at, so this runs them on a
/// catalog with one of each defect.
@Test func theRulesCatchWhatTheyAreFor() throws {
- let folder = FileManager.default.temporaryDirectory.appending(path: "StringCatalogTests-\(UUID().uuidString)")
- defer { try? FileManager.default.removeItem(at: folder) }
+ let directory = try TemporaryDirectory()
+ let folder = directory.url
try FileManager.default.createDirectory(at: folder.appending(path: "Localization/Peel"), withIntermediateDirectories: true)
func unit(_ value: String, _ state: String = "translated") -> [String: Any] {
["stringUnit": ["state": state, "value": value]]
diff --git a/Packages/PeelCore/Tests/PeelCoreTests/TemporaryDirectoryTests.swift b/Packages/PeelCore/Tests/PeelCoreTests/TemporaryDirectoryTests.swift
new file mode 100644
index 00000000..9412242d
--- /dev/null
+++ b/Packages/PeelCore/Tests/PeelCoreTests/TemporaryDirectoryTests.swift
@@ -0,0 +1,22 @@
+import Foundation
+import Testing
+
+struct TemporaryDirectoryTests {
+ /// It takes its folder away when the test ends.
+ @Test func onlyTemporaryDirectoryNamesTheTemporaryFolder() throws {
+ let this = URL(filePath: #filePath)
+ let folder = this.deletingLastPathComponent()
+ let walk = try #require(FileManager.default.enumerator(at: folder, includingPropertiesForKeys: nil))
+ var found: [String] = []
+ for case let file as URL in walk where file.pathExtension == "swift"
+ && ![this.lastPathComponent, "TemporaryDirectory.swift"].contains(file.lastPathComponent) {
+ let lines = try String(contentsOf: file, encoding: .utf8)
+ .split(separator: "\n", omittingEmptySubsequences: false)
+ for (index, line) in lines.enumerated()
+ where ["temporaryDirectory", "NSTemporaryDirectory", "mkdtemp"].contains(where: { line.contains($0) }) {
+ found.append("\(file.lastPathComponent):\(index + 1)")
+ }
+ }
+ #expect(found.isEmpty, "\(found.joined(separator: "\n"))")
+ }
+}
diff --git a/Packages/PeelCore/Tests/PeelCoreTests/TerminalToolTests.swift b/Packages/PeelCore/Tests/PeelCoreTests/TerminalToolTests.swift
index e96e03f2..7718a6d3 100644
--- a/Packages/PeelCore/Tests/PeelCoreTests/TerminalToolTests.swift
+++ b/Packages/PeelCore/Tests/PeelCoreTests/TerminalToolTests.swift
@@ -44,7 +44,8 @@ struct TerminalToolTests {
}
@Test func gitsOwnKeysInTheCommandsAreOnesTheGitOnThisMacKnows() async throws {
- let git = try #require(await GitConfig.find(home: FileManager.default.temporaryDirectory))
+ let home = try TemporaryDirectory()
+ let git = try #require(await GitConfig.find(home: home.url))
let known = try #require(await git.knownKeys())
let keys = TerminalTool.allCases.flatMap { $0.setup(prefix: Self.prefix) }.flatMap(\.lines)
.filter { $0.hasPrefix("git config --global ") }
@@ -99,7 +100,8 @@ struct TerminalToolTests {
}
@Test func aToolIsInstalledOnlyWhenHomebrewLinkedEveryFormulaItNeeds() throws {
- let prefix = FileManager.default.temporaryDirectory.appending(path: "TerminalToolTests-\(UUID().uuidString)", directoryHint: .isDirectory)
+ let directory = try TemporaryDirectory()
+ let prefix = directory.url
let cellar = prefix.appending(path: "Cellar/fzf-tab/1.3.0", directoryHint: .isDirectory)
try FileManager.default.createDirectory(at: cellar, withIntermediateDirectories: true)
try FileManager.default.createDirectory(at: prefix.appending(path: "opt"), withIntermediateDirectories: true)
diff --git a/Packages/PeelCore/Tests/PeelCoreTests/ZshHome.swift b/Packages/PeelCore/Tests/PeelCoreTests/ZshHome.swift
index 552c6488..0f914807 100644
--- a/Packages/PeelCore/Tests/PeelCoreTests/ZshHome.swift
+++ b/Packages/PeelCore/Tests/PeelCoreTests/ZshHome.swift
@@ -4,16 +4,20 @@ import Testing
/// A made-up home whose `.zshrc` sources Peel's file, the way a person's does once they add Peel's line, with
/// `before` above that line and `thenRun` below it.
-struct ZshHome {
+struct ZshHome: ~Copyable {
let home: URL
let peelFile: URL
+ private let directory: TemporaryDirectory
init(before: [String] = [], thenRun lines: [String] = []) throws {
- home = FileManager.default.temporaryDirectory.appending(path: "ZshHome-\(UUID().uuidString)", directoryHint: .isDirectory)
- peelFile = ShellFile.url(in: home.appending(path: "Library/Application Support/Peel", directoryHint: .isDirectory))
- try FileManager.default.createDirectory(at: home, withIntermediateDirectories: true)
+ let directory = try TemporaryDirectory()
+ let home = directory.url
+ let peelFile = ShellFile.url(in: home.appending(path: "Library/Application Support/Peel", directoryHint: .isDirectory))
try (before + [ShellFile.line(sourcing: peelFile, home: home)] + lines).joined(separator: "\n").appending("\n")
.write(to: home.appending(path: ".zshrc"), atomically: true, encoding: .utf8)
+ self.home = home
+ self.peelFile = peelFile
+ self.directory = directory
}
var environment: [String: String] {