added -cache-path option

Author: tgymnich

Sources/Commands/Options.swift

@@ -24,6 +24,9 @@ public class ToolOptions {
     /// The custom build directory, if provided.
     public var buildPath: AbsolutePath?
 
+    /// The custom cache directory, if provided.
+    public var cachePath: AbsolutePath?
+
     /// The custom working directory that the tool should operate in (deprecated).
     public var chdir: AbsolutePath?
 

Sources/Commands/SwiftTool.swift

@@ -249,6 +249,9 @@ public class SwiftTool<Options: ToolOptions> {
     /// Path to the build directory.
     let buildPath: AbsolutePath
 
+    /// Path to the repository cache.
+    let cachePath: AbsolutePath
+
     /// Reference to the argument parser.
     let parser: ArgumentParser
 
@@ -330,9 +333,15 @@ public class SwiftTool<Options: ToolOptions> {
         binder.bind(
             option: parser.add(
                 option: "--build-path", kind: PathArgument.self,
-                usage: "Specify build/cache directory [default: ./.build]"),
+                usage: "Specify build directory [default: ./.build]"),
             to: { $0.buildPath = $1.path })
 
+        binder.bind(
+            option: parser.add(
+                option: "--cache-path", kind: PathArgument.self,
+                usage: "Specify the cache directory [default: \(Workspace.globalCachePath.prettyPath(cwd: localFileSystem.homeDirectory))]"),
+            to: { $0.cachePath = $1.path })
+
         binder.bind(
             option: parser.add(
                 option: "--chdir", shortName: "-C", kind: PathArgument.self),
@@ -537,12 +546,14 @@ public class SwiftTool<Options: ToolOptions> {
 
         // Create local variables to use while finding build path to avoid capture self before init error.
         let customBuildPath = options.buildPath
+        let customCachePath = options.cachePath
         let packageRoot = findPackageRoot()
 
         self.packageRoot = packageRoot
         self.buildPath = getEnvBuildPath(workingDir: cwd) ??
             customBuildPath ??
             (packageRoot ?? cwd).appending(component: ".build")
+        self.cachePath = getEnvCachePath(workingDir: cwd) ?? customCachePath ?? Workspace.globalCachePath
     }
 
     class func postprocessArgParserResult(result: ArgumentParser.Result, diagnostics: DiagnosticsEngine) throws {
@@ -619,6 +630,7 @@ public class SwiftTool<Options: ToolOptions> {
         let provider = GitRepositoryProvider(processSet: processSet)
         let workspace = Workspace(
             dataPath: buildPath,
+            cachePath: cachePath,
             editablesPath: try editablesPath(),
             pinsFile: try resolvedFilePath(),
             manifestLoader: try getManifestLoader(),
@@ -920,6 +932,14 @@ private func getEnvBuildPath(workingDir: AbsolutePath) -> AbsolutePath? {
     return AbsolutePath(env, relativeTo: workingDir)
 }
 
+/// Returns the cache path from the environment, if present.
+private func getEnvCachePath(workingDir: AbsolutePath) -> AbsolutePath? {
+    // Don't rely on build path from env for SwiftPM's own tests.
+    guard ProcessEnv.vars["SWIFTPM_TESTS_MODULECACHE"] == nil else { return nil }
+    guard let env = ProcessEnv.vars["SWIFTPM_CACHE_DIR"] else { return nil }
+    return AbsolutePath(env)
+}
+
 /// Returns the sandbox profile to be used when parsing manifest on macOS.
 private func sandboxProfile(allowedDirectories: [AbsolutePath]) -> String {
     let stream = BufferedOutputByteStream()

Sources/Workspace/Workspace.swift

@@ -370,6 +370,14 @@ public class Workspace {
 
     fileprivate let additionalFileRules: [FileRuleDescription]
 
+    /// The default location of the git repository cache
+    public static let globalCachePath: AbsolutePath = {
+        guard let cacheURL = FileManager.default.urls(for: .cachesDirectory, in: .userDomainMask).first else {
+            return localFileSystem.homeDirectory.appending(components: ".swiftpm", "repositories")
+        }
+        return AbsolutePath(cacheURL.path).appending(components: "org.swift.swiftpm", "repositories")
+    }()
+
     /// Create a new package workspace.
     ///
     /// This will automatically load the persisted state for the package, if
@@ -386,6 +394,7 @@ public class Workspace {
     /// - Throws: If the state was present, but could not be loaded.
     public init(
         dataPath: AbsolutePath,
+        cachePath: AbsolutePath? = nil,
         editablesPath: AbsolutePath,
         pinsFile: AbsolutePath,
         manifestLoader: ManifestLoaderProtocol,
@@ -421,16 +430,8 @@ public class Workspace {
         self.resolvedFile = pinsFile
         self.additionalFileRules = additionalFileRules
 
-        /// The default location of the git repository cache
-        let repositoriesPath: AbsolutePath = {
-            guard let cacheURL = FileManager.default.urls(for: .cachesDirectory, in: .userDomainMask).first else {
-                return localFileSystem.homeDirectory.appending(components: ".swiftpm", "repositories")
-            }
-            return AbsolutePath(cacheURL.path).appending(components: "org.swift.swiftpm", "repositories")
-        }()
-
         let repositoryManager = repositoryManager ?? RepositoryManager(
-            path: repositoriesPath,
+            path: cachePath ?? Workspace.globalCachePath,
             provider: repositoryProvider,
             delegate: delegate.map(WorkspaceRepositoryManagerDelegate.init(workspaceDelegate:)),
             fileSystem: fileSystem)
@@ -633,6 +634,7 @@ extension Workspace {
 
         repositoryManager.reset()
         try? fileSystem.removeFileTree(dataPath)
+        // Reset global cache
         try? fileSystem.removeFileTree(repositoryManager.path)
     }