Skip to content

Diagnose when we incorrectly infer the type of a capture list item in an exit test. #1152

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.

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

grynspan
Copy link
Contributor

@grynspan grynspan commented Jun 13, 2025

Follow-up to #1130, split out for clarity.

This PR adds a custom diagnostic at compile time if we incorrectly infer the type of a captured function argument or self in an exit test. For example:

func f(_ x: Int) async {
  let x = String(x) // local type of 'x' is String, not Int
  await #expect(processExitsWith: ...) { [x] in
    ...
  }
}

This improves our feedback to the developer when we encounter a pattern like that. The developer will now see:

🛑 Type of captured value 'x' is ambiguous

Checklist:

  • Code and documentation should follow the style of the Style Guide.
  • If public symbols are renamed or modified, DocC references should be updated.

grynspan and others added 6 commits May 25, 2025 15:24
…t test.

This PR adds the ability to infer the type of a parameter of a function or closure that encloses an exit test. For example, `x` here:

```swift
func f(x: Int) async {
  await #expect(processExitsWith: .failure) { [x] in
    ...
  }
}
```

This inference still fails if a parameter is shadowed by a variable with an incompatible type; we still need something like `decltype()` to solve for such cases. Still, being able to capture `@Test` function arguments with minimal ceremony is helpful:

```swift
@test(arguments: 0 ..< 100) func f(i: Int) async {
  await #expect(exitsWith: .failure) { [i] in
    ...
  }
}
```
@grynspan grynspan added this to the Swift 6.x milestone Jun 13, 2025
@grynspan grynspan self-assigned this Jun 13, 2025
@grynspan grynspan added enhancement New feature or request exit-tests ☠️ Work related to exit tests parameterized-testing Related to parameterized testing functionality labels Jun 13, 2025

// Diagnose that the type of 'expr' is invalid.
let name = nameExpr.representedLiteralValue ?? expr.trimmedDescription
let capture = ClosureCaptureSyntax(name: .identifier(name))
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This fake ClosureCaptureSyntax instance is created because we can't pass such a thing as an expression and we need to use a string instead. It's a temporary abstraction until swiftlang/swift-syntax#3085 is resolved.

@grynspan grynspan marked this pull request as ready for review June 13, 2025 20:43
@grynspan
Copy link
Contributor Author

@swift-ci test

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request exit-tests ☠️ Work related to exit tests parameterized-testing Related to parameterized testing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant