test

Author: rintaro

utils/swift-xcodegen/Sources/SwiftXcodeGen/Ninja/NinjaBuildFile.swift

@@ -47,7 +47,7 @@ extension NinjaBuildFile {
     }
   }
 
-  struct Rule {
+  struct Rule: Equatable {
     let name: String
     var bindings: Bindings
 

utils/swift-xcodegen/Sources/SwiftXcodeGen/Ninja/NinjaParser.swift

@@ -14,16 +14,19 @@ import Foundation
 
 struct NinjaParser {
   private let filePath: AbsolutePath
+  private let fileReader: (AbsolutePath) throws -> Data
   private var lexer: Lexer
 
-  private init(filePath: AbsolutePath, input: UnsafeRawBufferPointer) throws {
+  private init(input: UnsafeRawBufferPointer, filePath: AbsolutePath, fileReader: @escaping (AbsolutePath) throws -> Data) throws {
     self.filePath = filePath
+    self.fileReader = fileReader
     self.lexer = Lexer(ByteScanner(input))
   }
 
-  static func parse(filePath: AbsolutePath, input: Data) throws -> NinjaBuildFile {
-    try input.withUnsafeBytes { bytes in
-      var parser = try Self(filePath: filePath, input: bytes)
+  static func parse(filePath: AbsolutePath, fileReader: @escaping (AbsolutePath) throws -> Data = { try $0.read() }) throws -> NinjaBuildFile {
+
+    try fileReader(filePath).withUnsafeBytes { bytes in
+      var parser = try Self(input: bytes, filePath: filePath, fileReader: fileReader)
       return try parser.parse()
     }
   }
@@ -347,7 +350,7 @@ fileprivate extension NinjaParser {
 
     let baseDirectory = self.filePath.parentDir!
     let path = AnyPath(fileName).absolute(in: baseDirectory)
-    return try NinjaParser.parse(filePath: path, input: path.read())
+    return try NinjaParser.parse(filePath: path, fileReader: fileReader)
   }
 
   mutating func parse() throws -> NinjaBuildFile {

utils/swift-xcodegen/Sources/SwiftXcodeGen/Ninja/RepoBuildDir.swift

@@ -82,7 +82,7 @@ extension RepoBuildDir {
         }
 
         log.debug("[*] Reading '\(fileName)'")
-        let ninjaFile = try NinjaParser.parse(filePath: fileName, input: fileName.read())
+        let ninjaFile = try NinjaParser.parse(filePath: fileName)
         _ninjaFile = ninjaFile
         return ninjaFile
       }

utils/swift-xcodegen/Tests/SwiftXcodeGenTest/NinjaParserTests.swift

@@ -54,11 +54,27 @@ fileprivate func expectEqual<T, U: Equatable>(
 fileprivate func assertParse(
   _ str: String,
   bindings: [String: String] = [:],
+  rules: [String: NinjaBuildFile.Rule] = [:],
+  edges: [NinjaBuildFile.BuildEdge],
+  file: StaticString = #file, line: UInt = #line
+) {
+  let filePath: AbsolutePath = "/tmp/build.ninja"
+  let files: [AbsolutePath: String] = [
+    filePath: str
+  ]
+  assertParse(filePath, in: files, bindings: bindings, rules: rules, edges: edges, file: file, line: line)
+}
+
+fileprivate func assertParse(
+  _ filePath: AbsolutePath,
+  in fileSystem: [AbsolutePath: String],
+  bindings: [String: String] = [:],
+  rules: [String: NinjaBuildFile.Rule] = [:],
   edges: [NinjaBuildFile.BuildEdge],
   file: StaticString = #file, line: UInt = #line
 ) {
   do {
-    let buildFile = try NinjaParser.parse(filePath: "/tmp/build.ninja", input: Data(str.utf8))
+    let buildFile = try NinjaParser.parse(filePath: "/tmp/build.ninja", fileReader: { Data(fileSystem[$0]!.utf8) })
     guard edges.count == buildFile.buildEdges.count else {
       XCTFail(
         "Expected \(edges.count) rules, got \(buildFile.buildEdges.count)",
@@ -71,6 +87,10 @@ fileprivate func assertParse(
       buildFile.bindings.values,
       file: file, line: line
     )
+    XCTAssertEqual(
+      rules, buildFile.rules,
+      file: file, line: line
+    )
     for (expected, actual) in zip(edges, buildFile.buildEdges) {
       expectEqual(expected, actual, \.ruleName, file: file, line: line)
       expectEqual(expected, actual, \.inputs, file: file, line: line)
@@ -87,12 +107,14 @@ fileprivate func assertParse(
 
 class NinjaParserTests: XCTestCase {
   func testBuildEdge() throws {
-    assertParse("""
+    assertParse(
+      """
       # ignore comment, build foo.o: a.swift | dep || orderdep
       #another build comment
       build foo.o foo.swiftmodule: SWIFTC a.swift | dep || orderdep
       notpartofthebuildrule
-      """, edges: [
+      """,
+      edges: [
         .init(
           ruleName: "SWIFTC",
           inputs: ["a.swift"],
@@ -104,10 +126,66 @@ class NinjaParserTests: XCTestCase {
     )
   }
 
+  func testRule() throws {
+    assertParse(
+      """
+      rule SWIFTC
+        command = /bin/switfc -wmo -target unknown
+        other = whatever
+      notpartoftherule
+      """,
+      rules: [
+        "SWIFTC": .init(
+          name: "SWIFTC",
+          bindings: [
+            "command": "/bin/switfc -wmo -target unknown",
+            "other": "whatever",
+          ])
+      ],
+      edges: []
+    )
+  }
+
+  func testInclude() throws {
+    let files: [AbsolutePath: String] = [
+      "/tmp/build.ninja": """
+        include path/to/sub.ninja
+        
+        build foo.swiftmodule : SWIFTC foo.swift
+        """,
+      "/tmp/path/to/sub.ninja": """
+        rule SWIFTC
+          command = /bin/swiftc $in -o $out
+        """
+    ]
+    assertParse(
+      "/tmp/build.ninja",
+      in: files,
+      rules: [
+        "SWIFTC": .init(
+          name: "SWIFTC",
+          bindings: [
+            "command": "/bin/swiftc $in -o $out",
+          ])
+      ],
+      edges: [
+        .init(
+          ruleName: "SWIFTC",
+          inputs: ["foo.swift"],
+          outputs: ["foo.swiftmodule"],
+          dependencies: [],
+          bindings: [:]
+        )
+      ]
+    )
+  }
+
   func testPhonyRule() throws {
-    assertParse("""
+    assertParse(
+      """
       build foo.swiftmodule : phony bar.swiftmodule
-      """, edges: [
+      """,
+      edges: [
         .phony(
           for: ["foo.swiftmodule"],
           inputs: ["bar.swiftmodule"]
@@ -116,8 +194,9 @@ class NinjaParserTests: XCTestCase {
     )
   }
 
-  func testAttributes() throws {
-    assertParse("""
+  func testBindings() throws {
+    assertParse(
+      """
       x = y
 
       CONFIGURATION = Debug
@@ -175,12 +254,14 @@ class NinjaParserTests: XCTestCase {
 
   func testEscape() throws {
     for newline in ["\n", "\r", "\r\n"] {
-      assertParse("""
+      assertParse(
+        """
         build foo.o$:: SWIFTC xyz$ foo$$.swift | baz$ bar.o
           FLAGS = -I /a$\(newline)\
                   /b -wmo
           COMMAND = swiftc$$
-        """, edges: [
+        """,
+        edges: [
           .init(
             ruleName: "SWIFTC",
             inputs: ["xyz foo$.swift"],