Consolidate enviroment variables used to configuration SwiftPM

PR #9925 added new environment variables that would control
authentication with the Package registry using environment variables.

Move the newly added environment variables to the `ConfigurableEnvVar`
enum, to have all configurable environment variables in a single
location, so we can eventually generated documentation from this source.

Author: bkhouri

Sources/Basics/AuthorizationProvider.swift

@@ -71,16 +71,16 @@ public struct EnvironmentAuthorizationProvider: AuthorizationProvider {
     public func authentication(for url: URL) -> (user: String, password: String)? {
         switch kind {
         case .registry:
-            if let token = nonEmpty(environment[.swiftpmRegistryToken]) {
+            if let token = nonEmpty(ConfigurableEnvVar.SWIFTPM_REGISTRY_TOKEN.getEnvVar()) {
                 return (user: "token", password: token)
             }
-            if let login = nonEmpty(environment[.swiftpmRegistryLogin]),
-               let password = nonEmpty(environment[.swiftpmRegistryPassword]) {
+            if let login = nonEmpty(ConfigurableEnvVar.SWIFTPM_REGISTRY_LOGIN.getEnvVar()),
+               let password = nonEmpty(ConfigurableEnvVar.SWIFTPM_REGISTRY_PASSWORD.getEnvVar()) {
                 return (user: login, password: password)
             }
             return nil
         case .sourceControl:
-            if let token = nonEmpty(environment[.swiftpmSourceControlToken]) {
+            if let token = nonEmpty(ConfigurableEnvVar.SWIFTPM_REGISTRY_TOKEN.getEnvVar()) {
                 return (user: "token", password: token)
             }
             return nil
@@ -328,7 +328,7 @@ public final class KeychainAuthorizationProvider: AuthorizationProvider, Authori
                 throw AuthorizationProviderError
                     .other("Failed to extract credentials for '\(protocolHostPort)' from keychain")
             }
-          
+
             let password = String(decoding: passwordData, as: UTF8.self)
 
             return (user: account, password: password)

Sources/Basics/CMakeLists.txt

@@ -26,6 +26,7 @@ add_library(Basics
   Concurrency/ThreadSafeKeyValueStore.swift
   Concurrency/ThrowingDefer.swift
   Concurrency/TokenBucket.swift
+  ConfigurableEnvVar.swift
   DispatchTimeInterval+Extensions.swift
   Environment/Environment.swift
   Environment/EnvironmentKey.swift

Sources/Basics/Environment/ConfigurableEnvVar.swift

@@ -0,0 +1,72 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift open source project
+//
+// Copyright (c) 2025 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See http://swift.org/LICENSE.txt for license information
+// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import Foundation
+import struct Basics.EnvironmentKey
+
+package enum ConfigurableEnvVar: String, CaseIterable {
+    /// SBOM specification(s) to generate (comma-separated list)
+    case SWIFTPM_BUILD_SBOM_SPEC
+
+    /// Directory path to generate SBOM(s) in
+    case SWIFTPM_BUILD_SBOM_OUTPUT_DIR
+
+    /// Filter SBOM components and dependencies by entity (package, product, or both)
+    case SWIFTPM_BUILD_SBOM_FILTER
+
+    /// Whether to treat SBOM generation errors as warnings
+    case SWIFTPM_BUILD_SBOM_WARNING_ONLY
+
+    /// Package Registra token
+    case SWIFTPM_REGISTRY_TOKEN
+
+    /// Package Registra username
+    case SWIFTPM_REGISTRY_LOGIN
+
+    /// Package Registra password
+    case SWIFTPM_REGISTRY_PASSWORD
+
+    /// Swift Package Manager source countrol token
+    case SWIFTPM_SOURCE_CONTROL_TOKEN
+
+    /// Swift Package Manager .netrc data contents
+    case SWIFTPM_NETRC_DATA
+
+    private var isCachable : Bool {
+        switch self {
+        case .SWIFTPM_BUILD_SBOM_SPEC: false
+        case .SWIFTPM_BUILD_SBOM_OUTPUT_DIR: false
+        case .SWIFTPM_BUILD_SBOM_FILTER: false
+        case .SWIFTPM_BUILD_SBOM_WARNING_ONLY: false
+        case .SWIFTPM_REGISTRY_TOKEN: true
+        case .SWIFTPM_REGISTRY_LOGIN: true
+        case .SWIFTPM_REGISTRY_PASSWORD: true
+        case .SWIFTPM_SOURCE_CONTROL_TOKEN: true
+        case .SWIFTPM_NETRC_DATA: true
+
+        }
+    }
+
+    package static func getNonCachableEnvVars() -> Set<EnvironmentKey> {
+        return Set(
+            Self.allCases.filter { !$0.isCachable }
+                .map { variable in
+                    EnvironmentKey(variable.rawValue)
+                }
+        )
+    }
+
+    package func getEnvVar() -> String? {
+        // ProcessInfo.processInfo.environment[self.rawValue]
+        Environment.current[EnvironmentKey(self.rawValue)]
+    }
+}

Sources/Basics/Environment/Environment.swift

@@ -59,6 +59,12 @@ extension Environment {
         _read { yield self.storage[key] }
         _modify { yield &self.storage[key] }
     }
+
+    package subscript(_ key: ConfigurableEnvVar) -> String? {
+        _read { yield self.storage[EnvironmentKey(key.rawValue)] }
+        _modify { yield &self.storage[EnvironmentKey(key.rawValue)] }
+    }
+
 }
 
 // MARK: - Conversions between Dictionary<String, String>

Sources/Basics/Environment/EnvironmentKey.swift

@@ -24,12 +24,6 @@ public struct EnvironmentKey {
 extension EnvironmentKey {
     package static let path: Self = "PATH"
 
-    package static let swiftpmRegistryToken: Self = "SWIFTPM_REGISTRY_TOKEN"
-    package static let swiftpmRegistryLogin: Self = "SWIFTPM_REGISTRY_LOGIN"
-    package static let swiftpmRegistryPassword: Self = "SWIFTPM_REGISTRY_PASSWORD"
-    package static let swiftpmSourceControlToken: Self = "SWIFTPM_SOURCE_CONTROL_TOKEN"
-    package static let swiftpmNetrcData: Self = "SWIFTPM_NETRC_DATA"
-
     package static var libraryPath: Self {
         #if os(Windows)
         path
@@ -41,7 +35,7 @@ extension EnvironmentKey {
     }
 
     /// A set of known keys which should not be included in cache keys.
-    package static let nonCachable: Set<Self> = [
+    package static let nonCachable: Set<Self> = Set([
         "TERM",
         "TERM_PROGRAM",
         "TERM_PROGRAM_VERSION",
@@ -57,12 +51,7 @@ extension EnvironmentKey {
         "VSCODE_IPC_HOOK_CLI",
         "HYPERFINE_RANDOMIZED_ENVIRONMENT_OFFSET",
         "SSH_AUTH_SOCK",
-        .swiftpmRegistryToken,
-        .swiftpmRegistryLogin,
-        .swiftpmRegistryPassword,
-        .swiftpmSourceControlToken,
-        .swiftpmNetrcData,
-    ]
+    ]).union(ConfigurableEnvVar.getNonCachableEnvVars())
 }
 
 extension EnvironmentKey: CodingKeyRepresentable {}

Sources/CoreCommands/Options.swift

@@ -13,6 +13,7 @@
 import ArgumentParser
 
 import struct Basics.AbsolutePath
+import enum Basics.ConfigurableEnvVar
 import var Basics.localFileSystem
 import enum Basics.TestingLibrary
 import struct Basics.Triple
@@ -35,7 +36,6 @@ import enum SBOMModel.SBOMCommandError
 
 import struct SPMBuildCore.BuildParameters
 import struct SPMBuildCore.BuildSystemProvider
-import enum SPMBuildCore.ConfigurableEnvVar
 
 import struct TSCBasic.StringError
 
@@ -816,7 +816,7 @@ public struct SBOMOptions: ParsableArguments {
             if !_sbomSpecs.isEmpty {
                 return _sbomSpecs
             }
-            if let envSpecs = SPMBuildCore.ConfigurableEnvVar.SWIFTPM_BUILD_SBOM_SPEC.getEnvVar() {
+            if let envSpecs = Basics.ConfigurableEnvVar.SWIFTPM_BUILD_SBOM_SPEC.getEnvVar() {
                 let specStrings = envSpecs.components(separatedBy: ",").map { $0.trimmingCharacters(in: .whitespaces) }
                 var specs: Set<SBOMModel.Spec> = []
                 for specString in specStrings {
@@ -838,7 +838,7 @@ public struct SBOMOptions: ParsableArguments {
         if let cmdLineDir = _sbomDirectory {
             return cmdLineDir
         }
-        if let envDir = SPMBuildCore.ConfigurableEnvVar.SWIFTPM_BUILD_SBOM_OUTPUT_DIR.getEnvVar() {
+        if let envDir = ConfigurableEnvVar.SWIFTPM_BUILD_SBOM_OUTPUT_DIR.getEnvVar() {
             guard let path = AbsolutePath(argument: envDir) else {
                 return nil
             }
@@ -854,7 +854,7 @@ public struct SBOMOptions: ParsableArguments {
             if let cliFilter = _sbomFilter {
                 return cliFilter
             }
-            if let envFilter = SPMBuildCore.ConfigurableEnvVar.SWIFTPM_BUILD_SBOM_FILTER.getEnvVar() {
+            if let envFilter = Basics.ConfigurableEnvVar.SWIFTPM_BUILD_SBOM_FILTER.getEnvVar() {
                 guard let filter = SBOMModel.Filter(rawValue: envFilter) else {
                     throw SBOMModel.SBOMCommandError.invalidFilterValue(value: envFilter)
                 }
@@ -869,7 +869,7 @@ public struct SBOMOptions: ParsableArguments {
         if _sbomWarningOnly {
             return true
         }
-        if let envWarningOnly = SPMBuildCore.ConfigurableEnvVar.SWIFTPM_BUILD_SBOM_WARNING_ONLY.getEnvVar() {
+        if let envWarningOnly = Basics.ConfigurableEnvVar.SWIFTPM_BUILD_SBOM_WARNING_ONLY.getEnvVar() {
             let lowercased = envWarningOnly.lowercased()
             return !["false", "0", "no"].contains(lowercased)
         }

Sources/SPMBuildCore/CMakeLists.txt

@@ -26,7 +26,6 @@ add_library(SPMBuildCore
   Plugins/PluginMessages.swift
   Plugins/PluginScriptRunner.swift
   CommandPluginResult.swift
-  ConfigurableEnvVar.swift
   MainAttrDetection.swift
   ResolvedPackage+Extensions.swift
   Triple+Extensions.swift

Sources/SPMBuildCore/ConfigurableEnvVar.swift

@@ -310,11 +310,11 @@ extension Workspace.Configuration {
             var providers = [AuthorizationProvider]()
 
             let env = Environment.current
-            if let token = env[.swiftpmSourceControlToken], !token.isEmpty {
+            if let token = ConfigurableEnvVar.SWIFTPM_SOURCE_CONTROL_TOKEN.getEnvVar(), !token.isEmpty {
                 providers.append(EnvironmentAuthorizationProvider(kind: .sourceControl))
             }
 
-            if let netrcData = env[.swiftpmNetrcData], !netrcData.isEmpty {
+            if let netrcData = ConfigurableEnvVar.SWIFTPM_NETRC_DATA.getEnvVar(), !netrcData.isEmpty {
                 do {
                     providers.append(try InMemoryNetrcAuthorizationProvider(content: netrcData))
                 } catch {
@@ -371,22 +371,22 @@ extension Workspace.Configuration {
             observabilityScope: ObservabilityScope
         ) throws -> AuthorizationProvider? {
             let env = Environment.current
-            if let token = env[.swiftpmRegistryToken], !token.isEmpty {
+            if let token = ConfigurableEnvVar.SWIFTPM_REGISTRY_TOKEN.getEnvVar(), !token.isEmpty {
                 return EnvironmentAuthorizationProvider(kind: .registry)
             }
-            if let login = env[.swiftpmRegistryLogin], !login.isEmpty,
-               let password = env[.swiftpmRegistryPassword], !password.isEmpty {
+            if let login = ConfigurableEnvVar.SWIFTPM_REGISTRY_LOGIN.getEnvVar(), !login.isEmpty,
+               let password = ConfigurableEnvVar.SWIFTPM_REGISTRY_PASSWORD.getEnvVar(), !password.isEmpty {
                 return EnvironmentAuthorizationProvider(kind: .registry)
-            } else if let login = env[.swiftpmRegistryLogin], !login.isEmpty {
+            } else if let login = ConfigurableEnvVar.SWIFTPM_REGISTRY_LOGIN.getEnvVar(), !login.isEmpty {
                 observabilityScope.emit(
                     warning: "SWIFTPM_REGISTRY_LOGIN is set but SWIFTPM_REGISTRY_PASSWORD is not; both are required for login/password authentication"
                 )
-            } else if let password = env[.swiftpmRegistryPassword], !password.isEmpty {
+            } else if let password = ConfigurableEnvVar.SWIFTPM_REGISTRY_PASSWORD.getEnvVar(), !password.isEmpty {
                 observabilityScope.emit(
                     warning: "SWIFTPM_REGISTRY_PASSWORD is set but SWIFTPM_REGISTRY_LOGIN is not; both are required for login/password authentication"
                 )
             }
-            if let netrcData = env[.swiftpmNetrcData], !netrcData.isEmpty {
+            if let netrcData = ConfigurableEnvVar.SWIFTPM_NETRC_DATA.getEnvVar(), !netrcData.isEmpty {
                 do {
                     return try InMemoryNetrcAuthorizationProvider(content: netrcData)
                 } catch {

Sources/Workspace/Workspace+Configuration.swift

@@ -249,7 +249,7 @@ final class AuthorizationProviderTests: XCTestCase {
 
     func testEnvironmentRegistryToken() {
         var env = Environment()
-        env[.swiftpmRegistryToken] = "my-registry-token"
+        env[.SWIFTPM_REGISTRY_TOKEN] = "my-registry-token"
 
         let provider = EnvironmentAuthorizationProvider(environment: env, kind: .registry)
         let url = URL("https://registry.example.com")
@@ -261,8 +261,8 @@ final class AuthorizationProviderTests: XCTestCase {
 
     func testEnvironmentRegistryLoginPassword() {
         var env = Environment()
-        env[.swiftpmRegistryLogin] = "myuser"
-        env[.swiftpmRegistryPassword] = "mypassword"
+        env[.SWIFTPM_REGISTRY_LOGIN] = "myuser"
+        env[.SWIFTPM_REGISTRY_PASSWORD] = "mypassword"
 
         let provider = EnvironmentAuthorizationProvider(environment: env, kind: .registry)
         let url = URL("https://registry.example.com")
@@ -274,9 +274,9 @@ final class AuthorizationProviderTests: XCTestCase {
 
     func testEnvironmentRegistryTokenPrecedence() {
         var env = Environment()
-        env[.swiftpmRegistryToken] = "my-token"
-        env[.swiftpmRegistryLogin] = "myuser"
-        env[.swiftpmRegistryPassword] = "mypassword"
+        env[.SWIFTPM_REGISTRY_TOKEN] = "my-token"
+        env[.SWIFTPM_REGISTRY_LOGIN] = "myuser"
+        env[.SWIFTPM_REGISTRY_PASSWORD] = "mypassword"
 
         let provider = EnvironmentAuthorizationProvider(environment: env, kind: .registry)
         let url = URL("https://registry.example.com")
@@ -288,7 +288,7 @@ final class AuthorizationProviderTests: XCTestCase {
 
     func testEnvironmentSourceControlToken() {
         var env = Environment()
-        env[.swiftpmSourceControlToken] = "sc-token-123"
+        env[.SWIFTPM_SOURCE_CONTROL_TOKEN] = "sc-token-123"
 
         let provider = EnvironmentAuthorizationProvider(environment: env, kind: .sourceControl)
         let url = URL("https://github.com/org/repo")
@@ -310,18 +310,18 @@ final class AuthorizationProviderTests: XCTestCase {
 
     func testEnvironmentPartialLoginOnly() {
         var env = Environment()
-        env[.swiftpmRegistryLogin] = "myuser"
+        env[.SWIFTPM_REGISTRY_LOGIN] = "myuser"
 
         let provider = EnvironmentAuthorizationProvider(environment: env, kind: .registry)
         XCTAssertNil(provider.authentication(for: URL("https://registry.example.com")))
     }
 
     func testEnvironmentEmptyStringTreatedAsUnset() {
         var env = Environment()
-        env[.swiftpmRegistryToken] = ""
-        env[.swiftpmRegistryLogin] = ""
-        env[.swiftpmRegistryPassword] = ""
-        env[.swiftpmSourceControlToken] = ""
+        env[.SWIFTPM_REGISTRY_TOKEN] = ""
+        env[.SWIFTPM_REGISTRY_LOGIN] = ""
+        env[.SWIFTPM_REGISTRY_PASSWORD] = ""
+        env[.SWIFTPM_SOURCE_CONTROL_TOKEN] = ""
 
         let registryProvider = EnvironmentAuthorizationProvider(environment: env, kind: .registry)
         XCTAssertNil(registryProvider.authentication(for: URL("https://registry.example.com")))
@@ -332,7 +332,7 @@ final class AuthorizationProviderTests: XCTestCase {
 
     func testEnvironmentInComposite() {
         var env = Environment()
-        env[.swiftpmRegistryToken] = "env-token"
+        env[.SWIFTPM_REGISTRY_TOKEN] = "env-token"
 
         let url = URL("https://registry.example.com")
         let envProvider = EnvironmentAuthorizationProvider(environment: env, kind: .registry)