Skip to content

Commit ad73dd3

Browse files
VerdentVerdent
authored
Userguide updates (#321)
* User guide updates * JSONP API version bump Signed-off-by: David Kral <david.k.kral@oracle.com>
1 parent c1d3b77 commit ad73dd3

File tree

13 files changed

+225
-1797
lines changed

13 files changed

+225
-1797
lines changed

‎.github/workflows/maven.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ jobs:
4242
~/.m2
4343
key: build-${{ env.cache-name }}
4444
- name: API compilation
45-
run: cd api && mvn clean install
45+
run: cd api && mvn clean install -Pstaging
4646
- name: TCK test compilation
47-
run: cd tck && mvn clean install
47+
run: cd tck && mvn clean install -Pstaging
4848
- name: Javadoc compilation
49-
run: cd docs && mvn clean install
49+
run: cd docs && mvn clean install -Pstaging
5050
- name: Generating specification
51-
run: cd spec && mvn clean install
51+
run: cd spec && mvn clean install -Pstaging

‎api/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@
9090
<non.final>false</non.final>
9191
<skip.release.tests>false</skip.release.tests>
9292
<spec.version>3.0</spec.version>
93-
<jakarta.json.version>2.0.1</jakarta.json.version>
93+
<jakarta.json.version>2.1.0</jakarta.json.version>
9494
<!-- The version of JSON-B API to compare against to verify we follow semantic versioning rules -->
9595
<baseline.compare.version>2.0.0</baseline.compare.version>
9696
<api_package>jakarta.json.bind</api_package>

‎tck-docs/JSONB3.0-ReleaseNotes.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
1818
-->
1919

20-
<html><head><title>Jakarta JSON Binding TCK, Version 3.0 Release Notes, December 2021</title>
20+
<html><head><title>Jakarta JSON Binding TCK, Version 3.0 Release Notes, March 2022</title>
2121

2222
<style type="text/css">
2323
<!--

‎tck-docs/assertions/JSONB10JavadocAssertions.html

Lines changed: 0 additions & 847 deletions
This file was deleted.

‎tck-docs/assertions/JSONB10SpecAssertions.html

Lines changed: 0 additions & 910 deletions
This file was deleted.

‎tck-docs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ <h2>Guide to JSON-B TCK 3.0 Documentation</h2>
4848
<ul>
4949
<li><p>The <cite><a href="JSONB3.0-ReleaseNotes.html">JSON-B Release Notes</a></cite> provide the information that you need to install, set up, and run the JSON-B TCK, Version 3.0. The Release Notes are located in the TCK product bundle.</p></li>
5050
<li><p>The <cite>JSON-B 3.0 Technology Compatibility Kit User's Guide</cite> provides the information that you need to install, set up, and run the JSON-B TCK as well as the rules you must comply with for certification.</p></li>
51-
<li><p>The <a href="assertions/JSONB10JavadocAssertions.html">Javadoc Assertion List</a> lists all the javadoc assertions that are tested by the JSON-B TCK.</p></li>
52-
<li><p>The <a href="assertions/JSONB10SpecAssertions.html">Specification Assertion List</a> lists all the specification assertions that are tested by the JSON-B TCK.</p></li>
51+
<li><p>The <a href="assertions/JSONBJavadocAssertions.html">Javadoc Assertion List</a> lists all the javadoc assertions that are tested by the JSON-B TCK.</p></li>
52+
<li><p>The <a href="assertions/JSONBSpecAssertions.html">Specification Assertion List</a> lists all the specification assertions that are tested by the JSON-B TCK.</p></li>
5353
</ul>
5454
<hr>
5555
<p><cite><small><address>Copyright (c) 2017, 2022 Oracle and/or its affiliates. All rights reserved.</address></small><cite></p>

‎tck-docs/userguide/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<parent>
2323
<groupId>org.eclipse.ee4j</groupId>
2424
<artifactId>project</artifactId>
25-
<version>1.0.5</version>
25+
<version>1.0.7</version>
2626
</parent>
2727
<groupId>jakarta.json.bind</groupId>
2828
<artifactId>jakarta.json.bind-tck-ug</artifactId>
@@ -101,7 +101,7 @@
101101
</goals>
102102
<configuration>
103103
<chapterPatterns>
104-
[0-9]+\s.*,Preface.*,Part\s.*
104+
[A-C0-9]+\s.*,Preface.*,Part\s.*
105105
</chapterPatterns>
106106
</configuration>
107107
</execution>

‎tck-docs/userguide/src/main/jbake/content/attributes.conf

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,15 @@
2424
// Java SE version required.
2525
:SEversion: 11+
2626
:MavenVersion: 3.6.3+
27+
:JunitVersion: 5.7.2+
2728
:JakartaEEVersion: 10
2829
:excludeListFileName: TCK-Exclude-List.txt
2930
:TCKPackageName: jakarta-jsonb-tck-3.0.0.zip
3031
// Directory names used in examples in using.adoc.
31-
:sigTestDirectoryExample: jakarta.json.bind.tck.signaturetest.jsonb
32-
:singleTestDirectoryExample: jakarta.json.bind.tck.api.annotation
33-
:subsetTestDirectoryExample: jakarta.json.bind.tck.api
32+
:sigTestDirectoryExample: ee.jakarta.tck.json.bind.signaturetest.jsonb
33+
:singleTestDirectoryExample: ee.jakarta.tck.json.bind.api.annotation
34+
:subsetTestDirectoryExample: ee.jakarta.tck.json.bind.api
35+
:singleTestExample: ee.jakarta.tck.json.bind.api.jsonb.JsonbTest
36+
:sigTestExample: ee.jakarta.tck.json.bind.signaturetest.jsonb.JSONBSigTest
3437
// Define this attribute (uncomment it) if the TCK needs the rebuild appendix.
3538
// :rebuild:

‎tck-docs/userguide/src/main/jbake/content/config.inc

Lines changed: 148 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,81 @@ slashes as a path separator instead.
4444
d. `PATH` to include the following directories: `JAVA_HOME/bin`,
4545
and `M2_HOME/bin`
4646

47-
[[GCLHU]][[configuring-your-environment-to-repackage-and-run-the-tck-against-the-vendor-implementation]]
48-
49-
4.2 Configuring Your Environment to Repackage and Run the TCK Against the Vendor Implementation
47+
2. Set below Maven/System properties
48+
a. `jimage.dir` This property specifies the directory where Java 11+ modules will be expanded by the
49+
jimage tool for use in sigTestClasspath
50+
b. `sigTestClasspath` This property must be set when running signature tests.
51+
This property should be set to a list of jar files and/or directories which contain your
52+
Jakarta EE and Java SE classes. Paths must be separated by the appropriate path separator (';' windows, ':' Unixes).
53+
54+
3. Set the below jars to the classpath
55+
a. JAR file for the {TechnologyShortName} {TechnologyVersion} CI. +
56+
`jakarta.json.bind-api.jar`.
57+
b. JUnit 5 jars ({JunitVersion})
58+
c. sigtest-maven-plugin (1.4) to run the signature tests.
59+
d. {TechnologyShortName} TCK tests (`jakarta.json.bind:jakarta.json.bind-tck`)
60+
61+
+
62+
.Example: Maven configuration
63+
[source,oac_no_warn,xml]
64+
----
65+
<dependencies>
66+
<dependency>
67+
<groupId>CI.group.id</groupId>
68+
<artifactId>CI.artifact.id</artifactId>
69+
<version>CI.version</version>
70+
<scope>test</scope>
71+
</dependency>
72+
<dependency>
73+
<groupId>jakarta.json.bind</groupId>
74+
<artifactId>jakarta.json.bind-api</artifactId>
75+
<version>3.0.0</version>
76+
<scope>test</scope>
77+
</dependency>
78+
<dependency>
79+
<groupId>jakarta.json</groupId>
80+
<artifactId>jakarta.json-api</artifactId>
81+
<version>2.1.0</version>
82+
<scope>provided</scope>
83+
</dependency>
84+
<dependency>
85+
<groupId>org.jboss.weld.se</groupId>
86+
<artifactId>weld-se-core</artifactId>
87+
<version>4.0.2.Final</version>
88+
<scope>test</scope>
89+
</dependency>
90+
<dependency>
91+
<groupId>jakarta.json.bind</groupId>
92+
<artifactId>jakarta.json.bind-tck</artifactId>
93+
<scope>test</scope>
94+
</dependency>
95+
</dependencies>
96+
----
97+
<plugins>
98+
<plugin>
99+
<artifactId>maven-surefire-plugin</artifactId>
100+
<version>3.0.0-M5</version>
101+
<configuration>
102+
<trimStackTrace>false</trimStackTrace>
103+
<failIfNoTests>true</failIfNoTests>
104+
<dependenciesToScan>jakarta.json.bind:jakarta.json.bind-tck</dependenciesToScan>
105+
<systemPropertyVariables>
106+
<!-- Needed for signature tests to pass -->
107+
<jimage.dir>${project.build.directory}/jdk-bundles</jimage.dir>
108+
<signature.sigTestClasspath>
109+
${project.build.directory}/signaturedirectory/jakarta.json.bind-api.jar:
110+
${jimage.dir}/java.base:${jimage.dir}/java.rmi:${jimage.dir}/java.sql:${jimage.dir}/java.naming
111+
</signature.sigTestClasspath>
112+
</systemPropertyVariables>
113+
</configuration>
114+
</plugin>
115+
</plugins>
116+
----
117+
+
118+
119+
[[GCLHU]][[configuring-your-environment-run-the-tck-against-the-vendor-implementation]]
120+
121+
4.2 Configuring Your Environment to Run the TCK Against the Vendor Implementation
50122
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
51123

52124
After configuring your environment as described in this section,
@@ -72,13 +144,85 @@ slashes as a path separator instead.
72144

73145

74146
1. Set the following environment variables in your shell environment:
75-
a. `JAVA_HOME` to the directory in which Java SE 8 or Java SE 11 is installed
147+
a. `JAVA_HOME` to the directory in which Java SE {SEversion} is installed
76148
b. `M2_HOME` to the directory in which the Apache Maven build tool is installed.
77149
c. +{TechnologyHomeEnv}+ to the directory in which the {TechnologyShortName}
78150
{TechnologyVersion} CI has been installed
79151
d. `PATH` to include the following directories: `JAVA_HOME/bin`,
80152
and `M2_HOME/bin`
81153

154+
2. Set below Maven/System properties
155+
a. `jimage.dir` This property specifies the directory where Java 11+ modules will be expanded by the
156+
jimage tool for use in sigTestClasspath
157+
b. `sigTestClasspath` This property must be set when running signature tests.
158+
This property should be set to a list of jar files and/or directories which contain your
159+
Java EE and Java SE classes. Paths must be separated by the appropriate path separator (';' windows, ':' Unixes).
160+
161+
3. Set the below jars to the classpath
162+
a. JAR file for the {TechnologyShortName} {TechnologyVersion} VI. +
163+
`yasson.jar`.
164+
b. JUnit 5 jars ({JunitVersion})
165+
c. sigtest-maven-plugin (1.4) to run the signature tests.
166+
d. {TechnologyShortName} TCK tests (`jakarta.json.bind:jakarta.json.bind-tck`)
167+
168+
+
169+
.Example: Maven configuration
170+
[source,oac_no_warn,xml]
171+
----
172+
<dependencies>
173+
<dependency>
174+
<groupId>VI.grou.id</groupId>
175+
<artifactId>VI.artefact.id</artifactId>
176+
<version>VI.version</version>
177+
<scope>test</scope>
178+
</dependency>
179+
<dependency>
180+
<groupId>org.eclipse</groupId>
181+
<artifactId>yasson</artifactId>
182+
<version>3.0.0-R1</version>
183+
<scope>test</scope>
184+
</dependency>
185+
<dependency>
186+
<groupId>jakarta.json</groupId>
187+
<artifactId>jakarta.json-api</artifactId>
188+
<version>2.1.0</version>
189+
<scope>test</scope>
190+
</dependency>
191+
<dependency>
192+
<groupId>org.jboss.weld.se</groupId>
193+
<artifactId>weld-se-core</artifactId>
194+
<version>4.0.2.Final</version>
195+
<scope>test</scope>
196+
</dependency>
197+
<dependency>
198+
<groupId>jakarta.json.bind</groupId>
199+
<artifactId>jakarta.json.bind-tck</artifactId>
200+
<scope>test</scope>
201+
</dependency>
202+
</dependencies>
203+
----
204+
<plugins>
205+
<plugin>
206+
<artifactId>maven-surefire-plugin</artifactId>
207+
<version>3.0.0-M5</version>
208+
<configuration>
209+
<trimStackTrace>false</trimStackTrace>
210+
<failIfNoTests>true</failIfNoTests>
211+
<dependenciesToScan>jakarta.json.bind:jakarta.json.bind-tck</dependenciesToScan>
212+
<systemPropertyVariables>
213+
<!-- Needed for signature tests to pass -->
214+
<jimage.dir>${project.build.directory}/jdk-bundles</jimage.dir>
215+
<signature.sigTestClasspath>
216+
${project.build.directory}/signaturedirectory/jakarta.json.bind-api.jar:
217+
${jimage.dir}/java.base:${jimage.dir}/java.rmi:${jimage.dir}/java.sql:${jimage.dir}/java.naming
218+
</signature.sigTestClasspath>
219+
</systemPropertyVariables>
220+
</configuration>
221+
</plugin>
222+
</plugins>
223+
224+
----
225+
+
82226

83227
[[GHGDG]][[publishing-the-test-applications]]
84228

‎tck-docs/userguide/src/main/jbake/content/intro.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,13 +290,17 @@ steps are explained in more detail in subsequent chapters of this
290290
guide.
291291

292292
1. Make sure that the following software has been correctly installed
293-
on the system hosting the JavaTest harness:
293+
on the system:
294+
+
295+
--
294296
include::req-software.inc[]
295297
* Java SE {SEversion}
296298
* A CI for {TechnologyShortName} {TechnologyVersion}. One example is {TechnologyRI}.
297299
* {TechnologyShortName} TCK version {TechnologyVersion}, which includes:
298300
include::tck-packages.inc[]
299301
* The {TechnologyShortName} {TechnologyVersion} Vendor Implementation (VI) +
302+
* Any Jupiter API compatible test runner
303+
--
300304
See the documentation for each of these software applications for
301305
installation instructions. See link:install.html#GBFTP[Chapter 3,
302306
"Installation,"] for instructions on installing the {TechnologyShortName} TCK.

0 commit comments

Comments
 (0)