Installation

## 3 Installation

This chapter explains how to install the Jakarta Persistence 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.

### 3.1 Obtaining a Compatible Implementation

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

### 3.2 Installing the Software

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

- Java SE 11 or 17

- Apache Ant 1.10.0+

- A CI for Persistence 3.1, one example is EclipseLink 3.1

- Persistence TCK version 3.1, which includes:

  - JDOM 1.1.3

  - Apache Commons HTTP Client 3.1

  - Apache Commons Logging 1.1.3

  - Apache Commons Codec 1.9

- The Persistence 3.1 Vendor Implementation (VI)

Follow these steps:

1. Install the Java SE 11 or 17 software, if it is not already installed.
   Download and install the Java SE 11 or 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 Apache Ant 1.10.0+ software, if it is not already installed.
   Download and install Apache Ant 1.10.0+ software from Apache Ant Project. For complete information about Ant, refer to the extensive documentation on the Apache Ant Project site. The Apache Ant Manual is available at `http://ant.apache.org/manual/index.html`. Apache Ant is protected under the Apache Software, License 2.0, which is is available on the Apache Ant Project license page at `http://ant.apache.org/license.html`.

3. Install the Persistence TCK 3.1 software.

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

   2. Use the `unzip` command to extract the bundle in the directory of your choice:
      `unzip jakarta-persistence-tck-3.1.0.zip`
      This creates the TCK directory. The TCK is the test suite home, `<TS_HOME>`.

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

5. Install the Persistence VI to be tested.
   Follow the installation instructions for the particular VI under test.

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