fixup

Author: tomerd

Sources/Commands/APIDigester.swift

@@ -49,8 +49,6 @@ struct APIDigesterBaselineDumper {
         self.baselineRevision = baselineRevision
         self.packageRoot = packageRoot
         self.inputBuildParameters = buildParameters
-        //self.manifestLoader = manifestLoader
-        //self.repositoryManager = repositoryManager
         self.apiDigesterTool = apiDigesterTool
         self.diags = diags
     }

Sources/Commands/SwiftTool.swift

@@ -556,9 +556,9 @@ public class SwiftTool {
             location: .init(
                 workingDirectory: buildPath,
                 editsDirectory: try editablesPath(),
-                resolvedVersionsFilePath: try resolvedVersionsFilePath()
+                resolvedVersionsFilePath: try resolvedVersionsFilePath(),
+                sharedCacheDirectory: cachePath
             ),
-            cachePath: cachePath,
             netrcFilePath: try netrcFilePath(),
             mirrors: self.getMirrorsConfig().mirrors,
             customManifestLoader: try getManifestLoader(), // FIXME: doe we really need to customize it?

Sources/PackageGraph/Pubgrub/PubgrubDependencyResolver.swift

@@ -108,7 +108,7 @@ public struct PubgrubDependencyResolver {
     /// Should resolver prefetch the containers.
     private let prefetchingEnabled: Bool
 
-    /// Skip updating containers while fetching them.
+    /// Update containers while fetching them.
     private let updateEnabled: Bool
 
     /// Resolver delegate

Sources/SPMTestSupport/MockWorkspace.swift

@@ -161,9 +161,9 @@ public final class MockWorkspace {
             location: .init (
                 workingDirectory: self.sandbox.appending(component: ".build"),
                 editsDirectory: self.sandbox.appending(component: "edits"),
-                resolvedVersionsFilePath: self.sandbox.appending(component: "Package.resolved")
+                resolvedVersionsFilePath: self.sandbox.appending(component: "Package.resolved"),
+                sharedCacheDirectory: self.fs.swiftPMCacheDirectory
             ),
-            cachePath: self.fs.swiftPMCacheDirectory,
             mirrors: self.config.mirrors,
             customToolsVersion: self.toolsVersion,
             customManifestLoader: self.manifestLoader,

Sources/Workspace/Workspace.swift

@@ -211,7 +211,7 @@ public class Workspace {
     /// Enable prefetching containers in resolver.
     fileprivate let resolverPrefetchingEnabled: Bool
 
-    /// Skip updating containers while fetching them.
+    /// Update containers while fetching them.
     fileprivate let resolverUpdateEnabled: Bool
 
     /// Write dependency resolver trace to a file.
@@ -238,9 +238,6 @@ public class Workspace {
     /// - Parameters:
     ///   - fileSystem: The file system to use.
     ///   - location: Workspace location configuration.
-    ///   - editablesPath: Path to store the editable versions of dependencies.
-    ///   - resolvedVersionsFilePath: Path to the Package.resolved file.
-    ///   - cachePath: Path to the shared cache.
     ///   - netrcFilePath: Path tot he netrc file.
     ///   - mirrors: Dependencies mirrors.
     ///   - customToolsVersion: A custom tools version.
@@ -259,7 +256,6 @@ public class Workspace {
     public init(
         fileSystem: FileSystem,
         location: Location,
-        cachePath: AbsolutePath? = .none,
         netrcFilePath: AbsolutePath? = .none,
         mirrors: DependencyMirrors? = .none,
         customToolsVersion: ToolsVersion? = .none,
@@ -281,14 +277,12 @@ public class Workspace {
         let toolsVersionLoader = ToolsVersionLoader()
         let manifestLoader = try customManifestLoader ?? ManifestLoader(toolchain: UserToolchain(destination: .hostDestination()).configuration)
         let repositoryProvider = customRepositoryProvider ?? GitRepositoryProvider()
-        let repositoriesPath = location.workingDirectory.appending(component: "repositories")
-        let repositoriesCachePath = cachePath.map { $0.appending(component: "repositories") }
         let repositoryManager = customRepositoryManager ?? RepositoryManager(
-            path: repositoriesPath,
+            path: location.repositoriesDirectory,
             provider: repositoryProvider,
             delegate: delegate.map(WorkspaceRepositoryManagerDelegate.init(workspaceDelegate:)),
             fileSystem: fileSystem,
-            cachePath: repositoriesCachePath)
+            cachePath: location.repositoriesSharedCacheDirectory)
         let httpClient = customHTTPClient ?? HTTPClient()
         let archiver = customArchiver ?? ZipArchiver()
         let mirrors = mirrors ?? DependencyMirrors()
@@ -374,9 +368,9 @@ public class Workspace {
             location: .init(
                 workingDirectory: dataPath,
                 editsDirectory: editablesPath,
-                resolvedVersionsFilePath: pinsFile
+                resolvedVersionsFilePath: pinsFile,
+                sharedCacheDirectory: cachePath
             ),
-            cachePath: cachePath,
             netrcFilePath: netrcFilePath,
             mirrors: config?.mirrors,
             customToolsVersion: currentToolsVersion,
@@ -602,7 +596,7 @@ extension Workspace {
         // These are the things we don't want to remove while cleaning.
         let protectedAssets = [
             repositoryManager.path,
-            self.location.checkoutsDirectory,
+            self.location.repositoriesCheckoutsDirectory,
             self.location.artifactsDirectory,
             state.path,
         ].map({ path -> String in
@@ -646,7 +640,7 @@ extension Workspace {
     ///       and notes.
     public func reset(with diagnostics: DiagnosticsEngine) {
         let removed = diagnostics.wrap {
-            try fileSystem.chmod(.userWritable, path: self.location.checkoutsDirectory, options: [.recursive, .onlyFiles])
+            try fileSystem.chmod(.userWritable, path: self.location.repositoriesCheckoutsDirectory, options: [.recursive, .onlyFiles])
             // Reset state.
             try self.resetState()
         }
@@ -1072,7 +1066,7 @@ extension Workspace {
 
         // Remove the existing checkout.
         do {
-            let oldCheckoutPath = self.location.checkoutsDirectory.appending(dependency.subpath)
+            let oldCheckoutPath = self.location.repositoriesCheckoutsDirectory.appending(dependency.subpath)
             try fileSystem.chmod(.userWritable, path: oldCheckoutPath, options: [.recursive, .onlyFiles])
             try fileSystem.removeFileTree(oldCheckoutPath)
         }
@@ -1370,7 +1364,7 @@ extension Workspace {
     fileprivate func createCacheDirectories(with diagnostics: DiagnosticsEngine) {
         do {
             try fileSystem.createDirectory(repositoryManager.path, recursive: true)
-            try fileSystem.createDirectory(self.location.checkoutsDirectory, recursive: true)
+            try fileSystem.createDirectory(self.location.repositoriesCheckoutsDirectory, recursive: true)
             try fileSystem.createDirectory(self.location.artifactsDirectory, recursive: true)
         } catch {
             diagnostics.emit(error)
@@ -1385,7 +1379,7 @@ extension Workspace {
     public func path(to dependency: ManagedDependency) -> AbsolutePath {
         switch dependency.state {
         case .checkout:
-            return self.location.checkoutsDirectory.appending(dependency.subpath)
+            return self.location.repositoriesCheckoutsDirectory.appending(dependency.subpath)
         case .edited(let path):
             return path ?? self.location.editsDirectory.appending(dependency.subpath)
         case .local:
@@ -2620,7 +2614,7 @@ extension Workspace {
     private func fetch(package: PackageReference) throws -> AbsolutePath {
         // If we already have it, fetch to update the repo from its remote.
         if let dependency = state.dependencies[forURL: package.location] {
-            let path = self.location.checkoutsDirectory.appending(dependency.subpath)
+            let path = self.location.repositoriesCheckoutsDirectory.appending(dependency.subpath)
 
             // Make sure the directory is not missing (we will have to clone again
             // if not).
@@ -2652,7 +2646,7 @@ extension Workspace {
         }
 
         // Clone the repository into the checkouts.
-        let path = self.location.checkoutsDirectory.appending(component: package.repository.basename)
+        let path = self.location.repositoriesCheckoutsDirectory.appending(component: package.repository.basename)
 
         try fileSystem.chmod(.userWritable, path: path, options: [.recursive, .onlyFiles])
         try fileSystem.removeFileTree(path)
@@ -2696,7 +2690,7 @@ extension Workspace {
         // Write the state record.
         state.dependencies.add(ManagedDependency(
             packageRef: package,
-            subpath: path.relative(to: self.location.checkoutsDirectory),
+            subpath: path.relative(to: self.location.repositoriesCheckoutsDirectory),
             checkoutState: checkoutState))
         try state.saveState()
 
@@ -2779,7 +2773,7 @@ extension Workspace {
         }
 
         // Remove the checkout.
-        let dependencyPath = self.location.checkoutsDirectory.appending(dependencyToRemove.subpath)
+        let dependencyPath = self.location.repositoriesCheckoutsDirectory.appending(dependencyToRemove.subpath)
         let workingCopy = try repositoryManager.provider.openWorkingCopy(at: dependencyPath)
         guard !workingCopy.hasUncommittedChanges() else {
             throw WorkspaceDiagnostics.UncommitedChanges(repositoryPath: dependencyPath)

Sources/Workspace/WorkspaceConfiguration.swift

@@ -27,12 +27,25 @@ extension Workspace {
         /// Path to the Package.resolved file.
         public var resolvedVersionsFilePath: AbsolutePath
 
-        /// Path to working repository clones (checkouts).
-        public var checkoutsDirectory: AbsolutePath {
+        /// Path to the shared cache
+        public var sharedCacheDirectory: AbsolutePath?
+
+        /// Path to the repositories shared cache.
+        public var repositoriesSharedCacheDirectory: AbsolutePath? {
+            self.sharedCacheDirectory.map { $0.appending(component: "repositories") }
+        }
+
+        /// Path to the repositories clones.
+        public var repositoriesDirectory: AbsolutePath {
+            self.workingDirectory.appending(component: "repositories")
+        }
+
+        /// Path to the repository checkouts.
+        public var repositoriesCheckoutsDirectory: AbsolutePath {
             self.workingDirectory.appending(component: "checkouts")
         }
 
-        // Path for downloaded binary artifacts.
+        /// Path to the downloaded binary artifacts.
         public var artifactsDirectory: AbsolutePath {
             self.workingDirectory.appending(component: "artifacts")
         }
@@ -43,14 +56,17 @@ extension Workspace {
         ///   - workingDirectory: Path to working directory for this workspace.
         ///   - editsDirectory: Path to store the editable versions of dependencies.
         ///   - resolvedVersionsFile: Path to the Package.resolved file.
+        ///   - sharedCachePath: Path to the sharedCache
         public init(
             workingDirectory: AbsolutePath,
             editsDirectory: AbsolutePath,
-            resolvedVersionsFilePath: AbsolutePath)
-        {
+            resolvedVersionsFilePath: AbsolutePath,
+            sharedCacheDirectory: AbsolutePath? = .none
+        ) {
             self.workingDirectory = workingDirectory
             self.editsDirectory = editsDirectory
             self.resolvedVersionsFilePath = resolvedVersionsFilePath
+            self.sharedCacheDirectory = sharedCacheDirectory
         }
 
         /// Create a new workspace location.

Tests/WorkspaceTests/WorkspaceTests.swift

@@ -141,9 +141,9 @@ final class WorkspaceTests: XCTestCase {
                     location: .init(
                         workingDirectory: sandbox.appending(component: ".build"),
                         editsDirectory: sandbox.appending(component: "edits"),
-                        resolvedVersionsFilePath: sandbox.appending(component: "Package.resolved")
+                        resolvedVersionsFilePath: sandbox.appending(component: "Package.resolved"),
+                        sharedCacheDirectory: fs.swiftPMCacheDirectory.appending(component: "repositories")
                     ),
-                    cachePath: fs.swiftPMCacheDirectory.appending(component: "repositories"),
                     customManifestLoader: manifestLoader,
                     delegate: MockWorkspaceDelegate()
                 )
@@ -1706,13 +1706,13 @@ final class WorkspaceTests: XCTestCase {
 
         // Sanity checks.
         XCTAssert(fs.exists(buildArtifact))
-        XCTAssert(fs.exists(ws.location.checkoutsDirectory))
+        XCTAssert(fs.exists(ws.location.repositoriesCheckoutsDirectory))
 
         // Check clean.
         workspace.checkClean { diagnostics in
             // Only the build artifact should be removed.
             XCTAssertFalse(fs.exists(buildArtifact))
-            XCTAssert(fs.exists(ws.location.checkoutsDirectory))
+            XCTAssert(fs.exists(ws.location.repositoriesCheckoutsDirectory))
             XCTAssert(fs.exists(ws.location.workingDirectory))
 
             XCTAssertNoDiagnostics(diagnostics)
@@ -1728,7 +1728,7 @@ final class WorkspaceTests: XCTestCase {
         workspace.checkReset { diagnostics in
             // Only the build artifact should be removed.
             XCTAssertFalse(fs.exists(buildArtifact))
-            XCTAssertFalse(fs.exists(ws.location.checkoutsDirectory))
+            XCTAssertFalse(fs.exists(ws.location.repositoriesCheckoutsDirectory))
             XCTAssertFalse(fs.exists(ws.location.workingDirectory))
 
             XCTAssertNoDiagnostics(diagnostics)
@@ -2044,7 +2044,7 @@ final class WorkspaceTests: XCTestCase {
             XCTAssertNoDiagnostics(diagnostics)
         }
 
-        try fs.removeFileTree(workspace.getOrCreateWorkspace().location.checkoutsDirectory)
+        try fs.removeFileTree(workspace.getOrCreateWorkspace().location.repositoriesCheckoutsDirectory)
 
         workspace.checkPackageGraph(roots: ["Root"]) { graph, diagnostics in
             PackageGraphTester(graph) { result in