Installation

## 3 Installation

This chapter explains how to install the Jakarta RESTful Web Services TCK software.

After installing the software according to the instructions in this chapter, proceed to Chapter 4, "Setup and Configuration," for instructions on configuring your test environment.

Note | Although the Jakarta REST 3.1 TCK is not depended on any particular build tool, it is convenient to install Apache Maven 3.6.3+ for setup and execution of tests. Any other build tools like Gradle and JUnit 5 Console Runner can also be used that is Jupiter API compatible.

### 3.1 Obtaining a Compatible Implementation

Each compatible implementation (CI) will provide instructions for obtaining their implementation. Eclipse Jersey 3.1 is a compatible implementation which may be obtained from https://projects.eclipse.org/projects/ee4j.jersey

### 3.2 Installing the Software

Before you can run the Jakarta REST TCK tests, you must install and set up the following software components:

- Jakarta EE 10 CI such as Eclipse GlassFish 6.1 or, at a minimum, a Web server with a Servlet container

- Java SE 11

- A CI for Jakarta REST 3.1, one example is Eclipse Jersey 3.1

- Jakarta REST TCK version 3.1

- The Jakarta REST 3.1 Vendor Implementation (VI)

- Any Jupiter API compatible test runner (eg. Apache Maven 3.6.3+)

Follow these steps:

1. Install the Java SE 11 software, if it is not already installed.
   Download and install the Java SE 11 software from http://www.oracle.com/technetwork/java/javase/downloads/index.html. Refer to the installation instructions that accompany the software for additional information.

2. Install the build tool that will be used to run the TCK, if it is not already installed.
   It will be convenient to use Apache Maven 3.6.3+ for running the tests. The test kit is not depended on Maven, any build tool compatible with Jupiter API is suffitient.

3. Install the Jakarta REST TCK 3.1 software.

   1. Copy or download the Jakarta REST TCK software to your local system.
      You can obtain the Jakarta REST TCK software from the Jakarta EE site https://jakarta.ee/specifications/restful-ws/3.1/.

   2. Use the `unzip` command to extract the bundle in the directory of your choice:
      `unzip jakarta-restful-ws-tck-x.y.z.zip`

4. Install the Jakarta EE 10 CI software (the servlet Web container used for running the Jakarta REST TCK with the Jakarta REST 3.1 CI), if it is not already installed.
   Download and install the Servlet Web container with the Jakarta REST 3.1 CI used for running the Jakarta REST TCK 3.1, represented by the Jakarta EE 10 CI. You may obtain a copy of this CI by downloading it from https://projects.eclipse.org/projects/ee4j.jersey.

5. Install a Jakarta REST 3.1 Compatible Implementation.
   A Compatible Implementation is used to validate your initial configuration and setup of the Jakarta REST TCK 3.1 tests, which are explained further in Chapter 4, "Setup and Configuration."
   The Compatible Implementations for Jakarta REST are listed on the Jakarta EE Specifications web site: https://jakarta.ee/specifications/restful-ws/3.1/.

6. Install a Web server on which the Jakarta REST TCK test applications can be published for testing the VI.

7. Install the Jakarta REST VI to be tested.
   Follow the installation instructions for the particular VI under test.

Copyright © 2017, 2021 Oracle and/or its affiliates. All rights reserved.