Make FileSystem and directory path required

Author: yim-lee

Sources/PackageFingerprint/FilePackageFingerprintStorage.swift

@@ -17,14 +17,14 @@ import TSCUtility
 
 public struct FilePackageFingerprintStorage: PackageFingerprintStorage {
     let fileSystem: FileSystem
-    let directory: AbsolutePath
+    let directoryPath: AbsolutePath
 
     private let encoder: JSONEncoder
     private let decoder: JSONDecoder
 
-    init(customFileSystem: FileSystem? = nil, customDirectory: AbsolutePath? = nil) {
-        self.fileSystem = customFileSystem ?? localFileSystem
-        self.directory = customDirectory ?? self.fileSystem.dotSwiftPM.appending(component: "fingerprints")
+    init(fileSystem: FileSystem, directoryPath: AbsolutePath) {
+        self.fileSystem = fileSystem
+        self.directoryPath = directoryPath
 
         self.encoder = JSONEncoder.makeWithDefaults()
         self.decoder = JSONDecoder.makeWithDefaults()
@@ -88,7 +88,7 @@ public struct FilePackageFingerprintStorage: PackageFingerprintStorage {
     }
 
     private func loadFromDisk(package: PackageIdentity) throws -> PackageFingerprints {
-        let path = self.directory.appending(component: package.fingerprintFilename)
+        let path = self.directoryPath.appending(component: package.fingerprintFilename)
 
         guard self.fileSystem.exists(path) else {
             return .init()
@@ -104,22 +104,22 @@ public struct FilePackageFingerprintStorage: PackageFingerprintStorage {
     }
 
     private func saveToDisk(package: PackageIdentity, fingerprints: PackageFingerprints) throws {
-        if !self.fileSystem.exists(self.directory) {
-            try self.fileSystem.createDirectory(self.directory, recursive: true)
+        if !self.fileSystem.exists(self.directoryPath) {
+            try self.fileSystem.createDirectory(self.directoryPath, recursive: true)
         }
 
         let container = StorageModel.Container(fingerprints)
         let buffer = try encoder.encode(container)
 
-        let path = self.directory.appending(component: package.fingerprintFilename)
+        let path = self.directoryPath.appending(component: package.fingerprintFilename)
         try self.fileSystem.writeFileContents(path, bytes: ByteString(buffer))
     }
 
     private func withLock<T>(_ body: () throws -> T) throws -> T {
-        if !self.fileSystem.exists(self.directory) {
-            try self.fileSystem.createDirectory(self.directory, recursive: true)
+        if !self.fileSystem.exists(self.directoryPath) {
+            try self.fileSystem.createDirectory(self.directoryPath, recursive: true)
         }
-        return try self.fileSystem.withLock(on: self.directory, type: .exclusive, body)
+        return try self.fileSystem.withLock(on: self.directoryPath, type: .exclusive, body)
     }
 
     private func makeAsync<T>(_ closure: @escaping (Result<T, Error>) -> Void, on queue: DispatchQueue) -> (Result<T, Error>) -> Void {

Tests/PackageFingerprintTests/FilePackageFingerprintStorageTests.swift

@@ -19,7 +19,8 @@ import XCTest
 final class FilePackageFingerprintStorageTests: XCTestCase {
     func testHappyCase() throws {
         let mockFileSystem = InMemoryFileSystem()
-        let storage = FilePackageFingerprintStorage(customFileSystem: mockFileSystem)
+        let directoryPath = AbsolutePath("/fingerprints")
+        let storage = FilePackageFingerprintStorage(fileSystem: mockFileSystem, directoryPath: directoryPath)
         let registryURL = Foundation.URL(string: "https://example.packages.com")!
         let sourceControlURL = Foundation.URL(string: "https://example.com/mona/LinkedList.git")!
 
@@ -33,8 +34,8 @@ final class FilePackageFingerprintStorageTests: XCTestCase {
         try storage.put(package: otherPackage, version: Version("1.0.0"), fingerprint: .init(origin: .registry(registryURL), value: "checksum-1.0.0"))
 
         // A checksum file should have been created for each package
-        XCTAssertTrue(mockFileSystem.exists(storage.directory.appending(component: package.fingerprintFilename)))
-        XCTAssertTrue(mockFileSystem.exists(storage.directory.appending(component: otherPackage.fingerprintFilename)))
+        XCTAssertTrue(mockFileSystem.exists(storage.directoryPath.appending(component: package.fingerprintFilename)))
+        XCTAssertTrue(mockFileSystem.exists(storage.directoryPath.appending(component: otherPackage.fingerprintFilename)))
 
         // Fingerprints should be saved
         do {
@@ -67,7 +68,8 @@ final class FilePackageFingerprintStorageTests: XCTestCase {
 
     func testNotFound() throws {
         let mockFileSystem = InMemoryFileSystem()
-        let storage = FilePackageFingerprintStorage(customFileSystem: mockFileSystem)
+        let directoryPath = AbsolutePath("/fingerprints")
+        let storage = FilePackageFingerprintStorage(fileSystem: mockFileSystem, directoryPath: directoryPath)
         let registryURL = Foundation.URL(string: "https://example.packages.com")!
 
         let package = PackageIdentity.plain("mona.LinkedList")
@@ -91,7 +93,8 @@ final class FilePackageFingerprintStorageTests: XCTestCase {
 
     func testSingleFingerprintPerKind() throws {
         let mockFileSystem = InMemoryFileSystem()
-        let storage = FilePackageFingerprintStorage(customFileSystem: mockFileSystem)
+        let directoryPath = AbsolutePath("/fingerprints")
+        let storage = FilePackageFingerprintStorage(fileSystem: mockFileSystem, directoryPath: directoryPath)
         let registryURL = Foundation.URL(string: "https://example.packages.com")!
 
         let package = PackageIdentity.plain("mona.LinkedList")