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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
/*
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 Swift project authors
*/
import XCTest
@testable import SwiftDocC
/// A test metric to use for tests.
class TestMetric: BenchmarkMetric, BenchmarkBlockMetric, DynamicallyIdentifiableMetric {
let identifier = "com.tests.DynamicMetric"
let displayName = "Dynamic Metric"
static let identifier = "com.tests.TestMetric"
static let displayName = "Test Metric"
let result: MetricValue? = .checksum("Result")
var didBegin = false
var didEnd = false
init() { }
init(didInit: inout Bool) {
didInit = true
}
func begin() { didBegin = true }
func end() { didEnd = true }
}
class BenchmarkTests: XCTestCase {
func testInitialState() {
let testBenchmark = Benchmark()
XCTAssertTrue(testBenchmark.metrics.isEmpty)
}
func testOneOffMetric() {
let testBenchmark = Benchmark()
// Add a one-off metric
benchmark(add: TestMetric(), benchmarkLog: testBenchmark)
XCTAssertEqual(testBenchmark.metrics.count, 1)
guard testBenchmark.metrics.count == 1 else { return }
// Verify the metric details
XCTAssertEqual(type(of: testBenchmark.metrics[0]).identifier, "com.tests.TestMetric")
}
func testRangeMetric() {
let testBenchmark = Benchmark()
// Test metric initial state
let metric = TestMetric()
XCTAssertFalse(metric.didBegin)
XCTAssertFalse(metric.didEnd)
// Test metric has begun
_ = benchmark(begin: metric, benchmarkLog: testBenchmark)
XCTAssertTrue(metric.didBegin)
XCTAssertFalse(metric.didEnd)
// Test metric has ended
benchmark(end: metric, benchmarkLog: testBenchmark)
XCTAssertTrue(metric.didBegin)
XCTAssertTrue(metric.didEnd)
}
func testFilteredMetric() {
// Verify exact filter query
do {
let testBenchmark = Benchmark(metricsFilter: "com.tests.TestMetric")
benchmark(add: TestMetric(), benchmarkLog: testBenchmark)
benchmark(end: benchmark(begin: TestMetric(), benchmarkLog: testBenchmark), benchmarkLog: testBenchmark)
XCTAssertEqual(testBenchmark.metrics.count, 2)
}
// Verify partial filter query
do {
let testBenchmark = Benchmark(metricsFilter: "com.tests")
benchmark(add: TestMetric(), benchmarkLog: testBenchmark)
benchmark(end: benchmark(begin: TestMetric(), benchmarkLog: testBenchmark), benchmarkLog: testBenchmark)
XCTAssertEqual(testBenchmark.metrics.count, 2)
}
// Verify non-matching filter query
do {
let testBenchmark = Benchmark(metricsFilter: "com.mests")
benchmark(add: TestMetric(), benchmarkLog: testBenchmark)
benchmark(end: benchmark(begin: TestMetric(), benchmarkLog: testBenchmark), benchmarkLog: testBenchmark)
XCTAssertEqual(testBenchmark.metrics.count, 0)
// Verify filtered range metric returns nil
XCTAssertNil(benchmark(begin: TestMetric(), benchmarkLog: testBenchmark))
}
}
func testFilteredMetricInit() {
// Verify exact filter query
do {
var didInitializeTheMetric = false
let testBenchmark = Benchmark(metricsFilter: "com.tests.TestMetric")
benchmark(add: TestMetric(didInit: &didInitializeTheMetric), benchmarkLog: testBenchmark)
XCTAssertTrue(didInitializeTheMetric)
// Verify exact filter query
didInitializeTheMetric = false
_ = benchmark(begin: TestMetric(didInit: &didInitializeTheMetric), benchmarkLog: testBenchmark)
XCTAssertTrue(didInitializeTheMetric)
}
// Verify with non-matching query
do {
var didInitializeTheMetric = false
let testBenchmark = Benchmark(metricsFilter: "com.mests")
benchmark(add: TestMetric(didInit: &didInitializeTheMetric), benchmarkLog: testBenchmark)
XCTAssertFalse(didInitializeTheMetric)
// Verify with non-matching query
didInitializeTheMetric = false
_ = benchmark(begin: TestMetric(didInit: &didInitializeTheMetric), benchmarkLog: testBenchmark)
XCTAssertFalse(didInitializeTheMetric)
}
}
func testDynamicMetrics() throws {
// Encode a dynamic metric
let testBenchmark = Benchmark()
benchmark(add: TestMetric(), benchmarkLog: testBenchmark)
let encoder = JSONEncoder()
let data = try encoder.encode(testBenchmark)
// Verify the dynamic id and name were encoded
let result = try JSONDecoder().decode(BenchmarkResults.self, from: data)
let metric = try XCTUnwrap(result.metrics.first)
XCTAssertEqual(metric.id, "com.tests.DynamicMetric")
XCTAssertEqual(metric.displayName, "Dynamic Metric")
}
func testRangeMetricWithBlock() {
let testBenchmark = Benchmark()
// Test metric initial state
let metric = TestMetric()
XCTAssertFalse(metric.didBegin)
XCTAssertFalse(metric.didEnd)
// Test metric has begun
benchmark(wrap: metric, benchmarkLog: testBenchmark) {
XCTAssertTrue(metric.didBegin)
XCTAssertFalse(metric.didEnd)
}
// Test metric has ended
XCTAssertTrue(metric.didBegin)
XCTAssertTrue(metric.didEnd)
}
func testRangeMetricWithBlockReturns() {
// Test with enabled benchmark
do {
let testBenchmark = Benchmark(isEnabled: true)
let result = benchmark(wrap: TestMetric(), benchmarkLog: testBenchmark) {
return "12345"
}
XCTAssertEqual("12345", result)
}
// Test with disabled benchmark
do {
let testBenchmark = Benchmark(isEnabled: false)
let result = benchmark(wrap: TestMetric(), benchmarkLog: testBenchmark) {
return "12345"
}
XCTAssertEqual("12345", result)
}
}
}
|
