testutil: Export ParseTestCaseFile #336
Closed
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
abhinav
changed the title
This moves the logic for parsing a test case file into a separate function named ParseTestCaseFile. This will make it easier for extensions to use the same format for test files, even if they want a different strategy to run them. The function does not do filtering like DoTestCaseFile; that logic has been left inside DoTestCaseFile. Minus that, this function does not modify any logic. The next commits do.
Instead of panicking, ParseTestCaseFile now reports errors.
The errors take the form,
line $line: $msg: $cause
For example,
line 12: invalid case No: parse error
As a result of this change,
we no longer discard the error returned by strconv.Atoi or json.Marshal
when we reject the test file,
and include it in the error message instead.
Note that the errors do not include the file name
because the file name is always the same
so the caller can add that if necessary
(which it will, in the next commit).
Instead of panicking, report the error in the form,
$file: $msg
So an error might look like,
foo.txt: line 12: invalid case No: [..]
And then kill the test with FailNow.
This is the same as calling `t.Fatalf(...)`.
Move core logic to ParseTestCases, which operates on an io.Reader, but keep the file-based function around for convenience.
|
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
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 PR extracts functionality from DoTestCaseFile
responsible for parsing test case files
into a ParseTestCases function.
The function is able to read from any io.Reader,
instead of being limited to just files.
A ParseTestCaseFile function is included for convenience.
The functions do not panic on errors--instead, they return the error.
While there, this updates DoTestCaseFile
so that it also does not panic on error,
and instead aborts the entire test instead.
Minor note about tests:
The tests for the parser use
reflect.DeepEqualand%#v.It would make for better error messages to use go-cmp
but I elected to not use that because so far,
goldmark has no third-party dependencies.
If you're open to the new dependency (only for test util),
I can make a separate PR for that in the future.