File: RepeatUntilExpectedResult.swift

package info (click to toggle)
swiftlang 6.1.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,791,604 kB
  • sloc: cpp: 9,901,740; ansic: 2,201,431; asm: 1,091,827; python: 308,252; objc: 82,166; f90: 80,126; lisp: 38,358; pascal: 25,559; sh: 20,429; ml: 5,058; perl: 4,745; makefile: 4,484; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (37 lines) | stat: -rw-r--r-- 1,352 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
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2020 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 SKLogging
import SwiftExtensions
import XCTest

/// Runs the body repeatedly once per second until it returns `true`, giving up after `timeout`.
///
/// This is useful to test some request that requires global state to be updated but will eventually converge on the
/// correct result.
///
/// `sleepInterval` is the duration to wait before re-executing the body.
package func repeatUntilExpectedResult(
  timeout: Duration = .seconds(defaultTimeout),
  sleepInterval: Duration = .seconds(1),
  _ body: () async throws -> Bool,
  file: StaticString = #filePath,
  line: UInt = #line
) async throws {
  for _ in 0..<Int(timeout.seconds / sleepInterval.seconds) {
    if try await body() {
      return
    }
    try await Task.sleep(for: sleepInterval)
  }
  XCTFail("Failed to get expected result", file: file, line: line)
}