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.

Sign up for GitHub

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

Update xfails info in README.md #233

Merged
merged 3 commits into from
Nov 22, 2024
Merged

Update xfails info in README.md #233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1291d9e
Update xfails info in README.md
loosebazooka Nov 4, 2024
9d9ebc2
README: Add xfail comment example, tweak language
jku Nov 22, 2024
bb89502
go-tuf.xfails: Add a comment explaining the xfail
jku Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,21 @@ There are two required steps:

### Expected failures

The test suite also contains tests that are not strictly speaking specification requirements (such as
tests for specific keytype or hash algorithm suport). Clients can mark tests as "expected failures"
The test suite contains tests that are not strictly specification requirements (such as
tests for specific keytype or hash algorithm support). Clients can mark tests as "expected failures"
if they do not intend to support this specific feature.

The tests that are expected to fail can be listed in `<entrypoint>.xfails` file. In the previous
workflow example the xfails file would be `path/to/my/test/executable.xfails`

the `.xfails` file may contain singular tests, test groups or parameterized tests from a test group
```
# Comments are ok on separate lines
test-name
test-group
test-group[parameter]
```

## Development

This repository contains two client-under-test CLI protocol implementations
Expand Down
1 change: 1 addition & 0 deletions clients/go-tuf/go-tuf.xfails
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
# RSA-PSS is not yet supported (https://github.com/theupdateframework/go-tuf/pull/625)
test_keytype_and_scheme[rsa/rsassa-pss-sha256]
Loading