SPB Git

Repository Public License

ScannerTests.swift 14.8 KB 314 lines swift

1// ORIX Clean — Packages/ORIXCleanCore/Tests/ORIXCleanCoreTests/ScannerTests.swift2// Description: Filesystem scanner tests: accounting accuracy, links, clones, sparse files, permissions, races, boundaries.3// Author: Simon-Pierre Boucher — contact@spboucher.ai4import Darwin5import Foundation6import Testing7@testable import ORIXCleanCore89@Suite struct ScannerTests {10    @Test func sizesMatchTheKernel() throws {11        let s = Sandbox()12        var logical: Int64 = 0, alloc: Int64 = 013        for (i, size) in [0, 1, 4095, 4096, 4097, 70_000, 1_500_000].enumerated() {14            let p = s.file("a/b\(i % 3)/f\(i).bin", size: size, seed: UInt8(i))15            logical += Int64(size); alloc += allocated(p)16        }17        let r = try s.scan()18        #expect(r.files == 7)19        #expect(r.directories == 5)20        #expect(r.tree[0].logicalSize == logical)21        #expect(r.tree[0].allocatedSize == alloc)22        #expect(r.tree[0].fileCount == 7)23        #expect(r.issues.isEmpty)24        let du = shell("/usr/bin/du", ["-sk", s.root]).output.split(separator: "\t").first.flatMap { Int64($0) } ?? -125        // du counts directory blocks too (0 on APFS).26        #expect(du * 1024 == alloc)27    }2829    @Test func unicodeAndLongNames() throws {30        let s = Sandbox()31        let names = ["été — résumé.txt", "日本語のファイル.txt", "emoji 🧹✨.txt", "e\u{301}.txt", String(repeating: "x", count: 240) + ".txt"]32        for n in names { s.text("u/" + n, "hello") }33        let r = try s.scan()34        let found = Set(r.tree.children(of: r.tree.index(forPath: s.path("u"))!).map { r.tree.name(of: $0) })35        let onDisk = Set(try FileManager.default.contentsOfDirectory(atPath: s.path("u")))36        #expect(found == onDisk)37        #expect(r.tree.fileExtension(of: r.tree.index(forPath: s.path("u/" + onDisk.first!))!) == "txt")38    }3940    @Test func pathsLongerThanPathMax() throws {41        let s = Sandbox()42        var rel = "deep"43        while (s.root + "/" + rel).utf8.count < 1500 { rel += "/" + String(repeating: "d", count: 200) }44        // Build with openat-relative calls because the full path is too long for mkdir.45        var fd = open(s.root, O_RDONLY)46        for part in rel.split(separator: "/") {47            mkdirat(fd, String(part), 0o755)48            let next = openat(fd, String(part), O_RDONLY)49            close(fd); fd = next50        }51        let f = openat(fd, "leaf.bin", O_CREAT | O_WRONLY, 0o644)52        write(f, "0123456789", 10)53        close(f); close(fd)54        let r = try s.scan()55        #expect(r.files == 1)56        #expect(r.tree[0].logicalSize == 10)57        #expect(r.issues.isEmpty)58        // Clean up the same way (removeItem cannot address the leaf).59        shell("/bin/rm", ["-rf", s.path("deep")])60    }6162    @Test func symlinkLoopsAreNotFollowed() throws {63        let s = Sandbox()64        s.file("real/data.bin", size: 10_000)65        symlink(s.root, s.path("real/loop"))66        symlink(s.path("real"), s.path("alias"))67        symlink("/nonexistent/target", s.path("dangling"))68        let r = try s.scan()69        #expect(r.files == 1)70        #expect(r.tree[0].logicalSize >= 10_000 && r.tree[0].logicalSize < 10_000 + 4096)71        let loop = r.tree.index(forPath: s.path("real/loop"))!72        #expect(r.tree[loop].flags.contains(.symlink))73        #expect(r.tree[loop].childCount == 0)74    }7576    @Test func hardLinksAreCountedOnce() throws {77        let s = Sandbox()78        let a = s.file("a.bin", size: 300_000)79        link(a, s.path("b.bin"))80        s.dir("sub"); link(a, s.path("sub/c.bin"))81        let r = try s.scan()82        #expect(r.files == 3)83        #expect(r.tree[0].logicalSize == 300_000)84        #expect(r.tree[0].allocatedSize == allocated(a))85        let dupes = r.tree.nodes.filter { $0.flags.contains(.hardLinkDuplicate) }.count86        #expect(dupes == 2)87    }8889    @Test func apfsClonesReportSharedBlocks() throws {90        let s = Sandbox()91        let a = s.file("orig.bin", size: 4_000_000)92        #expect(clonefile(a, s.path("clone.bin"), 0) == 0)93        let r = try s.scan()94        #expect(r.sharingMeasured)95        let o = r.tree[r.tree.index(forPath: a)!], c = r.tree[r.tree.index(forPath: s.path("clone.bin"))!]96        #expect(o.flags.contains(.mayShareBlocks) && c.flags.contains(.mayShareBlocks))97        // Each clone reports its full allocated size, but almost nothing private: removing one frees almost nothing.98        #expect(c.allocatedSize >= 4_000_000)99        #expect(c.privateSize >= 0 && c.privateSize < 100_000)100        #expect(r.tree[0].privateSize < r.tree[0].allocatedSize / 4)101        #expect(r.tree.cloneIDs[r.tree.index(forPath: a)!] == r.tree.cloneIDs[r.tree.index(forPath: s.path("clone.bin"))!])102    }103104    @Test func sparseFilesHaveSmallAllocation() throws {105        let s = Sandbox()106        let p = s.path("sparse.img")107        let fd = open(p, O_CREAT | O_WRONLY, 0o644)108        ftruncate(fd, 200_000_000)109        pwrite(fd, "end", 3, 199_999_000)110        close(fd)111        let r = try s.scan()112        let n = r.tree[r.tree.index(forPath: p)!]113        #expect(n.logicalSize == 200_000_000)114        #expect(n.allocatedSize < 1_000_000)115        #expect(n.allocatedSize == allocated(p))116    }117118    @Test func permissionDeniedIsReportedAndScanContinues() throws {119        let s = Sandbox()120        s.file("open/a.bin", size: 5000)121        s.file("locked/secret.bin", size: 9000)122        chmod(s.path("locked"), 0o000)123        defer { chmod(s.path("locked"), 0o700) }124        let r = try s.scan()125        #expect(r.files == 1)126        #expect(r.issues.count == 1)127        #expect(r.issues.first?.kind == .permissionDenied)128        #expect(r.issues.first?.path == s.path("locked"))129        #expect(r.tree[r.tree.index(forPath: s.path("locked"))!].flags.contains(.unreadable))130    }131132    @Test func missingAndNonDirectoryRoots() {133        let s = Sandbox()134        s.text("file.txt", "x")135        #expect(throws: ScanError.rootNotFound(s.path("nope"))) { try FileScanner(root: s.path("nope")).run() }136        #expect(throws: ScanError.rootNotDirectory(s.path("file.txt"))) { try FileScanner(root: s.path("file.txt")).run() }137    }138139    @Test func filesChangingAndDisappearingDuringScan() throws {140        let s = Sandbox()141        for d in 0 ..< 60 { for f in 0 ..< 40 { s.text("churn/d\(d)/f\(f).txt", String(repeating: "x", count: f * 10)) } }142        let stop = NSLock(); nonisolated(unsafe) var running = true143        let root = s.root144        let t = Thread {145            var round = 0146            while true {147                stop.lock(); let go = running; stop.unlock()148                if !go { break }149                let d = round % 60150                try? FileManager.default.removeItem(atPath: root + "/churn/d\(d)")151                try? FileManager.default.createDirectory(atPath: root + "/churn/d\(d)", withIntermediateDirectories: true)152                FileManager.default.createFile(atPath: root + "/churn/d\(d)/new\(round).txt", contents: Data(count: round % 500))153                round += 1154            }155        }156        t.start()157        for _ in 0 ..< 25 {158            let r = try s.scan()159            #expect(r.tree[0].logicalSize >= 0)160            #expect(r.issues.allSatisfy { $0.kind == .vanished || $0.kind == .ioError })161            var sum: Int64 = 0162            r.tree.forEachFile { _, n in sum += n.logicalSize }163            #expect(sum == r.tree[0].logicalSize)164        }165        stop.lock(); running = false; stop.unlock()166        while !t.isFinished { usleep(1000) }167    }168169    @Test func largeDirectoryTree() throws {170        let s = Sandbox()171        for d in 0 ..< 200 {172            let dir = s.dir("big/d\(d)")173            for f in 0 ..< 100 { close(open(dir + "/f\(f)", O_CREAT | O_WRONLY, 0o644)) }174        }175        let big = s.dir("flat")176        for f in 0 ..< 12_000 { close(open(big + "/file-\(f).dat", O_CREAT | O_WRONLY, 0o644)) }177        let r = try s.scan()178        #expect(r.files == 32_000)179        #expect(r.directories == 203)180        #expect(r.tree[r.tree.index(forPath: big)!].childCount == 12_000)181    }182183    @Test func packagesAreFlagged() throws {184        let s = Sandbox()185        s.file("Demo.app/Contents/MacOS/Demo", size: 50_000)186        s.file("Lib.photoslibrary/database/Photos.sqlite", size: 20_000)187        s.file("plain/file.bin", size: 30_000)188        let r = try s.scan()189        #expect(r.tree[r.tree.index(forPath: s.path("Demo.app"))!].flags.contains(.package))190        #expect(r.tree[r.tree.index(forPath: s.path("Lib.photoslibrary"))!].flags.contains(.package))191        #expect(!r.tree[r.tree.index(forPath: s.path("plain"))!].flags.contains(.package))192        let hits = TreeQuery.largestFiles(in: r.tree)193        #expect(hits.map { r.tree.name(of: $0.node) } == ["file.bin"])194        var f = FileFilter(); f.includePackageContents = true195        #expect(TreeQuery.largestFiles(in: r.tree, filter: f).count == 3)196    }197198    @Test func cancellationAndPause() throws {199        let s = Sandbox()200        for d in 0 ..< 50 { s.text("c/d\(d)/f.txt", "x") }201        let scanner = FileScanner(root: s.root)202        scanner.cancel()203        let r = try scanner.run()204        #expect(r.cancelled)205        #expect(r.files < 50)206207        let paused = FileScanner(root: s.root)208        paused.pause()209        nonisolated(unsafe) var result: ScanResult?210        let t = Thread { result = try? paused.run() }211        t.start()212        usleep(200_000)213        #expect(result == nil)214        #expect(paused.isPaused)215        #expect(paused.progress.files == 0)216        paused.resume()217        while !t.isFinished { usleep(1000) }218        #expect(result?.files == 50)219        #expect(result?.cancelled == false)220    }221222    @Test func excludedPathsAndRemoval() throws {223        let s = Sandbox()224        s.file("keep/a.bin", size: 10_000)225        s.file("skip/b.bin", size: 20_000)226        s.file("keep/sub/c.bin", size: 30_000)227        var o = ScanOptions(); o.excludedPaths = [s.path("skip")]228        let r = try s.scan(options: o)229        #expect(r.files == 2)230        #expect(r.tree[r.tree.index(forPath: s.path("skip"))!].flags.contains(.skipped))231        let sub = r.tree.index(forPath: s.path("keep/sub"))!232        let before = r.tree[0]233        r.tree.markRemoved(sub)234        #expect(r.tree[0].logicalSize == before.logicalSize - 30_000)235        #expect(r.tree[0].fileCount == 1)236        #expect(r.tree.sortedChildren(of: r.tree.index(forPath: s.path("keep"))!).count == 1)237        #expect(TreeQuery.largestFiles(in: r.tree).count == 1)238    }239240    @Test func mountedVolumeIsABoundaryAndRemovalIsAnError() throws {241        let s = Sandbox()242        s.file("local.bin", size: 10_000)243        let mount = s.dir("mnt")244        guard let v = TestVolume(mountAt: mount) else { Issue.record("hdiutil unavailable"); return }245        FileManager.default.createFile(atPath: mount + "/onvolume.bin", contents: Data(count: 500_000))246        let r = try s.scan()247        #expect(r.files == 1)248        #expect(r.tree[r.tree.index(forPath: mount)!].flags.contains(.boundary))249        var o = ScanOptions(); o.stayOnDevice = false250        #expect(try s.scan(options: o).files >= 2)251        // Scanning the volume itself works; after it is ejected the mount point is an empty local directory.252        #expect(try FileScanner(root: mount).run().tree[0].logicalSize >= 500_000)253        v.detach()254        #expect(try FileScanner(root: mount).run().files == 0)255    }256257    @Test func queriesAndCategories() throws {258        let s = Sandbox()259        s.file("m/movie.mp4", size: 900_000)260        s.file("m/song.mp3", size: 300_000)261        s.file("m/old.zip", size: 600_000)262        s.file("m/pic.JPG", size: 100_000)263        var times = [timeval(tv_sec: 1_500_000_000, tv_usec: 0), timeval(tv_sec: 1_500_000_000, tv_usec: 0)]264        utimes(s.path("m/old.zip"), &times)265        let r = try s.scan()266        #expect(TreeQuery.largestFiles(in: r.tree, limit: 2).map { r.tree.name(of: $0.node) } == ["movie.mp4", "old.zip"])267        var f = FileFilter(); f.categories = [.archive]268        #expect(TreeQuery.largestFiles(in: r.tree, filter: f).count == 1)269        f = FileFilter(); f.modifiedBefore = Date(timeIntervalSince1970: 1_600_000_000)270        #expect(TreeQuery.largestFiles(in: r.tree, filter: f).map { r.tree.name(of: $0.node) } == ["old.zip"])271        f = FileFilter(); f.nameContains = "PIC"272        #expect(TreeQuery.largestFiles(in: r.tree, filter: f).count == 1)273        f = FileFilter(); f.minimumSize = 500_000; f.sizeKind = .logical274        #expect(TreeQuery.largestFiles(in: r.tree, filter: f).count == 2)275        let cats = Dictionary(uniqueKeysWithValues: TreeQuery.categories(in: r.tree).map { ($0.category, $0.logical) })276        #expect(cats[.video] == 900_000 && cats[.audio] == 300_000 && cats[.archive] == 600_000 && cats[.image] == 100_000)277        #expect(TreeQuery.largestFolders(in: r.tree).first.map { r.tree.name(of: $0.node) } == "m")278        let m = Measure.item(s.path("m"))!279        #expect(m.logical == 1_900_000 && m.files == 4 && m.isDirectory)280        #expect(Volumes.containing(s.root) != nil)281        #expect(Volumes.mounted().contains { $0.isStartup })282    }283}284285@Suite struct TreemapTests {286    @Test func areasAreProportionalAndInsideTheParent() throws {287        let s = Sandbox()288        s.file("a/big.bin", size: 4_000_000); s.file("a/mid.bin", size: 2_000_000); s.file("b/small.bin", size: 1_000_000)289        for i in 0 ..< 50 { s.file("b/tiny\(i).bin", size: 300) }290        let tree = try s.scan().tree291        let rect = CGRect(x: 0, y: 0, width: 800, height: 600)292        var o = TreemapOptions(); o.padding = 0; o.header = 0; o.sizeKind = .logical; o.minimumArea = 40293        let cells = Treemap.layout(tree: tree, root: 0, in: rect, options: o)294        #expect(cells.allSatisfy { rect.insetBy(dx: -0.01, dy: -0.01).contains($0.rect) })295        let leaves = cells.filter { $0.isLeaf && $0.aggregateCount == 0 }296        let big = leaves.first { tree.name(of: $0.node) == "big.bin" }!, mid = leaves.first { tree.name(of: $0.node) == "mid.bin" }!297        let ratio = (big.rect.width * big.rect.height) / (mid.rect.width * mid.rect.height)298        #expect(abs(ratio - 2) < 0.01)299        let total = Double(tree[0].logicalSize)300        #expect(abs(Double(big.rect.width * big.rect.height) / Double(rect.width * rect.height) - 4_000_000 / total) < 0.001)301        // The 50 tiny files are merged into one honest aggregate cell.302        let aggregate = cells.first { $0.aggregateCount > 0 }303        #expect(aggregate?.aggregateCount == 50 && aggregate?.aggregateSize == 15_000)304        // Leaves do not overlap.305        for i in leaves.indices { for j in leaves.indices where j > i {306            let x = leaves[i].rect.intersection(leaves[j].rect)307            #expect(x.isNull || x.width * x.height < 0.5)308        } }309        #expect(Treemap.squarify(areas: [], in: rect).isEmpty)310        var culled = o; culled.visible = CGRect(x: 0, y: 0, width: 10, height: 10)311        #expect(Treemap.layout(tree: tree, root: 0, in: rect, options: culled).count < cells.count)312    }313}314
Files main
Menu

Theme