Add a E2E test for testing swiftly installation in a custom location

Author: cmcgee1024

.github/workflows/pull_request.yml

@@ -94,6 +94,28 @@ jobs:
       - name: Extract and Run Workflow Tests
         run: cp swiftly-*.tar.gz /root/swiftly.tar.gz && cp test-swiftly-*.tar.gz /root && cd /root && tar zxf test-swiftly-*.tar.gz && ./test-swiftly -y ./swiftly.tar.gz
 
+  release-custom-install-test:
+    name: Test Release - Custom Install Location
+    needs: releasebuildcheck
+    runs-on: ubuntu-latest
+    container:
+      image: "ubuntu:24.04"
+    steps:
+      - name: Prepare System
+        run: apt-get update && DEBIAN_FRONTEND=noninteractive TZ=Etc/UTC apt-get -y install ca-certificates gpg tzdata ${{matrix.shell.pkg}} && chs
+h -s ${{matrix.shell.bin}}
+      - name: Download Release
+        uses: actions/download-artifact@v4
+        with:
+          name: swiftly-release-x86_64
+      - name: Download Tests
+        uses: actions/download-artifact@v4
+        with:
+          name: swiftly-tests-x86_64
+      - name: Extract and Run Workflow Tests
+        run: cp swiftly-*.tar.gz /root/swiftly.tar.gz && cp test-swiftly-*.tar.gz /root && cd /root && tar zxf test-swiftly-*.tar.gz && ./test-swif
+tly -y --custom-location ./swiftly.tar.gz
+
   formatcheck:
     name: Format Check
     runs-on: ubuntu-latest

Sources/TestSwiftly/TestSwiftly.swift

@@ -21,6 +21,9 @@ struct TestSwiftly: AsyncParsableCommand {
     @Flag(name: [.customShort("y"), .long], help: "Disable confirmation prompts by assuming 'yes'")
     var assumeYes: Bool = false
 
+    @Flag(help: "Install swiftly to a custom location, not added to the user profile.")
+    var customLocation: Bool = false
+
     @Argument var swiftlyArchive: String? = nil
 
     mutating func run() async throws {
@@ -41,30 +44,40 @@ struct TestSwiftly: AsyncParsableCommand {
         try currentPlatform.runProgram("installer", "-pkg", swiftlyArchive, "-target", "CurrentUserHomeDirectory", quiet: false)
 #endif
 
-        print("Running 'swiftly init --assume-yes --verbose' to install swiftly and the latest toolchain")
-
 #if os(Linux)
         let extractedSwiftly = "./swiftly"
 #elseif os(macOS)
         let extractedSwiftly = FileManager.default.homeDirectoryForCurrentUser.appendingPathComponent(".swiftly/bin/swiftly").path
 #endif
 
-        try currentPlatform.runProgram(extractedSwiftly, "init", "--assume-yes", "--skip-install", quiet: false)
-
+        var env = ProcessInfo.processInfo.environment
         let shell = try await currentPlatform.getShell()
+        var customLoc: URL?
 
-        var env = ProcessInfo.processInfo.environment
+        if self.customLocation {
+            let customLoc = currentPlatform.getTempFilePath()
 
-        // Setting this environment helps to ensure that the profile gets sourced with bash, even if it is not in an interactive shell
-        if shell.hasSuffix("bash") {
-            env["BASH_ENV"] = FileManager.default.homeDirectoryForCurrentUser.appendingPathComponent(".profile").path
-        } else if shell.hasSuffix("zsh") {
-            env["ZDOTDIR"] = FileManager.default.homeDirectoryForCurrentUser.path
-        } else if shell.hasSuffix("fish") {
-            env["XDG_CONFIG_HOME"] = FileManager.default.homeDirectoryForCurrentUser.appendingPathComponent(".config").path
-        }
+            print("Installing swiftly to custom location \(customLoc.path).")
+            env["SWIFTLY_HOME_DIR"] = customLoc.path
+            env["SWIFTLY_BIN_DIR"] = customLoc.appendingPathComponent("bin").path
+            env["SWIFTLY_TOOLCHAIN_DIR"] = customLoc.appendingPathComponent("toolchains").path
 
-        try currentPlatform.runProgram(shell, "-l", "-c", "swiftly install --assume-yes latest --post-install-file=./post-install.sh", quiet: false, env: env)
+            try currentPlatform.runProgram(extractedSwiftly, "init", "--assume-yes", "--no-modify-profile", "--skip-install", quiet: false, env: env)
+            try currentPlatform.runProgram(shell, "-l", "-c", ". \"\(customLoc.path)/env.sh\" && swiftly install --assume-yes latest --post-install-file=./post-install.sh", quiet: false, env: env)
+        } else {
+            print("Installing swiftly to the default location.")
+            // Setting this environment helps to ensure that the profile gets sourced with bash, even if it is not in an interactive shell
+            if shell.hasSuffix("bash") {
+                env["BASH_ENV"] = FileManager.default.homeDirectoryForCurrentUser.appendingPathComponent(".profile").path
+            } else if shell.hasSuffix("zsh") {
+                env["ZDOTDIR"] = FileManager.default.homeDirectoryForCurrentUser.path
+            } else if shell.hasSuffix("fish") {
+                env["XDG_CONFIG_HOME"] = FileManager.default.homeDirectoryForCurrentUser.appendingPathComponent(".config").path
+            }
+
+            try currentPlatform.runProgram(extractedSwiftly, "init", "--assume-yes", "--skip-install", quiet: false, env: env)
+            try currentPlatform.runProgram(shell, "-l", "-c", "swiftly install --assume-yes latest --post-install-file=./post-install.sh", quiet: false, env: env)
+        }
 
         var swiftReady = false
 
@@ -77,7 +90,9 @@ struct TestSwiftly: AsyncParsableCommand {
             swiftReady = true
         }
 
-        if swiftReady {
+        if let customLoc = customLoc, swiftReady {
+            try currentPlatform.runProgram(shell, "-l", "-c", ". \"\(customLoc.path)/env.sh\" && swift --version", quiet: false, env: env)
+        } else if swiftReady {
             try currentPlatform.runProgram(shell, "-l", "-c", "swift --version", quiet: false, env: env)
         }
     }