[JAVA] J'ai examiné le cycle de vie de l'extension de JUnit Jupiter

Quel est le cycle de vie d'une instance d'extension essayant d'écrire une extension pour JUnit 5 (JUnit Jupiter)? Comme c'est devenu, rédigez un mémorandum.

environnement

• AdoptOpenJDK 11
• JUnit 5.5.0

TL;TR

• L'instance enregistrée avec @ Extension est partagée pour chaque classe de test, et différentes classes de test ont différentes instances d'extension. --Instance enregistrée avec @ RegisterExtension
• Dans le cas des champs statiques, il est partagé par chaque classe de test.
• Pour les champs non statiques, cela dépend du cycle de vie de la classe de test.

Examen du modèle d'extension

Le modèle d'extension de JUnit 5 est un mécanisme de standardisation du pré-traitement, du post-traitement, du traitement des exceptions, etc. pour chaque test. Le degré de liberté est inférieur à celui de la Rule de Junit 4, mais vous pouvez facilement créer une extension simplement en implémentant une interface qui prend en charge les points d'extension.

Il existe trois façons d'utiliser l'extension.

1. Enregistrez l'extension avec @ Extension.
2. Enregistrez l'extension par programme avec @ RegisterExtension.
3. Enregistrez-vous automatiquement avec Service Loader.

Cette fois, utilisez les méthodes 1 et 2 pour vérifier quand l'instance d'extension est créée.

Les extensions utilisées pour la confirmation sont les suivantes.

FooExtension.java

import org.junit.jupiter.api.extension.*;

public class FooExtension implements BeforeEachCallback, AfterEachCallback, BeforeAllCallback, AfterAllCallback {

    {
        System.out.println(String.format("[%s] created", this.toString()));
    }

    @Override
    public void beforeAll(ExtensionContext extensionContext) throws Exception {
        System.out.println(String.format("[%s] before all", this.toString()));
    }

    @Override
    public void beforeEach(ExtensionContext context) throws Exception {
        System.out.println(String.format("[%s] before each", this.toString()));
    }

    @Override
    public void afterEach(ExtensionContext extensionContext) throws Exception {
        System.out.println(String.format("[%s] after each", this.toString()));
    }

    @Override
    public void afterAll(ExtensionContext extensionContext) throws Exception {
        System.out.println(String.format("[%s] after all", this.toString()));
    }
}

Enregistrer l'extension avec @ Extension

La source

@ExtendWith(FooExtension.class)
public class ExtensionTest {

    @Test
    void test1() { System.out.println("test 1"); }

    @Test
    void test2() { System.out.println("test 2"); }

    @Test
    void test3() { System.out.println("test 3"); }
}

résultat

[example.FooExtension@70325e14] created
[example.FooExtension@70325e14] before all
[example.FooExtension@70325e14] before each
test 1
[example.FooExtension@70325e14] after each
[example.FooExtension@70325e14] before each
test 2
[example.FooExtension@70325e14] after each
[example.FooExtension@70325e14] before each
test 3
[example.FooExtension@70325e14] after each
[example.FooExtension@70325e14] after all

Vous pouvez voir que chaque test partage une instance d'extension. Une instance d'ExtensionTest est créée pour chaque test, mais le même résultat a été obtenu lors du changement de partage de l'instance extensionTest avec @TestInstance (Lifecycle.PER_CLASS).

@ RegisterExtension + Register Extension avec champ statique

La source

SecondExtensionTest.java

public class SecondExtensionTest {

    @RegisterExtension
    static FooExtension fooExtension = new FooExtension();

    @Test
    void test1() { System.out.println("test 1"); }

    @Test
    void test2() { System.out.println("test 2"); }

    @Test
    void test3() { System.out.println("test 3"); }
}

résultat

[example.FooExtension@55183b20] created
[example.FooExtension@55183b20] before all
[example.FooExtension@55183b20] before each
test 1
[example.FooExtension@55183b20] after each
[example.FooExtension@55183b20] before each
test 2
[example.FooExtension@55183b20] after each
[example.FooExtension@55183b20] before each
test 3
[example.FooExtension@55183b20] after each
[example.FooExtension@55183b20] after all

Bien sûr, puisqu'il s'agit d'un champ statique, la même instance est partagée.

Register Extension avec @ RegisterExtension + champ non statique

Supprimons le static de la fooExtension du SecondExtensionTest plus tôt.

Pour Lifecycle.PER_METHOD

La source

SecondExtensionTest.java

public class SecondExtensionTest {

    @RegisterExtension
-   static FooExtension fooExtension = new FooExtension();
+   FooExtension fooExtension = new FooExtension();

    //Omission
}

résultat

[example.FooExtension@40a4337a] created
[example.FooExtension@40a4337a] before each
test 1
[example.FooExtension@40a4337a] after each
[example.FooExtension@fa4c865] created
[example.FooExtension@fa4c865] before each
test 2
[example.FooExtension@fa4c865] after each
[example.FooExtension@3bd82cf5] created
[example.FooExtension@3bd82cf5] before each
test 3
[example.FooExtension@3bd82cf5] after each

Vous pouvez voir que chaque test a une instance d'Extension différente. En effet, une instance de SecondExtensionTest lui-même est générée pour chaque test. BeforeAll et AfterAll ne fonctionnent pas, mais vous devez les rendre statiques dans le cas de Lifecycle.PER_METHOD ainsi que lorsque vous ajoutez @ BeforeAll à la méthode.

Pour Lifecycle.PER_CLASS

Alors, faisons du cycle de vie de Second Extension Test une forme dans laquelle une instance n'est créée qu'une seule fois.

La source

SecondExtensionTest.java

+ @TestInstance(Lifecycle.PER_CLASS)
public class SecondExtensionTest {

    @RegisterExtension
    FooExtension fooExtension = new FooExtension();

    //Omission
}

résultat

[example.FooExtension@c730b35] created
[example.FooExtension@c730b35] before all
[example.FooExtension@c730b35] before each
test 1
[example.FooExtension@c730b35] after each
[example.FooExtension@c730b35] before each
test 2
[example.FooExtension@c730b35] after each
[example.FooExtension@c730b35] before each
test 3
[example.FooExtension@c730b35] after each
[example.FooExtension@c730b35] after all

L'instance d'extension est partagée. En outre, Avant tout et Après tout fonctionnent maintenant. Si vous enregistrez une extension dans un champ non statique de cette manière, cela dépend naturellement du cycle de vie de la classe de test d'origine.

Si vous le lisez correctement, il sera écrit

https://junit.org/junit5/docs/current/user-guide/#extensions