Merge branch 'main' of https://github.com/swiftlang/swiftly into build-swiftly-release-cleanup

Author: cmcgee1024

.github/workflows/nightly_snapshot_check.yml

@@ -0,0 +1,28 @@
+name: Smoke Test - Nightly Swift Toolchain
+
+on:
+  schedule:
+    - cron: '30 3 * * *'
+
+env:
+  SWIFTLY_BOOTSTRAP_VERSION: 1.0.0
+
+jobs:
+  tests-selfhosted:
+    name: Test (Smoke Test - Nightly Swift Toolchain) / ${{ matrix.container }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        container: ["ubuntu:20.04", "ubuntu:22.04", "ubuntu:24.04", "redhat/ubi9", "debian:12", "fedora:39"]
+    container:
+      image: ${{ matrix.container }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Prepare the action
+        run: ./scripts/prep-gh-action.sh --install-swiftly --swift-main-snapshot
+      - name: Build and Test
+        # UBI 9 and Ubuntu 20.04 - See https://github.com/swiftlang/swift/issues/80908
+        # UBI 9 - See https://github.com/swiftlang/swift/issues/80909
+        run: bash -c 'if [[ "${{ matrix.container }}" == "redhat/ubi9" ]]; then swiftly run +main-snapshot swift build --build-tests; elif [[ "${{ matrix.container }}" == "ubuntu:20.04" ]]; then swiftly run +main-snapshot swift build --build-tests; else swiftly run +main-snapshot swift test; fi'

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

@@ -545,3 +545,81 @@ The script will receive the argument '+abcde' followed by '+xyz'.
 
 
 
+## link
+
+Link swiftly so it resumes management of the active toolchain.
+
+```
+swiftly link [<toolchain-selector>] [--assume-yes] [--verbose] [--version] [--help]
+```
+
+**toolchain-selector:**
+
+*Links swiftly if it has been disabled.*
+
+
+Links swiftly if it has been disabled.
+
+
+**--assume-yes:**
+
+*Disable confirmation prompts by assuming 'yes'*
+
+
+**--verbose:**
+
+*Enable verbose reporting from swiftly*
+
+
+**--version:**
+
+*Show the version.*
+
+
+**--help:**
+
+*Show help information.*
+
+
+
+
+## unlink
+
+Unlinks swiftly so it no longer manages the active toolchain.
+
+```
+swiftly unlink [<toolchain-selector>] [--assume-yes] [--verbose] [--version] [--help]
+```
+
+**toolchain-selector:**
+
+*Unlinks swiftly, allowing the system default toolchain to be used.*
+
+
+Unlinks swiftly until swiftly is linked again with:
+
+    $ swiftly link
+
+
+**--assume-yes:**
+
+*Disable confirmation prompts by assuming 'yes'*
+
+
+**--verbose:**
+
+*Enable verbose reporting from swiftly*
+
+
+**--version:**
+
+*Show the version.*
+
+
+**--help:**
+
+*Show help information.*
+
+
+
+

README.md

@@ -61,7 +61,7 @@ This command checks to see if there are new versions of swiftly itself and upgra
 
 Welcome to the Swift community!
 
-Contributions to Swiftly are welcomed and encouraged! Please see the [Contributing to Swift guide](swift.org/contributing) and check out the [structure of the community](https://www.swift.org/community/#community-structure).
+Contributions to Swiftly are welcomed and encouraged! Please see the [Contributing to Swift guide](https://www.swift.org/contributing) and check out the [structure of the community](https://www.swift.org/community/#community-structure).
 
 To be a truly great community, Swift needs to welcome developers from all walks of life, with different backgrounds, and with a wide range of experience. A diverse and friendly community will have more great ideas, more unique perspectives, and produce more great code. We will work diligently to make the Swift community welcoming to everyone.
 

Sources/LinuxPlatform/Linux.swift

@@ -275,12 +275,11 @@ public struct Linux: Platform {
             try await fs.withTemporary(files: tmpFile) {
                 try await ctx.httpClient.getGpgKeys().download(to: tmpFile)
                 if let mockedHomeDir = ctx.mockedHomeDir {
-                    try self.runProgram(
-                        "gpg", "--import", "\(tmpFile)", quiet: true,
-                        env: ["GNUPGHOME": (mockedHomeDir / ".gnupg").string]
-                    )
+                    var env = ProcessInfo.processInfo.environment
+                    env["GNUPGHOME"] = (mockedHomeDir / ".gnupg").string
+                    try await sys.gpg()._import(keys: tmpFile).run(self, env: env, quiet: true)
                 } else {
-                    try self.runProgram("gpg", "--import", "\(tmpFile)", quiet: true)
+                    try await sys.gpg()._import(keys: tmpFile).run(self, quiet: true)
                 }
             }
         }
@@ -417,12 +416,11 @@ public struct Linux: Platform {
             await ctx.print("Verifying toolchain signature...")
             do {
                 if let mockedHomeDir = ctx.mockedHomeDir {
-                    try self.runProgram(
-                        "gpg", "--verify", "\(sigFile)", "\(archive)", quiet: false,
-                        env: ["GNUPGHOME": (mockedHomeDir / ".gnupg").string]
-                    )
+                    var env = ProcessInfo.processInfo.environment
+                    env["GNUPGHOME"] = (mockedHomeDir / ".gnupg").string
+                    try await sys.gpg().verify(detachedSignature: sigFile, signedData: archive).run(self, env: env, quiet: false)
                 } else {
-                    try self.runProgram("gpg", "--verify", "\(sigFile)", "\(archive)", quiet: !verbose)
+                    try await sys.gpg().verify(detachedSignature: sigFile, signedData: archive).run(self, quiet: !verbose)
                 }
             } catch {
                 throw SwiftlyError(message: "Signature verification failed: \(error).")
@@ -447,12 +445,11 @@ public struct Linux: Platform {
             await ctx.print("Verifying swiftly signature...")
             do {
                 if let mockedHomeDir = ctx.mockedHomeDir {
-                    try self.runProgram(
-                        "gpg", "--verify", "\(sigFile)", "\(archive)", quiet: false,
-                        env: ["GNUPGHOME": (mockedHomeDir / ".gnupg").string]
-                    )
+                    var env = ProcessInfo.processInfo.environment
+                    env["GNUPGHOME"] = (mockedHomeDir / ".gnupg").string
+                    try await sys.gpg().verify(detachedSignature: sigFile, signedData: archive).run(self, env: env, quiet: false)
                 } else {
-                    try self.runProgram("gpg", "--verify", "\(sigFile)", "\(archive)", quiet: !verbose)
+                    try await sys.gpg().verify(detachedSignature: sigFile, signedData: archive).run(self, quiet: !verbose)
                 }
             } catch {
                 throw SwiftlyError(message: "Signature verification failed: \(error).")

Sources/MacOSPlatform/MacOS.swift

@@ -70,10 +70,8 @@ public struct MacOS: Platform {
         if toolchainsDir == self.defaultToolchainsDirectory {
             // If the toolchains go into the default user location then we use the installer to install them
             await ctx.print("Installing package in user home directory...")
-            try runProgram(
-                "installer", "-verbose", "-pkg", "\(tmpFile)", "-target", "CurrentUserHomeDirectory",
-                quiet: !verbose
-            )
+
+            try await sys.installer(.verbose, pkg: tmpFile, target: "CurrentUserHomeDirectory").run(self, quiet: !verbose)
         } else {
             // Otherwise, we extract the pkg into the requested toolchains directory.
             await ctx.print("Expanding pkg...")
@@ -86,7 +84,7 @@ public struct MacOS: Platform {
 
             await ctx.print("Checking package signature...")
             do {
-                try runProgram("pkgutil", "--check-signature", "\(tmpFile)", quiet: !verbose)
+                try await sys.pkgutil().checkSignature(pkgPath: tmpFile).run(self, quiet: !verbose)
             } catch {
                 // If this is not a test that uses mocked toolchains then we must throw this error and abort installation
                 guard ctx.mockedHomeDir != nil else {
@@ -96,7 +94,7 @@ public struct MacOS: Platform {
                 // We permit the signature verification to fail during testing
                 await ctx.print("Signature verification failed, which is allowable during testing with mocked toolchains")
             }
-            try runProgram("pkgutil", "--verbose", "--expand", "\(tmpFile)", "\(tmpDir)", quiet: !verbose)
+            try await sys.pkgutil(.verbose).expand(pkgPath: tmpFile, dirPath: tmpDir).run(self, quiet: !verbose)
 
             // There's a slight difference in the location of the special Payload file between official swift packages
             // and the ones that are mocked here in the test framework.
@@ -106,7 +104,7 @@ public struct MacOS: Platform {
             }
 
             await ctx.print("Untarring pkg Payload...")
-            try runProgram("tar", "-C", "\(toolchainDir)", "-xvf", "\(payload)", quiet: !verbose)
+            try await sys.tar(.directory(toolchainDir)).extract(.verbose, .archive(payload)).run(self, quiet: !verbose)
         }
     }
 
@@ -119,16 +117,19 @@ public struct MacOS: Platform {
 
         if ctx.mockedHomeDir == nil {
             await ctx.print("Extracting the swiftly package...")
-            try runProgram("installer", "-pkg", "\(archive)", "-target", "CurrentUserHomeDirectory")
-            try? runProgram("pkgutil", "--volume", "\(userHomeDir)", "--forget", "org.swift.swiftly")
+            try await sys.installer(
+                pkg: archive,
+                target: "CurrentUserHomeDirectory"
+            )
+            try? await sys.pkgutil(.volume(userHomeDir)).forget(packageId: "org.swift.swiftly").run(self)
         } else {
             let installDir = userHomeDir / ".swiftly"
             try await fs.mkdir(.parents, atPath: installDir)
 
             // In the case of a mock for testing purposes we won't use the installer, perferring a manual process because
             //  the installer will not install to an arbitrary path, only a volume or user home directory.
             let tmpDir = fs.mktemp()
-            try runProgram("pkgutil", "--expand", "\(archive)", "\(tmpDir)")
+            try await sys.pkgutil().expand(pkgPath: archive, dirPath: tmpDir).run(self)
 
             // There's a slight difference in the location of the special Payload file between official swift packages
             // and the ones that are mocked here in the test framework.
@@ -138,7 +139,7 @@ public struct MacOS: Platform {
             }
 
             await ctx.print("Extracting the swiftly package into \(installDir)...")
-            try runProgram("tar", "-C", "\(installDir)", "-xvf", "\(payload)", quiet: false)
+            try await sys.tar(.directory(installDir)).extract(.verbose, .archive(payload)).run(self, quiet: false)
         }
 
         try self.runProgram((userHomeDir / ".swiftly/bin/swiftly").string, "init")
@@ -161,9 +162,7 @@ public struct MacOS: Platform {
 
         try await fs.remove(atPath: toolchainDir)
 
-        try? runProgram(
-            "pkgutil", "--volume", "\(fs.home)", "--forget", pkgInfo.CFBundleIdentifier, quiet: !verbose
-        )
+        try? await sys.pkgutil(.volume(fs.home)).forget(packageId: pkgInfo.CFBundleIdentifier).run(self, quiet: !verbose)
     }
 
     public func getExecutableName() -> String {

Sources/Swiftly/Init.swift

@@ -297,14 +297,7 @@ struct Init: SwiftlyCommand {
         }
 
         if let postInstall {
-            await ctx.print("""
-            There are some dependencies that should be installed before using this toolchain.
-            You can run the following script as the system administrator (e.g. root) to prepare
-            your system:
-
-                \(postInstall)
-
-            """)
+            await ctx.print(Messages.postInstall(postInstall))
         }
     }
 }