test: Add new unit test framework with JSON fixtures #589
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
ykim-akamai
requested review from
jriddle-linode and
ezilber-akamai
and removed request for
a team
| } | ||
|
|
||
| // loadFixtures loads all JSON files in fixtures directory | ||
| func (tf *TestFixtures) loadFixtures() { |
There was a problem hiding this comment.
optional: One other potential way to handle this would be using the embed directive with the embed.FS type. I think the current implementation is perfectly acceptable too, just figured I'd share another potential approach 🙂
There was a problem hiding this comment.
Appreciate the feedback. I wasn't aware of this option at all, but it seems like a great improvement to implement. This change should enhance performance as the test framework scales with additional tests and components 👍
… into test/new_unit_testing_framework # Conflicts: # test/go.mod
lgarber-akamai
approved these changes
Oct 22, 2024
ezilber-akamai
approved these changes
Oct 22, 2024
Co-authored-by: Lena Garber <[email protected]>
zliang-akamai
approved these changes
Oct 23, 2024
ezilber-akamai
approved these changes
Oct 23, 2024
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.
📝 Description
This PR implements new improved unit testing framework that allows writing unit test against JSON fixtures. Here is the list of core files for the framework:
base.go:Implements the ClientBaseCase struct for setting up the mock Linode client. This file includes utility functions like SetUp, TearDown, and MockGet to simplify mocking API requests for unit tests.
fixtures.go:Provides the TestFixtures struct for loading and retrieving test fixtures from JSON files. This allows test cases to easily mock API responses using predefined data from the fixtures directory
instance_test.go:Example test file containing test for List Instances endpoint via command
base.Client.ListInstances(context.Background(), nil)e.g.
fixtures/linodes_list.json:JSON fixture file containing mock data for Linode instances. This is used in the unit test to simulate a response from the List Instances API endpoint.
✔️ How to Test
make testunit📷 Preview
If applicable, include a screenshot or code snippet of this change. Otherwise, please remove this section.