Add test cases for existing events in GitHubEventAction component
#18
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
mattxwang
requested changes
Oct 17, 2021
There was a problem hiding this comment.
Hi Ansh, thank you for your contribution! As-is, this looks good. However, I have a few questions for you:
- I'd like to test the content of the links as well (i.e. the
href), to see if we properly interpret the API. Is this something you could add to this PR? - As we add more events, I think inlining everything in the test file itself is probably not sustainable. In addition, we're currently testing a fragment of the data returned, rather than the entire input. Could we:
- move all the test input data (the "fixtures") to their own file(s)? I think one file per test fixture may make sense, but feel free to give me feedback on this idea.
- include the entire GitHub API response in the test fixture? instead of just the data that we'd need
|
Hey, thanks for the review. I'll be working on these on the weekend. |
mattxwang
requested changes
Oct 24, 2021
mattxwang
approved these changes
Oct 26, 2021
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.
Closes #16
Hi, I've setup a basic framework for testing events in this component. For future development, we can just keep adding more objects in the
testCasesarray with the expected output. I've added atestContextkey (optional) which can be used to give more context to the test name. Like handling singular and plural cases etc...I've kept the
payloadminimal to avoid bloating the file with lots of data. That would've made writing new test cases harder. I would love to know your thoughts on this approach.