test(logger): simplify unit tests structure #2942
Merged
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
boring-cyborg
bot
added
logger
pull-request-size
bot
added
the
size/XXL
dreamorosi
changed the title
leandrodamascena
previously approved these changes
Aug 19, 2024
There was a problem hiding this comment.
Hello @dreamorosi! Just a few comments that don't impact the tests, but make it easier to read and understand.
APPROVED!
|
2 tasks
2 tasks
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.
Summary
Changes
This PR aims at improving maintainability and lower the barrier of entry for working on the unit tests for the Logger feature.
Before working on this PR we had 310 unit test cases, many of which redundant, and most importantly the majority of the tests were organised in a single big file (
Logger.test.ts) which after 3 yrs of work had grown to over 3K LOC.As primary objective, the PR breaks down the big test file in smaller and more focused files. As a secondary objective, the PR also in many cases changed the test strategy to prioritize observing side effects (i.e. the log output) versus testing the internals of the Logger or its implementation details.
The result of this work is a new test suite with ~130 test cases and the same coverage level that is instead more interested in asserting that the logger actually logs things in the expect way rather than how its internals work.
With this new testing strategy, we are also enabling
POWERTOOLS_DEVby default for all tests except one, which allows us to put spies on the global console object, and remove the behavior described in #2821.In future PRs, once we have migrated this module to Vitest, I'll continue investing some time in further improving the tests by creating custom assertions that will allow us to cut even more boilerplate from the tests.
Issue number: #2821
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.