From 6cf282c51e6ceb2bbcaef07ae99e32d5b12bdcc2 Mon Sep 17 00:00:00 2001
From: NinjaLikesCheez <NinjaLikesCheez@users.noreply.github.com>
Date: Mon, 27 May 2024 14:40:47 +0200
Subject: [PATCH] Add support for CMake builds

These have different PIF cache locations in the build cache
---
 Sources/GenIR/BuildCacheManipulator.swift     |  1 +
 .../GenIR/Extensions/Process+Extension.swift  | 13 +++-
 Sources/GenIR/PIFCache.swift                  | 25 +++-----
 Sources/GenIR/XcodeLogParser.swift            | 27 ++++++---
 TestAssets/CMakeDiscoveryTest/CMakeLists.txt  | 60 +++++++++++++++++++
 .../CMakeDiscoveryTest/Source/App.swift       | 10 ++++
 Tests/GenIRTests/CMakeDiscoveryTests.swift    | 54 +++++++++++++++++
 Tests/GenIRTests/DependencyGraphTests.swift   | 10 ++--
 8 files changed, 168 insertions(+), 32 deletions(-)
 create mode 100644 TestAssets/CMakeDiscoveryTest/CMakeLists.txt
 create mode 100644 TestAssets/CMakeDiscoveryTest/Source/App.swift
 create mode 100644 Tests/GenIRTests/CMakeDiscoveryTests.swift

diff --git a/Sources/GenIR/BuildCacheManipulator.swift b/Sources/GenIR/BuildCacheManipulator.swift
index b9a2e7a..43501db 100644
--- a/Sources/GenIR/BuildCacheManipulator.swift
+++ b/Sources/GenIR/BuildCacheManipulator.swift
@@ -38,6 +38,7 @@ struct BuildCacheManipulator {
 	func manipulate() throws {
 		if shouldDeploySkipInstallHack {
 			let intermediatesPath = buildCachePath
+			.appendingPathComponent("Build")
 			.appendingPathComponent("Intermediates.noindex")
 			.appendingPathComponent("ArchiveIntermediates")
 
diff --git a/Sources/GenIR/Extensions/Process+Extension.swift b/Sources/GenIR/Extensions/Process+Extension.swift
index a5df895..7de2e80 100644
--- a/Sources/GenIR/Extensions/Process+Extension.swift
+++ b/Sources/GenIR/Extensions/Process+Extension.swift
@@ -54,7 +54,16 @@ extension Process {
 
 		let process = Process()
 
-		let executable = command.replacingOccurrences(of: "\\", with: "")
+		let executable: String
+		let args: [String]
+
+		if command.starts(with: ".") || command.starts(with: "/") {
+			executable = command.replacingOccurrences(of: "\\", with: "")
+			args = arguments
+		} else {
+			executable = "/usr/bin/env"
+			args = [command] + arguments
+		}
 
 		if #available(macOS 10.13, *) {
 			process.executableURL = executable.fileURL
@@ -62,7 +71,7 @@ extension Process {
 			process.launchPath = executable
 		}
 
-		process.arguments = arguments.map { $0.replacingOccurrences(of: "\\", with: "") }
+		process.arguments = args.map { $0.replacingOccurrences(of: "\\", with: "") }
 		process.standardOutput = stdoutPipe
 		process.standardError = stderrPipe
 		process.standardInput = FileHandle.nullDevice
diff --git a/Sources/GenIR/PIFCache.swift b/Sources/GenIR/PIFCache.swift
index 449b4e5..3325c3a 100644
--- a/Sources/GenIR/PIFCache.swift
+++ b/Sources/GenIR/PIFCache.swift
@@ -2,7 +2,6 @@ import Foundation
 import PIFSupport
 
 class PIFCache {
-	private let buildCache: URL
 	private let pifCachePath: URL
 	private let workspace: PIF.Workspace
 
@@ -22,7 +21,6 @@ class PIFCache {
 	}
 
 	init(buildCache: URL) throws {
-		self.buildCache = buildCache
 		self.pifCachePath = try Self.pifCachePath(in: buildCache)
 
 		do {
@@ -34,13 +32,12 @@ class PIFCache {
 	}
 
 	private static func pifCachePath(in buildCache: URL) throws -> URL {
-		// TODO: test this variation, because I haven't seen this personally
 		let cmakePIFCachePath = buildCache
-				.deletingLastPathComponent()
 				.appendingPathComponent("XCBuildData")
 				.appendingPathComponent("PIFCache")
 
 		let regularPIFCachePath = buildCache
+				.appendingPathComponent("Build")
 				.appendingPathComponent("Intermediates.noindex")
 				.appendingPathComponent("XCBuildData")
 				.appendingPathComponent("PIFCache")
@@ -111,12 +108,10 @@ extension PIF.BaseTarget: Hashable {
 }
 
 struct PIFDependencyProvider: DependencyProviding {
-	private let targets: [Target]
 	private let cache: PIFCache
 	private var guidToTargets: [PIF.GUID: Target]
 
 	init(targets: [Target], cache: PIFCache) {
-		self.targets = targets
 		self.cache = cache
 
 		self.guidToTargets = targets
@@ -168,24 +163,20 @@ struct PIFDependencyProvider: DependencyProviding {
 			.compactMap { resolveSwiftPackage($0) }
 
 		// Framework build phase dependencies
-		let frameworkBuildPhases = value
+		// NOTE: Previously we just cast this - all of a sudden with pods this is broken
+		// Not the end of the world - just as quick to do a dictionary lookup
+		let frameworkGUIDs = value
 			.baseTarget
 			.buildPhases
-			.compactMap { $0 as? PIF.FrameworksBuildPhase }
-
-		let referenceGUIDs = frameworkBuildPhases
 			.flatMap { $0.buildFiles }
+			// .compactMap { $0 as? PIF.FrameworksBuildPhase }
 			.compactMap {
 				switch $0.reference {
-				case .file(let guid): return guid
-				case .target: return nil // TODO: is this fine? I think so since we're looking for .framework file references here not targets which should be a dependency
+				case let .file(guid): return guid
+				case .target: return nil
 				}
 			}
-
-		let frameworkGUIDs = referenceGUIDs
-			.compactMap {
-				cache.frameworks[$0]?.guid
-			}
+			.compactMap { cache.frameworks[$0]?.guid }
 
 		let dependencyTargets = (dependencyTargetGUIDs + frameworkGUIDs).compactMap { guidToTargets[$0] }
 
diff --git a/Sources/GenIR/XcodeLogParser.swift b/Sources/GenIR/XcodeLogParser.swift
index ced8b74..2d2f0cb 100644
--- a/Sources/GenIR/XcodeLogParser.swift
+++ b/Sources/GenIR/XcodeLogParser.swift
@@ -92,14 +92,25 @@ class XcodeLogParser {
 				guard let startIndex = line.firstIndex(of: ":") else { continue }
 
 				let stripped = line[line.index(after: startIndex)..<line.endIndex].trimmingCharacters(in: .whitespacesAndNewlines)
-				// Stripped will be to the build description path, we want the root of the build path which is 6 folders up
-				buildCachePath = String(stripped).fileURL
-					.deletingLastPathComponent()
-					.deletingLastPathComponent()
-					.deletingLastPathComponent()
-					.deletingLastPathComponent()
-					.deletingLastPathComponent()
-					.deletingLastPathComponent()
+				var cachePath = String(stripped).fileURL
+
+				if cachePath.pathComponents.contains("DerivedData") {
+					// We want the 'project' folder which is the 'Project-randomcrap' folder inside of DerivedData.
+					// Build description path is inside this folder, but depending on the build - it can be a variable number of folders up
+					while cachePath.deletingLastPathComponent().lastPathComponent != "DerivedData" {
+						cachePath.deleteLastPathComponent()
+					}
+				} else {
+					// This build location is outside of the DerivedData directory - we want to go up to the folder _after_ the Build directory
+					// TODO: test this with fucking CMake....
+					while cachePath.lastPathComponent != "Build" {
+						cachePath.deleteLastPathComponent()
+					}
+
+					cachePath.deleteLastPathComponent()
+				}
+
+				buildCachePath = cachePath
 			}
 
 			if let target = target(from: line), currentTarget != target {
diff --git a/TestAssets/CMakeDiscoveryTest/CMakeLists.txt b/TestAssets/CMakeDiscoveryTest/CMakeLists.txt
new file mode 100644
index 0000000..87f797d
--- /dev/null
+++ b/TestAssets/CMakeDiscoveryTest/CMakeLists.txt
@@ -0,0 +1,60 @@
+cmake_minimum_required(VERSION 3.20)
+
+set(DEPLOYMENT_TARGET 17.0)
+set(CMAKE_OSX_DEPLOYMENT_TARGET ${DEPLOYMENT_TARGET})
+set(CMAKE_SYSTEM_NAME iOS)
+
+project("CMakeDiscoveryTest" Swift)
+
+set(NAME "CMakeDiscovery")
+set(APP_BUNDLE_IDENTIFIER "com.veracode.${NAME}")
+set(EXECUTABLE_NAME ${NAME})
+set(PRODUCT_NAME ${NAME})
+set(CODE_SIGNING_IDENTITY "")
+set(EXECUTABLE_NAME ${NAME})
+set(MACOSX_BUNDLE_EXECUTABLE_NAME ${NAME})
+set(MACOSX_BUNDLE_INFO_STRING ${APP_BUNDLE_IDENTIFIER})
+set(MACOSX_BUNDLE_GUI_IDENTIFIER ${APP_BUNDLE_IDENTIFIER})
+set(MACOSX_BUNDLE_BUNDLE_NAME ${APP_BUNDLE_IDENTIFIER})
+set(MACOSX_BUNDLE_ICON_FILE "")
+set(MACOSX_BUNDLE_LONG_VERSION_STRING "1.0")
+set(MACOSX_BUNDLE_SHORT_VERSION_STRING "1.0")
+set(MACOSX_BUNDLE_BUNDLE_VERSION "1.0")
+set(MACOSX_BUNDLE_COPYRIGHT "Copyright")
+set(IPHONEOS_DEPLOYMENT_TARGET ${DEPLOYMENT_TARGET})
+
+set(SOURCE_FILES
+	"${CMAKE_SOURCE_DIR}/Source/App.swift"
+)
+
+add_executable(
+	${NAME}
+	MACOSX_BUNDLE
+	${SOURCE_FILES}
+)
+
+find_library(SWIFTUI SwiftUI)
+find_library(FOUNDATION Foundation)
+
+target_link_libraries(${NAME} ${SWIFT_UI})
+target_link_libraries(${NAME} ${FOUNDATION})
+
+set_target_properties(${NAME} PROPERTIES
+					  XCODE_ATTRIBUTE_DEBUG_INFORMATION_FORMAT "dwarf-with-dsym"
+					  XCODE_ATTRIBUTE_GCC_PREFIX_HEADER "${CMAKE_CURRENT_SOURCE_DIR}/Prefix.pch"
+					  RESOURCE "${RESOURCES}"
+					  XCODE_ATTRIBUTE_GCC_PRECOMPILE_PREFIX_HEADER "YES"
+					  XCODE_ATTRIBUTE_IPHONEOS_DEPLOYMENT_TARGET ${DEPLOYMENT_TARGET}
+					  XCODE_ATTRIBUTE_CODE_SIGN_IDENTITY ""
+					  XCODE_ATTRIBUTE_DEVELOPMENT_TEAM ""
+					  XCODE_ATTRIBUTE_TARGETED_DEVICE_FAMILY "1"
+					  XCODE_ATTRIBUTE_CLANG_ENABLE_OBJC_ARC YES
+					  XCODE_ATTRIBUTE_COMBINE_HIDPI_IMAGES NO
+					  XCODE_ATTRIBUTE_INSTALL_PATH "$(LOCAL_APPS_DIR)"
+					  XCODE_ATTRIBUTE_ENABLE_TESTABILITY YES
+					  XCODE_ATTRIBUTE_GCC_SYMBOLS_PRIVATE_EXTERN YES
+					  XCODE_ATTRIBUTE_SUPPORTED_PLATFORMS "iphoneos iphonesimulator"
+					  XCODE_ATTRIBUTE_ARCHS "$(ARCHS_STANDARD)"
+					  XCODE_ATTRIBUTE_CODE_SIGN_IDENTITY ""
+					  XCODE_ATTRIBUTE_CODE_SIGN_STYLE Manual
+)
diff --git a/TestAssets/CMakeDiscoveryTest/Source/App.swift b/TestAssets/CMakeDiscoveryTest/Source/App.swift
new file mode 100644
index 0000000..d540e45
--- /dev/null
+++ b/TestAssets/CMakeDiscoveryTest/Source/App.swift
@@ -0,0 +1,10 @@
+import SwiftUI
+
+@main
+struct MyApp: App {
+	var body: some Scene {
+		WindowGroup {
+			Text("Hello, World!")
+		}
+	}
+}
diff --git a/Tests/GenIRTests/CMakeDiscoveryTests.swift b/Tests/GenIRTests/CMakeDiscoveryTests.swift
new file mode 100644
index 0000000..9120d61
--- /dev/null
+++ b/Tests/GenIRTests/CMakeDiscoveryTests.swift
@@ -0,0 +1,54 @@
+import XCTest
+@testable import gen_ir
+
+final class CMakeDiscoveryTests: XCTestCase {
+	let testPath: URL = {
+		TestContext.testAssetPath
+			.appendingPathComponent("CMakeDiscoveryTest")
+			.appendingPathComponent(".build")
+			.appendingPathComponent("CMakeDiscoveryTest.xcodeproj")
+	}()
+
+	private lazy var buildPath: URL = {
+		TestContext.testAssetPath
+			.appendingPathComponent("CMakeDiscoveryTest")
+			.appendingPathComponent(".build")
+	}()
+
+	let scheme = "CMakeDiscovery"
+
+	private func generate() throws {
+		if !FileManager.default.fileExists(atPath: buildPath.path) {
+			try FileManager.default.createDirectory(at: buildPath, withIntermediateDirectories: true)
+		}
+
+		_ = try Process.runShell(
+			"cmake",
+			arguments: [
+				"-GXcode",
+				TestContext.testAssetPath.appendingPathComponent("CMakeDiscoveryTest").path
+			],
+			runInDirectory: buildPath
+		)
+
+		// If this isn't set - xcodebuild will refuse to clean the project (thanks Apple!)
+		_ = try Process.runShell(
+			"xattr",
+			arguments: [
+				"-w",
+				"com.apple.xcode.CreatedByBuildSystem",
+				"true",
+				buildPath.appendingPathComponent("build").path
+			]
+		)
+	}
+
+	func testCMakeDiscovery() throws {
+		try generate()
+		let context = TestContext()
+		try context.build(test: testPath, scheme: scheme)
+
+		let cache = context.pifCache
+		XCTAssertEqual(cache.targets.filter { $0.name == "CMakeDiscovery" }.count, 1)
+	}
+}
diff --git a/Tests/GenIRTests/DependencyGraphTests.swift b/Tests/GenIRTests/DependencyGraphTests.swift
index 2c72eda..2fee28d 100644
--- a/Tests/GenIRTests/DependencyGraphTests.swift
+++ b/Tests/GenIRTests/DependencyGraphTests.swift
@@ -23,17 +23,17 @@ final class DependencyGraphTests: XCTestCase {
 
 		// App should have two nodes - Framework & Common
 		XCTAssertTrue(app.edges.count == 2, "App's edges is not equal to 2")
-		_ = try XCTUnwrap(app.edges.first(where: { $0.to.valueName == "Framework" }), "Failed to get Framework edge from App")
-		let commonEdge = try XCTUnwrap(app.edges.first(where: { $0.to.valueName == "Common" }), "Failed to get Common edge from App")
+		_ = try XCTUnwrap(app.edges.first(where: { $0.to.valueName == "Framework.framework" }), "Failed to get Framework edge from App")
+		let commonEdge = try XCTUnwrap(app.edges.first(where: { $0.to.valueName == "Common.framework" }), "Failed to get Common edge from App")
 
 		let frameworkTarget = try XCTUnwrap(targets.first(where: { $0.name ==  "Framework"}), "Failed to get Framework from targets")
 		let framework = try XCTUnwrap(graph.findNode(for: frameworkTarget), "Failed to find Framework node in graph")
 
 		// Framework should have two dependency edges - Common & SFSafeSymbols and one depender edge - App
 		XCTAssertTrue(framework.edges.count == 3, "Framework's edges is not equal to 3")
-		let symbolsEdge = try XCTUnwrap(framework.edges.first(where: { $0.to.valueName == "SFSafeSymbols" }), "Failed to get SFSafeSymbols edge from Framework")
-		let frameworkCommonEdge = try XCTUnwrap(framework.edges.first(where: { $0.to.valueName == "Common" }), "Failed to get SFSafeSymbols edge from Framework")
-		let frameworkAppEdge = try XCTUnwrap(framework.edges.first(where: { $0.to.valueName == "App" }), "Failed to get App edge from Framework")
+		let symbolsEdge = try XCTUnwrap(framework.edges.first(where: { $0.to.valueName == "SFSafeSymbols.o" }), "Failed to get SFSafeSymbols edge from Framework")
+		let frameworkCommonEdge = try XCTUnwrap(framework.edges.first(where: { $0.to.valueName == "Common.framework" }), "Failed to get SFSafeSymbols edge from Framework")
+		let frameworkAppEdge = try XCTUnwrap(framework.edges.first(where: { $0.to.valueName == "App.app" }), "Failed to get App edge from Framework")
 
 		XCTAssertNotEqual(commonEdge, frameworkCommonEdge, "App's Common edge is equal to Framework's Common edge - they should have different from values")
 		XCTAssertEqual(symbolsEdge.relationship, .dependency)