Add optional location information on test assertion functions #291
Conversation
This file contains 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
This location information is used to give more helpful error messages if the assertions fail.
Co-authored-by: ngoguey <ngoguey@student.42.fr>
|
Thanks @Ngoguey42. I'd appreciate a second review / opinion on the API from others who might use the feature, since this is a change to a fairly core set of functions. @gs0510, @icristescu: any thoughts? |
gs0510
reviewed
Feb 17, 2021
| [FAIL] fail 1 pos. | ||
|
|
||
| ┌──────────────────────────────────────────────────────────────────────────────┐ | ||
| │ [FAIL] check 0 here. │ |
There was a problem hiding this comment.
I see that the error messages are descriptive (which is great!) but the 1 pos. confuses me a bit. What are the 1 pos. or 0 here supposed to indicate?
There was a problem hiding this comment.
I agree that looks confusing here; it's actually a general feature of Alcotest output: tests are printed with their index + name, so for a more normal set of tests it might look like this:
[OK] FS 0 Basic operations on contents.
[OK] FS 1 Basic operations on nodes.
[OK] FS 2 Basic operations on commits.
[OK] FS 3 Basic operations on branches.
[OK] FS 4 Hash operations on trees.
[OK] FS 5 Basic merge operations.
[OK] FS 6 Basic operations on slices.
[OK] FS 7 Test merges on tree updates.
[OK] FS 8 Tree caches and hashconsing.
[OK] FS 9 Complex histories.
[OK] FS 10 Empty stores.
[OK] FS 11 Private node manipulation.
There was a problem hiding this comment.
Ooh okay, that makes sense. Thanks! LGTM! :)
craigfe
added a commit
to craigfe/opam-repository
that referenced
this pull request
Apr 13, 2021
…lwt (1.4.0) CHANGES: - Add `?here` and `?pos` arguments to the test assertion functions. These can be used to pass information about the location of the call-site, which is displayed in failing test output. (mirage/alcotest#291, @craigfe)
craigfe
added a commit
to craigfe/opam-repository
that referenced
this pull request
Apr 15, 2021
…lwt (1.4.0) CHANGES: - Add `?here` and `?pos` arguments to the test assertion functions. These can be used to pass information about the location of the call-site, which is displayed in failing test output. (mirage/alcotest#291, @craigfe) - Add a pretty-printer for the exception raised by `Alcotest.check` and related functions. This allows them to be used outside of an Alcotest test runner for making general assertions. (mirage/alcotest#296, @craigfe) - Add `--bail` option (and corresponding `ALCOTEST_BAIL` environment variable), which causes Alcotest to terminate after the first test failure. (mirage/alcotest#298, @craigfe)
craigfe
added a commit
to craigfe/opam-repository
that referenced
this pull request
Apr 16, 2021
…lwt (1.4.0) CHANGES: - Add `?here` and `?pos` arguments to the test assertion functions. These can be used to pass information about the location of the call-site, which is displayed in failing test output. (mirage/alcotest#291, @craigfe) - Add a pretty-printer for the exception raised by `Alcotest.check` and related functions. This allows them to be used outside of an Alcotest test runner for making general assertions. (mirage/alcotest#296, @craigfe) - Add `--bail` option (and corresponding `ALCOTEST_BAIL` environment variable), which causes Alcotest to terminate after the first test failure. (mirage/alcotest#298, @craigfe)
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.
This location information is used to give more helpful error messages if the assertions fail.
CC: @mefyl.