plx/hdxl-xctest-retrofit

Seamlessly migrate XCTest assertions to Swift Testing with familiar syntax.

Overview

HDXLXCTestRetrofit provides drop-in replacements for XCTest assertions that work with Swift Testing. Simply prefix your existing XCTest assertions with # to use the new Swift Testing framework while keeping your test logic intact.

// Before: XCTest
func testAddition() {
  XCTAssertEqual(2 + 2, 4, "Math still works")
}

// After: Swift Testing with HDXLXCTestRetrofit
@Test
func addition() {
  #XCTAssertEqual(2 + 2, 4, "Math still works")
}

Installation

Add HDXLXCTestRetrofit to your Package.swift:

dependencies: [
    .package(url: "https://github.com/hdxl/hdxl-xctest-retrofit.git", from: "1.0.0")
]

Then add it as a dependency to your test target:

.testTarget(
    name: "MyTests",
    dependencies: [
        "HDXLXCTestRetrofit",
        // your other dependencies
    ]
)

Quick Start

Import the package in your test files:

``swift import Testing import HDXLXCTestRetrofit ``

Convert test classes to @Suite and test methods to @Test

Prefix XCTest assertions with #:

``swift #XCTAssertTrue(user.isActive) #XCTAssertNil(error) #XCTAssertEqual(result, expected, "Custom failure message") ``

Why Use This?

Migrating large test suites from XCTest to Swift Testing can be daunting when you have:

Thousands of assertions across hundreds of test files
Custom validation helpers built on XCTest assertions
Carefully crafted failure messages providing context

HDXLXCTestRetrofit lets you migrate incrementally:

Update test structure (@Suite, @Test)
Add # prefix to assertions
Keep all your existing test logic and messages

Supported Assertions

All standard XCTest assertions are supported:

Basic Assertions

#XCTAssert / #XCTAssertTrue
#XCTAssertFalse
#XCTAssertNil / #XCTAssertNotNil
#XCTFail
#XCTUnwrap

Equality & Comparison

#XCTAssertEqual / #XCTAssertNotEqual
#XCTAssertIdentical / #XCTAssertNotIdentical
#XCTAssertGreaterThan / #XCTAssertGreaterThanOrEqual
#XCTAssertLessThan / #XCTAssertLessThanOrEqual

Floating Point

#XCTAssertEqual (with accuracy parameter)
#XCTAssertNotEqual (with accuracy parameter)

Error Handling

#XCTAssertThrowsError
#XCTAssertNoThrow

Advanced Usage

Custom Validation Helpers

Each assertion supports a sourceLocation parameter for better error reporting in helper functions:

func verifyUserState(
    _ user: User,
    isActive: Bool,
    sourceLocation: Testing.SourceLocation = #_sourceLocation
) {
    #XCTAssertEqual(user.isActive, isActive, sourceLocation: sourceLocation)
    #XCTAssertNotNil(user.lastLogin, "Active users must have login history", sourceLocation: sourceLocation)
}

@Test func userValidation() {
    let user = User(name: "Test")
    verifyUserState(user, isActive: true)  // Failures point to this line
}

Documentation

Requirements

Swift 6.0+
Xcode 16.0+
Platforms: macOS 15+, iOS 18+, tvOS 18+, watchOS 11+, visionOS 2+

License

MIT License - see LICENSE file for details.

Package Metadata

Repository: plx/hdxl-xctest-retrofit

Default branch: main

README: README.md