テストをカスタマイズ - Cloud

カスタムテスト設定を作成

Webhookを利用したりテストの実行をカスタマイズしたりする場合は、pomを自分で設定できます。

ここではpom.xmlの例を示しますが、設定可能なオプションは以下のとおりです。

<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>

Pom設定

以下の属性をpomに追加して、プラグインの動作を微調整できます。追加方法には次の2つがあります。

• pomの設定タグ(上の例の属性ファイルを参照してください)
• JVM引数でプラグインに渡す

Pomで属性が${attributeName}で定義されている場合は、JVMプラグインを使用してmvnコマンドを実行すると、値を渡すことができます。上記のpomのaccountIdの場合、以下のように渡すことができます。

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

Pom属性

次の表に、使用可能なカスタマイズオプションを示します。

以下は完全な設定例です:

<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>

環境変数の上書き

環境変数を上書きするには、プラグインの設定でvariablesタグを追加します。

特定のマシン上の別のポートでAPIを実行する必要がある場合は、環境変数host経由で443に設定されていても、1337のポートで実行する必要があります。これは、次に示すように環境変数portを上書きすることで簡単に行うことができます。

<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

プロキシを使用

APIはプロキシ経由のアクセスに限られる可能性があります。この場合、Talendではmavenプラグインによって行われたすべてのHTTPコールに対してプロキシを設定する簡単な方法が用意されています。

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

通知形式

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

{
  "event":[Begin|End]
}