Skip to content

Generalize the selectedTests facility to be closure-based, to allow filtering tests via other criteria than ID #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 6 commits into from
Oct 20, 2023
Merged

Generalize the selectedTests facility to be closure-based, to allow filtering tests via other criteria than ID #48

merged 6 commits into from
Oct 20, 2023

Conversation

@stmontgomery
Copy link
Contributor

@stmontgomery stmontgomery commented Oct 3, 2023 •
edited by suzannaratcliff
Loading

Replace Configuration.selectedTests with an optional closure property which acts as a predicate for choosing which tests should be selected.

Motivation:

Currently, the testing library supports selecting specific test(s) to run based on their Test.ID, but we would like it to be possible to select tests based on other criteria, such as specific tag(s), or even based on arbitrary logic. Offering a closure-based predicate to filter tests would help accomplish this.

Modifications:

  • Remove the Configuration.selectedTestIDs and associated storage property.
  • Add a closure property Configuration.testSelectionFilter which accepts a Test and returns Bool whether to include it in the selected tests.
  • Update selection logic in Runner.Plan based on the above changes.
  • Update unit tests.

Result:

There is now a more flexible closure-based facility for selecting/filtering tests.

@stmontgomery stmontgomery added the enhancement New feature or request label Oct 3, 2023
@stmontgomery
Copy link
Contributor Author

stmontgomery commented Oct 3, 2023

@swift-ci please test

grynspan
grynspan reviewed Oct 3, 2023
View reviewed changes
grynspan
grynspan reviewed Oct 3, 2023
View reviewed changes
grynspan
grynspan reviewed Oct 3, 2023
View reviewed changes
grynspan
grynspan reviewed Oct 3, 2023
View reviewed changes
grynspan
grynspan reviewed Oct 3, 2023
View reviewed changes
@suzannaratcliff
Generalize the selectedTests facility to be closure-based, to allow f…
a12bc60 
…iltering tests via other criteria than ID

Add documentation and update the selection to be outside the loop
stmontgomery
stmontgomery commented Oct 5, 2023
View reviewed changes
stmontgomery
stmontgomery commented Oct 5, 2023
View reviewed changes
stmontgomery
stmontgomery commented Oct 5, 2023
View reviewed changes
stmontgomery
stmontgomery commented Oct 5, 2023
View reviewed changes
@suzannaratcliff suzannaratcliff self-requested a review October 10, 2023 22:41
@suzannaratcliff suzannaratcliff marked this pull request as ready for review October 10, 2023 22:43
stmontgomery
stmontgomery commented Oct 17, 2023
View reviewed changes
stmontgomery
stmontgomery commented Oct 17, 2023
View reviewed changes
grynspan
grynspan reviewed Oct 17, 2023
View reviewed changes
grynspan
grynspan reviewed Oct 17, 2023
View reviewed changes
grynspan
grynspan reviewed Oct 17, 2023
View reviewed changes
grynspan
grynspan reviewed Oct 17, 2023
View reviewed changes
@suzannaratcliff
Copy link
Contributor

suzannaratcliff commented Oct 20, 2023

@swift-ci please test

@stmontgomery
Copy link
Contributor Author

stmontgomery commented Oct 20, 2023

Looks good, pending CI!

@suzannaratcliff suzannaratcliff merged commit 5202136 into swiftlang:main Oct 20, 2023
stmontgomery added a commit that referenced this pull request Nov 14, 2023
@stmontgomery
Remove Test.ID.Selection.testIDs Set property
5c43190 
This removes the `Test.ID.Selection.testIDs` property whose type is `Set<Test.ID>`, since it's no longer used as of #48
@stmontgomery stmontgomery mentioned this pull request Nov 14, 2023
Merged
2 tasks
stmontgomery added a commit that referenced this pull request Nov 14, 2023
@stmontgomery
Remove Test.ID.Selection.testIDs Set property (#116)
5d943f2 
This removes the `Test.ID.Selection.testIDs` property whose type is `Set<Test.ID>`, since it's no longer used as of #48
grynspan added a commit that referenced this pull request Jun 11, 2025
@grynspan
Add an unreachable marker function.
39da1cc 
This PR adds a wrapper around `__builtin_unreachable()` (`Builtin.unreachable()`
when building the Swift standard library) that we can use in place of
`fatalError()`. The benefit is that the generated code size for unreachable
paths is significantly reduced. For example, given the following function
compiled with `-O`:

```swift
@available(*, unavailable) func f() {
  fatalError("Unreachable")
}
```

The compiler currently produces:

```asm
sub    sp, sp, #0x20
stp    x29, x30, [sp, #0x10]
add    x29, sp, #0x10
mov    w8, #0x1                  ; =1
str    w8, [sp, #0x8]
mov    w8, #0xc                  ; =12
str    x8, [sp]
adrp   x0, 0
add    x0, x0, #0x6a8            ; "Fatal error"
adrp   x5, 0
add    x5, x5, #0x690            ; "UnreachableTest/S.swift"
mov    x3, #0x6e55               ; =28245
movk   x3, #0x6572, lsl #16
movk   x3, #0x6361, lsl #32
movk   x3, #0x6168, lsl #48
mov    x4, #0x6c62               ; =27746
movk   x4, #0x65, lsl #16
movk   x4, #0xeb00, lsl #48
mov    w1, #0xb                  ; =11
mov    w2, #0x2                  ; =2
mov    w6, #0x17                 ; =23
mov    w7, #0x2                  ; =2
bl     0x100000680               ; symbol stub for: Swift._assertionFailure(_: Swift.StaticString, _: Swift.String, file: Swift.StaticString, line: Swift.UInt, flags: Swift.UInt32) -> Swift.Never
brk    #0x1
```

But with this change:
```swift
@available(*, unavailable) func f() {
  swt_unreachable()
}
```

It instead compiles to simply:

```asm
brk    #0x1
```
grynspan added a commit that referenced this pull request Jun 11, 2025
@grynspan
Add an unreachable marker function.
fcd2cb7 
This PR adds a wrapper around `__builtin_unreachable()` (`Builtin.unreachable()`
when building the Swift standard library) that we can use in place of
`fatalError()`. The benefit is that the generated code size for unreachable
paths is significantly reduced. For example, given the following function
compiled with `-O`:

```swift
@available(*, unavailable) func f() {
  fatalError("Unreachable")
}
```

The compiler currently produces:

```asm
sub    sp, sp, #0x20
stp    x29, x30, [sp, #0x10]
add    x29, sp, #0x10
mov    w8, #0x1                  ; =1
str    w8, [sp, #0x8]
mov    w8, #0xc                  ; =12
str    x8, [sp]
adrp   x0, 0
add    x0, x0, #0x6a8            ; "Fatal error"
adrp   x5, 0
add    x5, x5, #0x690            ; "UnreachableTest/S.swift"
mov    x3, #0x6e55               ; =28245
movk   x3, #0x6572, lsl #16
movk   x3, #0x6361, lsl #32
movk   x3, #0x6168, lsl #48
mov    x4, #0x6c62               ; =27746
movk   x4, #0x65, lsl #16
movk   x4, #0xeb00, lsl #48
mov    w1, #0xb                  ; =11
mov    w2, #0x2                  ; =2
mov    w6, #0x17                 ; =23
mov    w7, #0x2                  ; =2
bl     0x100000680               ; symbol stub for: Swift._assertionFailure(_: Swift.StaticString, _: Swift.String, file: Swift.StaticString, line: Swift.UInt, flags: Swift.UInt32) -> Swift.Never
brk    #0x1
```

But with this change:
```swift
@available(*, unavailable) func f() {
  swt_unreachable()
}
```

It instead compiles to simply:

```asm
brk    #0x1
```
grynspan added a commit that referenced this pull request Jun 12, 2025
@grynspan
Add an unreachable marker function. (#1150)
f66ef03 
This PR adds a wrapper around `__builtin_unreachable()`
(`Builtin.unreachable()` when building the Swift standard library) that
we can use in place of `fatalError()`. The benefit is that the generated
code size for unreachable paths is significantly reduced. For example,
given the following function compiled with `-O`:

```swift
@available(*, unavailable) func f() {
  fatalError("Unreachable")
}
```

The compiler currently produces:

```asm
sub    sp, sp, #0x20
stp    x29, x30, [sp, #0x10]
add    x29, sp, #0x10
mov    w8, #0x1                  ; =1
str    w8, [sp, #0x8]
mov    w8, #0xc                  ; =12
str    x8, [sp]
adrp   x0, 0
add    x0, x0, #0x6a8            ; "Fatal error"
adrp   x5, 0
add    x5, x5, #0x690            ; "UnreachableTest/S.swift"
mov    x3, #0x6e55               ; =28245
movk   x3, #0x6572, lsl #16
movk   x3, #0x6361, lsl #32
movk   x3, #0x6168, lsl #48
mov    x4, #0x6c62               ; =27746
movk   x4, #0x65, lsl #16
movk   x4, #0xeb00, lsl #48
mov    w1, #0xb                  ; =11
mov    w2, #0x2                  ; =2
mov    w6, #0x17                 ; =23
mov    w7, #0x2                  ; =2
bl     0x100000680               ; symbol stub for: Swift._assertionFailure(_: Swift.StaticString, _: Swift.String, file: Swift.StaticString, line: Swift.UInt, flags: Swift.UInt32) -> Swift.Never
brk    #0x1
```

But with this change:
```swift
@available(*, unavailable) func f() {
  swt_unreachable()
}
```

It instead compiles to simply:

```asm
brk    #0x1
```

### Checklist:

- [x] Code and documentation should follow the style of the [Style
Guide](https://github.com/apple/swift-testing/blob/main/Documentation/StyleGuide.md).
- [x] If public symbols are renamed or modified, DocC references should
be updated.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@grynspan grynspan grynspan left review comments

@briancroom briancroom briancroom approved these changes

@dennisweissmann dennisweissmann dennisweissmann approved these changes

@suzannaratcliff suzannaratcliff suzannaratcliff approved these changes

@SeanROlszewski SeanROlszewski Awaiting requested review from SeanROlszewski

Assignees

@suzannaratcliff suzannaratcliff

Labels

enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@stmontgomery @suzannaratcliff @briancroom @grynspan @dennisweissmann