Mock out test interactions with swift.org and github.com #133
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The unit tests currently perform numerous requests against these websites, which causes problems. First, GitHub API's are rate limited, which is often encountered while running the tests both in CI and at desk since not all environments are prepared to manage their own app/dev token. Downloads from swift.org, usually toolchains, are large, take a significant time for each to download in aggregate during testing. Ultimately, network interactions can fail due to network conditions outside of the control of the tests. There is already the infrastructure in the tests to mock the downloading of toolchains by locally constructing them with executable shell scripts in place of the real tools. In the case of macOS there is also logic to assemble the .pkg file. Use this mock for the majority of the unit tests. TODO: create a small set of integration and e2e tests that do make real network requests. Create static files that represent a mocked snapshot of the GitHub API's response JSON and use those when using the mock toolchain downloader during the automated tests. Add these as resources to the test target so that they can be loaded at the runtime of the tests. In order to decrease the exposure to network issues related to the Ubuntu keyserver in the automated tests add a latch so that the GPG keys are only refreshed once per session of the swiftly executable. Since swiftly operates normally as a short-lived process this should not affect the real-world usage of it, but it makes a big improvement in both the speed and reliability of the automated tests. It's very unlikely that in the span of a test run that the swift keys will need to be refreshed.
|
@swift-ci test macOS |
|
@swift-server-bot test this please |
|
@swift-ci test macOS |
adam-fowler
approved these changes
Jul 15, 2024
There was a problem hiding this comment.
This is great. Nice to see all the tests complete in such a short time.
Maybe not for this PR but the system relies a lot on global variables which means there is no chance we can run these tests in parallel. Would be good to look in the future at cleaning up these globals.
Any attempt to support strict concurrency will probably require some work to these globals.
| Array("[]".utf8) | ||
| } | ||
|
|
||
| return HTTPClientResponse(body: .bytes(ByteBuffer(data: Data(payload)))) |
There was a problem hiding this comment.
No need to convert to Data to then convert to ByteBuffer
Suggested change
| return HTTPClientResponse(body: .bytes(ByteBuffer(data: Data(payload)))) | |
| return HTTPClientResponse(body: .bytes(ByteBuffer(bytes: payload))) |
There was a problem hiding this comment.
Thanks, I've fixed this in the latest commit.
| @@ -62,7 +64,11 @@ let package = Package( | |||
| ), | |||
| .testTarget( | |||
| name: "SwiftlyTests", | |||
| dependencies: ["Swiftly"] | |||
| dependencies: ["Swiftly"], | |||
| resources: ghApiCacheResources + [ | |||
There was a problem hiding this comment.
I didn't know about embedInCode. Nice!
|
@swift-ci test macOS |
Remove unnecessary resources for the github tags to speed up compilation of the tests Fix platform use() when given a toolchain version that is not installed
Fix source formatting
|
@swift-ci test macOS |
cmcgee1024
changed the title
|
@swift-ci test macOS |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The unit tests currently perform numerous requests against these websites, which causes problems. First, GitHub API's are rate limited, which is often encountered while running the tests both in CI and at desk since not all environments are prepared to manage their own app/dev token. Downloads from swift.org, usually toolchains, are large, take a significant time for each to download in aggregate during testing. Ultimately, network interactions can fail due to network conditions outside of the control of the tests.
There is already the infrastructure in the tests to mock the downloading of toolchains by locally constructing them with executable shell scripts in place of the real tools. In the case of macOS there is also logic to assemble the .pkg file. Use this mock for the majority of the unit tests.
Create a small set of integration and e2e tests that do make real network requests.
Create static files that represent a mocked snapshot of the GitHub API's response JSON and use those when using the mock toolchain downloader during the automated tests. Add these as resources to the test target so that they can be loaded at the runtime of the tests.
In order to decrease the exposure to network issues related to the Ubuntu keyserver in the automated tests add a latch so that the GPG keys are only refreshed once per session of the swiftly executable. Since swiftly operates normally as a short-lived process this should not affect the real-world usage of it, but it makes a big improvement in both the speed and reliability of the automated tests. It's very unlikely that in the span of a test run that the swift keys will need to be refreshed.