Skip to content

Latest commit

 

History

History
118 lines (93 loc) · 3.29 KB

README.adoc

File metadata and controls

118 lines (93 loc) · 3.29 KB
Raw

Running the MicroProfile Telemetry Tracing TCK

Any MicroProfile Telemetry implementation must pass this test suite. The TCK uses testng

Hardware Requirements

All systems should meet the following recommended hardware requirements:

  • CPU running at 2.0 GHz or higher

  • 4 GB of RAM or more

  • Network access to the Internet

Software Requirements

You can run this TCK on platforms running the Solaris, Linux, Windows, and Mac OS with the following software installed:

  • Maven

  • JDK11+

Dependencies

To enable the tests in your project you need to add the following dependency to your build:

<dependency>
    <groupId>org.eclipse.microprofile.telemetry.tracing</groupId>
    <artifactId>microprofile-telemetry-tracing-tck</artifactId>
    <version>1.0</version>
    <scope>test</scope>
</dependency>

Declaring the Tests to run

You also need to specify which tests you want to run, e.g. create a file tck-suite.xml in your project which contains the following content:

<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd" >

<suite name="microprofile-opentracing-TCK" verbose="2" configfailurepolicy="continue" >

    <test name="microprofile-telemetry 1.0 TCK">
        <packages>
            <package name="org.eclipse.microprofile.telemetry.tracing.tck.*">
            </package>
        </packages>
    </test>

</suite>

Configuration in Apache Maven pom.xml

If you use Apache Maven then the tests are run via the maven-surefire-plugin

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>2.22.2</version>
            <configuration>
                <suiteXmlFiles>
                    <suiteXmlFile>tck-suite.xml</suiteXmlFile>
                </suiteXmlFiles>
            </configuration>
        </plugin>
    </plugins>
</build>

Running as a Scanned Dependency

You can also run the TCK as a scanned dependency.

Surefire Configuration in your pom.xml

Once you’ve added the dependency, you don’t need a tck-suite.xml you can just scan the dependency for tests.

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>2.22.2</version>
            <configuration>
                <dependenciesToScan>
                    <dependency>org.eclipse.microprofile.telemetry.tracing:microprofile-telemetry-tracing-tck</dependency>
                </dependenciesToScan>
            </configuration>
        </plugin>
    </plugins>
</build>