Fixes for the system managed detection and installation logic

Author: cmcgee1024

Sources/Swiftly/Init.swift

@@ -138,26 +138,8 @@ internal struct Init: SwiftlyCommand {
 
         guard var config else { throw Error(message: "Configuration could not be set") }
 
-        let swiftlyBin = Swiftly.currentPlatform.swiftlyBinDir.appendingPathComponent("swiftly", isDirectory: false)
-
-        let cmd = URL(fileURLWithPath: CommandLine.arguments[0])
-        let systemManagedSwiftlyBin = try Swiftly.currentPlatform.systemManagedBinary(CommandLine.arguments[0])
-
-        // Don't move the binary if it's already in the right place, this is being invoked inside an xctest, or it is a system managed binary
-        if cmd != swiftlyBin && !cmd.path.hasSuffix("xctest") && systemManagedSwiftlyBin == nil {
-            SwiftlyCore.print("Moving swiftly into the installation directory...")
-
-            if swiftlyBin.fileExists() {
-                try FileManager.default.removeItem(at: swiftlyBin)
-            }
-
-            do {
-                try FileManager.default.moveItem(at: cmd, to: swiftlyBin)
-            } catch {
-                try FileManager.default.copyItem(at: cmd, to: swiftlyBin)
-                SwiftlyCore.print("Swiftly has been copied into the installation directory. You can remove '\(cmd.path)'. It is no longer needed.")
-            }
-        }
+        // Move our executable over to the correct place
+        let _ = try Swiftly.currentPlatform.findSwiftlyBin(installSwiftly: true)
 
         if overwrite || !FileManager.default.fileExists(atPath: envFile.path) {
             SwiftlyCore.print("Creating shell environment file for the user...")

Sources/Swiftly/Install.swift

@@ -243,22 +243,14 @@ struct Install: SwiftlyCommand {
 
         var pathChanged = false
 
-        // Don't create the proxies in the tests
-        if CommandLine.arguments.count > 0 && !CommandLine.arguments[0].hasSuffix("xctest") {
+        // Create proxies if we have a location where we can point them
+        if let proxyTo = try? Swiftly.currentPlatform.findSwiftlyBin(installSwiftly: false) {
             // Ensure swiftly doesn't overwrite any existing executables without getting confirmation first.
-            let swiftlyBin = Swiftly.currentPlatform.swiftlyBinDir.appendingPathComponent("swiftly", isDirectory: false)
-            let systemManagedSwiftlyBin = try Swiftly.currentPlatform.systemManagedBinary(CommandLine.arguments[0])
             let swiftlyBinDir = Swiftly.currentPlatform.swiftlyBinDir
             let swiftlyBinDirContents = (try? FileManager.default.contentsOfDirectory(atPath: swiftlyBinDir.path)) ?? [String]()
             let toolchainBinDir = Swiftly.currentPlatform.findToolchainBinDir(version)
             let toolchainBinDirContents = try FileManager.default.contentsOfDirectory(atPath: toolchainBinDir.path)
 
-            let proxyTo = if let systemManagedSwiftlyBin = systemManagedSwiftlyBin {
-                systemManagedSwiftlyBin
-            } else {
-                swiftlyBin.path
-            }
-
             let existingProxies = swiftlyBinDirContents.filter { bin in
                 do {
                     let linkTarget = try FileManager.default.destinationOfSymbolicLink(atPath: swiftlyBinDir.appendingPathComponent(bin).path)

Sources/SwiftlyCore/Platform.swift

@@ -267,27 +267,61 @@ extension Platform {
         }
     }
 
-    public func systemManagedBinary(_ cmd: String) throws -> String? {
-        let userHome = FileManager.default.homeDirectoryForCurrentUser
-        let binLocs = [cmd] + ProcessInfo.processInfo.environment["PATH"]!.components(separatedBy: ":").map { $0 + "/" + cmd }
-        var bin: String?
-        for binLoc in binLocs {
-            if FileManager.default.fileExists(atPath: binLoc) {
-                bin = binLoc
-                break
-            }
+    // Find the resting place for the swiftly binary, installing ourselves there if possible.
+    public func findSwiftlyBin(installSwiftly: Bool) throws -> String? {
+        let swiftlyHomeBin = self.swiftlyBinDir.appendingPathComponent("swiftly", isDirectory: false).path
+
+        // First, let's find out where we are.
+        let cmd = CommandLine.arguments[0]
+        let cmdAbsolute = if cmd.hasPrefix("/") {
+            cmd
+        } else {
+            ([FileManager.default.currentDirectoryPath] + (ProcessInfo.processInfo.environment["PATH"]?.components(separatedBy: ":") ?? [])).map {
+                $0 + "/" + cmd
+            }.filter {
+                FileManager.default.fileExists(atPath: $0)
+            }.first
+        }
+
+        // We couldn't find outselves in the usual places, so if we're not going to be installing
+        // swiftly then we can assume that we are running from the final location.
+        if cmdAbsolute == nil && !installSwiftly && FileManager.default.fileExists(atPath: swiftlyHomeBin) {
+            return swiftlyHomeBin
         }
-        guard let bin = bin else {
-            throw Error(message: "Could not locate source of \(cmd) binary in either the PATH, relative, or absolute path")
+
+        // If we are system managed then we know where swiftly should be, no installation necessary.
+        let userHome = FileManager.default.homeDirectoryForCurrentUser
+        if let cmdAbsolute, !cmdAbsolute.hasPrefix(userHome.path + "/") && (cmdAbsolute.hasPrefix("/usr/") || cmdAbsolute.hasPrefix("/opt/") || cmdAbsolute.hasPrefix("/bin/")) {
+            return cmdAbsolute
         }
 
-        // If the binary is in the user's home directory, or is not in system locations ("/usr", "/opt", "/bin")
-        //  then it is expected to be outside of a system package location and we manage the binary ourselves.
-        if bin.hasPrefix(userHome.path + "/") || (!bin.hasPrefix("/usr") && !bin.hasPrefix("/opt") && !bin.hasPrefix("/bin")) {
+        // If we're running inside an xctest or we couldn't determine our absolute path then
+        //  we don't install nor do we have a swiftly location for the proxies.
+        guard let cmdAbsolute, !cmdAbsolute.hasSuffix("xctest") else {
             return nil
         }
 
-        return bin
+        // We're installed and running in our bin directory, return our location
+        if cmdAbsolute == swiftlyHomeBin {
+            return swiftlyHomeBin
+        }
+
+        if installSwiftly {
+            SwiftlyCore.print("Installing swiftly in \(swiftlyHomeBin)...")
+
+            if FileManager.default.fileExists(atPath: swiftlyHomeBin) {
+                try FileManager.default.removeItem(atPath: swiftlyHomeBin)
+            }
+
+            do {
+                try FileManager.default.moveItem(atPath: cmdAbsolute, toPath: swiftlyHomeBin)
+            } catch {
+                try FileManager.default.copyItem(atPath: cmdAbsolute, toPath: swiftlyHomeBin)
+                SwiftlyCore.print("Swiftly has been copied into the installation directory. You can remove '\(cmd)'. It is no longer needed.")
+            }
+        }
+
+        return FileManager.default.fileExists(atPath: swiftlyHomeBin) ? swiftlyHomeBin : nil
     }
 
     public func findToolchainBinDir(_ toolchain: ToolchainVersion) -> URL {