Merge pull request #492 from davidungar/move-mock

[Incremental, NFC] Move mocking functions to the testing directory

Author: David Ungar

Sources/SwiftDriver/IncrementalCompilation/DependencyKey.swift

@@ -1,3 +1,14 @@
+//===------------------- DependencyKey.swift ------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2020-2021 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
 
 import Foundation
 import TSCBasic

Sources/SwiftDriver/IncrementalCompilation/ModuleDependencyGraph.swift

@@ -353,23 +353,6 @@ extension ModuleDependencyGraph {
   }
 }
 
-// MARK: - utilities for unit testing
-extension ModuleDependencyGraph {
-  /// Testing only
-  /*@_spi(Testing)*/ public func haveAnyNodesBeenTraversed(inMock i: Int) -> Bool {
-    let dependencySource = DependencySource(mock: i)
-    // optimization
-    if let fileNode = nodeFinder.findFileInterfaceNode(forMock: dependencySource),
-       isTraced(fileNode) {
-      return true
-    }
-    if let nodes = nodeFinder.findNodes(for: dependencySource)?.values,
-       nodes.contains(where: isTraced) {
-      return true
-    }
-    return false
-  }
-}
 // MARK: - verification
 extension ModuleDependencyGraph {
   @discardableResult

Sources/SwiftDriver/IncrementalCompilation/ModuleDependencyGraphParts/DependencySource.swift

@@ -46,17 +46,6 @@ public struct DependencySource: Hashable, CustomStringConvertible {
   }
 }
 
-// MARK: - mocking
-extension DependencySource {
-  /*@_spi(Testing)*/ public init(mock i: Int) {
-    self.init(try! VirtualPath(path: String(i) + "." + FileType.swiftDeps.rawValue))!
-  }
-
-  /*@_spi(Testing)*/ public var mockID: Int {
-    Int(file.basenameWithoutExt)!
-  }
-}
-
 // MARK: - reading
 extension DependencySource {
   /// Throws if a read error
@@ -79,17 +68,7 @@ extension DependencySource {
     return graphIfPresent
   }
 }
-// MARK: - testing
-extension DependencySource {
-  /*@_spi(Testing)*/
-  public var sourceFileProvideNameForMockDependencySource: String {
-    file.name
-  }
-  /*@_spi(Testing)*/
-  public var interfaceHashForMockDependencySource: String {
-    file.name
-  }
-}
+
 // MARK: - comparing
 extension DependencySource: Comparable {
   public static func < (lhs: Self, rhs: Self) -> Bool {

Sources/SwiftDriver/IncrementalCompilation/ModuleDependencyGraphParts/NodeFinder.swift

@@ -40,12 +40,6 @@ extension ModuleDependencyGraph {
 // MARK: - finding
 
 extension ModuleDependencyGraph.NodeFinder {
-  func findFileInterfaceNode(
-    forMock dependencySource: DependencySource
-  ) -> Graph.Node?  {
-    let fileKey = DependencyKey(fileKeyForMockDependencySource: dependencySource)
-    return findNode((dependencySource, fileKey))
-  }
   func findNode(_ mapKey: (DependencySource?, DependencyKey)) -> Graph.Node? {
     nodeMap[mapKey]
   }
@@ -235,22 +229,6 @@ extension ModuleDependencyGraph.NodeFinder {
     fatalError("An expat is not defined anywhere and thus cannot be used")
   }
 }
-// MARK: - key helpers
-
-fileprivate extension DependencyKey {
-  init(fileKeyForMockDependencySource dependencySource: DependencySource) {
-    self.init(aspect: .interface,
-              designator:
-                .sourceFileProvide(name: dependencySource.sourceFileProvidesNameForMocking)
-    )
-  }
-}
-fileprivate extension DependencySource {
-  var sourceFileProvidesNameForMocking: String {
-    // Only when mocking are these two guaranteed to be the same
-    file.name
-  }
-}
 
 // MARK: - Checking Serialization
 extension ModuleDependencyGraph.NodeFinder {

Tests/SwiftDriverTests/Helpers/MockingIncrementalCompilation.swift

@@ -0,0 +1,74 @@
+//===------------- MockingIncrementalCompilation.swift --------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2021 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+@testable import SwiftDriver
+
+// MARK: - utilities for unit testing
+extension ModuleDependencyGraph {
+  func haveAnyNodesBeenTraversed(inMock i: Int) -> Bool {
+    let dependencySource = DependencySource(mock: i)
+    // optimization
+    if let fileNode = nodeFinder.findFileInterfaceNode(forMock: dependencySource),
+       isTraced(fileNode) {
+      return true
+    }
+    if let nodes = nodeFinder.findNodes(for: dependencySource)?.values,
+       nodes.contains(where: isTraced) {
+      return true
+    }
+    return false
+  }
+}
+
+// MARK: - mocking
+extension DependencySource {
+  init(mock i: Int) {
+    self.init(try! VirtualPath(path: String(i) + "." + FileType.swiftDeps.rawValue))!
+  }
+
+  var mockID: Int {
+    Int(file.basenameWithoutExt)!
+  }
+
+  var sourceFileProvideNameForMockDependencySource: String {
+    file.name
+  }
+
+  var interfaceHashForMockDependencySource: String {
+    file.name
+  }
+}
+
+extension ModuleDependencyGraph.NodeFinder {
+  func findFileInterfaceNode(
+    forMock dependencySource: DependencySource
+  ) -> Graph.Node?  {
+    let fileKey = DependencyKey(fileKeyForMockDependencySource: dependencySource)
+    return findNode((dependencySource, fileKey))
+  }
+}
+
+fileprivate extension DependencyKey {
+  init(fileKeyForMockDependencySource dependencySource: DependencySource) {
+    self.init(aspect: .interface,
+              designator:
+                .sourceFileProvide(name: dependencySource.sourceFileProvidesNameForMocking)
+    )
+  }
+}
+
+fileprivate extension DependencySource {
+  var sourceFileProvidesNameForMocking: String {
+    // Only when mocking are these two guaranteed to be the same
+    file.name
+  }
+}