Skip to content

Commit

Permalink
Update for Persistence 3.1 and 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 Dec 10, 2021
1 parent af669cb commit bc35cbb
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 65 deletions.
10 changes: 5 additions & 5 deletions user_guides/jpa/src/main/jbake/assets/_config.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
remote_theme: jakartaee/jekyll-theme-jakarta-ee

title: [tck_jpa_v3_0]
description: [Jakarta EE Persistence API Technology Compatibility Kit User's Guide, Release 3.0]
title: [tck_jpa_v3_1]
description: [Jakarta EE Persistence API Technology Compatibility Kit User's Guide, Release 3.1]

# sidebar links url
links:
source: https://github.com/eclipse-ee4j/jakartaee-tck
download: https://jakarta.ee/specifications/persistence/3.0/
download: https://jakarta.ee/specifications/persistence/3.1/
#mailinglist: https://javaee.groups.io/g/tck_jpa_v2_2
javadocs: https://jakarta.ee/specifications/persistence/3.0/
docs: https://jakarta.ee/specifications/persistence/3.0/
javadocs: https://jakarta.ee/specifications/persistence/3.1/
docs: https://jakarta.ee/specifications/persistence/3.1/
#faq:

14 changes: 7 additions & 7 deletions user_guides/jpa/src/main/jbake/content/attributes.conf
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
:TechnologyFullName: Jakarta Persistence
:TechnologyShortName: Persistence
:LegacyAcronym: JPA
:ReleaseDate: May 2021
:ReleaseDate: December 2021
:CopyrightDates: 2017, 2021
:TechnologyVersion: 3.0
:TechnologyRI: EclipseLink 3.0
:TechnologyVersion: 3.1
:TechnologyRI: EclipseLink 3.1
:TechnologyRIURL: https://projects.eclipse.org/projects/ee4j.eclipselink
:SpecificationURL: https://jakarta.ee/specifications/persistence/3.0/
:SpecificationURL: https://jakarta.ee/specifications/persistence/3.1/
:TCKInquiryList: mailto:jakartaee-tck-dev@eclipse.org[jakartaee-tck-dev@eclipse.org]
:SpecificationInquiryList: mailto:jpa-dev@eclipse.org[jpa-dev@eclipse.org]
:techID: Persistence
Expand All @@ -22,13 +22,13 @@
// for the technology. Used in config.inc.
:TechnologyHomeEnv: ECLIPSELINK_HOME
// Java SE version required.
:SEversion: 8 (1.8) or 11
:SEversion: 11 or 17
:AntVersion: 1.10.0+
:JakartaEEVersion: 9.1
:JakartaEEVersion: 10
:JavaTestVersion: 5.0
:jteFileName: <TS_HOME>/bin/ts.jte
:jtxFileName: <TS_HOME>/bin/ts.jtx
:TCKPackageName: jakarta-persistence-tck-3.0.1.zip
:TCKPackageName: jakarta-persistence-tck-3.1.0.zip
// Directory names used in examples in using.adoc.
:sigTestDirectoryExample: <TS_HOME>/src/com/sun/ts/tests/signaturetest/jpa
:singleTestDirectoryExample: <TS_HOME>/src/com/sun/ts/tests/jpa/core
Expand Down
16 changes: 1 addition & 15 deletions user_guides/jpa/src/main/jbake/content/intro.inc
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,7 @@ instead of the one provided by the implementation.

The following may be useful to users of previous TCK versions:

In the legacy Java EE {LegacyAcronym} (2.0) TCK, the tests were located in the
`src/com/sun/ts/tests/ejb30/persistence` directory. In the Java EE {LegacyAcronym} 2.1 TCK and
{TechnologyFullName} {TechnologyVersion} TCK, the tests have been reorganized and are now in a new
location: `src/com/sun/ts/tests/jpa`.

The TCKs for Jakarta {LegacyAcronym} 3.0 and higher follows the organization of legacy Java EE {LegacyAcronym} 2.1 TCK.

In the Java EE {LegacyAcronym} (2.0) TCK, the pluggability tests required special setup in
order to be run. This is no longer the case; the Java EE {LegacyAcronym} 2.1 and {TechnologyFullName} {TechnologyVersion} TCK
now executes the pluggability tests along with all the other {TechnologyShortName} TCK
tests without any special setup. The pluggability tests have also been
rewritten to use a stubbed-out {TechnologyShortName} implementation, which is located in
the `src/com/sun/ts/jpa/common/pluggibility/altprovider` directory.

The TCKs for Jakarta {LegacyAcronym} 3.0 and higher also follow the same simplified setup.
No significant changes were made to how tests are run.

=======================================================================

52 changes: 14 additions & 38 deletions user_guides/jpa/src/main/jbake/content/rules.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -207,38 +207,16 @@ include::defns.inc[]
2.2.2 Rules for {TechnologyFullName} Products
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The following rules apply for each version of an operating system,
software component, and hardware platform Documented as supporting the
Product:

*{techID}1* The Product must be able to satisfy all applicable compatibility
requirements, including passing all Conformance Tests, in every Product
Configuration and in every combination of Product Configurations, except
only as specifically exempted by these Rules.

For example, if a Product provides distinct Operating Modes to optimize
performance, then that Product must satisfy all applicable compatibility
requirements for a Product in each Product Configuration, and
combination of Product Configurations, of those Operating Modes.

*{techID}1.1* If an Operating Mode controls a Resource necessary for the
basic execution of the Test Suite, testing may always use a Product
Configuration of that Operating Mode providing that Resource, even if
other Product Configurations do not provide that Resource.
Notwithstanding such exceptions, each Product must have at least one set
of Product Configurations of such Operating Modes that is able to pass
all the Conformance Tests.

For example, a Product with an Operating Mode that controls a security
policy (i.e., Security Resource) which has one or more Product
Configurations that cause Conformance Tests to fail may be tested using
a Product Configuration that allows all Conformance Tests to pass.

*{techID}1.2* A Product Configuration of an Operating Mode that causes the
Product to report only version, usage, or diagnostic information is
exempted from these compatibility rules.

*{techID}1.3* An API Definition Product is exempt from all functional
The following rules apply for each implementation:

*{techID}1* The implementation must be able to satisfy compatibility
requirements, including passing all required TCK Tests.

*{techID}1.1* Each implementation must have at least one configuration that can be used to pass
all required TCK Tests, although such configuration may need adjustment (e.g. whether statically
or via administrative tooling).

*{techID}1.2* An API Definition Product is exempt from all functional
testing requirements defined here, except the signature tests.

*{techID}2* Some Conformance Tests may have properties that may be changed.
Expand Down Expand Up @@ -267,11 +245,6 @@ that are not part of the Product but required for the Product to satisfy
the compatibility requirements, must be Documented and available to
users of the Product.

For example, if a patch to a particular version of a supporting
operating system is required for the Product to pass the Conformance
Tests, that patch must be Documented and available to users of the
Product.

*{techID}7* The Product must contain the full set of public and protected
classes and interfaces for all the Libraries. Those classes and
interfaces must contain exactly the set of public and protected methods,
Expand All @@ -280,7 +253,7 @@ Libraries. No subsetting, supersetting, or modifications of the public
and protected API of the Libraries are allowed except only as
specifically exempted by these Rules.

*{techID}7.1* If a Product includes Technologies in addition to the
*{techID}7.1* If a Product includes Jakarta EE Technologies in addition to the
Technology Under Test, then it must contain the full set of combined
public and protected classes and interfaces. The API of the Product
must contain the union of the included Technologies. No further
Expand All @@ -306,6 +279,9 @@ include::rules.inc[]
2.3 Test Appeals Process
~~~~~~~~~~~~~~~~~~~~~~~~

Refer to https://jakarta.ee/committees/specification/tckprocess as the definitive source for
the TCK rules.

Jakarta has a well established process for managing challenges to its
TCKs. Any implementor may submit a challenge to one or more tests in the
{TechnologyShortName} TCK as it relates to their implementation. Implementor
Expand Down

0 comments on commit bc35cbb

Please sign in to comment.