[SE-0046] Implemented consistent function labels

Author: Harlan Haskins

Sources/XCTest/TestFiltering.swift

@@ -35,7 +35,7 @@ internal struct TestFiltering {
         return { _ in true }
     }
 
-    static func filterTests(entries: [XCTestCaseEntry], filter: TestFilter) -> [XCTestCaseEntry] {
+    static func filterTests(_ entries: [XCTestCaseEntry], filter: TestFilter) -> [XCTestCaseEntry] {
         return entries
             .map { testCase, tests in
                 return (testCase, tests.filter { filter(testCase, $0.0) } )
@@ -68,7 +68,7 @@ private extension SelectedTest {
         }
     }
 
-    func matches(testCase testCase: XCTestCase.Type, testName: String) -> Bool {
+    func matches(testCase: XCTestCase.Type, testName: String) -> Bool {
         return String(reflecting: testCase) == testCaseName && (self.testName == nil || testName == self.testName)
     }
 }

Sources/XCTest/XCTAssert.swift

@@ -58,7 +58,7 @@ private enum _XCTAssertionResult {
         }
     }
 
-    func failureDescription(assertion: _XCTAssertion) -> String {
+    func failureDescription(_ assertion: _XCTAssertion) -> String {
         let explanation: String
         switch self {
         case .Success: explanation = "passed"
@@ -75,7 +75,7 @@ private enum _XCTAssertionResult {
     }
 }
 
-private func _XCTEvaluateAssertion(assertion: _XCTAssertion, @autoclosure message: () -> String = "", file: StaticString = #file, line: UInt = #line, @noescape expression: () throws -> _XCTAssertionResult) {
+private func _XCTEvaluateAssertion(_ assertion: _XCTAssertion, @autoclosure message: () -> String = "", file: StaticString = #file, line: UInt = #line, @noescape expression: () throws -> _XCTAssertionResult) {
     let result: _XCTAssertionResult
     do {
         result = try expression()
@@ -148,7 +148,7 @@ private func _XCTEvaluateAssertion(assertion: _XCTAssertion, @autoclosure messag
 ///
 ///  Now calling failures in `AssertEmpty` will be reported in the file and on
 ///  the line that the assert function is *called*, not where it is defined.
-public func XCTAssert(@autoclosure expression: () throws -> Boolean, @autoclosure _ message: () -> String = "", file: StaticString = #file, line: UInt = #line) {
+public func XCTAssert(@autoclosure _ expression: () throws -> Boolean, @autoclosure _ message: () -> String = "", file: StaticString = #file, line: UInt = #line) {
     XCTAssertTrue(expression, message, file: file, line: line)
 }
 
@@ -218,7 +218,7 @@ public func XCTAssertEqualWithAccuracy<T: FloatingPoint>(@autoclosure expression
     }
 }
 
-public func XCTAssertFalse(@autoclosure expression: () throws -> Boolean, @autoclosure _ message: () -> String = "", file: StaticString = #file, line: UInt = #line) {
+public func XCTAssertFalse(@autoclosure _ expression: () throws -> Boolean, @autoclosure _ message: () -> String = "", file: StaticString = #file, line: UInt = #line) {
     _XCTEvaluateAssertion(.False, message: message, file: file, line: line) {
         let value = try expression()
         if !value.boolValue {
@@ -273,7 +273,7 @@ public func XCTAssertLessThanOrEqual<T: Comparable>(@autoclosure expression1: ()
     }
 }
 
-public func XCTAssertNil(@autoclosure expression: () throws -> Any?, @autoclosure _ message: () -> String = "", file: StaticString = #file, line: UInt = #line) {
+public func XCTAssertNil(@autoclosure _ expression: () throws -> Any?, @autoclosure _ message: () -> String = "", file: StaticString = #file, line: UInt = #line) {
     _XCTEvaluateAssertion(.Nil, message: message, file: file, line: line) {
         let value = try expression()
         if value == nil {
@@ -350,7 +350,7 @@ public func XCTAssertNotEqualWithAccuracy<T: FloatingPoint>(@autoclosure express
     }
 }
 
-public func XCTAssertNotNil(@autoclosure expression: () throws -> Any?, @autoclosure _ message: () -> String = "", file: StaticString = #file, line: UInt = #line) {
+public func XCTAssertNotNil(@autoclosure _ expression: () throws -> Any?, @autoclosure _ message: () -> String = "", file: StaticString = #file, line: UInt = #line) {
     _XCTEvaluateAssertion(.NotNil, message: message, file: file, line: line) {
         let value = try expression()
         if value != nil {
@@ -361,7 +361,7 @@ public func XCTAssertNotNil(@autoclosure expression: () throws -> Any?, @autoclo
     }
 }
 
-public func XCTAssertTrue(@autoclosure expression: () throws -> Boolean, @autoclosure _ message: () -> String = "", file: StaticString = #file, line: UInt = #line) {
+public func XCTAssertTrue(@autoclosure _ expression: () throws -> Boolean, @autoclosure _ message: () -> String = "", file: StaticString = #file, line: UInt = #line) {
     _XCTEvaluateAssertion(.True, message: message, file: file, line: line) {
         let value = try expression()
         if value.boolValue {
@@ -372,7 +372,7 @@ public func XCTAssertTrue(@autoclosure expression: () throws -> Boolean, @autocl
     }
 }
 
-public func XCTFail(message: String = "", file: StaticString = #file, line: UInt = #line) {
+public func XCTFail(_ message: String = "", file: StaticString = #file, line: UInt = #line) {
     _XCTEvaluateAssertion(.Fail, message: message, file: file, line: line) {
         return .ExpectedFailure(nil)
     }

Sources/XCTest/XCTestCase.swift

@@ -84,7 +84,7 @@ extension XCTestCase {
         }
     }
 
-    internal static func invokeTests(tests: [(String, XCTestCase throws -> Void)]) {
+    internal static func invokeTests(_ tests: [(String, XCTestCase throws -> Void)]) {
         let observationCenter = XCTestObservationCenter.shared()
 
         var totalDuration = 0.0
@@ -156,7 +156,7 @@ extension XCTestCase {
 
     /// It is an API violation to create expectations but not wait for them to
     /// be completed. Notify the user of a mistake via a test failure.
-    private func failIfExpectationsNotWaitedFor(expectations: [XCTestExpectation]) {
+    private func failIfExpectationsNotWaitedFor(_ expectations: [XCTestExpectation]) {
         if expectations.count > 0 {
             let failure = XCTFailure(
                 message: "Failed due to unwaited expectations.",
@@ -190,7 +190,7 @@ extension XCTestCase {
     ///   between these environments. To ensure compatibility of tests between
     ///   swift-corelibs-xctest and Apple XCTest, it is not recommended to pass
     ///   explicit values for `file` and `line`.
-    public func expectationWithDescription(description: String, file: StaticString = #file, line: UInt = #line) -> XCTestExpectation {
+    public func expectationWithDescription(_ description: String, file: StaticString = #file, line: UInt = #line) -> XCTestExpectation {
         let expectation = XCTestExpectation(
             description: description,
             file: file,
@@ -225,7 +225,7 @@ extension XCTestCase {
     ///   these environments. To ensure compatibility of tests between
     ///   swift-corelibs-xctest and Apple XCTest, it is not recommended to pass
     ///   explicit values for `file` and `line`.
-    public func waitForExpectationsWithTimeout(timeout: NSTimeInterval, file: StaticString = #file, line: UInt = #line, handler: XCWaitCompletionHandler?) {
+    public func waitForExpectationsWithTimeout(_ timeout: NSTimeInterval, file: StaticString = #file, line: UInt = #line, handler: XCWaitCompletionHandler?) {
         // Mirror Objective-C XCTest behavior; display an unexpected test
         // failure when users wait without having first set expectations.
         // FIXME: Objective-C XCTest raises an exception for most "API
@@ -323,7 +323,7 @@ extension XCTestCase {
     ///   notification is observed. It will not be invoked on timeout. Use the
     ///   handler to further investigate if the notification fulfills the 
     ///   expectation.
-    public func expectationForNotification(notificationName: String, object objectToObserve: AnyObject?, handler: XCNotificationExpectationHandler?) -> XCTestExpectation {
+    public func expectationForNotification(_ notificationName: String, object objectToObserve: AnyObject?, handler: XCNotificationExpectationHandler?) -> XCTestExpectation {
         let objectDescription = objectToObserve == nil ? "any object" : "\(objectToObserve!)"
         let expectation = self.expectationWithDescription("Expect notification '\(notificationName)' from " + objectDescription)
         // Start observing the notification with specified name and object.

Sources/XCTest/XCTestExpectation.swift

@@ -47,7 +47,7 @@ public class XCTestExpectation {
     ///   between these environments. To ensure compatibility of tests between
     ///   swift-corelibs-xctest and Apple XCTest, it is not recommended to pass
     ///   explicit values for `file` and `line`.
-    public func fulfill(file: StaticString = #file, line: UInt = #line) {
+    public func fulfill(_ file: StaticString = #file, line: UInt = #line) {
         // FIXME: Objective-C XCTest emits failures when expectations are
         //        fulfilled after the test cases that generated those
         //        expectations have completed. Similarly, this should cause an

Sources/XCTest/XCTestMain.swift

@@ -20,7 +20,7 @@
     import SwiftFoundation
 #endif
 
-internal func XCTPrint(message: String) {
+internal func XCTPrint(_ message: String) {
     print(message)
     fflush(stdout)
 }
@@ -34,7 +34,7 @@ struct XCTFailure {
 
     var failureMessage: String { return "\(failureDescription) - \(message)" }
 
-    func emit(method: String) {
+    func emit(_ method: String) {
         XCTPrint("\(file):\(line): \(expected ? "" : "unexpected ")error: \(method) : \(failureMessage)")
     }
 }
@@ -78,7 +78,7 @@ internal struct XCTRun {
 ///
 /// - Parameter testCases: An array of test cases run, each produced by a call to the `testCase` function
 /// - seealso: `testCase`
-@noreturn public func XCTMain(testCases: [XCTestCaseEntry]) {
+@noreturn public func XCTMain(_ testCases: [XCTestCaseEntry]) {
     let observationCenter = XCTestObservationCenter.shared()
     let testBundle = NSBundle.mainBundle()
     observationCenter.testBundleWillStart(testBundle)

Sources/XCTest/XCTestObservation.swift

@@ -25,17 +25,17 @@ public protocol XCTestObservation: class {
     /// Sent immediately before tests begin as a hook for any pre-testing setup.
     /// - Parameter testBundle: The bundle containing the tests that were
     ///   executed.
-    func testBundleWillStart(testBundle: NSBundle)
+    func testBundleWillStart(_ testBundle: NSBundle)
 
     /// Sent when a test suite starts executing.
     /// - Parameter testSuite: The test suite that started. Additional
     ///   information can be retrieved from the associated XCTestRun.
-    func testSuiteWillStart(testSuite: XCTestSuite)
+    func testSuiteWillStart(_ testSuite: XCTestSuite)
 
     /// Called just before a test begins executing.
     /// - Parameter testCase: The test case that is about to start. Its `name`
     ///   property can be used to identify it.
-    func testCaseWillStart(testCase: XCTestCase)
+    func testCaseWillStart(_ testCase: XCTestCase)
 
     /// Called when a test failure is reported.
     /// - Parameter testCase: The test case that failed. Its `name` property 
@@ -45,17 +45,17 @@ public protocol XCTestObservation: class {
     ///   was reported, if available.
     /// - Parameter lineNumber: The line number in the source file where the
     ///   failure was reported.
-    func testCase(testCase: XCTestCase, didFailWithDescription description: String, inFile filePath: String?, atLine lineNumber: UInt)
+    func testCase(_ testCase: XCTestCase, didFailWithDescription description: String, inFile filePath: String?, atLine lineNumber: UInt)
 
     /// Called just after a test finishes executing.
     /// - Parameter testCase: The test case that finished. Its `name` property 
     ///   can be used to identify it.
-    func testCaseDidFinish(testCase: XCTestCase)
+    func testCaseDidFinish(_ testCase: XCTestCase)
 
     /// Sent when a test suite finishes executing.
     /// - Parameter testSuite: The test suite that finished. Additional
     ///   information can be retrieved from the associated XCTestRun.
-    func testSuiteDidFinish(testSuite: XCTestSuite)
+    func testSuiteDidFinish(_ testSuite: XCTestSuite)
 
     /// Sent immediately after all tests have finished as a hook for any
     /// post-testing activity. The test process will generally exit after this
@@ -64,16 +64,16 @@ public protocol XCTestObservation: class {
     /// it blocks until all such activity is complete.
     /// - Parameter testBundle: The bundle containing the tests that were
     ///   executed.
-    func testBundleDidFinish(testBundle: NSBundle)
+    func testBundleDidFinish(_ testBundle: NSBundle)
 }
 
 // All `XCTestObservation` methods are optional, so empty default implementations are provided
 public extension XCTestObservation {
-    func testBundleWillStart(testBundle: NSBundle) {}
-    func testSuiteWillStart(testSuite: XCTestSuite) {}
-    func testCaseWillStart(testCase: XCTestCase) {}
-    func testCase(testCase: XCTestCase, didFailWithDescription description: String, inFile filePath: String?, atLine lineNumber: UInt) {}
-    func testCaseDidFinish(testCase: XCTestCase) {}
-    func testSuiteDidFinish(testSuite: XCTestSuite) {}
-    func testBundleDidFinish(testBundle: NSBundle) {}
+    func testBundleWillStart(_ testBundle: NSBundle) {}
+    func testSuiteWillStart(_ testSuite: XCTestSuite) {}
+    func testCaseWillStart(_ testCase: XCTestCase) {}
+    func testCase(_ testCase: XCTestCase, didFailWithDescription description: String, inFile filePath: String?, atLine lineNumber: UInt) {}
+    func testCaseDidFinish(_ testCase: XCTestCase) {}
+    func testSuiteDidFinish(_ testSuite: XCTestSuite) {}
+    func testBundleDidFinish(_ testBundle: NSBundle) {}
 }

Sources/XCTest/XCTestObservationCenter.swift

@@ -33,45 +33,45 @@ public class XCTestObservationCenter {
 
     /// Register an observer to receive future events during a test run. The order
     /// in which individual observers are notified about events is undefined.
-    public func addTestObserver(testObserver: XCTestObservation) {
+    public func addTestObserver(_ testObserver: XCTestObservation) {
         observers.insert(testObserver.wrapper)
     }
 
     /// Remove a previously-registered observer so that it will no longer receive
     /// event callbacks.
-    public func removeTestObserver(testObserver: XCTestObservation) {
+    public func removeTestObserver(_ testObserver: XCTestObservation) {
         observers.remove(testObserver.wrapper)
     }
 
-    internal func testBundleWillStart(testBundle: NSBundle) {
+    internal func testBundleWillStart(_ testBundle: NSBundle) {
         forEachObserver { $0.testBundleWillStart(testBundle) }
     }
 
-    internal func testSuiteWillStart(testSuite: XCTestSuite) {
+    internal func testSuiteWillStart(_ testSuite: XCTestSuite) {
         forEachObserver { $0.testSuiteWillStart(testSuite) }
     }
 
-    internal func testCaseWillStart(testCase: XCTestCase) {
+    internal func testCaseWillStart(_ testCase: XCTestCase) {
         forEachObserver { $0.testCaseWillStart(testCase) }
     }
 
-    internal func testCase(testCase: XCTestCase, didFailWithDescription description: String, inFile filePath: String?, atLine lineNumber: UInt) {
+    internal func testCase(_ testCase: XCTestCase, didFailWithDescription description: String, inFile filePath: String?, atLine lineNumber: UInt) {
         forEachObserver { $0.testCase(testCase, didFailWithDescription: description, inFile: filePath, atLine: lineNumber) }
     }
 
-    internal func testCaseDidFinish(testCase: XCTestCase) {
+    internal func testCaseDidFinish(_ testCase: XCTestCase) {
         forEachObserver { $0.testCaseDidFinish(testCase) }
     }
 
-    internal func testSuiteDidFinish(testSuite: XCTestSuite) {
+    internal func testSuiteDidFinish(_ testSuite: XCTestSuite) {
         forEachObserver { $0.testSuiteDidFinish(testSuite) }
     }
 
-    internal func testBundleDidFinish(testBundle: NSBundle) {
+    internal func testBundleDidFinish(_ testBundle: NSBundle) {
         forEachObserver { $0.testBundleDidFinish(testBundle) }
     }
 
-    private func forEachObserver(@noescape body: XCTestObservation -> Void) {
+    private func forEachObserver(@noescape _ body: XCTestObservation -> Void) {
         for observer in observers {
             body(observer.object)
         }

Sources/XCTest/XCTestSuite.swift

@@ -52,7 +52,7 @@ public class XCTestSuite: XCTest {
 
     /// Adds a test (either an `XCTestSuite` or an `XCTestCase` to this
     /// collection.
-    public func addTest(test: XCTest) {
+    public func addTest(_ test: XCTest) {
         tests.append(test)
     }
 }

Sources/XCTest/XCTimeUtilities.swift

@@ -30,7 +30,7 @@ private func currentTimeIntervalSinceReferenceTime() -> NSTimeInterval {
 }
 
 /// Execute the given block and return the time spent during execution
-internal func measureTimeExecutingBlock(@noescape block: () -> Void) -> NSTimeInterval {
+internal func measureTimeExecutingBlock(@noescape _ block: () -> Void) -> NSTimeInterval {
     let start = currentTimeIntervalSinceReferenceTime()
     block()
     let end = currentTimeIntervalSinceReferenceTime()
@@ -39,6 +39,6 @@ internal func measureTimeExecutingBlock(@noescape block: () -> Void) -> NSTimeIn
 }
 
 /// Returns a string version of the given time interval rounded to no more than 3 decimal places.
-internal func printableStringForTimeInterval(timeInterval: NSTimeInterval) -> String {
+internal func printableStringForTimeInterval(_ timeInterval: NSTimeInterval) -> String {
     return String(round(timeInterval * 1000.0) / 1000.0)
 }

Tests/Functional/Observation/All/main.swift

@@ -19,31 +19,31 @@ class Observer: XCTestObservation {
     var finishedTestSuites = [XCTestSuite]()
     var finishedBundlePaths = [String]()
 
-    func testBundleWillStart(testBundle: NSBundle) {
+    func testBundleWillStart(_ testBundle: NSBundle) {
         startedBundlePaths.append(testBundle.bundlePath)
     }
 
-    func testSuiteWillStart(testSuite: XCTestSuite) {
+    func testSuiteWillStart(_ testSuite: XCTestSuite) {
         startedTestSuites.append(testSuite)
     }
 
-    func testCaseWillStart(testCase: XCTestCase) {
+    func testCaseWillStart(_ testCase: XCTestCase) {
         startedTestCaseNames.append(testCase.name)
     }
 
-    func testCase(testCase: XCTestCase, didFailWithDescription description: String, inFile filePath: String?, atLine lineNumber: UInt) {
+    func testCase(_ testCase: XCTestCase, didFailWithDescription description: String, inFile filePath: String?, atLine lineNumber: UInt) {
         failureDescriptions.append(description)
     }
 
-    func testCaseDidFinish(testCase: XCTestCase) {
+    func testCaseDidFinish(_ testCase: XCTestCase) {
         finishedTestCaseNames.append(testCase.name)
     }
 
-    func testSuiteDidFinish(testSuite: XCTestSuite) {
+    func testSuiteDidFinish(_ testSuite: XCTestSuite) {
         print("In \(#function): \(testSuite.name)")
     }
 
-    func testBundleDidFinish(testBundle: NSBundle) {
+    func testBundleDidFinish(_ testBundle: NSBundle) {
         print("In \(#function)")
     }
 }

Tests/Functional/Observation/Selected/main.swift

@@ -14,21 +14,21 @@ class Observer: XCTestObservation {
     var startedTestSuites = [XCTestSuite]()
     var finishedTestSuites = [XCTestSuite]()
 
-    func testBundleWillStart(testBundle: NSBundle) {}
+    func testBundleWillStart(_ testBundle: NSBundle) {}
 
-    func testSuiteWillStart(testSuite: XCTestSuite) {
+    func testSuiteWillStart(_ testSuite: XCTestSuite) {
         startedTestSuites.append(testSuite)
     }
 
-    func testCaseWillStart(testCase: XCTestCase) {}
-    func testCase(testCase: XCTestCase, didFailWithDescription description: String, inFile filePath: String?, atLine lineNumber: UInt) {}
-    func testCaseDidFinish(testCase: XCTestCase) {}
+    func testCaseWillStart(_ testCase: XCTestCase) {}
+    func testCase(_ testCase: XCTestCase, didFailWithDescription description: String, inFile filePath: String?, atLine lineNumber: UInt) {}
+    func testCaseDidFinish(_ testCase: XCTestCase) {}
 
-    func testSuiteDidFinish(testSuite: XCTestSuite) {
+    func testSuiteDidFinish(_ testSuite: XCTestSuite) {
         print("In \(#function): \(testSuite.name)")
     }
 
-    func testBundleDidFinish(testBundle: NSBundle) {}
+    func testBundleDidFinish(_ testBundle: NSBundle) {}
 }
 
 let observer = Observer()