Load test specs with PyYAML instead of json #1266
Open
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
YAML is a superset of JSON, so most of the existing tests still parse correctly this way, switching to YAML for future tests provides additional flexibility (e.g. multiline strings, comments, more permissive about commas and quotes.)
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.
YAML provides a number of advantages over JSON for this application. It supports comments, which could make it easier to communicate what a test is doing and why, and it also allows multiline strings, which makes it much easier to write fact tests (which currently must transform their output into an array of strings, one per line).
YAML is a superset of JSON (valid JSON is also valid YAML) so nearly all the existing tests can be carried forward with no changes. (A few did contain inconsistent use of tabs and spaces for indentation -- JSON allows this but YAML does not so these tests were corrected in commit 1361068).
However, I have also converted the tests for the ZFS facts and operations to YAML for demonstration purposes, and as an example of how future tests could be written.