Giter VIP home page Giter VIP logo

swift-xctesting's Introduction

XCTesting

Archived because Xcode 16 supports Swift Testing directly

A Swift Macro for generating XCTest compatible scaffolding around tests written for swift-testing

This allows Test Suites & Cases Placeholders to be shown in Even tough you shouldn't need more than the Getting Started Section there is an in progress Documentation hosted here: +Documentation

Getting Started

  • Swift Package Index
  • Documentation

Installing

First add XCTesting as a depency to your Swift Package or Xcode Project

// Dependency
.package(url: "https://github.com/NoahKamara/swift-xctesting.git", from: "0.1.0")

// Target Dependency
.product(name: "Testing", package: "swift-testing")

Usage

Simply add the @XCTesting attribute to a Test or Suite and it will generate a XCTestCase with dummy tests

@XCTesting
@Suite
struct MyTests {
    @Test(arguments: [1,2,3])
    func example(arg: Int) {
        #expect(arg > 0
    }
}

// Expansion from XCTesting
class MyTests_XCTest: XCTestCase {
    func testExample() async throws {
        try await Tests.run(suite: MyTests.self, testName: "testExample(arg:)", hostedBy: self)
    }
}

If you apply @XCTesting to standalone test function it will generate a XCTestCase with only one dummy

be warned: this might clutter xcodes test output

@Test(arguments: [1,2,3])
func standaloneExample(arg: Int) {
    #expect(arg > 0)
}

// Expansion from XCTesting
class standaloneExample_XCTest: XCTestCase {
    func testStandaloneExample() async throws {
        try await Tests.run(testName: "testExample(arg:)", hostedBy: self)
    }
}

Contributing

Contributions are always welcome!

The Scope of this project should remain bridging swift-testing and XCTest for IDE support

Roadmap

  • Scaffolding for Suites
  • Scaffolding for Functions
  • Support Failures
  • Support Skip
  • Add better documentation
  • Investigate better supporting traits
  • ...

swift-xctesting's People

Contributors

noahkamara avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.