features: Implement JSON trace format #878
Merged
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.
HOW-TO-READ commit by commit:
81ec379 adds first version of the parser and writer with test files
8c42810 is a large commit which exports action and state wherever they are mentioned. just a chore. all changes should be the words action to Action and state to State
ec6a6bf is also a large commit. It exports all fields of all action types. All changes should be capitalizing words
f1c3c0f is also a chore: it maps strings of action types to their action structs
e6753ff refactors the first version of the parser and writer, and contains much of the final logic
85f5d15 adds some examples of what the trace format looks like
Description
Add a writer and reader for a simple JSON file format which is marshalled directly from
the Step objects in our code.
There are some chores which involve changing lots of fields to be exported (so that they can be properly Unmarshalled/Marshalled).
Closes: #875
Add a parser/writer to input traces from files for the e2e tests.
Most critical files:
tests/e2e/trace_*.go - the new files in this PR
The rest are almost only chore changes to export some fields which otherwise gave me trouble with cmp and Json Marshal/Unmarshaling
See an example of the trace format here: tests/e2e/traces/start_provider_chain.json
Files in tests/e2e/traces are meant to eventually be input files for e2e tests
Files in tests/e2e/tracehandler_testdata are meant to be tests for the parser
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
Reviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
!
in the type prefix if API or client breaking change