Skip to content
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

Document test updates associated with amendments #2910

Merged
merged 18 commits into from
Mar 21, 2024

Conversation

dontcallmedom
Copy link
Member

@dontcallmedom dontcallmedom commented Nov 15, 2023

This is a first pass at associating amendments to the relevant test cases and updates made to WPT as part of the amendment documenting process.

I have not documented associated test updates for the following PRs: #2758 #2759 #2794 #2797 #2801 #2847 #2853 #2861 - most likely because no updates were brought, but it could be that I missed them too.

It would be useful if someone could review that the annotations made in amendments.json are correct. Namely that:

Merging this PR will also require that any new amendment documents its test status (either as "already-tested", "not-testable", or as an array of pointers to WPT pull requests).


Preview | Diff

@henbos
Copy link
Contributor

henbos commented Nov 16, 2023

There are WebIDL validation steps failing, can you take a look @dontcallmedom ?

@dontcallmedom
Copy link
Member Author

I did - I think they're bogus (since this PR doesn't touch the document at all), but in any case, I can spend more time on them once there is approval at least with the principles and the data :)

@henbos
Copy link
Contributor

henbos commented Nov 16, 2023

Ack, @jan-ivar to take a closer look, but free free to merge if he is happy about doing so

@henbos
Copy link
Contributor

henbos commented Jan 4, 2024

PTAL @jan-ivar :)

@dontcallmedom dontcallmedom changed the base branch from binarytype-setter to main February 26, 2024 12:59
tools/check-rec-amendment.js Outdated Show resolved Hide resolved
}
const validTestUpdates = ["already-tested", "not-testable"];
if (typeof prAmendment.testUpdates === "string" && !validTestUpdates.includes(prAmendment.testUpdates)) {
core.setFailed(`Pull request ${context.issue.number} declares an invalid test status in its amendment testUpdates field`);
Copy link
Contributor

Choose a reason for hiding this comment

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

Does it mandate to have the test at the time we add the ammendment?

Copy link
Member Author

Choose a reason for hiding this comment

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

for spec changes that imply a change in the test suite, it requires a link to a WPT pull request at the moment, indeed (but that's distinct from it being implemented anywhere); this could be relaxed, but personally, I think there is real value in requiring an update to the test suite before merging a test-impacting amendment.

Copy link
Contributor

Choose a reason for hiding this comment

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

I understand this but, without an implementation, those tests will be low quality probably, might break and so on.
At least we should flag these tests or make easy to manage/understand they are still experimental.

@youennf
Copy link
Contributor

youennf commented Mar 7, 2024

If the tool requires to put a test status in the amendment, we might need a 'to-be-added-shortly' state, as implementation might not be yet available.

Copy link
Member

@jan-ivar jan-ivar left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks! ❤️

@@ -169,6 +234,12 @@
{
"description": "Add RTCIceCandidate.relayProtocol",
"pr": 2763,
"tests": [
"idlharness.https.window.js"
Copy link
Member

Choose a reason for hiding this comment

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

Just a note: idlharness.https.window.js tests that relayProtocol exists (1 implementation), but no WPT tests exist to verify it returns anything other than null, which might be difficult to test without a TURN server.

Comment on lines 275 to +278
"description": "Add RTCIceCandidate.url",
"pr": 2773,
"tests": [
"idlharness.https.window.js"
Copy link
Member

Choose a reason for hiding this comment

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

Just a note: idlharness.https.window.js tests that url exists (1 implementation), but no WPT test exists to verify it returns anything other than null, which might be difficult to test without a TURN server.

amendments.json Outdated Show resolved Hide resolved
amendments.json Outdated Show resolved Hide resolved
Co-authored-by: Jan-Ivar Bruaroey <[email protected]>
@jan-ivar jan-ivar merged commit 7fddf0a into main Mar 21, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants