Setup and Configuration

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.

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 Authorization TCK.

4.1 Configuring Your Environment to Run the TCK Against the Compatible Implementation (CI)

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.

Set the following environment variables in your shell environment:
1. JAVA_HOME to the directory in which Java SE 17 is installed
2. M2_HOME to the directory in which the Apache Maven build tool is installed.
3. JAVAEE_HOME to the directory in which the Authorization 3.0 CI has been installed
4. PATH to include the following directories: JAVA_HOME/bin, and M2_HOME/bin

Set the below jars to the classpath

JAR file for the Authorization 3.0 API.
eg. ${web.home}/modules/jakarta.authorization-api.jar.

Arquillian JAR arquillian-junit-container Maven cordinates :

        <dependency>
            <groupId>org.jboss.arquillian</groupId>
            <artifactId>arquillian-bom</artifactId>
            <version>1.8.0.Final</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        <dependency>
            <groupId>org.jboss.arquillian.container</groupId>
            <artifactId>arquillian-container-test-api</artifactId>
            <version>1.8.0.Final</version>
        </dependency>
        
        <dependency>
            <groupId>org.jboss.arquillian.junit</groupId>
            <artifactId>arquillian-junit-container</artifactId>
            <scope>test</scope>
        </dependency>
        
        <dependency>
            <groupId>org.jboss.arquillian.protocol</groupId>
            <artifactId>arquillian-protocol-servlet</artifactId>
            <scope>test</scope>
        </dependency>

JUnit 4 jars (4.13.2) Maven cordinates :

       <dependency>
          <groupId>org.junit</groupId>
          <artifactId>junit-bom</artifactId>
          <version>4.13.2</version>
          <type>pom</type>
          <scope>import</scope>
       </dependency>

sigtest-maven-plugin (1.5) to run the signature tests. Maven cordinates :

       <dependency>
            <groupId>org.netbeans.tools</groupId>
            <artifactId>sigtest-maven-plugin</artifactId>
            <version>1.5</version>
       </dependency>

Eclipse Exousia 3.0 CI jars
For eg, if you are using the Eclipse Exousia 3.0 CI below jars need to be added to Classpath

${web.home}/modules/jakarta.servlet-api:
${web.home}/modules/jakarta.annotation-api.jar:

4.2 Configuring Your Environment to Run the TCK Against the Vendor Implementation (VI)

Follow the instructions above, customized as necessary for the Vendor implementation. A custom deployment handler will need to be created for the Vendor implementation.