Skip to content

Commit 29a2568

Browse files
VerdentVerdent
authored
userguide and tck dist eftl bundle tuning (#322)
Signed-off-by: David Kral <david.k.kral@oracle.com>
1 parent ad73dd3 commit 29a2568

File tree

5 files changed

+245
-48
lines changed

5 files changed

+245
-48
lines changed

‎tck-dist/pom.xml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,15 @@
6666
<properties>
6767
<license>EFTL</license>
6868
<bundle-name>jakarta-jsonb-tck</bundle-name>
69+
<assembly-descriptor>src/main/assembly/assembly-eftl.xml</assembly-descriptor>
6970
</properties>
7071
</profile>
7172
<profile>
7273
<id>EPL</id>
7374
<properties>
7475
<license>EPL</license>
7576
<bundle-name>jsonb-tck</bundle-name>
77+
<assembly-descriptor>src/main/assembly/assembly.xml</assembly-descriptor>
7678
</properties>
7779
<activation>
7880
<activeByDefault>true</activeByDefault>
@@ -83,7 +85,9 @@
8385
<build>
8486
<plugins>
8587
<plugin>
88+
<groupId>org.apache.maven.plugins</groupId>
8689
<artifactId>maven-assembly-plugin</artifactId>
90+
<version>3.3.0</version>
8791
<executions>
8892
<execution>
8993
<id>distribution</id>
@@ -93,8 +97,9 @@
9397
</goals>
9498
<configuration>
9599
<descriptors>
96-
<descriptor>src/main/assembly/assembly.xml</descriptor>
100+
<descriptor>${assembly-descriptor}</descriptor>
97101
</descriptors>
102+
<escapeString>\</escapeString>
98103
<appendAssemblyId>false</appendAssemblyId>
99104
<finalName>${bundle-name}-${project.version}</finalName>
100105
</configuration>

‎tck-dist/src/main/assembly/assembly-eftl.xml

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
4+
Copyright (c) 2022 Oracle and/or its affiliates. All rights reserved.
5+
6+
This program and the accompanying materials are made available under the
7+
terms of the Eclipse Public License v. 2.0, which is available at
8+
http://www.eclipse.org/legal/epl-2.0.
9+
10+
This Source Code may also be made available under the following Secondary
11+
Licenses when the conditions for such availability set forth in the
12+
Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
13+
version 2 with the GNU Classpath Exception, which is available at
14+
https://www.gnu.org/software/classpath/license.html.
15+
16+
SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
17+
18+
-->
19+
20+
<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
21+
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd">
22+
<id>distribution</id>
23+
<baseDirectory>jsonb-tck</baseDirectory>
24+
<formats>
25+
<format>zip</format>
26+
</formats>
27+
28+
<files>
29+
<!-- license -->
30+
<file>
31+
<source>${project.basedir}/src/main/resources/LICENSE_${license}.md</source>
32+
<destName>LICENSE.md</destName>
33+
</file>
34+
</files>
35+
<fileSets>
36+
<fileSet>
37+
<directory>${project.build.scriptSourceDirectory}</directory>
38+
<outputDirectory>artifacts</outputDirectory>
39+
<fileMode>755</fileMode>
40+
<includes>
41+
<include>**/*.sh</include>
42+
</includes>
43+
</fileSet>
44+
<fileSet>
45+
<directory>${project.basedir}/src/main/bin</directory>
46+
<outputDirectory>bin</outputDirectory>
47+
<includes>
48+
<include>**/*.xml</include>
49+
</includes>
50+
<filtered>true</filtered>
51+
</fileSet>
52+
</fileSets>
53+
<dependencySets>
54+
<dependencySet>
55+
<includes>
56+
<include>jakarta.json.bind:jakarta.json.bind-tck</include>
57+
</includes>
58+
<useTransitiveDependencies>true</useTransitiveDependencies>
59+
<outputDirectory>artifacts</outputDirectory>
60+
<useProjectArtifact>false</useProjectArtifact>
61+
</dependencySet>
62+
<dependencySet>
63+
<includes>
64+
<include>jakarta.json.bind:jakarta.json.bind-tck-ug</include>
65+
</includes>
66+
<unpack>true</unpack>
67+
<outputDirectory>.</outputDirectory>
68+
</dependencySet>
69+
</dependencySets>
70+
71+
</assembly>

‎tck-dist/src/main/bin/pom.xml

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
4+
Copyright (c) 2022 Oracle and/or its affiliates. All rights reserved.
5+
6+
This program and the accompanying materials are made available under the
7+
terms of the Eclipse Public License v. 2.0, which is available at
8+
http://www.eclipse.org/legal/epl-2.0.
9+
10+
This Source Code may also be made available under the following Secondary
11+
Licenses when the conditions for such availability set forth in the
12+
Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
13+
version 2 with the GNU Classpath Exception, which is available at
14+
https://www.gnu.org/software/classpath/license.html.
15+
16+
SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
17+
18+
-->
19+
<project xmlns="http://maven.apache.org/POM/4.0.0"
20+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
21+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
22+
23+
<modelVersion>4.0.0</modelVersion>
24+
25+
<parent>
26+
<groupId>org.eclipse.ee4j</groupId>
27+
<artifactId>project</artifactId>
28+
<version>1.0.7</version>
29+
<relativePath/>
30+
</parent>
31+
32+
<groupId>jakarta.json.bind</groupId>
33+
<artifactId>jakarta.json.bind-tck-tests</artifactId>
34+
<version>${project.version}</version>
35+
36+
<properties>
37+
<!-- Vendor Implementation (VI) -->
38+
<jsonb-api.groupId>jakarta.json.bind</jsonb-api.groupId>
39+
<jsonb-api.artifactId>jakarta.json.bind-api</jsonb-api.artifactId>
40+
<jsonb-api.version>3.0.0</jsonb-api.version>
41+
42+
<!-- Compatible Implementation (CI) -->
43+
<jsonb-impl.groupId>org.eclipse</jsonb-impl.groupId>
44+
<jsonb-impl.artifactId>yasson</jsonb-impl.artifactId>
45+
<jsonb-impl.version>3.0.0-RC1</jsonb-impl.version>
46+
47+
<!-- TCK -->
48+
<jsonb.tck.version>${project.version}</jsonb.tck.version>
49+
50+
<!-- properties -->
51+
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
52+
<jimage.dir>\${project.build.directory}/jdk-bundle</jimage.dir>
53+
54+
<!-- !!! DO NOT EDIT !!! -->
55+
<jakarta.jsonb-api.version>3.0.0</jakarta.jsonb-api.version>
56+
<jakarta.json-api.version>2.1.0</jakarta.json-api.version>
57+
</properties>
58+
59+
60+
<dependencies>
61+
<dependency>
62+
<groupId>jakarta.json.bind</groupId>
63+
<artifactId>jakarta.json.bind-tck</artifactId>
64+
<version>\${jsonb.tck.version}</version>
65+
<scope>test</scope>
66+
</dependency>
67+
<dependency>
68+
<groupId>\${jsonb-api.groupId}</groupId>
69+
<artifactId>\${jsonb-api.artifactId}</artifactId>
70+
<version>\${jsonb-api.version}</version>
71+
<scope>test</scope>
72+
</dependency>
73+
<dependency>
74+
<groupId>\${jsonb-impl.groupId}</groupId>
75+
<artifactId>\${jsonb-impl.artifactId}</artifactId>
76+
<version>\${jsonb-impl.version}</version>
77+
<scope>test</scope>
78+
</dependency>
79+
<dependency>
80+
<groupId>org.jboss.weld.se</groupId>
81+
<artifactId>weld-se-core</artifactId>
82+
<version>5.0.0.Beta1</version>
83+
<scope>test</scope>
84+
</dependency>
85+
</dependencies>
86+
87+
<build>
88+
<defaultGoal>verify</defaultGoal>
89+
<plugins>
90+
<plugin>
91+
<groupId>org.apache.maven.plugins</groupId>
92+
<artifactId>maven-dependency-plugin</artifactId>
93+
<version>3.2.0</version>
94+
<executions>
95+
<execution>
96+
<id>copy</id>
97+
<phase>generate-test-sources</phase>
98+
<goals>
99+
<goal>copy</goal>
100+
</goals>
101+
<configuration>
102+
<artifactItems>
103+
<artifactItem>
104+
<groupId>jakarta.json.bind</groupId>
105+
<artifactId>jakarta.json.bind-api</artifactId>
106+
<version>\${jakarta.jsonb-api.version}</version>
107+
<type>jar</type>
108+
<overWrite>true</overWrite>
109+
<outputDirectory>\${project.build.directory}/signaturedirectory</outputDirectory>
110+
<destFileName>jakarta.json.bind-api.jar</destFileName>
111+
</artifactItem>
112+
<artifactItem>
113+
<groupId>jakarta.json</groupId>
114+
<artifactId>jakarta.json-api</artifactId>
115+
<version>\${jakarta.json-api.version}</version>
116+
<type>jar</type>
117+
<overWrite>true</overWrite>
118+
<outputDirectory>\${project.build.directory}/signaturedirectory</outputDirectory>
119+
<destFileName>jakarta.json-api.jar</destFileName>
120+
</artifactItem>
121+
</artifactItems>
122+
</configuration>
123+
</execution>
124+
</executions>
125+
</plugin>
126+
<plugin>
127+
<artifactId>maven-surefire-plugin</artifactId>
128+
<version>3.0.0-M5</version>
129+
<configuration>
130+
<trimStackTrace>false</trimStackTrace>
131+
<failIfNoTests>true</failIfNoTests>
132+
<dependenciesToScan>jakarta.json.bind:jakarta.json.bind-tck</dependenciesToScan>
133+
<systemPropertyVariables>
134+
<jimage.dir>\${jimage.dir}</jimage.dir>
135+
<signature.sigTestClasspath>\${project.build.directory}/signaturedirectory/jakarta.json.bind-api.jar:\${jimage.dir}/java.base:\${jimage.dir}/java.rmi:\${jimage.dir}/java.sql:\${jimage.dir}/java.naming</signature.sigTestClasspath>
136+
</systemPropertyVariables>
137+
</configuration>
138+
</plugin>
139+
<plugin>
140+
<artifactId>maven-surefire-report-plugin</artifactId>
141+
<version>3.0.0-M4</version>
142+
<executions>
143+
<execution>
144+
<id>post-unit-test</id>
145+
<phase>test</phase>
146+
<goals>
147+
<goal>report</goal>
148+
</goals>
149+
</execution>
150+
</executions>
151+
</plugin>
152+
</plugins>
153+
</build>
154+
</project>

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

Lines changed: 10 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,15 @@ slashes as a path separator instead.
5050
b. `sigTestClasspath` This property must be set when running signature tests.
5151
This property should be set to a list of jar files and/or directories which contain your
5252
Jakarta EE and Java SE classes. Paths must be separated by the appropriate path separator (';' windows, ':' Unixes).
53+
c. `jsonb-impl.groupId` property is set to the Maven Group Id of the CI to test.
54+
d. `jsonb-impl.artifactId` property is set to the Maven Artifact Id of the CI to test.
55+
e. `jsonb-impl.version` property is set to the Maven Version of the CI to test.
5356

5457
3. Set the below jars to the classpath
5558
a. JAR file for the {TechnologyShortName} {TechnologyVersion} CI. +
5659
`jakarta.json.bind-api.jar`.
5760
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`)
61+
c. {TechnologyShortName} TCK tests (`jakarta.json.bind:jakarta.json.bind-tck`)
6062

6163
+
6264
.Example: Maven configuration
@@ -84,7 +86,7 @@ slashes as a path separator instead.
8486
<dependency>
8587
<groupId>org.jboss.weld.se</groupId>
8688
<artifactId>weld-se-core</artifactId>
87-
<version>4.0.2.Final</version>
89+
<version>5.0.0.Beta1</version>
8890
<scope>test</scope>
8991
</dependency>
9092
<dependency>
@@ -93,26 +95,6 @@ slashes as a path separator instead.
9395
<scope>test</scope>
9496
</dependency>
9597
</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>
11698
----
11799
+
118100

@@ -157,13 +139,15 @@ slashes as a path separator instead.
157139
b. `sigTestClasspath` This property must be set when running signature tests.
158140
This property should be set to a list of jar files and/or directories which contain your
159141
Java EE and Java SE classes. Paths must be separated by the appropriate path separator (';' windows, ':' Unixes).
142+
c. `jsonb-api.groupId` property is set to the Maven Group Id of the VI to test.
143+
d. `jsonb-api.artifactId` property is set to the Maven Artifact Id of the VI to test.
144+
e. `jsonb-api.version` property is set to the Maven Version of the VI to test.
160145

161146
3. Set the below jars to the classpath
162147
a. JAR file for the {TechnologyShortName} {TechnologyVersion} VI. +
163148
`yasson.jar`.
164149
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`)
150+
c. {TechnologyShortName} TCK tests (`jakarta.json.bind:jakarta.json.bind-tck`)
167151

168152
+
169153
.Example: Maven configuration
@@ -191,7 +175,7 @@ slashes as a path separator instead.
191175
<dependency>
192176
<groupId>org.jboss.weld.se</groupId>
193177
<artifactId>weld-se-core</artifactId>
194-
<version>4.0.2.Final</version>
178+
<version>5.0.0.Beta1</version>
195179
<scope>test</scope>
196180
</dependency>
197181
<dependency>
@@ -200,27 +184,6 @@ slashes as a path separator instead.
200184
<scope>test</scope>
201185
</dependency>
202186
</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-
224187
----
225188
+
226189

0 commit comments

Comments
 (0)