Skip to content

Commit

Permalink
first pass through user guide changes for Jakarta EE 10
Browse files Browse the repository at this point in the history
Signed-off-by: Scott Marlow <smarlow@redhat.com>
  • Loading branch information
scottmarlow committed May 19, 2022
1 parent eb58a29 commit 2473546
Show file tree
Hide file tree
Showing 18 changed files with 438 additions and 518 deletions.
4 changes: 2 additions & 2 deletions user_guides/jakartaee/pom.xml
Expand Up @@ -27,8 +27,8 @@
<groupId>org.glassfish</groupId>
<artifactId>cts_javaee</artifactId>
<packaging>pom</packaging>
<version>9.1.0</version>
<name>Eclipse Foundation Jakarta EE Platform, Enterprise Edition Test Compatibility Kit User's Guide, Release 9.1</name>
<version>10.0.0</version>
<name>Eclipse Foundation Jakarta EE Platform, Enterprise Edition Test Compatibility Kit User's Guide, Release 10.0</name>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
Expand Down
22 changes: 11 additions & 11 deletions user_guides/jakartaee/src/main/jbake/content/TCKpreface.adoc
Expand Up @@ -28,16 +28,16 @@ Please see the Title page for additional license information.
========================================================================

This book introduces the Test Compatibility Kit (TCK) for the Jakarta
Platform, Enterprise Edition 9.1 (Jakarta EE 9.1) and Jakarta Platform, Enterprise
Edition 9.1 Web Profile (Jakarta EE 9.1 Web Profile), and explains how to
Platform, Enterprise Edition 10 (Jakarta EE 10) and Jakarta Platform, Enterprise
Edition 10 Web Profile (Jakarta EE 10 Web Profile), and explains how to
configure and run the test suite. It also provides information for
troubleshooting problems you may encounter as you run the test suite.

The Jakarta Platform, Enterprise Edition 9.1 Test Compatibility Kit (Jakarta
EE 9.1 TCK) is a portable, configurable automated test suite for verifying
the compatibility of an implementer's compliance with the Jakarta EE 9.1
The Jakarta Platform, Enterprise Edition 10 Test Compatibility Kit (Jakarta
EE 10 TCK) is a portable, configurable automated test suite for verifying
the compatibility of an implementer's compliance with the Jakarta EE 10
Specification (hereafter referred to as the implementer's implementation, or VI).
The Jakarta EE 9.1 Platform TCK uses the JavaTest harness version 5.0 to run the
The Jakarta EE 10 Platform TCK uses the JavaTest harness version 5.0 to run the
test suite.


Expand All @@ -56,9 +56,9 @@ of this guide.
Who Should Use This Book
~~~~~~~~~~~~~~~~~~~~~~~~

This guide is for developers of the Jakarta EE 9.1 technology to assist them
This guide is for developers of the Jakarta EE 10 technology to assist them
in running the test suite that verifies compatibility of their
implementation of the Jakarta EE 9.1 Specification.
implementation of the Jakarta EE 10 Specification.


[[GJFXS]][[before-you-read-this-book]]
Expand All @@ -67,13 +67,13 @@ Before You Read This Book
~~~~~~~~~~~~~~~~~~~~~~~~~

Before reading this guide, you should familiarize yourself with the Java
programming language, the Jakarta Platform, Enterprise Edition 9.1 (Jakarta EE
programming language, the Jakarta Platform, Enterprise Edition 10 (Jakarta EE
9) Specification, and the JavaTest documentation.

The Jakarta Platform, Enterprise Edition 9.1 (Jakarta EE 9.1) Specification can be
The Jakarta Platform, Enterprise Edition 10 (Jakarta EE 10) Specification can be
downloaded from `https://projects.eclipse.org/projects/ee4j.jakartaee-platform`.

For documentation on the test harness used for running the Jakarta EE 9.1 Platform TCK
For documentation on the test harness used for running the Jakarta EE 10 Platform TCK
test suite, see
`https://wiki.openjdk.java.net/display/CodeTools/Documentation`.

Expand Down
16 changes: 8 additions & 8 deletions user_guides/jakartaee/src/main/jbake/content/building.adoc
Expand Up @@ -44,7 +44,7 @@ the Solaris platform:

1. Set the following environment variables in your shell environment to
use the build infrastructure that comes with the TCK:
* `TS_HOME` to the directory in which the Jakarta EE 9.1 Platform TCK software is
* `TS_HOME` to the directory in which the Jakarta EE 10 Platform TCK software is
installed.
* `TS_HOME/bin` to your `PATH` in your command shell.
* C Shell: +
Expand Down Expand Up @@ -79,7 +79,7 @@ build infrastructure
10.2 Building the Tests
~~~~~~~~~~~~~~~~~~~~~~~

To build the Jakarta EE 9.1 Platform TCK tests using Ant, complete the following
To build the Jakarta EE 10 Platform TCK tests using Ant, complete the following
steps:

1. To build a single test directory, type the following: +
Expand Down Expand Up @@ -118,7 +118,7 @@ ant pc
10.3 Running the Tests
~~~~~~~~~~~~~~~~~~~~~~

To run the Jakarta EE 9.1 Platform TCK tests using Ant, use one of the following
To run the Jakarta EE 10 Platform TCK tests using Ant, use one of the following
procedures.

[[GFAOW]][[to-run-a-single-test-directory]]
Expand Down Expand Up @@ -223,20 +223,20 @@ HelloHome.class
10.5 Debugging Service Tests
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The Jakarta EE 9.1 Platform TCK service tests test the compatibility of the Jakarta
The Jakarta EE 10 Platform TCK service tests test the compatibility of the Jakarta
Platform, Enterprise Edition Service APIs: Jakarta Mail, JDBC, Jakarta Messaging, Jakarta Transactions,
Jakarta XML Web Services, Jakarta Web Services Metadata, Jakarta Annotations. The test suite contains sets of
tests that the JavaTest harness, in conjunction with the Jakarta EE 9.1 Platform TCK
tests that the JavaTest harness, in conjunction with the Jakarta EE 10 Platform TCK
harness extensions, runs from different Jakarta Platform, Enterprise
Edition containers (Jakarta Enterprise Beans, Jakarta Server Pages, Jakarta Servlet, and application
client). The test suite wraps each of these tests inside generic
components, called vehicles. Each Jakarta EE 9.1 Platform TCK service test has been
components, called vehicles. Each Jakarta EE 10 Platform TCK service test has been
set up to run in a default set of vehicles. Each technology's
specification determines this set. When run as part of the certification
process, all service API tests must pass in their default vehicle set.

Refer to the `<TS_HOME>/src/vehicle.properties` file to for a list the
default vehicle sets for the Jakarta EE 9.1 Platform TCK service API tests.
default vehicle sets for the Jakarta EE 10 Platform TCK service API tests.

To help you debug service API tests, the test suite provides a mechanism
that allows for fine-grained control over which tests you can run in
Expand Down Expand Up @@ -278,7 +278,7 @@ the Ant `gui` or `runclient` targets:
Before you run the test or tests, you should temporarily rename the file
`<TS_HOME>/src/testsuite.jtd`.

Note that you must remove these properties before you run the Jakarta EE 9.1
Note that you must remove these properties before you run the Jakarta EE 10
TCK test suite for certification.

[[GFARW]][[obtaining-additional-debugging-information]]
Expand Down

0 comments on commit 2473546

Please sign in to comment.