test(jest): define a custom render function to set providers

1 files changed, 44 insertions, 0 deletions

diff --git a/__tests__/utils/test-utils.tsx b/__tests__/utils/test-utils.tsx
new file mode 100644
index 0000000..4befd47
--- /dev/null
+++ b/__tests__/utils/test-utils.tsx
@@ -0,0 +1,44 @@
+import { render, RenderOptions } from '@testing-library/react';
+import { ThemeProvider } from 'next-themes';
+import { FC } from 'react';
+import { IntlProvider } from 'react-intl';
+
+type ProvidersConfig = {
+  locale?: 'en' | 'fr';
+};
+
+type CustomRenderOptions = {
+  providers: ProvidersConfig;
+  testingLibrary: Omit<RenderOptions, 'wrapper'>;
+};
+
+/**
+ * Return a component wrapped with Intl and Theme Provider.
+ *
+ * @returns A component wrapped Intl and Theme providers.
+ */
+const AllTheProviders: FC<ProvidersConfig> = ({ children, locale = 'en' }) => {
+  return (
+    <IntlProvider locale={locale}>
+      <ThemeProvider>{children}</ThemeProvider>
+    </IntlProvider>
+  );
+};
+
+/**
+ * Render a component with all the providers.
+ *
+ * @param {JSX.Element} ui - A React component.
+ * @param {CustomRenderOptions} [options] - An object of render options and providers options.
+ * @returns A React component wrapped with all the providers.
+ */
+const customRender = (ui: JSX.Element, options?: CustomRenderOptions) => {
+  const Component = () => ui;
+  render(<Component />, {
+    wrapper: () => <AllTheProviders {...options?.providers} />,
+    ...options?.testingLibrary,
+  });
+};
+
+export * from '@testing-library/react';
+export { customRender as render };