Updated TestState to remove the value after the test. #1240

CraigSiemens · 2023-08-31T19:59:32Z

Currently, a property with @TestState will have its value reset to nil before any afterEach in the same ExampleGroup is run. This is because:

the @TestState needs to be defined first so the tests can use it
the @TestState was adding an afterEach to the current ExampleGroup
the afterEach closures are run in the order they are defined in an ExampleGroup

This causes the afterEach resetting the TestState value to always be run before the afterEach closures defined in the same ExampleGroup.

This is an issue when a test needs to do additional cleanup using the value from TestState. Ideally the value in the TestState` would only be cleaned up after all the code in the test has finished running.

Example

@TestState var tempDir: URL!
        
beforeEach {
    tempDir = FileManager.default
        .temporaryDirectory
        .appendingPathComponent(randomDirName())
    try? FileManager.default.createDirectory(at: tempDir, withIntermediateDirectories: true)    
}

afterEach {
    try? FileManager.default.removeItem(at: tempDir)
}

When this runs, the afterEach will crash because tempDir has already been reset to nil.

Solution

TestState has been updated to use an afterEach set in a QuickConfiguration to ensure that the value is reset after the current example group has finished running. This works because configurations behave like a parent ExampleGroup of the root ExampleGroup for the spec.

~~On one hand this does feel a little wierd to for Quick itself to be defining a configuration, but it was the simplest approach I could find.~~

It's been updated to add a teardown block to the test case to set the value back to nil since that will always be run after the afterEach blocks.

Alternatives considered

Update ExampleGroup/ExampleHooks to a alwaysAfterEach array that would function similar to justBeforeEach where it's a second array of closures that are always run last. This would have been a larger change to add support to the Sync/Async versions of World, ExampleGroup, and ExampleHooks

Checklist

Does this have tests?
Does this have documentation?
Does this break the public API (Requires major version bump)?
Is this a new feature (Requires minor version bump)?

…sts using it.

younata

Thanks for this! Really appreciate it.

Also, would you like commit privileges to Quick and Nimble? You've been doing some great work, and I'd like to invite you to the Quick team.

Sources/Quick/TestState.swift

…ation.

CraigSiemens · 2023-09-06T17:55:58Z

Also, would you like commit privileges to Quick and Nimble? You've been doing some great work, and I'd like to invite you to the Quick team.

I could take it, though I probably wouldn't do much with it until I felt more comfortable with the repo.

younata

Sorry about the delay. This looks great, though. Thanks for doing this!

This PR contains the following updates: | Package | Update | Change | |---|---|---| | [Quick/Quick](https://togithub.com/Quick/Quick) | minor | `from: "7.2.0"` -> `from: "7.3.0"` | --- ### Release Notes <details> <summary>Quick/Quick (Quick/Quick)</summary> ### [`v7.3.0`](https://togithub.com/Quick/Quick/releases/tag/v7.3.0) [Compare Source](https://togithub.com/Quick/Quick/compare/v7.2.0...v7.3.0) #### Highlights - Adds a property wrapper default initializer for TestState. Meaning the following declaration is now accepted! ```swift @TestState var foo: Int! = 30 ``` Thanks [@tahirmt](https://togithub.com/tahirmt)! - TestState now nils out the value after all afterEach blocks run, instead of in the middle of the afterEach chain. Thanks [@CraigSiemens](https://togithub.com/CraigSiemens) #### What's Changed - Bump activesupport from 7.0.4.3 to 7.0.7.2 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/Quick/Quick/pull/1238](https://togithub.com/Quick/Quick/pull/1238) - Add property wrapper default initializer for TestState by [@tahirmt](https://togithub.com/tahirmt) in [https://github.com/Quick/Quick/pull/1235](https://togithub.com/Quick/Quick/pull/1235) - Bump actions/checkout from 3 to 4 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/Quick/Quick/pull/1241](https://togithub.com/Quick/Quick/pull/1241) - Updated TestState to remove the value after the test. by [@CraigSiemens](https://togithub.com/CraigSiemens) in [https://github.com/Quick/Quick/pull/1240](https://togithub.com/Quick/Quick/pull/1240) - Update release script to generate a carthage binary and include it in the release. by [@younata](https://togithub.com/younata) in [https://github.com/Quick/Quick/pull/1234](https://togithub.com/Quick/Quick/pull/1234) #### New Contributors - [@tahirmt](https://togithub.com/tahirmt) made their first contribution in [https://github.com/Quick/Quick/pull/1235](https://togithub.com/Quick/Quick/pull/1235) **Full Changelog**: Quick/Quick@v7.2.0...v7.3.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://togithub.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://togithub.com/renovatebot/renovate).  Co-authored-by: Self-hosted Renovate Bot <361546+cgrindel-self-hosted-renovate[bot]@users.noreply.github.enterprise.com>

Updated TestState to remove the value after the afterEach from the te…

0bcca89

…sts using it.

younata approved these changes Sep 2, 2023

View reviewed changes

Sources/Quick/TestState.swift Outdated Show resolved Hide resolved

Updated TestState to add a teardown block instead of using a configur…

a677932

…ation.

CraigSiemens requested a review from younata September 6, 2023 18:02

younata approved these changes Sep 11, 2023

View reviewed changes

younata enabled auto-merge September 11, 2023 15:15

younata approved these changes Sep 11, 2023

View reviewed changes

Merge branch 'main' into test-state-clearing-order

6e3feba

younata merged commit 55f2e48 into Quick:main Sep 11, 2023

CraigSiemens deleted the test-state-clearing-order branch September 11, 2023 20:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Updated TestState to remove the value after the test. #1240

Updated TestState to remove the value after the test. #1240

Uh oh!

CraigSiemens commented Aug 31, 2023 •

edited

Loading

Uh oh!

younata left a comment

Uh oh!

Uh oh!

CraigSiemens commented Sep 6, 2023

Uh oh!

younata left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Updated TestState to remove the value after the test. #1240

Updated TestState to remove the value after the test. #1240

Uh oh!

Conversation

CraigSiemens commented Aug 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Example

Solution

Alternatives considered

Checklist

Uh oh!

younata left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

CraigSiemens commented Sep 6, 2023

Uh oh!

younata left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

CraigSiemens commented Aug 31, 2023 •

edited

Loading