Cours de tests unitaires JS - Le guide pratique

Ceci est un résumé du cours "JavaScript Unit Testing - The Practical Guide" dispensé par Maximilian Schwarzmüller.

Introduction

Plonger dans les tests automatisés peut être une excellente idée car par rapport aux tests manuels, ils sont bien plus prévisibles et cohérents.

Considérons un scénario dans lequel vous ajoutez une nouvelle fonctionnalité ou modifiez une partie de votre code.

Vous ne connaîtrez pas nécessairement chaque partie ou toutes les parties du code qui ont été réellement affectées.

Avec les tests manuels, nous devrions tester (ou essayer) l'ensemble de l'application, ou du moins les éléments susceptibles d'être affectés par le changement. Pourquoi? Parce que nous aurions besoin de voir si tout fonctionne toujours et si ce petit changement ou cette nouvelle fonctionnalité n'a pas cassé le code quelque part.

Donc, comme on peut l'imaginer, beaucoup de travail.

De plus, on ne peut pas garantir que tout ce qui doit être testé le sera, et chaque fois que quelque chose change, on ne peut pas être assuré que les choses seront testées de la même manière.

Avec les tests automatisés, nous avons un effort initial, mais cela apporte beaucoup de bénéfices plus tard.

Parmi la variété de tests automatisés dont nous disposons aujourd'hui, nous allons parler ici des tests unitaires et d'intégration, mais principalement des tests unitaires.

Pensons à une unité comme à la plus petite partie de notre code, par exemple des fonctions ou des classes. Ainsi, dans les tests unitaires, comme son nom l’indique, nous testerons chaque unité de notre application. Ainsi, si nous avons par exemple 50 fonctions, nous créerons des tests pour toutes ou pour la majorité. C'est parce que nous voulons garantir que chaque pièce, chaque unité, fonctionne comme il se doit, comme prévu au départ.

Les tests d'intégration, en revanche, porteront sur le test de ces unités ensemble, ou, mieux dit, sur la façon dont elles fonctionnent ensemble et si elles fonctionnent bien ensemble. En effet, même si nous testons les unités seuls, cela ne garantit pas qu'elles fonctionnent ensemble ou qu'elles fonctionnent comme elles le devraient.

Développement piloté par les tests (TDD)

Nous devons également être conscients du TDD, la forme abrégée de Test-Driven Development.

TDD est un framework/philosophie qui nous amène à penser d'abord à écrire un test qui échoue, puis à implémenter le code qui fera que le test réussisse. Et puis refactoriser, comme une chose cyclique.

Un rappel

Gardez vos tests simples !

Lorsque quelqu'un d'autre a besoin de lire votre code ou même vous dans un scénario futur, il est important que cela ne prenne pas trop de temps à comprendre. Cela doit être une tâche facile.

Vitester

Pour ces conseils, nous allons travailler avec Vitest, un outil basé sur la célèbre application Jest pour tester et bien plus encore. Ici, il n'est pas destiné à approfondir la syntaxe Vitest ou toutes les fonctionnalités, mais comme un outil pour comprendre le cœur des tests.

Si vous souhaitez apprendre ou voir tout ce pour quoi Vitest peut nous aider, rendez-vous sur la documentation au lien suivant : Documentation Vitest

Indice

Vitest peut fonctionner de la même manière que l'outil Webpack pour le regroupement, donc lorsque nous utilisons la notation ES Module, nous n'avons pas réellement besoin d'informer explicitement l'extension du fichier que nous importons. Par exemple :

Importer des mathématiques depuis './math/Math'

Ce qui est le contraire serait :

Importer les mathématiques depuis './math/Math.js'

Bonnes pratiques

Voici un petit guide pour vous guider vers les bonnes pratiques dans votre routine de tests d'écriture.

Rédiger de bons tests

Les tests unitaires et d'intégration peuvent être très utiles, mais seulement s'ils sont bien rédigés. Et pour cela, nous pouvons suivre une série de « bonnes pratiques » qui seront explorées ci-dessous :

Testez uniquement votre code

Lorsque nous parlons de tester notre propre code, cela signifie que le code tiers n'est pas de notre responsabilité de le tester. Eh bien, il est destiné à celui qui a écrit le code tiers pour s'assurer qu'il fonctionne correctement, il est donc de sa responsabilité de le tester.

Aussi parce que vous ne pourrez pas le changer, donc ça ne sert à rien de le tester.

Savoir différencier les tests

Vous n'allez pas tester implicitement votre code côté serveur via votre code côté client.

Et vous testerez votre réaction côté client à différentes réponses et erreurs.

Alors séparez vos tests, les tests pour votre développement frontend et les tests pour votre développement backend.

AAA

• Organiser : définir l'environnement de test et les valeurs
• Act : exécutez le code/la fonction qui doit être testé
• Assert : évaluez la valeur/le résultat produit et comparez-le à la valeur/le résultat attendu.

Voici un exemple de code Vitest :

import { expect, it } from 'vitest';
import { toSum } from './math';

it('should sum two numbers', () => {
    //Arrange
    const num1 = 1;
    const num2 = 2;

    //Act
    const result = toSum(num1, num2);

    //Assert
    const expectedResult = num1 + num2;

    expect(result).toBe(expectedResult);
});

Juste pour clarifier ce que fait le code, au cas où vous ne le sauriez pas.

Tout d'abord, nous importons "expect" et "it" depuis vitest, qui sont des fonctionnalités dont nous avons besoin, et la fonction "toSum", qui est une fonction construite pour l'exemple mais qui se trouve dans un autre fichier.

The "it" works as the scope for our test; it receives a string that behaves as the identifier and a function that will run the test code. Here is very simple; we are saying that it should sum two numbers, that's our expectation for the function and for the test.

In the arrange part we create the variables which will be passed to the "toSum" function. Then, in the act part, we create a constant that will receive the result of the function. Finally, in the assert, we will store the expected result, which would be the sum of the two numbers and use "expect" from Vitest to make the assertion. Basically, we are saying that we expect the result to be the same as the expected result.

There are many assertion possibilities, so please do check the documentation for further study.

Note: "it" is an alias for "test"

Also, it's very important the following line:

const expectedResult = num1 + num2;

Imagine if we've done it like this:

const expectedResult = 3;

It's okay for the current test because we are indeed expecting 3 as the result.

But, imagine in the future, someone changes "num1" or "num2", and forgets to change the "expectedResult"; it would not work if the result of the sum was not 3.

Essence of what is being tested

If you, for example, created a function that is going to receive an array of numbers as an argument and you need to test if it actually received an array of numbers in your test file, you just need to reference an array, for example:
const items = [1, 2];

You don't need to create a bigger array, for example:
const items = [1, 2, 3, 4, 5, 6, 7, 8];

It's unnecessary and redundant. Keep it short, simple and concise, so you will make sure that you are only testing what needs to be tested or what is important for the function.

Test one thing

You can think of one thing as one feature or one behavior. For example, if you have a function that will sum two numbers (the same example above) and you need to make sure that is summing two numbers (because indeed that's the main functionality) but also that the output is of type number, then, you can separate it into two assertions, for example:

import { describe, expect, it } from 'vitest';
import { toSum } from './math';

describe('toSum()', () => {
 it('should sum two numbers', () => {
    const num1 = 1;
    const num2 = 2;

    const result = toSum(num1, num2);

    const expectedResult = num1 + num2;

    expect(result).toBe(expectedResult);
 });

 it('should output a result of type number', () => {
    const num1 = 1;
    const num2 = 2;

    const result = toSum(num1, num2);

    const expectedResult = num1 + num2;

    expect(result).toBe(expectedResult);
 });

})

If you're wondering what describe does, it help us to create suites. As many suites as we want, like dividing blocks of tests. It keeps our code organized, clear, and easier to understand the outputting.

Here's an example using the toSum function:

As you can see in the image above, it will show us the file path, and after that the "describe" name, and then the "it" name. It's a good idea to keep the describer name short and referencing the function to what the tests are about.

And you could have describers inside describers to organize even further, it's up to you.

SO,

when we create our tests following good practices, we are creating tests that will actually help us on what's needed to be tested. And also, testing forces us to write better code. For that, we can write good functions that will hold only the logic of that function so it'll be easier to test what's need to be tested.

Code coverage

It's important to understand also that coverage doesn't mean good testing or testing that is useful and meaningful for the application. Well, you could cover 100% of your code with meaningless tests after all, or, missing important tests that you didn't think of.

Don't see a high amount of code coverage as the ultimate goal!

You will want to try and test cover the majority of the units (functions or classes) in your application, because that's what unit testing is about, but, there is some code that doesn't need to be tested.

Vitest comes with a built-in functionality to help us measure the code coverage; you can access in the following link: Vitest coverage tool

Callbacks and Async Functions

As callbacks and async functions exhibit specific behavior in Vitest, this section is dedicated to exploring them superficially.

When testing for a callback, keep in mind that Vitest does not wait for the response or for the callback to be executed. Therefore, we need to use the "done" argument.

Consider the following test as an example:

import { expect, it } from 'vitest';
import { generateToken } from './async-example';

it('should generate a token value', (done) => {
   const email = 'test@mail.com';

   generateToken(email, (err, token) => {
       expect(token).toBeDefined();
       done()
   })

})

Now, we are working with a callback function. Notice that there's a parameter being passed. The "done".

Vitest now needs to wait until the done function is called.

What would happen if we didn't use the "done" argument? The "expect" wouldn't be executed.

Try and catch

Still in that function, imagine if we changed toBeDefined to toBe, as in the image below:

import { expect, it } from 'vitest';
import { generateToken } from './async-example';

it('should generate a token value', (done) => {
   const email = 'test@mail.com';

   generateToken(email, (err, token) => {
       expect(token).toBe(2);
       done();
   });
})

By default, in Vitest, the "toBe" function throws an error each time something doesn't go as expected, in this case, if the token returned wasn't 2.

However, as we are working with a callback, we will need to add an exception handling syntax, such as "try and catch", because if we don't do so, the test will timeout.

import { expect, it } from 'vitest';
import { generateToken } from './async-example';

it('should generate a token value', (done) => {
   const email = 'test@mail.com';

   try {
     generateToken(email, (err, token) => {
         expect(token).toBe(2);
     });
   } catch (error) {
       done(error);
   }
})

Since we are dealing with an error, we also need to pass this error to the "done" function.

Promises

Now, when working with promises, it's a bit easier, or should we say, simpler.

import { expect, it } from 'vitest';
import { generateTokenPromise } from './async-example';

it('should generate a token value', () => {
  const email = 'test@mail.com';

  return expect(generateTokenPromise(email)).resolves.toBeDefined();

  //or

  return expect(generateTokenPromise(email)).rejects.toBe();
});

Here we have two possibilities: resolves and rejects

The "return" statement guarantees Vitest waits for the promise to be resolved.

Alternatively, we have:

import { expect, it } from 'vitest';
import { generateTokenPromise } from './async-example';

it('should generate a token value', async () => {
  const email = 'test@mail.com';

  const token = await generateTokenPromise(email);

  expect(token).resolves.toBeDefined();

  // or

  expect(token).rejects.toBe();
})

Here we don't need to use "return" because "async/await" is being used (since a function annotated with "async" returns a promise implicitly).

Hooks, spies and mocks

Here, we are going to explore a little bit of these important functionalities that Vitest provides to us.

Hooks

Imagine working with a bunch of tests that use the same variable, and you don't want to initialize it every single time in every single test because it's the same.

Hooks can help us in this case because you can use functions provided by it that allow us to reuse this variable.

Functions available: "beforeAll", "beforeEach", "afterEach", "afterAll".

Here goes a simple example just to show how it works:

import { beforeEach } from 'vitest';

let myVariable;

beforeEach(() => {
  myVariable = "";
});

it('sentence', () => {
  myVariable = "Hello";
});

it('another sentence', () => {
  myVariable += 2;
});

Now, imagine the same but without the hook:

let myVariable;

it('sentence', () => {
  myVariable = "Hello";
});

it('another sentence', () => {
  myVariable += 2;
});

As we can see, when using "beforeEach" and a global variable, before each test starts to execute, the variable will be "cleaned". This allows the tests to use the variable as if it were fresh.

But, without using the hook and using a global variable, in some cases, things would be tricky. In the example of the test "another sentence," if we didn't clean the variable, it would be holding "Hello" because the "sentence" test is run first. And that's not what we want.

Mocks and Spies

Mocks and spies are mainly to handle side effects and external dependencies.

We could say that spies help us deal with side effects in our functions, and mocks help us deal with side effects of external dependencies.

For that, you will have to import "vi" from vitest.

To build a spy, you can use "vi.fn()" and for a mock "vi.mock()". Inside each function, you will pass the name to the other function (your or external).

So, spies and mocks kind of replace the actual functions with other functions or empty functions.

Mocks will be available only for tests of the file you called them and Vitest, behind the scenes, puts them at the start of the file.

Conclusion

In summary, you need to consider what the unit should or should not do. To achieve this, you can utilize the "it" syntax provided by Vitest, which takes a string describing your expectations and a function that will test the given expectations.

The name of the test should be short, simple and easy to understand.

The testing magic lies in thinking about aspects that were not initially considered, leading to code improvement. This process helps prevent errors and promotes a clearer understanding of what the function should do and its expected behaviors.

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!