Comment définir une variable d'environnement ou une propriété système dans les tests de printemps?

J'aimerais écrire quelques tests qui vérifient la configuration XML Spring d'un WAR déployé. Malheureusement, certains beans nécessitent que certaines variables d'environnement ou propriétés système soient définies. Comment puis-je définir une variable d'environnement avant l'initialisation des beans spring lors de l'utilisation du style de test pratique avec @ContextConfiguration?

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = "classpath:whereever/context.xml")
public class TestWarSpringContext { ... }

Si je configure le contexte de l'application avec des annotations, je ne vois pas de hook où je peux faire quelque chose avant que le contexte de printemps ne soit initialisé.

Vous pouvez initialiser la propriété System dans un initialiseur statique:

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = "classpath:whereever/context.xml")
public class TestWarSpringContext {

    static {
        System.setProperty("myproperty", "foo");
    }

}

Le code d'initialisation statique sera exécuté avant l'initialisation du contexte de l'application Spring.

La bonne façon de faire cela, à partir de Spring 4.1, est d'utiliser une @TestPropertySourceannotation.

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = "classpath:whereever/context.xml")
@TestPropertySource(properties = {"myproperty = foo"})
public class TestWarSpringContext {
    ...    
}

Voir @TestPropertySource dans les documents Spring et Javadocs .

On peut également utiliser un test ApplicationContextInitializer pour initialiser une propriété système:

public class TestApplicationContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext>
{
    @Override
    public void initialize(ConfigurableApplicationContext applicationContext)
    {
        System.setProperty("myproperty", "value");
    }
}

puis configurez-le sur la classe de test en plus des emplacements des fichiers de configuration de contexte Spring:

@ContextConfiguration(initializers = TestApplicationContextInitializer.class, locations = "classpath:whereever/context.xml", ...)
@RunWith(SpringJUnit4ClassRunner.class)
public class SomeTest
{
...
}

De cette façon, la duplication de code peut être évitée si une certaine propriété système doit être définie pour tous les tests unitaires.

Toutes les réponses ici ne parlent actuellement que des propriétés du système qui sont différentes des variables d'environnement qui sont plus complexes à définir, esp. pour les tests. Heureusement, la classe ci-dessous peut être utilisée pour cela et la documentation de la classe a de bons exemples

EnvironmentVariables.html

Un exemple rapide tiré de la documentation, modifié pour fonctionner avec @SpringBootTest

@SpringBootTest
public class EnvironmentVariablesTest {
   @ClassRule
   public final EnvironmentVariables environmentVariables = new EnvironmentVariables().set("name", "value");

   @Test
   public void test() {
     assertEquals("value", System.getenv("name"));
   }
 }

Si vous voulez que vos variables soient valides pour tous les tests, vous pouvez avoir un application.propertiesfichier dans votre répertoire de ressources de test (par défaut:) src/test/resourcesqui ressemblera à ceci:

MYPROPERTY=foo

Celui-ci sera ensuite chargé et utilisé à moins que vous n'ayez des définitions via @TestPropertySourceou une méthode similaire - l'ordre exact dans lequel les propriétés sont chargées peut être trouvé dans le chapitre 24 de la documentation de Spring . Configuration externalisée .

Vous pouvez définir les propriétés système comme arguments de machine virtuelle.

Si votre projet est un projet maven, vous pouvez exécuter la commande suivante lors de l'exécution de la classe de test:

mvn test -Dapp.url="https://stackoverflow.com"

Classe de test:

public class AppTest  {
@Test
public void testUrl() {
    System.out.println(System.getProperty("app.url"));
    }
}

Si vous souhaitez exécuter une classe ou une méthode de test individuelle dans eclipse, alors:

1) Allez dans Exécuter -> Exécuter la configuration

2) Sur le côté gauche, sélectionnez votre classe de test dans la section Junit.

3) procédez comme suit:

Pour les tests unitaires, la variable système n'est pas encore instanciée lorsque je fais "mvn clean install" car aucun serveur n'exécute l'application. Donc, pour définir les propriétés système, je dois le faire dans pom.xml. Ainsi:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>2.21.0</version>
    <configuration>
        <systemPropertyVariables>
            <propertyName>propertyValue</propertyName>
            <MY_ENV_VAR>newValue</MY_ENV_VAR>
            <ENV_TARGET>olqa</ENV_TARGET>
            <buildDirectory>${project.build.directory}</buildDirectory>
        </systemPropertyVariables>
    </configuration>
</plugin>