Validate framework search path args

Author: owenv

Sources/SwiftDriver/Driver/Driver.swift

@@ -31,6 +31,7 @@ public struct Driver {
     case cannotAssignToConditionalCompilationFlag(String)
     case conditionalCompilationFlagHasRedundantPrefix(String)
     case conditionalCompilationFlagIsNotValidIdentifier(String)
+    case frameworkSearchPathIncludesExtension(String)
     // Explicit Module Build Failures
     case malformedModuleDependency(String, String)
     case missingPCMArguments(String)
@@ -61,6 +62,14 @@ public struct Driver {
         return "failed to retrieve frontend target info"
       case .missingProfilingData(let arg):
         return "no profdata file exists at '\(arg)'"
+      case .cannotAssignToConditionalCompilationFlag(let name):
+        return "conditional compilation flags do not have values in Swift; they are either present or absent (rather than '\(name)')"
+      case .conditionalCompilationFlagHasRedundantPrefix(let name):
+        return "invalid argument '-D\(name)'; did you provide a redundant '-D' in your build settings?"
+      case .conditionalCompilationFlagIsNotValidIdentifier(let name):
+        return "conditional compilation flags must be valid Swift identifiers (rather than '\(name)')"
+      case .frameworkSearchPathIncludesExtension(let arg):
+        return "framework search path ends in \".framework\"; add directory containing framework instead: \(arg)"
       // Explicit Module Build Failures
       case .malformedModuleDependency(let moduleName, let errorDescription):
         return "Malformed Module Dependency: \(moduleName), \(errorDescription)"
@@ -74,12 +83,6 @@ public struct Driver {
         return "unable to load output file map '\(path)': no such file or directory"
       case .missingExternalDependency(let moduleName):
         return "Missing External dependency info for module: \(moduleName)"
-      case .cannotAssignToConditionalCompilationFlag(let name):
-        return "conditional compilation flags do not have values in Swift; they are either present or absent (rather than '\(name)')"
-      case .conditionalCompilationFlagHasRedundantPrefix(let name):
-        return "invalid argument '-D\(name)'; did you provide a redundant '-D' in your build settings?"
-      case .conditionalCompilationFlagIsNotValidIdentifier(let name):
-        return "conditional compilation flags must be valid Swift identifiers (rather than '\(name)')"
       }
     }
   }
@@ -344,6 +347,7 @@ public struct Driver {
                                    fileSystem: fileSystem,
                                    workingDirectory: workingDirectory)
     try Self.validateCompilationConditionArgs(&parsedOptions)
+    try Self.validateFrameworkSearchPathArgs(&parsedOptions)
     Self.validateCoverageArgs(&parsedOptions, diagnosticsEngine: diagnosticEngine)
     try toolchain.validateArgs(&parsedOptions,
                                targetTriple: self.frontendTargetInfo.target.triple,
@@ -1614,6 +1618,14 @@ extension Driver {
     }
   }
 
+  static func validateFrameworkSearchPathArgs(_ parsedOptions: inout ParsedOptions) throws {
+    for arg in parsedOptions.arguments(for: .F, .Fsystem).map(\.argument.asSingle) {
+      if arg.hasSuffix(".framework") || arg.hasSuffix(".framework/") {
+        throw Error.frameworkSearchPathIncludesExtension(arg)
+      }
+    }
+  }
+
   private static func validateCoverageArgs(_ parsedOptions: inout ParsedOptions, diagnosticsEngine: DiagnosticsEngine) {
     for coveragePrefixMap in parsedOptions.arguments(for: .coveragePrefixMap) {
       let value = coveragePrefixMap.argument.asSingle

Tests/SwiftDriverTests/SwiftDriverTests.swift

@@ -1706,6 +1706,22 @@ final class SwiftDriverTests: XCTestCase {
     XCTAssertNoThrow(try Driver(args: ["swiftc", "foo.swift", "-DFOO"]))
   }
 
+  func testFrameworkSearchPathArgValidation() throws {
+    XCTAssertThrowsError(try Driver(args: ["swiftc", "foo.swift", "-F/some/dir/xyz.framework"])) {
+      XCTAssertEqual($0 as? Driver.Error, .frameworkSearchPathIncludesExtension("/some/dir/xyz.framework"))
+    }
+
+    XCTAssertThrowsError(try Driver(args: ["swiftc", "foo.swift", "-F/some/dir/xyz.framework/"])) {
+      XCTAssertEqual($0 as? Driver.Error, .frameworkSearchPathIncludesExtension("/some/dir/xyz.framework/"))
+    }
+
+    XCTAssertThrowsError(try Driver(args: ["swiftc", "foo.swift", "-Fsystem", "/some/dir/xyz.framework"])) {
+      XCTAssertEqual($0 as? Driver.Error, .frameworkSearchPathIncludesExtension("/some/dir/xyz.framework"))
+    }
+
+    XCTAssertNoThrow(try Driver(args: ["swiftc", "foo.swift", "-Fsystem", "/some/dir/"]))
+  }
+
   // Test cases ported from Driver/macabi-environment.swift
   func testDarwinSDKVersioning() throws {
     try withTemporaryDirectory { tmpDir in