Merge pull request #1 from trill-lang/unique-prefixes

Enforce uniqueness of check prefixes

Author: CodaFi

Sources/FileCheck/FileCheck.swift

@@ -94,8 +94,8 @@ public enum FileCheckFD {
 /// - returns: Whether or not FileCheck succeeded in verifying the file.
 public func fileCheckOutput(of FD : FileCheckFD = .stdout, withPrefixes prefixes : [String] = ["CHECK"], checkNot : [String] = [], against file : String = #file, options: FileCheckOptions = [], block : () -> ()) -> Bool {
   guard let validPrefixes = validateCheckPrefixes(prefixes) else {
-    print("Supplied check-prefix is invalid! Prefixes must be unique and ",
-          "start with a letter and contain only alphanumeric characters, ",
+    print("Supplied check-prefix is invalid! Prefixes must be unique and",
+          "start with a letter and contain only alphanumeric characters,",
           "hyphens and underscores")
     return false
   }
@@ -166,11 +166,13 @@ private func overrideFDAndCollectOutput(file : FileCheckFD, of block : () -> ())
 private func validateCheckPrefixes(_ prefixes : [String]) -> [String]? {
   let validator = try! NSRegularExpression(pattern: "^[a-zA-Z0-9_-]*$")
 
+  var prefixUniquer = Set<String>()
   for prefix in prefixes {
     // Reject empty prefixes.
-    if prefix.isEmpty {
+    guard !prefix.isEmpty && !prefixUniquer.contains(prefix) else {
       return nil
     }
+    prefixUniquer.insert(prefix)
 
     let range = NSRange(
       location: 0,
@@ -181,7 +183,7 @@ private func validateCheckPrefixes(_ prefixes : [String]) -> [String]? {
     }
   }
 
-  return [String](Set<String>(prefixes))
+  return [String](prefixUniquer)
 }
 
 extension CChar {

Tests/FileCheckTests/FileCheckSpec.swift

@@ -163,6 +163,30 @@ class FileCheckSpec : XCTestCase {
     })
   }
 
+  func testInvalidCheckPrefix() {
+    // BAD_PREFIX: Supplied check-prefix is invalid! Prefixes must be unique and start with a letter and contain only alphanumeric characters, hyphens and underscores
+    XCTAssert(fileCheckOutput(of: .stdout, withPrefixes: ["BAD_PREFIX"]) {
+      XCTAssertFalse(fileCheckOutput(of: .stdout, withPrefixes: ["A!"]) { })
+    })
+
+    XCTAssert(fileCheckOutput(of: .stdout, withPrefixes: ["A1a-B_c"]) {
+      // A1a-B_c: foobar
+      print("foobar")
+    })
+
+    XCTAssert(fileCheckOutput(of: .stdout, withPrefixes: ["BAD_PREFIX"]) {
+      XCTAssertFalse(fileCheckOutput(of: .stdout, withPrefixes: ["REPEAT", "REPEAT"]) { })
+    })
+
+    XCTAssert(fileCheckOutput(of: .stdout, withPrefixes: ["BAD_PREFIX"]) {
+      XCTAssertFalse(fileCheckOutput(of: .stdout, withPrefixes: ["VALID", "A!"]) { })
+    })
+
+    XCTAssert(fileCheckOutput(of: .stdout, withPrefixes: ["BAD_PREFIX"]) {
+      XCTAssertFalse(fileCheckOutput(of: .stdout, withPrefixes: [" "]) { })
+    })
+  }
+
   #if !os(macOS)
   static var allTests = testCase([
     ("testWhitespace", testWhitespace),
@@ -173,6 +197,7 @@ class FileCheckSpec : XCTestCase {
     ("testNearestPattern", testNearestPattern),
     ("testNotDiagInfo", testNotDiagInfo),
     ("testNonExistentPrefix", testNonExistentPrefix),
+    ("testInvalidCheckPrefix", testInvalidCheckPrefix),
   ])
   #endif
 }

Tests/FileCheckTests/VariableRefSpec.swift

@@ -0,0 +1,24 @@
+import FileCheck
+import XCTest
+import Foundation
+
+class VariableRefSpec : XCTestCase {
+  func testSameLineVarRef() {
+    XCTAssert(fileCheckOutput(of: .stdout) {
+      // CHECK: op1 [[REG:r[0-9]+]], {{r[0-9]+}}, [[REG]]
+      print("op1 r1, r2, r1")
+      // CHECK: op3 [[REG1:r[0-9]+]], [[REG2:r[0-9]+]], [[REG1]], [[REG2]]
+      print("op3 r1, r2, r1, r2")
+      // Test that parens inside the regex don't confuse FileCheck
+      // CHECK: {{([a-z]+[0-9])+}} [[REG:g[0-9]+]], {{g[0-9]+}}, [[REG]]
+      print("op4 g1, g2, g1")
+    })
+  }
+  #if !os(macOS)
+  static var allTests = testCase([
+    ("testSameLineVarRef", testSameLineVarRef),
+  ])
+  #endif
+}
+
+

Tests/LinuxMain.swift

@@ -10,5 +10,6 @@ XCTMain([
   LabelSpec.allTests,
   LineCountSpec.allTests,
   MultiPrefixSpec.allTests,
+  VariableRefSpec.allTests,
 ])
 #endif