File: HiddenTrait.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 (38 lines) | stat: -rw-r--r-- 1,220 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
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2023 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 Swift project authors
//

/// A type that indicates that a test should be hidden from automatic discovery
/// and only run if explicitly requested.
///
/// This is different from disabled or skipped, and is primarily meant to be
/// used on tests defined in this project's own test suite, so that example
/// tests can be defined using the `@Test` attribute but not run by default
/// except by the specific unit test(s) which have requested to run them.
///
/// This type is not part of the public interface of the testing library.
struct HiddenTrait: TestTrait, SuiteTrait {
  var isRecursive: Bool {
    true
  }
}

extension Trait where Self == HiddenTrait {
  static var hidden: Self {
    HiddenTrait()
  }
}

extension Test {
  /// Whether this test is hidden, whether directly or via a trait inherited
  /// from a parent test.
  var isHidden: Bool {
    traits.contains { $0 is HiddenTrait }
  }
}