Vorlesungen zum JS-Unit-Testen – Der praktische Leitfaden

Dies ist eine Zusammenfassung des Kurses „JavaScript Unit Testing – The Practical Guide“, gehalten von Maximilian Schwarzmüller.

Einführung

Der Einstieg in automatisierte Tests kann eine großartige Idee sein, da diese im Vergleich zu manuellen Tests viel vorhersehbarer und konsistenter sind.

Betrachten wir ein Szenario, in dem Sie eine neue Funktion hinzufügen oder einen Teil Ihres Codes ändern.

Sie kennen nicht unbedingt jeden Teil oder alle Teile des Codes, die tatsächlich betroffen waren.

Bei manuellen Tests müssten wir die gesamte Anwendung testen (oder ausprobieren) oder zumindest Dinge, die von der Änderung betroffen sein könnten. Warum? Denn wir müssten sehen, ob alles noch funktioniert und ob diese kleine Änderung oder neue Funktion den Code nicht irgendwo kaputt gemacht hat.

Also, wie wir uns vorstellen können, eine Menge Arbeit.

Außerdem kann nicht garantiert werden, dass alles, was getestet werden muss, getestet wird, und jedes Mal, wenn sich etwas ändert, kann nicht garantiert werden, dass die Dinge auf die gleiche Weise getestet werden.

Mit automatisierten Tests haben wir zunächst einen Aufwand, der später jedoch viele Vorteile bringt.

Von der Vielzahl automatisierter Tests, die wir heutzutage haben, werden wir hier über Unit- und Integrationstests sprechen, aber hauptsächlich über Unit-Tests.

Stellen wir uns eine Einheit als den kleinsten Teil unseres Codes vor, zum Beispiel Funktionen oder Klassen. Bei Unit-Tests testen wir also, wie der Name schon sagt, jede Einheit unserer Anwendung. Wenn wir also beispielsweise 50 Funktionen haben, erstellen wir Tests für alle oder die Mehrheit. Denn wir wollen garantieren, dass jedes Teil, jede Einheit so funktioniert, wie sie soll, wie ursprünglich vorgesehen.

Bei Integrationstests geht es hingegen darum, diese Einheiten gemeinsam zu testen, oder besser gesagt, wie sie zusammenarbeiten und ob sie gut zusammenarbeiten. Denn selbst wenn wir die Einheiten einzeln testen, ist das keine Garantie dafür, dass sie zusammenarbeiten oder so funktionieren, wie sie sollten.

Testgetriebene Entwicklung (TDD)

Wir sollten auch TDD kennen, die Kurzform von Test-Driven Development.

TDD ist ein Framework/eine Philosophie, die uns dazu bringt, darüber nachzudenken, zuerst einen fehlgeschlagenen Test zu schreiben und dann den Code zu implementieren, der den Test zum Erfolg führt. Und dann die Umgestaltung als zyklische Sache.

Eine Erinnerung

Halten Sie Ihre Tests einfach!

Wenn jemand anderes Ihren Code lesen muss oder in einem zukünftigen Szenario sogar Sie selbst, ist es wichtig, dass es nicht zu lange dauert, bis er ihn versteht. Es muss eine einfache Aufgabe sein.

Vitest

Für diese Anleitung werden wir mit Vitest arbeiten, einem Tool, das auf der berühmten Jest-App zum Testen und mehr basiert. Hier geht es nicht darum, tief in die Vitest-Syntax oder alle Funktionalitäten einzusteigen, sondern als Werkzeug zum Verständnis des Kerns des Testens.

Wenn Sie alles erfahren oder sehen möchten, bei dem Vitest uns helfen kann, gehen Sie zur Dokumentation unter dem folgenden Link: Vitest-Dokumentation

Hinweis

Vitest kann ähnlich wie das Webpack-Tool zum Bündeln funktionieren. Wenn wir also die ES-Modul-Notation verwenden, müssen wir die Erweiterung der Datei, die wir importieren, nicht explizit angeben. Zum Beispiel:

Mathe aus './math/Math' importieren

Das Gegenteil wäre:

Mathematik aus „./math/Math.js“ importieren

Gute Praktiken

Hier ist ein kleiner Leitfaden, der Sie in die Praxis Ihrer Schreibtestroutine einführt.

Gute Tests schreiben

Unit- und Integrationstests können sehr nützlich sein, aber nur, wenn sie gut geschrieben sind. Und dafür können wir einer Reihe von „guten Praktiken“ folgen, die im Folgenden untersucht werden:

Testen Sie nur Ihren Code

Wenn wir über das Testen unseres eigenen Codes sprechen, bedeutet das, dass wir nicht für das Testen von Code Dritter verantwortlich sind. Nun, es ist für denjenigen gedacht, der den Code von Drittanbietern geschrieben hat, um sicherzustellen, dass er einwandfrei funktioniert. Daher liegt es in ihrer Verantwortung, ihn zu testen.

Auch weil Sie es nicht ändern können und es daher keinen Sinn macht, es zu testen.

Wissen, wie man Tests unterscheidet

Sie werden Ihren serverseitigen Code nicht implizit über Ihren clientseitigen Code testen.

Und Sie testen Ihre kundenseitige Reaktion auf verschiedene Reaktionen und Fehler.

Trennen Sie also Ihre Tests, Tests für Ihre Frontend-Entwicklung und Tests für Ihre Backend-Entwicklung.

AAA

• Anordnen: Testumgebung und Werte definieren
• Aktion: Führen Sie den eigentlichen Code/die eigentliche Funktion aus, die getestet werden soll
• Bestätigen: Bewerten Sie den erzeugten Wert/Ergebnis und vergleichen Sie ihn mit dem erwarteten Wert/Ergebnis.

Hier gibt es ein Vitest-Codebeispiel:

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);
});

Nur ​​um zu verdeutlichen, was der Code tut, falls Sie sich dessen nicht bewusst sind.

Zuerst importieren wir „expect“ und „it“ aus vitest, das sind die von uns benötigten Funktionalitäten, sowie die „toSum“-Funktion, die eine für das Beispiel erstellte Funktion ist, sich aber in einer anderen Datei befindet.

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.

Das obige ist der detaillierte Inhalt vonVorlesungen zum JS-Unit-Testen – Der praktische Leitfaden. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!