registerCleanupForTesting

[dskloetd]

Motivation

Our unit tests have always been quite brittle because we need to remember to clean up all global state between each test.
Often tests fail when run in a different order because one test accidentally depends on state left behind by other tests.

This has improved a lot now that we always reset all stores and restore all mocks, but there are still other cleanups that need to be performed in tests.

This PR proposes a generic way of registering a cleanup in the file that defines the thing that needs to be cleaned up, instead of in every test. As a proof of concept, it is then used to automatically call resetMockedConstants(); in every test that (transitively) imports $tests/utils/mockable-constants.test-utils.ts.

Changes

1. Create an empty registerCleanupForTesting function which should be used to register cleanup functions.
2. In frontend/vitest.setup.ts mock frontend/src/lib/utils/test-support.utils.ts such that the registered cleanup functions are called before every test.

Tests

Tests only

Todos

• Add entry to changelog (if necessary).
  not necessary

[yhabib]

That's a quite clever way to approach it! 🙌

It is a draft

[mstrasinskis]

Thank you!

[yhabib]

Thanks for the improvement