Skip to content

Add support for watchOS - #916

Merged
younata merged 12 commits into
Quick:mainfrom
JosephDuffy:master
May 31, 2022
Merged

Add support for watchOS#916
younata merged 12 commits into
Quick:mainfrom
JosephDuffy:master

Conversation

@JosephDuffy

@JosephDuffyJosephDuffy commented Jun 19, 2021

Copy link
Copy Markdown
Contributor

This PR is to add support for running on watchOS. Since Xcode 12.5 watchOS has been supported but Nimble doesn't currently compile for watchOS.

A new target has been added to the project, along with explicit support in the Package.swift.

I don't believe anything here is a breaking change.

I have a fork of Quick that also supports watchOS. I'll create a PR for that if this PR gets approved and merged.

@JosephDuffyJosephDuffy changed the title Add preliminarily support for watchOSAdd support for watchOSJun 19, 2021
@JosephDuffy
JosephDuffy marked this pull request as draft June 19, 2021 23:49
@JosephDuffy
JosephDuffy marked this pull request as ready for review June 20, 2021 11:17
Similar to tvOS the debugger cannot be used during tests
@ikesyoikesyo added this to the v10 milestone Sep 29, 2021
@younata

Copy link
Copy Markdown
Member

Hey @JosephDuffy, thank you for this! I'd love to get this in. I just merged main into it. Perhaps this should also include a revert of #953 (or, at least, disable throwException if you run the test suite on actual hardware)? Sorry to add that extra work on you.

@younata

Copy link
Copy Markdown
Member

In the interest of getting v10 released sooner, I'm going to move watchOS support to the next major release (v11).

@JosephDuffy

Copy link
Copy Markdown
ContributorAuthor

@younata I've re-enabled watchOS support, I think this PR is ready again. Once this is merged I'll create the accompanying PR for Quick.

@younatayounata left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for updating this!

I think this overall looks good. A couple requests/suggestions though:

  • Can this target watchOS 5.0 and later? we're planning on the next releases of Quick and Nimble to target the (as of this comment) last 4 major releases of iOS, macOS, and tvOS. Applying that same standard would mean targeting watchOS 5.0. (Just setting the version target to 5.0 doesn't seem to cause compilation issues, and the unit tests here still pass).
  • Instead of setting the watchOS deployment target individually in the Nimble-watchOS and Nimble-watchOSTests targets, it would be easier to maintain if we set watchOS deployment target of the project, and let each target inherit the deployment target. (We're not currently doing that in Nimble, this PR in Quick is making that change to Quick, and I'll be making a PR to Nimble in the coming weeks to have OS deployment target versions set in the project and inherited by each target)
  • Let's update the Nimble.podspec to also specify a watchOS deployment version (and also the excluded files).

Thank you so much! We really appreciate this.

@JosephDuffy

Copy link
Copy Markdown
ContributorAuthor

I've made the requested changes, although it's worth noting that watchOS tests can't be run on watchOS versions older than 7.4.

This is enforced by Xcode, but I thought it would be a compilation error rather than an error when trying to run the tests, which is why I originally had this set to watchOS 7.4.

@younatayounata left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I've made the requested changes, although it's worth noting that watchOS tests can't be run on watchOS versions older than 7.4.
This is enforced by Xcode, but I thought it would be a compilation error rather than an error when trying to run the tests, which is why I originally had this set to watchOS 7.4.

Huh. Odd.

Thanks for taking care of this! I think it's good to merge.

@younata
younata merged commit 44b9392 into Quick:mainMay 31, 2022
JosephDuffy added a commit to JosephDuffy/Quick that referenced this pull request Jun 1, 2022
The watchOS support PR (Quick/Nimble#916) has been merged.
renovateBot referenced this pull request in cgrindel/rules_swift_package_manager Jul 7, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)
This PR contains the following updates:
| Package | Update | Change |
|---|---|---|
| [Quick/Nimble](https://togithub.com/Quick/Nimble) | major | `from:
"10.0.0"` -> `from: "v12.0.1"` |
---
### Release Notes
<details>
<summary>Quick/Nimble (Quick/Nimble)</summary>
### [`v12.0.1`](https://togithub.com/Quick/Nimble/releases/tag/v12.0.1)
[Compare
Source](https://togithub.com/Quick/Nimble/compare/v12.0.0...v12.0.1)
#### What's Changed
- Fix wasm build by [@&#8203;ikesyo](https://togithub.com/ikesyo) in
[https://github.com/Quick/Nimble/pull/1053](https://togithub.com/Quick/Nimble/pull/1053)
- Bump cocoapods from 1.12.0 to 1.12.1 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/Quick/Nimble/pull/1054](https://togithub.com/Quick/Nimble/pull/1054)
- Bump swiftwasm/swiftwasm-action from 5.7 to 5.8 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/Quick/Nimble/pull/1057](https://togithub.com/Quick/Nimble/pull/1057)
- Make the async version of poll concurrency-safe by wrapping it in an
actor by [@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1059](https://togithub.com/Quick/Nimble/pull/1059)
- cast an empty array to avoid a warning during compile time by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1060](https://togithub.com/Quick/Nimble/pull/1060)
**Full Changelog**:
Quick/Nimble@v12.0.0...v12.0.1
### [`v12.0.0`](https://togithub.com/Quick/Nimble/releases/tag/v12.0.0)
[Compare
Source](https://togithub.com/Quick/Nimble/compare/v11.2.2...v12.0.0)
Nimble 12 adds the ability to using polling expectations with async
expressions. Additionally, Nimble 12 includes a number of
quality-of-life improvements and bug fixes.
#### What's Changed
- Update the README to have an accurate usage of expect by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1038](https://togithub.com/Quick/Nimble/pull/1038)
- Allow usage of toEventually with async expressions by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1039](https://togithub.com/Quick/Nimble/pull/1039)
- Replace public usage of DispatchTimeInterval with a new
NimbleTimeInterval by [@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1042](https://togithub.com/Quick/Nimble/pull/1042)
- Make NimbleTimeInterval.dispatchTimeInterval public by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1043](https://togithub.com/Quick/Nimble/pull/1043)
- Run SyncExpectation's expression in async contexts of toEventually on
the main actor. by [@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1044](https://togithub.com/Quick/Nimble/pull/1044)
- satisfyAllOf and satisfyAnyOf should only evaluate the expression
once. by [@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1045](https://togithub.com/Quick/Nimble/pull/1045)
- Rename AsyncDefaults to PollingDefaults by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1023](https://togithub.com/Quick/Nimble/pull/1023)
- Fixed Swift.package: added macCatalyst to the condition for
CwlPreconditionTesting dependency by
[@&#8203;uebelack](https://togithub.com/uebelack) in
[https://github.com/Quick/Nimble/pull/1048](https://togithub.com/Quick/Nimble/pull/1048)
- Raise minimum watchos deployment target to 7.0 by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1050](https://togithub.com/Quick/Nimble/pull/1050)
- Feature/handle multithreaded notifications by
[@&#8203;johnmckerrell](https://togithub.com/johnmckerrell) and
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1051](https://togithub.com/Quick/Nimble/pull/1051)
- Objective-C support in the Swift Package version by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1005](https://togithub.com/Quick/Nimble/pull/1005)
- Update documentation in preparation for Nimble 12 by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1052](https://togithub.com/Quick/Nimble/pull/1052)
#### New Contributors
- [@&#8203;uebelack](https://togithub.com/uebelack) made their first
contribution in
[https://github.com/Quick/Nimble/pull/1048](https://togithub.com/Quick/Nimble/pull/1048)
- [@&#8203;johnmckerrell](https://togithub.com/johnmckerrell) made their
first contribution in
[https://github.com/Quick/Nimble/pull/1051](https://togithub.com/Quick/Nimble/pull/1051)
**Full Changelog**:
Quick/Nimble@v11.2.2...v12.0.0
### [`v11.2.2`](https://togithub.com/Quick/Nimble/releases/tag/v11.2.2)
[Compare
Source](https://togithub.com/Quick/Nimble/compare/v11.2.1...v11.2.2)
### Highlights
Nimble v11.2.2 is a minor bug fix release which fixes the build on Xcode
14.3 and Wasm.
Thanks to [@&#8203;dymv](https://togithub.com/dymv) for fixing the Xcode
14.3 build and to [@&#8203;ikesyo](https://togithub.com/ikesyo) for
fixing the wasm build!
### Autogenerated Changelog
#### What's Changed
- Bump activesupport from 6.1.5 to 6.1.7.1 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/Quick/Nimble/pull/1029](https://togithub.com/Quick/Nimble/pull/1029)
- Bump cocoapods from 1.11.3 to 1.12.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/Quick/Nimble/pull/1032](https://togithub.com/Quick/Nimble/pull/1032)
- Fixes the build on Xcode 14.3b2 by
[@&#8203;dymv](https://togithub.com/dymv) in
[https://github.com/Quick/Nimble/pull/1033](https://togithub.com/Quick/Nimble/pull/1033)
- Bump activesupport from 7.0.4.2 to 7.0.4.3 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/Quick/Nimble/pull/1034](https://togithub.com/Quick/Nimble/pull/1034)
- Fix wasm build by [@&#8203;ikesyo](https://togithub.com/ikesyo) in
[https://github.com/Quick/Nimble/pull/1036](https://togithub.com/Quick/Nimble/pull/1036)
#### New Contributors
- [@&#8203;dymv](https://togithub.com/dymv) made their first
contribution in
[https://github.com/Quick/Nimble/pull/1033](https://togithub.com/Quick/Nimble/pull/1033)
**Full Changelog**:
Quick/Nimble@v11.2.1...v11.2.2
### [`v11.2.1`](https://togithub.com/Quick/Nimble/releases/tag/v11.2.1)
[Compare
Source](https://togithub.com/Quick/Nimble/compare/v11.2.0...v11.2.1)
Fixed tripping the main thread checker in async `toEventually` checks.
Your CI should no longer report that tests erroneously crashed because
the expression's `debugDescription` dared to reference something that
needed to run on the main thread.
#### What's Changed
- Add documentation on recommended ways to configure AsyncDefaults by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1022](https://togithub.com/Quick/Nimble/pull/1022)
- Ensure that stringify'ing an expression as part of the async/await
polling infrastructure always happens on the main thread by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1024](https://togithub.com/Quick/Nimble/pull/1024)
**Full Changelog**:
Quick/Nimble@v11.2.0...v11.2.1
### [`v11.2.0`](https://togithub.com/Quick/Nimble/releases/tag/v11.2.0)
[Compare
Source](https://togithub.com/Quick/Nimble/compare/v11.1.1...v11.2.0)
Improved developer experience by allowing you to use the sync form of
`expect` in a test that has other usage of async test. i.e. the
following code compiles again:
```swift
class MyTest: XCTestCase {
func testExample() {
await someAsyncFunction()
expect(someValue).to(equal(expectedValue))
}
}
```
#### What's Changed
- Remove autoclosure tag with async expectations by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1020](https://togithub.com/Quick/Nimble/pull/1020)
**Full Changelog**:
Quick/Nimble@v11.1.1...v11.2.0
### [`v11.1.1`](https://togithub.com/Quick/Nimble/releases/tag/v11.1.1)
[Compare
Source](https://togithub.com/Quick/Nimble/compare/v11.1.0...v11.1.1)
#### What's Changed
- Fix regression where named tuples could not be compared with unnamed
tuples of the same types using the == operator by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1017](https://togithub.com/Quick/Nimble/pull/1017)
- Use uncached expression in the async versions of toEventually by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1018](https://togithub.com/Quick/Nimble/pull/1018)
**Full Changelog**:
Quick/Nimble@v11.1.0...v11.1.1
### [`v11.1.0`](https://togithub.com/Quick/Nimble/releases/tag/v11.1.0)
[Compare
Source](https://togithub.com/Quick/Nimble/compare/v11.0.0...v11.1.0)
11.1.0 **drops support** for Swift 5.6 (you must use Xcode 14 or later).
[https://github.com/Quick/Nimble/pull/1009](https://togithub.com/Quick/Nimble/pull/1009)
11.1.0 fixes a developer experience bug where you could unknowingly use
the sync version of `toEventually` in an async context, which will cause
test timeout failures.
[https://github.com/Quick/Nimble/pull/1010](https://togithub.com/Quick/Nimble/pull/1010)
That is, the following test method (XCTest-style) would compile with no
errors or warnings emitted, but fail at test runtime due to timeout
issues. In v11.1.0, this now emits a warning that you're using the wrong
version of `toEventually` (and similar).
```swift
@&#8203;MainActor func testSomething() async {
expect(1).toEventually(equal(1)) // (in v11.0.0, this would not emit any kind of warning or error, but would definitely fail with a timeout error)
}
```
**Full Changelog**:
Quick/Nimble@v11.0.0...v11.1.0
### [`v11.0.0`](https://togithub.com/Quick/Nimble/releases/tag/v11.0.0)
[Compare
Source](https://togithub.com/Quick/Nimble/compare/v10.0.0...v11.0.0)
This closes the [v11.0.0
milestone](https://togithub.com/Quick/Nimble/milestone/12).
### Highlights
Primarily, this release now supports running tests in async contexts.
#### Fixed
- `toEventually` et. al. now works from background threads.
[https://github.com/Quick/Nimble/pull/1000](https://togithub.com/Quick/Nimble/pull/1000)
- `toEventually` et. al. now work in async tests.
[https://github.com/Quick/Nimble/issues/1007](https://togithub.com/Quick/Nimble/issues/1007)
#### New
- Async/await support in expectation expressions (e.g. `await
expect(await someAsyncFunction()).to(...)`).
[https://github.com/Quick/Nimble/pull/1004](https://togithub.com/Quick/Nimble/pull/1004)
- `append(details:)` now respects whitespace that is in the message.
[https://github.com/Quick/Nimble/pull/1001](https://togithub.com/Quick/Nimble/pull/1001)
- watchOS support.
[https://github.com/Quick/Nimble/pull/916](https://togithub.com/Quick/Nimble/pull/916)
- You can now directly check if an expectation has passed or not.
[https://github.com/Quick/Nimble/pull/995](https://togithub.com/Quick/Nimble/pull/995)
#### Breaking
- Raised version requirements to Swift 5.6, iOS 13, macOS 10.15, tvOS
13, and watchOS 6.
[https://github.com/Quick/Nimble/issues/984](https://togithub.com/Quick/Nimble/issues/984)
- The `Expectation` struct is now a protocol. There are 2 concrete
implementations, `SyncExpectation` and `AsyncExpectation`.
`AsyncExpectation` does not support `toEventually`, and is meant for
awaiting on async functions. `SyncExpectation` is effectively the older
`Expectation` implementation, and works as it used to.
[https://github.com/Quick/Nimble/pull/1004](https://togithub.com/Quick/Nimble/pull/1004)
### Auto-generated release notes
#### What's Changed
- Add support for watchOS by
[@&#8203;JosephDuffy](https://togithub.com/JosephDuffy) in
[https://github.com/Quick/Nimble/pull/916](https://togithub.com/Quick/Nimble/pull/916)
- Add [@&#8203;younata](https://togithub.com/younata) to funding.yml by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/994](https://togithub.com/Quick/Nimble/pull/994)
- Expose whether an expectation has passed and provide an option to
throw by [@&#8203;bnickel](https://togithub.com/bnickel) in
[https://github.com/Quick/Nimble/pull/995](https://togithub.com/Quick/Nimble/pull/995)
- Raise minimum required OS and Swift Versions to Async-Support
versions. by [@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/999](https://togithub.com/Quick/Nimble/pull/999)
- Don't strip whitespace from appended newlines by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1001](https://togithub.com/Quick/Nimble/pull/1001)
- Allow toEventually to run on background threads by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1000](https://togithub.com/Quick/Nimble/pull/1000)
- Allow using async/await in expect by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1004](https://togithub.com/Quick/Nimble/pull/1004)
- Get toEventually et al working in async contexts. by
[@&#8203;younata](https://togithub.com/younata) in
[https://github.com/Quick/Nimble/pull/1007](https://togithub.com/Quick/Nimble/pull/1007)
#### New Contributors
- [@&#8203;JosephDuffy](https://togithub.com/JosephDuffy) made their
first contribution in
[https://github.com/Quick/Nimble/pull/916](https://togithub.com/Quick/Nimble/pull/916)
- [@&#8203;bnickel](https://togithub.com/bnickel) made their first
contribution in
[https://github.com/Quick/Nimble/pull/995](https://togithub.com/Quick/Nimble/pull/995)
**Full Changelog**:
Quick/Nimble@v10.0.0...v11.0.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.
🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.
---
- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box
---
This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/cgrindel/rules_swift_package_manager).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4xNTkuNyIsInVwZGF0ZWRJblZlciI6IjM1LjE1OS43IiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@JosephDuffy@younata@ikesyo@jessesquires