Setup and Configuration

Previous Next Contents

4 Setup and Configuration

Note

The Jakarta EE Specification process provides for any number of compatible implementations. As additional implementations become available, refer to project or product documentation from those vendors for specific TCK setup and operational guidance.

This chapter describes how to set up the JSON Processing TCK . Before proceeding with the instructions in this chapter, be sure to install all required software, as described in Chapter 3, "Installation."

After completing the instructions in this chapter, proceed to Chapter 5, "Executing Tests," for instructions on running the JSON Processing TCK.

Note

The JSON Processing TCK is not depended on any particular build tool to run the tests. It will be convenient and advisable to create a Apache Maven project to setup and run the TCK. This chapter will henceforth use instructions and steps to provide setup with Apache Maven as a build tool.

4.1 Configuring Your Environment to Run the TCK Against the Compatible Implementation

After configuring your environment as described in this section, continue with the instructions in Chapter 5, "Executing Tests."

Note

In these instructions, variables in angle brackets need to be expanded for each platform. For example, <JAVA_HOME> becomes $JAVA_HOME on Solaris/Linux and %JAVA_HOME% on Windows. In addition, the forward slashes (/) used in all of the examples need to be replaced with backslashes (\) for Windows. Finally, be sure to use the appropriate separator for your operating system when specifying multiple path entries (; on Windows, : on UNIX/Linux).

On Windows, you must escape any backslashes with an extra backslash in path separators used in any of the following properties, or use forward slashes as a path separator instead.

  1. Set the following environment variables in your shell environment:

    1. JAVA_HOME to the directory in which Java SE 11+ is installed

    2. M2_HOME to the directory in which the Apache Maven build tool is installed.

    3. JSONPTCK_HOME to the directory in which the JSON Processing 2.1 TCK has been installed

    4. PATH to include the following directories: JAVA_HOME/bin, and M2_HOME/bin

  2. Set the following System properties:

    1. jsonp-impl.groupId property is set to the Maven Group Id of the CI to test.

    2. jsonp-impl.artifactId property is set to the Maven Artifact Id of the CI to test.

    3. jsonp-impl.version property is set to the Maven Version of the CI to test.

    4. jimage.dir property is set to extract the Java SE 11+ modules for running the signature tests.

  3. Set the below jars to the classpath

    1. JAR file for the JSON Processing 2.1 API.
      jakarta.json-api.jar.

    2. JUnit 5 jars (5.7.2+)

    3. sigtest-maven-plugin (1.4) to run the signature tests.

    4. JSON Processing TCK tests (jakarta.json:jakarta.json-tck-tests) or JSON Processing TCK pluggability tests (jakarta.json:jakarta.json-tck-tests-pluggability) depending on which test suite to run.

    Example: Maven configuration
        <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>jakarta.json</groupId>
                    <artifactId>jakarta.json-tck</artifactId>
                    <version>2.1.0</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
        ....
        <dependencies>
            <dependency>
                <groupId>org.eclipse.parsson</groupId>
                <artifactId>parsson</artifactId>
                <version>1.1.0</version>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>jakarta.json</groupId>
                <artifactId>jakarta.json-api</artifactId>
                <version>2.1.0</version>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.junit.jupiter</groupId>
                <artifactId>junit-jupiter-api</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.junit.jupiter</groupId>
                <artifactId>junit-jupiter-engine</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.netbeans.tools</groupId>
                <artifactId>sigtest-maven-plugin</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>jakarta.json</groupId>
                <artifactId>jakarta.json-tck-tests</artifactId> <!-- or jakarta.json-tck-tests-pluggability -->
                <scope>test</scope>
            </dependency>
        </dependencies>

4.2 Configuring Your Environment to Run the TCK Against the Vendor Implementation

After configuring your environment as described in this section, continue with the instructions in Chapter 5, "Executing Tests."

Note

In these instructions, variables in angle brackets need to be expanded for each platform. For example, <JAVA_HOME> becomes $JAVA_HOME on Solaris/Linux and %JAVA_HOME% on Windows. In addition, the forward slashes (/) used in all of the examples need to be replaced with backslashes (\) for Windows. Finally, be sure to use the appropriate separator for your operating system when specifying multiple path entries (; on Windows, : on UNIX/Linux).

On Windows, you must escape any backslashes with an extra backslash in path separators used in any of the following properties, or use forward slashes as a path separator instead.

  1. Set the following environment variables in your shell environment:

    1. JAVA_HOME to the directory in which Java SE 11+ is installed

    2. M2_HOME to the directory in which the Apache Maven build tool is installed.

    3. JSONPTCK_HOME to the directory in which the JSON Processing 2.1 TCK has been installed

    4. PATH to include the following directories: JAVA_HOME/bin, and M2_HOME/bin

  2. Set the following System properties:

    1. jsonp-api.groupId property is set to the Maven Group Id of the VI to test.

    2. jsonp-api.artifactId property is set to the Maven Artifact Id of the VI to test.

    3. jsonp-api.version property is set to the Maven Version of the VI to test.

    4. jimage.dir property is set to extract the Java SE 11+ modules for running the signature tests.

  3. Set the below jars to the classpath

    1. JAR file for the JSON Processing 2.1 CI.
      parsson.jar.

    2. JUnit 5 jars (5.7.2+)

    3. sigtest-maven-plugin (1.4) to run the signature tests.

    4. JSON Processing TCK tests (jakarta.json:jakarta.json-tck-tests) or JSON Processing TCK pluggability tests (jakarta.json:jakarta.json-tck-tests-pluggability) depending on which test suite to run.

    Example: Maven configuration
        <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>jakarta.json</groupId>
                    <artifactId>jakarta.json-tck</artifactId>
                    <version>2.1.0</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
        ....
        <dependencies>
            <dependency>
                <groupId>org.eclipse.parsson</groupId>
                <artifactId>parsson</artifactId>
                <version>1.1.0</version>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.junit.jupiter</groupId>
                <artifactId>junit-jupiter-api</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.junit.jupiter</groupId>
                <artifactId>junit-jupiter-engine</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.netbeans.tools</groupId>
                <artifactId>sigtest-maven-plugin</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>jakarta.json</groupId>
                <artifactId>jakarta.json-tck-tests</artifactId> <!-- or jakarta.json-tck-tests-pluggability -->
                <scope>test</scope>
            </dependency>
        </dependencies>

4.3 Publishing the Test Applications

Not needed for the JSON Processing TCK.


Previous Next Contents
Eclipse Foundation Logo  Copyright © 2017, 2022 Oracle and/or its affiliates. All rights reserved.