File: ExpectedCompilations.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (70 lines) | stat: -rw-r--r-- 2,894 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
//===-------------- ExpectedCompilations.swift - Swift Testing -------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 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 XCTest
import TSCBasic

/// The `Source`s expected to be compiled in a `Step`, when incremental imports are either enabled or disabled.
public struct ExpectedCompilations {
  let whenEnabled: Set<Source>
  let whenDisabled: Set<Source>

  private init(whenEnabled: Set<Source>, whenDisabled: Set<Source>) {
    self.whenEnabled = whenEnabled
    self.whenDisabled = whenDisabled
  }

  /// Create an `ExpectedCompilations`
  /// - Parameters:
  ///   - always: The sources to expect whether incremental imports are enabled or not
  ///   - andWhenDisabled: The additional sources to expect when incremental imports are disabled
  /// - Returns: An `ExpctecCompilations`
  public init(always: [Source], andWhenDisabled: [Source] = []) {
    self.init(whenEnabled: Set(always),
              whenDisabled: Set(always + andWhenDisabled))
  }

  public init(allSourcesOf modules: [Module]) {
    self.init(always: modules.flatMap {$0.sources})
  }

  /// Creates an `IncrementalImports` that expects no compilations.
  public static let none = Self(always: [])

  /// Check the actual compilations against what `self` expects.
  /// Fails an `XCTest assertion` with a somewhat wordy message of things are not hunky-dory.
  /// - Parameters:
  ///   - against: The actual compiled sources to check against.
  ///   - step: The `Step` that changed the source, ran the compiler, and needs to check the results.
  ///   - in: The context of this test.
  func check(against actuals: [Source], step: Step, in context: Context) {
    let expectedSet = Set(expected(when: context.incrementalImports))
    let actualsSet = Set(actuals)

    let   extraCompilations =  actualsSet.subtracting(expectedSet).map {$0.name}.sorted()
    let missingCompilations = expectedSet.subtracting( actualsSet).map {$0.name}.sorted()

    XCTAssert(extraCompilations.isEmpty,
      "Extra compilations: \(extraCompilations), \(context.failMessage(step))",
      file: context.file, line: context.line)

    XCTAssert(missingCompilations.isEmpty,
      "Missing compilations: \(missingCompilations), \(context.failMessage(step))",
      file: context.file, line: context.line)
  }

  private func expected(when incrementalImports: Context.IncrementalImports) -> Set<Source> {
    switch incrementalImports {
    case .enabled: return whenEnabled
    case .disabled: return whenDisabled
    }
  }
}