Add ability to self uninstall swiftly

Documentation/SwiftlyDocs.docc/swiftly-cli-reference.md

@@ -545,6 +545,36 @@ The script will receive the argument '+abcde' followed by '+xyz'.
 
 
 
+## self-uninstall
+
+Uninstall swiftly itself.
+
+```
+swiftly self-uninstall [--assume-yes] [--verbose] [--version] [--help]
+```
+
+**--assume-yes:**
+
+*Disable confirmation prompts by assuming 'yes'*
+
+
+**--verbose:**
+
+*Enable verbose reporting from swiftly*
+
+
+**--version:**
+
+*Show the version.*
+
+
+**--help:**
+
+*Show help information.*
+
+
+
+
 ## link
 
 Link swiftly so it resumes management of the active toolchain.

README.md

@@ -59,7 +59,12 @@ This command checks to see if there are new versions of swiftly itself and upgra
 
 ## Uninstalling swiftly
 
-Currently, only manual uninstallation is supported. If you need to uninstall swiftly, please follow the instructions below:
+swiftly can be safely removed with the following command:
+
+`swiftly self-uninstall`
+
+<details>
+<summary>If you want to do so manually, please follow the instructions below:</summary>
 
 NOTE: This will not uninstall any toolchains you have installed unless you do so manually with `swiftly uninstall all`.
 
@@ -76,6 +81,8 @@ NOTE: This will not uninstall any toolchains you have installed unless you do so
 
 4. Restart your shell and check you have correctly removed the swiftly environment.
 
+</details>
+
 ## Contributing
 
 Welcome to the Swift community!

Sources/Swiftly/SelfUninstall.swift

@@ -0,0 +1,109 @@
+// SelfUninstall.swift
+
+import ArgumentParser
+import Foundation
+import SwiftlyCore
+import SystemPackage
+
+struct SelfUninstall: SwiftlyCommand {
+    static let configuration = CommandConfiguration(
+        abstract: "Uninstall swiftly itself."
+    )
+
+    @OptionGroup var root: GlobalOptions
+
+    private enum CodingKeys: String, CodingKey {
+        case root
+    }
+
+    mutating func run() async throws {
+        try await self.run(Swiftly.createDefaultContext())
+    }
+
+    mutating func run(_ ctx: SwiftlyCoreContext) async throws {
+        _ = try await validateSwiftly(ctx)
+        let swiftlyBin = Swiftly.currentPlatform.swiftlyBinDir(ctx)
+
+        guard try await fs.exists(atPath: swiftlyBin) else {
+            throw SwiftlyError(
+                message: "Self uninstall doesn't work when swiftly has been installed externally. Please uninstall it from the source where you installed it in the first place."
+            )
+        }
+
+        if !self.root.assumeYes {
+            await ctx.print("""
+            You are about to uninstall swiftly.
+            This will remove the swiftly binary and all files in the swiftly home directory.
+            Installed toolchains will not be removed. To remove them, run `swiftly uninstall all`.
+            This action is irreversible.
+            """)
+            guard await ctx.promptForConfirmation(defaultBehavior: true) else {
+                throw SwiftlyError(message: "swiftly installation has been cancelled")
+            }
+        }
+
+        try await Self.execute(ctx, verbose: self.root.verbose)
+    }
+
+    static func execute(_ ctx: SwiftlyCoreContext, verbose: Bool) async throws {
+        await ctx.print("Uninstalling swiftly...")
+
+        let userHome = ctx.mockedHomeDir ?? fs.home
+        let swiftlyHome = Swiftly.currentPlatform.swiftlyHomeDir(ctx)
+        let swiftlyBin = Swiftly.currentPlatform.swiftlyBinDir(ctx)
+
+        let commentLine = """
+        # Added by swiftly
+        """
+        let fishSourceLine = """
+        source "\(swiftlyHome / "env.fish")"
+        """
+
+        let shSourceLine = """
+        . "\(swiftlyHome / "env.sh")"
+        """
+
+        var profilePaths: [FilePath] = [
+            userHome / ".zprofile",
+            userHome / ".bash_profile",
+            userHome / ".bash_login",
+            userHome / ".profile",
+        ]
+
+        // Add fish shell config path
+        if let xdgConfigHome = ProcessInfo.processInfo.environment["XDG_CONFIG_HOME"] {
+            profilePaths.append(FilePath(xdgConfigHome) / "fish/conf.d/swiftly.fish")
+        } else {
+            profilePaths.append(userHome / ".config/fish/conf.d/swiftly.fish")
+        }
+
+        await ctx.print("Cleaning up shell profile files...")
+
+        // Remove swiftly source lines from shell profiles
+        for path in profilePaths where try await fs.exists(atPath: path) {
+            if verbose {
+                await ctx.print("Checking \(path)...")
+            }
+            let isFish = path.extension == "fish"
+            let sourceLine = isFish ? fishSourceLine : shSourceLine
+            let contents = try String(contentsOf: path, encoding: .utf8)
+            let linesToRemove = [sourceLine, commentLine]
+            var updatedContents = contents
+            for line in linesToRemove where contents.contains(line) {
+                updatedContents = updatedContents.replacingOccurrences(of: line, with: "")
+                try Data(updatedContents.utf8).write(to: path, options: [.atomic])
+                if verbose {
+                    await ctx.print("\(path) was updated to remove swiftly line: \(line)")
+                }
+            }
+        }
+
+        await ctx.print("Removing swiftly binary at \(swiftlyBin)...")
+        try await fs.remove(atPath: swiftlyBin)
+
+        await ctx.print("Removing swiftly home directory at \(swiftlyHome)...")
+        try await fs.remove(atPath: swiftlyHome)
+
+        await ctx.print("Swiftly uninstalled successfully.")
+    }
+}

Sources/Swiftly/Swiftly.swift

@@ -46,6 +46,7 @@ public struct Swiftly: SwiftlyCommand {
             Init.self,
             SelfUpdate.self,
             Run.self,
+            SelfUninstall.self,
             Link.self,
             Unlink.self,
         ]

Tests/SwiftlyTests/SelfUninstallTests.swift

@@ -0,0 +1,96 @@
+import Foundation
+@testable import Swiftly
+@testable import SwiftlyCore
+import SystemPackage
+import Testing
+
+@Suite struct SelfUninstallTests {
+    // Test that swiftly uninstall successfully removes the swiftly binary and the bin directory
+    @Test(.mockedSwiftlyVersion()) func removesHomeAndBinDir() async throws {
+        try await SwiftlyTests.withTestHome {
+            let swiftlyBinDir = Swiftly.currentPlatform.swiftlyBinDir(SwiftlyTests.ctx)
+            let swiftlyHomeDir = Swiftly.currentPlatform.swiftlyHomeDir(SwiftlyTests.ctx)
+            #expect(
+                try await fs.exists(atPath: swiftlyBinDir) == true,
+                "swiftly bin directory should exist"
+            )
+            #expect(
+                try await fs.exists(atPath: swiftlyHomeDir) == true,
+                "swiftly home directory should exist"
+            )
+
+            try await SwiftlyTests.runCommand(SelfUninstall.self, ["self-uninstall"])
+
+            #expect(
+                try await fs.exists(atPath: swiftlyBinDir) == false,
+                "swiftly bin directory should be removed"
+            )
+            #expect(
+                try await fs.exists(atPath: swiftlyHomeDir) == false,
+                "swiftly home directory should be removed"
+            )
+        }
+    }
+
+    @Test(.mockedSwiftlyVersion(), .withShell("/bin/bash")) func removesEntryFromShellProfile_bash() async throws {
+        try await self.shellProfileRemovalTest()
+    }
+
+    @Test(.mockedSwiftlyVersion(), .withShell("/bin/zsh")) func removesEntryFromShellProfile_zsh() async throws {
+        try await self.shellProfileRemovalTest()
+    }
+
+    @Test(.mockedSwiftlyVersion(), .withShell("/bin/fish")) func removesEntryFromShellProfile_fish() async throws {
+        try await self.shellProfileRemovalTest()
+    }
+
+    func shellProfileRemovalTest() async throws {
+        try await SwiftlyTests.withTestHome {
+            // Fresh user without swiftly installed
+            try? await fs.remove(atPath: Swiftly.currentPlatform.swiftlyConfigFile(SwiftlyTests.ctx))
+            try await SwiftlyTests.runCommand(Init.self, ["init", "--assume-yes", "--skip-install"])
+
+            let fishSourceLine = """
+            # Added by swiftly
+
+            source "\(Swiftly.currentPlatform.swiftlyHomeDir(SwiftlyTests.ctx) / "env.fish")"
+            """
+
+            let shSourceLine = """
+            # Added by swiftly
+
+            . "\(Swiftly.currentPlatform.swiftlyHomeDir(SwiftlyTests.ctx) / "env.sh")"
+            """
+
+            // add a few random lines to the profile file(s), both before and after the source line
+            for p in [".profile", ".zprofile", ".bash_profile", ".bash_login", ".config/fish/conf.d/swiftly.fish"] {
+                let profile = SwiftlyTests.ctx.mockedHomeDir! / p
+                if try await fs.exists(atPath: profile) {
+                    if let profileContents = try? String(contentsOf: profile) {
+                        let newContents = "# Random line before swiftly source\n" +
+                            profileContents +
+                            "\n# Random line after swiftly source"
+                        try Data(newContents.utf8).write(to: profile, options: [.atomic])
+                    }
+                }
+            }
+
+            try await SwiftlyTests.runCommand(SelfUninstall.self, ["self-uninstall", "--assume-yes"])
+
+            for p in [".profile", ".zprofile", ".bash_profile", ".bash_login", ".config/fish/conf.d/swiftly.fish"] {
+                let profile = SwiftlyTests.ctx.mockedHomeDir! / p
+                if try await fs.exists(atPath: profile) {
+                    if let profileContents = try? String(contentsOf: profile) {
+                        // check that the source line is removed
+                        let isFishProfile = profile.extension == "fish"
+                        let sourceLine = isFishProfile ? fishSourceLine : shSourceLine
+                        #expect(
+                            !profileContents.contains(sourceLine),
+                            "swiftly source line should be removed from \(profile.string)"
+                        )
+                    }
+                }
+            }
+        }
+    }
+}

Tests/SwiftlyTests/SwiftlyTests.swift

@@ -159,6 +159,27 @@ extension Trait where Self == MockedSwiftlyVersionTrait {
     static func mockedSwiftlyVersion(_ name: String = "testHome") -> Self { Self(name) }
 }
 
+struct WithShellTrait: TestTrait, TestScoping {
+    let shell: String
+
+    init(_ shell: String) {
+        self.shell = shell
+    }
+
+    func provideScope(for _: Test, testCase _: Test.Case?, performing function: @Sendable () async throws -> Void) async throws {
+        var ctx = SwiftlyTests.ctx
+        ctx.mockedShell = self.shell
+        try await SwiftlyTests.$ctx.withValue(ctx) {
+            try await function()
+        }
+    }
+}
+
+extension Trait where Self == WithShellTrait {
+    /// Run the test with the provided shell.
+    static func withShell(_ shell: String) -> Self { Self(shell) }
+}
+
 struct MockHomeToolchainsTrait: TestTrait, TestScoping {
     var name: String = "testHome"
     var toolchains: Set<ToolchainVersion> = .allToolchains()