[SR-5643] Adopt Swift 4 API adjustments from Apple XCTest #198
Conversation
|
@swift-ci please test |
|
@parkera I used corelibs-foundation as a model for adding a couple of types here ( |
Prior to Swift 4, several XCTest APIs were brought into Swift using the `UInt` type, in contrast to other Apple system frameworks which consistently used `Int`. In Swift 4, XCTest began being treated as a system framework and now uses `Int` as well. This change adapts the swift-corelibs-xctest API to match.
… function This change was made in Xcode 9 as part of XCTest's Swiftification effort.
This is to match the struct generated by the Objective-C importer for Apple XCTest due to its XCTestErrorCode having been marked with the NSErrorDomain API note.
In Xcode 9, the XCTPerformanceMetric_WallClockTime string constant was turned into a string enumeration to improve the ability to use strong typing at call sites using it. At the same time, the defaultPerformanceMetrics class function on XCTestCase was changed to be a class property.
briancroom
force-pushed
the
swift4-API-compatibility
branch
from
d15f18c to
22e1c07
Compare
|
@swift-ci please test |
|
I updated this to no longer make the |
|
@swift-ci please test |
|
@czechboy0 could you take a look here when you get a chance? Thanks! |
| self.metrics = metrics | ||
| self.delegate = delegate | ||
| self.invocationFile = file | ||
| self.invocationLine = line | ||
| } | ||
|
|
||
| static func measureMetrics(_ metricNames: [String], delegate: PerformanceMeterDelegate, file: StaticString = #file, line: UInt = #line, for block: (PerformanceMeter) -> Void) { | ||
| static func measureMetrics(_ metricNames: [String], delegate: PerformanceMeterDelegate, file: StaticString = #file, line: Int = #line, for block: (PerformanceMeter) -> Void) { |
There was a problem hiding this comment.
Why not make metricNames: [PerformanceMetric] too? As they're strings, we have to map from PerformanceMetric to String down below.
There was a problem hiding this comment.
Hmm..
One of the design goals with the PerformanceMeter and WallClockTimeMetric classes was for them to be entirely decoupled from the XCTest-specific stuff. i.e. they are conceptually a lower layer upon which the XCTest API sits. Ideally they would exist in their own separate module, but it's not currently possible to do that while still keeping XCTest library product and module standalone. See #109 for earlier discussion.
How do you feel about this given that context?
There was a problem hiding this comment.
That makes sense. A possible (future) improvement could be to create a similar enum at the PerformanceMeter layer.
| guard _performanceMeter == nil else { | ||
| return recordAPIViolation(description: "Can only record one set of metrics per test method.", file: file, line: line) | ||
| } | ||
|
|
||
| PerformanceMeter.measureMetrics(metrics, delegate: self, file: file, line: line) { meter in | ||
| PerformanceMeter.measureMetrics(metrics.map({ $0.rawValue }), delegate: self, file: file, line: line) { meter in |
There was a problem hiding this comment.
We could get rid of this map if we move to [XCTPerformanceMetric] across the board.
|
It didn't make it to the Xcode9 GM either? I mean it works when building with Xcode, but not when launch test from the command line with "swift build" Apple Swift version 4.0 (swiftlang-900.0.65 clang-900.0.37) Target: x86_64-apple-macosx10.9 |
In Xcode 9, XCTest underwent a bit of a "Swiftification" effort to adopt more modern Swift idioms and improve how its APIs get presented in Swift 4. This PR adopts those changes here as well. They include:
UInt->Int. Prior to Swift 4, several XCTest APIs were brought into Swift using theUInttype, in contrast to other Apple system frameworks which consistently usedInt. In Swift 4, XCTest began being treated as a system framework and now usesIntas well.XCTestObservationCenter.shareda class property instead of class function.XCTestErrorstruct. This is to match the struct generated by the Objective-C importer forApple XCTest due to its
XCTestErrorCodehaving been marked with theNSErrorDomainAPI note.XCTPerformanceMetricstring enum. In Xcode 9, theXCTPerformanceMetric_WallClockTimestring constant was turned into a string enumeration to improve the ability to use strong typingat call sites using it. At the same time, the
defaultPerformanceMetricsclass function onXCTestCasewas changed to be a class property.