Merge branch 'renovate/all-minor-patch' into 'main'
[ProtonMail-WebClient.git] / packages / testing / README.md
blob765391eabd52b4a985123d41333186e19a74ca0e
1 # Testing
3 The testing package contains common mocks and test data to use across the monorepo.
5 ## Builders
7 Builders are using [test-data-bot](https://github.com/jackfranklin/test-data-bot) to generate data structures according to our types. It is reasonably flexible, allowing to create variations by using `traits` and using overrides, have some random and/or fixed fields and use builders within builders.
9 ## Handlers
11 Handlers are for [Mock Service Worker](https://mswjs.io) to use in mock API responses. It can be used both in tests as well as client side when needed. `handlers.ts` responses are loaded by default, but you can override via `server.use` and injecting a `rest.get` to override an existing handler.
13 ## Mocks
15 The mocks are all blank apart from the API and getRandomValues. The simple API mock is necessary to allow the use of `MSW`.