Tester les applications React avec Vitest : un guide complet

Les tests sont un aspect essentiel du développement logiciel moderne, garantissant que votre code fonctionne comme prévu et empêchant les régressions à mesure que votre application évolue. Dans l'écosystème React, des outils comme Vitest offrent un cadre de test rapide, puissant et facile à utiliser qui s'intègre parfaitement aux applications React modernes. Dans cet article, nous explorerons comment configurer et utiliser Vitest pour tester efficacement vos composants, hooks et utilitaires React.

---

1. Introduction à Vitest

Vitest est un framework de test ultra-rapide conçu pour les projets JavaScript et TypeScript modernes, en particulier ceux utilisant Vite comme outil de construction. Vitest s'inspire de Jest, l'un des frameworks de test les plus populaires de la communauté React, mais il est optimisé pour la vitesse et la simplicité, ce qui en fait un excellent choix pour les projets React alimentés par Vite.

Principales caractéristiques :

• Exécution rapide : Vitest exécute des tests en parallèle et exploite les capacités de construction rapide de Vite.
• Prise en charge native d'ESM : Vitest est conçu pour le JavaScript moderne, offrant une prise en charge prête à l'emploi pour les modules ES.
• Compatibilité avec Jest : Si vous êtes familier avec Jest, vous trouverez l'API de Vitest familière, rendant la transition fluide.
• Prise en charge de TypeScript intégrée : Vitest prend en charge nativement TypeScript, offrant ainsi une sécurité de type dans vos tests.

---

2. Configuration de Vitest dans un projet React

Commençons par configurer Vitest dans un projet React. Nous supposerons que vous disposez d'une application React créée à l'aide de Vite. Sinon, vous pouvez en créer un rapidement à l'aide de la commande suivante :

npm create vite@latest my-react-app -- --template react
cd my-react-app

Étape 1 : Installer Vitest et les dépendances associées

Installez Vitest avec la bibliothèque de tests React et d'autres dépendances nécessaires :

npm install --save-dev vitest @testing-library/react @testing-library/jest-dom @testing-library/user-event

• vitest : Le framework de test.
• @testing-library/react : Fournit des utilitaires pour tester les composants React.
• @testing-library/jest-dom : ajoute des correspondants personnalisés à Jest et Vitest pour les assertions de nœuds DOM.
• @testing-library/user-event : simule les interactions des utilisateurs avec le DOM.

Étape 2 : Configurer Vitest

Ensuite, configurez Vitest en créant ou en modifiant votre fichier vitest.config.ts à la racine de votre projet :

import { defineConfig } from 'vitest/config';
import react from '@vitejs/plugin-react';

export default defineConfig({
  plugins: [react()],
  test: {
    environment: 'jsdom',
    globals: true,
    setupFiles: './src/setupTests.ts',
  },
});

• environnement : 'jsdom' : se moque d'un environnement de navigateur à des fins de test.
• globals : true : permet d'utiliser des variables globales comme décrire, it, attendre sans les importer.
• setupFiles : un fichier pour configurer les configurations de test, similaire au setupFilesAfterEnv de Jest.

Étape 3 : Créer un fichier d'installation

Créez un fichier setupTests.ts dans votre répertoire src pour configurer @testing-library/jest-dom :

import '@testing-library/jest-dom';

Cette configuration inclura automatiquement les correspondants personnalisés fournis par jest-dom dans vos tests.

---

3. Écriture de tests pour les composants React

Une fois Vitest configuré, écrivons quelques tests pour un simple composant React. Considérez le composant Button suivant :

// src/components/Button.tsx
import React from 'react';

type ButtonProps = {
  label: string;
  onClick: () => void;
};

const Button: React.FC<ButtonProps> = ({ label, onClick }) => {
  return <button onClick={onClick}>{label}</button>;
};

export default Button;

Maintenant, écrivons des tests pour ce composant :

// src/components/Button.test.tsx
import { render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import Button from './Button';

describe('Button Component', () => {
  it('renders the button with the correct label', () => {
    render(<Button label="Click Me" onClick={() => {}} />);
    expect(screen.getByText('Click Me')).toBeInTheDocument();
  });

  it('calls the onClick handler when clicked', async () => {
    const handleClick = vi.fn();
    render(<Button label="Click Me" onClick={handleClick} />);
    await userEvent.click(screen.getByText('Click Me'));
    expect(handleClick).toHaveBeenCalledTimes(1);
  });
});

Explication :

• render : restitue le composant pour les tests.
• screen : interroge le DOM rendu.
• userEvent.click : simule un événement de clic sur le bouton.
• vi.fn() : se moque d'une fonction pour suivre ses appels.

---

4. Exécuter vos tests

Vous pouvez exécuter vos tests à l'aide de la commande suivante :

npx vitest

Cela exécutera tous les fichiers de test qui suivent le modèle *.test.tsx ou *.spec.tsx par défaut. Vous pouvez également exécuter des tests en mode montre avec :

npx vitest --watch

Vitest fournira un résultat détaillé, vous montrant l'état de chaque test et toutes les erreurs survenues.

---

5. Test des hooks et des utilitaires personnalisés

Vitest peut également être utilisé pour tester des hooks et des utilitaires React personnalisés. Disons que vous avez un hook personnalisé useCounter :

// src/hooks/useCounter.ts
import { useState } from 'react';

export function useCounter(initialValue = 0) {
  const [count, setCount] = useState(initialValue);

  const increment = () => setCount((prev) => prev + 1);
  const decrement = () => setCount((prev) => prev - 1);

  return { count, increment, decrement };
}

Vous pouvez écrire des tests pour ce hook comme suit :

// src/hooks/useCounter.test.ts
import { renderHook, act } from '@testing-library/react-hooks';
import { useCounter } from './useCounter';

describe('useCounter Hook', () => {
  it('initializes with the correct value', () => {
    const { result } = renderHook(() => useCounter(10));
    expect(result.current.count).toBe(10);
  });

  it('increments the counter', () => {
    const { result } = renderHook(() => useCounter());
    act(() => {
      result.current.increment();
    });
    expect(result.current.count).toBe(1);
  });

  it('decrements the counter', () => {
    const { result } = renderHook(() => useCounter(10));
    act(() => {
      result.current.decrement();
    });
    expect(result.current.count).toBe(9);
  });
});

Explication :

• renderHook : restitue un hook React dans un environnement de test.
• act : garantit que toutes les mises à jour de l'état ou des effets sont traitées avant de faire des assertions.

---

6.Conclusion

Vitest fournit un moyen puissant et efficace de tester les applications React, en particulier lorsqu'il est combiné avec des outils modernes comme Vite. Sa simplicité, sa rapidité et sa compatibilité avec les pratiques Jest existantes en font un excellent choix pour les petits et grands projets React.

By integrating Vitest into your workflow, you can ensure that your React components, hooks, and utilities are thoroughly tested, leading to more robust and reliable applications. Whether you’re testing simple components or complex hooks, Vitest offers the tools you need to write effective tests quickly.

For more information, visit the Vitest documentation.

Feel free to explore more advanced features of Vitest, such as mocking, snapshot testing, and parallel test execution, to further enhance your testing capabilities.

Happy Coding ?‍?

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!