Installation

## 3 Installation

This chapter explains how to install the Jakarta Servlet 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 Servlet 6.1 TCK is not depended on any particular build tool, it is convenient to install Apache Maven 3.8.5+ 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. Tomcat 11.0 is a compatible implementation which may be obtained from https://tomcat.apache.org/download-11.cgi

### 3.2 Installing the Software

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

- Jakarta EE 11 CI (for example Tomcat 11.0, from https://tomcat.apache.org/download-11.cgi) or, at a minimum, a Web server with a Servlet container

- Java SE 17

- A CI for Servlet 6.1, one example is Tomcat 11.0

- Servlet TCK version 6.1

- The Servlet 6.1 Vendor Implementation (VI)

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

Follow these steps:

1. Install the Java SE 17 software, if it is not already installed.
   Download and install the Java SE 17 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.8.5+ for running the tests. The test kit is not depended on Maven, any build tool compatible with Jupiter API is suffitient.

3. Install the Servlet TCK 6.1 software.

   1. Copy or download the Servlet TCK software to your local system.
      You can obtain the Servlet TCK software from the Jakarta EE site https://jakarta.ee/specifications/servlet/6.1/.

   2. Use the `unzip` command to extract the bundle in the directory of your choice:
      `unzip jakarta-servlet-tck-6.1.0.zip`

4. Install the Jakarta EE 11 CI software, for example Tomcat 11.0 (which hosts the servlet Web container used for running the Servlet TCK with the Servlet 6.1 CI), if it is not already installed.

5. Download and install the Servlet Web container with the Servlet 6.1 CI used for running the Servlet TCK 6.1. For example you could use Tomcat 11.0. This software may be obtained from https://tomcat.apache.org/download-11.cgi.

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

7. Install a Web server on which the Servlet TCK test applications can be published for testing the VI.

8. Install the Servlet 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.