Personnaliser vos tests - Cloud

Créez votre configuration de test personnalisée

Si vous souhaitez bénéficier des WebHooks ou personnaliser les exécutions des tests, vous pouvez configurer vous-même le pom.

Voici un exemple de pom.xml, les options configurables sont détaillées ci-dessous.

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.talend.ci.api-tester</groupId>
    <artifactId>petstore_api</artifactId>
    <version>1.0.0</version>
    <build>
        <plugins>
            <plugin>

                <!-- The Talend maven plugin -->
                <groupId>org.talend.ci</groupId>
                <artifactId>api-tester-maven-plugin</artifactId>
                <version>1.0.0</version>

                <executions>
                    <execution>
                        <phase>test</phase>
                        <goals>
                            <goal>test</goal>
                        </goals>
                        <configuration>
                          <file>Petstore_API.json</file>
                          <selectedEnvironment>API Services's context</selectedEnvironment>

                          <!-- Put your Account ID here. Consult your Account Information in Talend Management Console Subscription page -->
                          <accountId>${account_id}</accountId>

                          <instance>us</instance>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
    <pluginRepositories>
        <!-- Put your plugin repository configuration here -->
    </pluginRepositories>
</project>

Configuration du pom

Les attributs suivants peuvent être ajoutés au pom pour adapter le comportement du plug-in. Ils peuvent être ajoutés de deux façons différentes :

• dans le tag de la configuration du pom (consultez l'exemple ci-dessus avec le fichier d'attribut );
• passés au plug-in via les arguments JVM.

Si l'attribut est défini avec une valeur ${attributeName} dans le pom, alors vous pouvez lui passer une valeur lorsqu'il exécute la commande mvn via un plug-in JVM. Dans le cas du accountId dans le pom ci-dessus, vous pouvez le passer comme suit :

mvn clean test -Daccount_id=492b2ecd-888d-4087-8ab5-42cab17334ad

Attributs pom

Le tableau suivant décrit les options de personnalisation disponibles.

Consultez l'exemple de configuration en entier ci-dessous :

<configuration>
    <file>/path/to/json/configuration/file.json</file>
    <selectedEnvironment>QA</selectedEnvironment>
    <accountId>${account_id}</accountId>
    <stopOnFailure>true</stopOnFailure>
    <httpclientTimeoutInMs>30000</httpclientTimeoutInMs>
    <xhrEmulation>false</xhrEmulation>
    <followRedirects>ALL</followRedirects>
    <beforeTest>https://my-ci-api.com/api1/notifications</beforeTest>
    <afterTest>https://my-ci-api.com/api1/notifications</afterTest>
</configuration>

Écraser les variables d'environnement

Vous pouvez écraser une variable d'environnement en ajoutant un tag variables dans la configuration du plug-in.

Dans le cas où vous devez exécuter une API sur un port différent d'une machine spécifique, même si l'environnement est réglé sur 443 via une variable d'environnement host, il vous faudra l'exécuter sur un port à 1337. Vous pouvez faire cela en écrasant la variable d'environnement port comme illustré ci-dessous.

<configuration>
    <file>test.json</file>
    <selectedEnvironment>localhost</selectedEnvironment>
    <variables>
        <!-- The variable port's value will be overwritten to 1337 -->
        <property>
            <name>port</name>
            <value>1337</value>
        </property>
        <!-- The variable apiEndpoint's value can be set when invoking Maven -->
        <property>
            <name>apiEndpoint</name>
            <value>${api.endpoint}</value>
        </property>
    </variables>
</configuration>

mvn test -Dapi.endpoint=https://httpbin.org

Utiliser un proxy

Votre API peut n'être accessible que par le biais d'un proxy. Dans ce cas, Talend vous propose une façon simple de configurer un proxy pour tous les appels HTTP réalisés par le plug-in Maven.

mvn test -Djava.net.useSystemProxies=true

<configuration>
  <file>/test.json</file>
  <useMavenProxies>true</useMavenProxies>
</configuration>

mvn test -Dhttp.proxyHost=192.168.1.127

mvn test -Dhttps.proxyHost=192.168.1.127

Format de notifications

{
  "name":[test name],
  "event":[BeforeTest|AfterTest],
  "result":[Ok|Failure|Error] &Tab;<- present only if event=afterTest
}

{
  "event":[Begin|End]
}