Merge pull request #2988 from keith/ks/improve-sanitizer-usage

Improve sanitizer usage

Author: abertelrud

Sources/Commands/Options.swift

@@ -90,6 +90,27 @@ enum BuildSystemKind: String, ExpressibleByArgument, CaseIterable {
     case xcode
 }
 
+public extension Sanitizer {
+    init(argument: String) throws {
+        if let sanitizer = Sanitizer(rawValue: argument) {
+            self = sanitizer
+            return
+        }
+
+        for sanitizer in Sanitizer.allCases where sanitizer.shortName == argument {
+            self = sanitizer
+            return
+        }
+
+        throw ArgumentConversionError.custom("valid sanitizers: \(Sanitizer.formattedValues)")
+    }
+
+    /// All sanitizer options in a comma separated string
+    fileprivate static var formattedValues: String {
+        return Sanitizer.allCases.map(\.rawValue).joined(separator: ", ")
+    }
+}
+
 public struct SwiftToolOptions: ParsableArguments {
     @OptionGroup()
     var buildFlagsGroup: BuildFlagsGroup
@@ -180,7 +201,7 @@ public struct SwiftToolOptions: ParsableArguments {
 
     /// Which compile-time sanitizers should be enabled.
     @Option(name: .customLong("sanitize"),
-            help: "Turn on runtime checks for erroneous behavior",
+            help: "Turn on runtime checks for erroneous behavior, possible values: \(Sanitizer.formattedValues)",
             transform: { try Sanitizer(argument: $0) })
     var sanitizers: [Sanitizer] = []
 

Sources/SPMBuildCore/Sanitizers.swift

@@ -12,7 +12,7 @@ import TSCBasic
 import TSCUtility
 
 /// Available runtime sanitizers.
-public enum Sanitizer: String, Encodable {
+public enum Sanitizer: String, Encodable, CaseIterable {
     case address
     case thread
     case undefined

Tests/BuildTests/BuildPlanTests.swift

@@ -2464,6 +2464,22 @@ final class BuildPlanTests: XCTestCase {
         try testBinaryTargets(platform: "macos", arch: "arm64e", destinationTriple: arm64eTriple)
     }
 
+    func testCreatingSanitizers() throws {
+        for sanitizer in Sanitizer.allCases {
+            XCTAssertEqual(sanitizer, try Sanitizer(argument: sanitizer.shortName))
+        }
+    }
+
+    func testInvalidSanitizer() throws {
+        do {
+            _ = try Sanitizer(argument: "invalid")
+            XCTFail("Should have failed to create Sanitizer")
+        } catch let error as ArgumentConversionError {
+            XCTAssertEqual(
+                error.description, "valid sanitizers: address, thread, undefined, scudo")
+        }
+    }
+
     func testAddressSanitizer() throws {
         try sanitizerTest(.address, expectedName: "address")
     }