Merge pull request #2779 from mliberman/fix/pkgconfig-dependencies

Fix Absolute Path Dependencies in `.pc` Files

Author: abertelrud

Tests/BuildTests/BuildPlanTests.swift

@@ -1460,7 +1460,7 @@ final class BuildPlanTests: XCTestCase {
 
         let diagnostic = diagnostics.diagnostics.last!
 
-        XCTAssertEqual(diagnostic.message.text, "couldn't find pc file")
+        XCTAssertEqual(diagnostic.message.text, "couldn't find pc file for BTarget")
         XCTAssertEqual(diagnostic.message.behavior, .warning)
         XCTAssertEqual(diagnostic.location.description, "'BTarget' BTarget.pc")
     }

swift-tools-support-core/Sources/TSCUtility/PkgConfig.swift

@@ -12,14 +12,14 @@ import TSCBasic
 import Foundation
 
 public enum PkgConfigError: Swift.Error, CustomStringConvertible {
-    case couldNotFindConfigFile
+    case couldNotFindConfigFile(name: String)
     case parsingError(String)
     case nonWhitelistedFlags(String)
 
     public var description: String {
         switch self {
-        case .couldNotFindConfigFile:
-            return "couldn't find pc file"
+        case .couldNotFindConfigFile(let name):
+            return "couldn't find pc file for \(name)"
         case .parsingError(let error):
             return "parsing error(s): \(error)"
         case .nonWhitelistedFlags(let flags):
@@ -89,7 +89,7 @@ public struct PCFileFinder {
             PCFileFinder.shouldEmitPkgConfigPathsDiagnostic = false
             diagnostics.emit(warning: "failed to retrieve search paths with pkg-config; maybe pkg-config is not installed")
         }
-        throw PkgConfigError.couldNotFindConfigFile
+        throw PkgConfigError.couldNotFindConfigFile(name: name)
     }
 }
 
@@ -110,9 +110,6 @@ public struct PkgConfig {
     /// DiagnosticsEngine to emit diagnostics
     let diagnostics: DiagnosticsEngine
 
-    /// Helper to query `pkg-config` for library locations
-    private let pkgFileFinder: PCFileFinder
-
     /// Load the information for the named package.
     ///
     /// It will search `fileSystem` for the pkg config file in the following order:
@@ -132,12 +129,19 @@ public struct PkgConfig {
         fileSystem: FileSystem = localFileSystem,
         brewPrefix: AbsolutePath?
     ) throws {
-        self.name = name
-        self.pkgFileFinder = PCFileFinder(diagnostics: diagnostics, brewPrefix: brewPrefix)
-        self.pcFile = try pkgFileFinder.locatePCFile(
-            name: name,
-            customSearchPaths: PkgConfig.envSearchPaths + additionalSearchPaths,
-            fileSystem: fileSystem)
+
+        if let path = try? AbsolutePath(validating: name) {
+            guard fileSystem.isFile(path) else { throw PkgConfigError.couldNotFindConfigFile(name: name) }
+            self.name = path.basenameWithoutExt
+            self.pcFile = path
+        } else {
+            self.name = name
+            let pkgFileFinder = PCFileFinder(diagnostics: diagnostics, brewPrefix: brewPrefix)
+            self.pcFile = try pkgFileFinder.locatePCFile(
+                name: name,
+                customSearchPaths: PkgConfig.envSearchPaths + additionalSearchPaths,
+                fileSystem: fileSystem)
+        }
 
         self.diagnostics = diagnostics
         var parser = PkgConfigParser(pcFile: pcFile, fileSystem: fileSystem)
@@ -153,6 +157,7 @@ public struct PkgConfig {
                     name: dep, 
                     additionalSearchPaths: additionalSearchPaths,
                     diagnostics: diagnostics,
+                    fileSystem: fileSystem,
                     brewPrefix: brewPrefix
                 )
 

swift-tools-support-core/Tests/TSCUtilityTests/PkgConfigParserTests.swift

@@ -129,6 +129,36 @@ final class PkgConfigParserTests: XCTestCase {
         XCTAssertEqual(PCFileFinder.pkgConfigPaths, [AbsolutePath("/Volumes/BestDrive/pkgconfig")])
     }
 
+    func testAbsolutePathDependency() throws {
+
+        let libffiPath = "/usr/local/opt/libffi/lib/pkgconfig/libffi.pc"
+
+        try loadPCFile("gobject-2.0.pc") { parser in
+            XCTAssert(parser.dependencies.isEmpty)
+            XCTAssertEqual(parser.privateDependencies, [libffiPath])
+        }
+
+        try loadPCFile("libffi.pc") { parser in
+            XCTAssert(parser.dependencies.isEmpty)
+            XCTAssert(parser.privateDependencies.isEmpty)
+        }
+
+        let fileSystem = try InMemoryFileSystem(
+            files: [
+                "/usr/local/opt/glib/lib/pkgconfig/gobject-2.0.pc": pcFileByteString("gobject-2.0.pc"),
+                libffiPath: pcFileByteString("libffi.pc")
+            ]
+        )
+
+        XCTAssertNoThrow(
+            try PkgConfig(
+                name: "gobject-2.0",
+                additionalSearchPaths: [AbsolutePath("/usr/local/opt/glib/lib/pkgconfig")],
+                diagnostics: DiagnosticsEngine(),
+                fileSystem: fileSystem,
+                brewPrefix: AbsolutePath("/usr/local")))
+    }
+
     func testUnevenQuotes() throws {
         do {
             try loadPCFile("quotes_failure.pc")
@@ -138,10 +168,17 @@ final class PkgConfigParserTests: XCTestCase {
         }
     }
 
+    private func pcFilePath(_ inputName: String) -> AbsolutePath {
+        return AbsolutePath(#file).parentDirectory.appending(components: "pkgconfigInputs", inputName)
+    }
+
     private func loadPCFile(_ inputName: String, body: ((PkgConfigParser) -> Void)? = nil) throws {
-        let input = AbsolutePath(#file).parentDirectory.appending(components: "pkgconfigInputs", inputName)
-        var parser = PkgConfigParser(pcFile: input, fileSystem: localFileSystem)
+        var parser = PkgConfigParser(pcFile: pcFilePath(inputName), fileSystem: localFileSystem)
         try parser.parse()
         body?(parser)
     }
+
+    private func pcFileByteString(_ inputName: String) throws -> ByteString {
+        return try localFileSystem.readFileContents(pcFilePath(inputName))
+    }
 }

swift-tools-support-core/Tests/TSCUtilityTests/pkgconfigInputs/gobject-2.0.pc

@@ -0,0 +1,12 @@
+prefix=/usr/local/Cellar/glib/2.64.3
+libdir=${prefix}/lib
+includedir=${prefix}/include
+
+Name: GObject
+Description: GLib Type, Object, Parameter and Signal Library
+Version: 2.64.3
+# Requires: glib-2.0
+Requires.private: /usr/local/opt/libffi/lib/pkgconfig/libffi.pc >=  3.0.0
+Libs: -L${libdir} -lgobject-2.0
+Libs.private: -lintl
+Cflags:-I${includedir}

swift-tools-support-core/Tests/TSCUtilityTests/pkgconfigInputs/libffi.pc

@@ -0,0 +1,11 @@
+prefix=/usr/local/Cellar/libffi/3.3
+exec_prefix=${prefix}
+libdir=${exec_prefix}/lib
+toolexeclibdir=${libdir}
+includedir=${prefix}/include
+
+Name: libffi
+Description: Library supporting Foreign Function Interfaces
+Version: 3.3
+Libs: -L${toolexeclibdir} -lffi
+Cflags: -I${includedir}