add poms to run tests, reflect changes in the UG, remove obsolete content from the UG Signed-off-by: Lukas Jungmann <lukas.jungmann@oracle.com>
diff --git a/tck/pom.xml b/tck/pom.xml index 1f8a941..8cb2ea2 100644 --- a/tck/pom.xml +++ b/tck/pom.xml
@@ -27,9 +27,11 @@ </parent> <groupId>jakarta.json</groupId> - <artifactId>jakarta.json-tck-project</artifactId> + <artifactId>jakarta.json-tck</artifactId> <version>2.1.0-SNAPSHOT</version> <packaging>pom</packaging> + <name>Jakarta JSON Processing TCK</name> + <description>Jakarta JSON Processing TCK</description> <modules> <module>tck-common</module> @@ -39,9 +41,6 @@ <module>tck-dist</module> </modules> - <name>JSON-P TCK</name> - <description>Jakarta JSON-P TCK</description> - <licenses> <license> <name>Eclipse Public License 2.0</name> @@ -73,9 +72,24 @@ </dependency> <dependency> <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-tests</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-tests-pluggability</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>jakarta.json</groupId> <artifactId>jakarta.json-tck-ug</artifactId> <version>${project.version}</version> </dependency> + <dependency> + <groupId>org.netbeans.tools</groupId> + <artifactId>sigtest-maven-plugin</artifactId> + <version>1.4</version> + </dependency> <dependency> <groupId>jakarta.json</groupId>
diff --git a/tck/tck-common/pom.xml b/tck/tck-common/pom.xml index 49765c4..44b6b04 100644 --- a/tck/tck-common/pom.xml +++ b/tck/tck-common/pom.xml
@@ -21,7 +21,7 @@ <parent> <groupId>jakarta.json</groupId> - <artifactId>jakarta.json-tck-project</artifactId> + <artifactId>jakarta.json-tck</artifactId> <version>2.1.0-SNAPSHOT</version> <relativePath>../pom.xml</relativePath> </parent>
diff --git a/tck/tck-dist/pom.xml b/tck/tck-dist/pom.xml index c8d241b..f346290 100644 --- a/tck/tck-dist/pom.xml +++ b/tck/tck-dist/pom.xml
@@ -17,133 +17,134 @@ --> -<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> - <modelVersion>4.0.0</modelVersion> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> + <modelVersion>4.0.0</modelVersion> <parent> <groupId>jakarta.json</groupId> - <artifactId>jakarta.json-tck-project</artifactId> - <version>2.1.0-SNAPSHOT</version> - <relativePath>../pom.xml</relativePath> + <artifactId>jakarta.json-tck</artifactId> + <version>2.1.0-SNAPSHOT</version> + <relativePath>../pom.xml</relativePath> </parent> - <groupId>jakarta.json</groupId> - <artifactId>jakarta.json-tck</artifactId> - <packaging>pom</packaging> - <name>JSONP TCK Distribution</name> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-dist</artifactId> + <packaging>pom</packaging> + <name>JSONP TCK Distribution</name> - <dependencies> - <dependency> - <groupId>jakarta.json</groupId> - <artifactId>jakarta.json-tck-ug</artifactId> - <version>${project.version}</version> - <type>zip</type> - </dependency> - <dependency> - <groupId>jakarta.json</groupId> - <artifactId>jakarta.json-tck-project</artifactId> - <version>${project.version}</version> - <type>pom</type> - </dependency> - <dependency> - <groupId>jakarta.json</groupId> - <artifactId>jakarta.json-tck-common</artifactId> - <version>${project.version}</version> - <type>jar</type> - </dependency> - <dependency> - <groupId>jakarta.json</groupId> - <artifactId>jakarta.json-tck-common</artifactId> - <version>${project.version}</version> - <type>pom</type> - </dependency> - <dependency> - <groupId>jakarta.json</groupId> - <artifactId>jakarta.json-tck-common</artifactId> - <version>${project.version}</version> - <classifier>sources</classifier> - <optional>true</optional> - </dependency> - <dependency> - <groupId>jakarta.json</groupId> - <artifactId>jakarta.json-tck-tests</artifactId> - <version>${project.version}</version> - <type>jar</type> - </dependency> - <dependency> - <groupId>jakarta.json</groupId> - <artifactId>jakarta.json-tck-tests</artifactId> - <version>${project.version}</version> - <type>pom</type> - </dependency> - <dependency> - <groupId>jakarta.json</groupId> - <artifactId>jakarta.json-tck-tests</artifactId> - <version>${project.version}</version> - <classifier>sources</classifier> - <optional>true</optional> - </dependency> - <dependency> - <groupId>jakarta.json</groupId> - <artifactId>jakarta.json-tck-tests-pluggability</artifactId> - <version>${project.version}</version> - <type>jar</type> - </dependency> - <dependency> - <groupId>jakarta.json</groupId> - <artifactId>jakarta.json-tck-tests-pluggability</artifactId> - <version>${project.version}</version> - <type>pom</type> - </dependency> - <dependency> - <groupId>jakarta.json</groupId> - <artifactId>jakarta.json-tck-tests-pluggability</artifactId> - <version>${project.version}</version> - <classifier>sources</classifier> - <optional>true</optional> - </dependency> - </dependencies> + <dependencies> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-ug</artifactId> + <version>${project.version}</version> + <type>zip</type> + </dependency> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck</artifactId> + <version>${project.version}</version> + <type>pom</type> + </dependency> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-common</artifactId> + <version>${project.version}</version> + <type>jar</type> + </dependency> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-common</artifactId> + <version>${project.version}</version> + <type>pom</type> + </dependency> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-common</artifactId> + <version>${project.version}</version> + <classifier>sources</classifier> + <optional>true</optional> + </dependency> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-tests</artifactId> + <version>${project.version}</version> + <type>jar</type> + </dependency> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-tests</artifactId> + <version>${project.version}</version> + <type>pom</type> + </dependency> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-tests</artifactId> + <version>${project.version}</version> + <classifier>sources</classifier> + <optional>true</optional> + </dependency> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-tests-pluggability</artifactId> + <version>${project.version}</version> + <type>jar</type> + </dependency> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-tests-pluggability</artifactId> + <version>${project.version}</version> + <type>pom</type> + </dependency> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-tests-pluggability</artifactId> + <version>${project.version}</version> + <classifier>sources</classifier> + <optional>true</optional> + </dependency> + </dependencies> - <profiles> - <profile> - <id>EFTL</id> - <properties> - <license>EFTL</license> - <bundle-name>jakarta-jsonp-tck</bundle-name> - </properties> - </profile> - <profile> - <id>EPL</id> - <properties> - <license>EPL</license> - <bundle-name>jsonp-tck</bundle-name> - </properties> - <activation> - <activeByDefault>true</activeByDefault> - </activation> - </profile> - </profiles> + <profiles> + <profile> + <id>EFTL</id> + <properties> + <license>EFTL</license> + <bundle-name>jakarta-jsonp-tck</bundle-name> + </properties> + </profile> + <profile> + <id>EPL</id> + <properties> + <license>EPL</license> + <bundle-name>jsonp-tck</bundle-name> + </properties> + <activation> + <activeByDefault>true</activeByDefault> + </activation> + </profile> + </profiles> - <build> - <plugins> - <plugin> - <artifactId>maven-assembly-plugin</artifactId> - <executions> - <execution> - <id>distribution</id> - <phase>package</phase> - <goals> - <goal>single</goal> - </goals> - <configuration> - <descriptors> - <descriptor>src/main/assembly/assembly.xml</descriptor> - </descriptors> - <appendAssemblyId>false</appendAssemblyId> - <finalName>${bundle-name}-${project.version}</finalName> - </configuration> - </execution> - </executions> - </plugin> - </plugins> - </build> + <build> + <plugins> + <plugin> + <artifactId>maven-assembly-plugin</artifactId> + <executions> + <execution> + <id>distribution</id> + <phase>package</phase> + <goals> + <goal>single</goal> + </goals> + <configuration> + <descriptors> + <descriptor>src/main/assembly/assembly.xml</descriptor> + </descriptors> + <appendAssemblyId>false</appendAssemblyId> + <finalName>${bundle-name}-${project.version}</finalName> + </configuration> + </execution> + </executions> + </plugin> + </plugins> + </build> </project>
diff --git a/tck/tck-dist/src/main/assembly/assembly.xml b/tck/tck-dist/src/main/assembly/assembly.xml index 288e2dc..d0cd672 100644 --- a/tck/tck-dist/src/main/assembly/assembly.xml +++ b/tck/tck-dist/src/main/assembly/assembly.xml
@@ -41,11 +41,18 @@ <include>**/*.sh</include> </includes> </fileSet> + <fileSet> + <directory>${project.basedir}/src/main/bin</directory> + <outputDirectory>bin</outputDirectory> + <includes> + <include>**/*.xml</include> + </includes> + </fileSet> </fileSets> <dependencySets> <dependencySet> <includes> - <include>jakarta.json:jakarta.json-tck-project</include> + <include>jakarta.json:jakarta.json-tck</include> <include>jakarta.json:jakarta.json-tck-common</include> <include>jakarta.json:jakarta.json-tck-tests</include> <include>jakarta.json:jakarta.json-tck-tests-pluggability</include>
diff --git a/tck/tck-dist/src/main/bin/pom.xml b/tck/tck-dist/src/main/bin/pom.xml new file mode 100644 index 0000000..1c1cb30 --- /dev/null +++ b/tck/tck-dist/src/main/bin/pom.xml
@@ -0,0 +1,151 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + + Copyright (c) 2022 Oracle and/or its affiliates. All rights reserved. + + This program and the accompanying materials are made available under the + terms of the Eclipse Public License v. 2.0, which is available at + http://www.eclipse.org/legal/epl-2.0. + + This Source Code may also be made available under the following Secondary + Licenses when the conditions for such availability set forth in the + Eclipse Public License v. 2.0 are satisfied: GNU General Public License, + version 2 with the GNU Classpath Exception, which is available at + https://www.gnu.org/software/classpath/license.html. + + SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 + +--> +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + + <modelVersion>4.0.0</modelVersion> + + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-impl</artifactId> + <version>2.1.0-SNAPSHOT</version> + <packaging>pom</packaging> + + <properties> + <!-- Vendor Implementation (VI) --> + <jsonp-api.groupId>jakarta.json</jsonp-api.groupId> + <jsonp-api.artifactId>jakarta.json-api</jsonp-api.artifactId> + <jsonp-api.version>2.1.0</jsonp-api.version> + + <!-- Compatible Implementation (CI) --> + <jsonp-impl.groupId>org.eclipse.parsson</jsonp-impl.groupId> + <jsonp-impl.artifactId>parsson</jsonp-impl.artifactId> + <jsonp-impl.version>1.1.0</jsonp-impl.version> + + <!-- TCK --> + <jakarta.json-tck.version>2.1.0-SNAPSHOT</jakarta.json-tck.version> + + <!-- properties --> + <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> + <jimage.dir>${project.build.directory}/jdk-bundle</jimage.dir> + + <!-- !!! DO NOT EDIT !!! --> + <jakarta.json-api.version>2.1.0</jakarta.json-api.version> + <impl.alltests>true</impl.alltests> + </properties> + + <dependencyManagement> + <dependencies> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck</artifactId> + <version>${jakarta.json-tck.version}</version> + <type>pom</type> + <scope>import</scope> + </dependency> + </dependencies> + </dependencyManagement> + + <modules> + <module>tck-tests</module> + <module>tck-tests-pluggability</module> + </modules> + + <dependencies> + <dependency> + <groupId>${jsonp-api.groupId}</groupId> + <artifactId>${jsonp-api.artifactId}</artifactId> + <version>${jsonp-api.version}</version> + <scope>test</scope> + </dependency> + <dependency> + <groupId>${jsonp-impl.groupId}</groupId> + <artifactId>${jsonp-impl.artifactId}</artifactId> + <version>${jsonp-impl.version}</version> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.junit.jupiter</groupId> + <artifactId>junit-jupiter-api</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.junit.jupiter</groupId> + <artifactId>junit-jupiter-engine</artifactId> + <scope>test</scope> + </dependency> + </dependencies> + + <build> + <defaultGoal>verify</defaultGoal> + <pluginManagement> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-dependency-plugin</artifactId> + <version>3.2.0</version> + <configuration> + <artifactItems> + <artifactItem> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-api</artifactId> + <version>${jakarta.json-api.version}</version> + <type>jar</type> + <overWrite>true</overWrite> + <outputDirectory>${project.build.directory}/signaturedirectory</outputDirectory> + <destFileName>jakarta.json-api.jar</destFileName> + </artifactItem> + </artifactItems> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-surefire-plugin</artifactId> + <version>3.0.0-M5</version> + <configuration> + <trimStackTrace>false</trimStackTrace> + <failIfNoTests>${impl.alltests}</failIfNoTests> + <forkCount>1</forkCount> + <reuseForks>false</reuseForks> + <systemPropertyVariables> + <jimage.dir>${jimage.dir}</jimage.dir> + <signature.sigTestClasspath> + ${project.build.directory}/signaturedirectory/jakarta.json-api.jar:${jimage.dir}/java.base:${jimage.dir}/java.rmi:${jimage.dir}/java.sql:${jimage.dir}/java.naming + </signature.sigTestClasspath> + </systemPropertyVariables> + </configuration> + </plugin> + </plugins> + </pluginManagement> + </build> + + <profiles> + <profile> + <id>single-test</id> + <activation> + <property> + <name>test</name> + </property> + </activation> + <properties> + <impl.alltests>false</impl.alltests> + </properties> + </profile> + </profiles> +</project>
diff --git a/tck/tck-dist/src/main/bin/tck-tests-pluggability/pom.xml b/tck/tck-dist/src/main/bin/tck-tests-pluggability/pom.xml new file mode 100644 index 0000000..1b4dbac --- /dev/null +++ b/tck/tck-dist/src/main/bin/tck-tests-pluggability/pom.xml
@@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + + Copyright (c) 2022 Oracle and/or its affiliates. All rights reserved. + + This program and the accompanying materials are made available under the + terms of the Eclipse Public License v. 2.0, which is available at + http://www.eclipse.org/legal/epl-2.0. + + This Source Code may also be made available under the following Secondary + Licenses when the conditions for such availability set forth in the + Eclipse Public License v. 2.0 are satisfied: GNU General Public License, + version 2 with the GNU Classpath Exception, which is available at + https://www.gnu.org/software/classpath/license.html. + + SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 + +--> +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-impl</artifactId> + <version>2.1.0-SNAPSHOT</version> + <relativePath>../pom.xml</relativePath> + </parent> + + <artifactId>tck-tests-pluggability</artifactId> + + <dependencies> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-tests-pluggability</artifactId> + <scope>test</scope> + </dependency> + </dependencies> + + <build> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-surefire-plugin</artifactId> + <configuration> + <dependenciesToScan> + <dependency>jakarta.json:jakarta.json-tck-tests-pluggability</dependency> + </dependenciesToScan> + </configuration> + </plugin> + </plugins> + </build> +</project>
diff --git a/tck/tck-dist/src/main/bin/tck-tests/pom.xml b/tck/tck-dist/src/main/bin/tck-tests/pom.xml new file mode 100644 index 0000000..7f12335 --- /dev/null +++ b/tck/tck-dist/src/main/bin/tck-tests/pom.xml
@@ -0,0 +1,74 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + + Copyright (c) 2022 Oracle and/or its affiliates. All rights reserved. + + This program and the accompanying materials are made available under the + terms of the Eclipse Public License v. 2.0, which is available at + http://www.eclipse.org/legal/epl-2.0. + + This Source Code may also be made available under the following Secondary + Licenses when the conditions for such availability set forth in the + Eclipse Public License v. 2.0 are satisfied: GNU General Public License, + version 2 with the GNU Classpath Exception, which is available at + https://www.gnu.org/software/classpath/license.html. + + SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 + +--> +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-impl</artifactId> + <version>2.1.0-SNAPSHOT</version> + <relativePath>../pom.xml</relativePath> + </parent> + + <artifactId>tck-tests</artifactId> + + <dependencies> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-tests</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.netbeans.tools</groupId> + <artifactId>sigtest-maven-plugin</artifactId> + <scope>test</scope> + </dependency> + </dependencies> + + <build> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-dependency-plugin</artifactId> + <executions> + <execution> + <id>copy</id> + <phase>generate-test-sources</phase> + <goals> + <goal>copy</goal> + </goals> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-surefire-plugin</artifactId> + <configuration> + <dependenciesToScan> + <dependency>jakarta.json:jakarta.json-tck-tests</dependency> + </dependenciesToScan> + </configuration> + + </plugin> + </plugins> + </build> +</project>
diff --git a/tck/tck-dist/src/main/scripts/artifact-install.sh b/tck/tck-dist/src/main/scripts/artifact-install.sh index f735ccd..38c7327 100755 --- a/tck/tck-dist/src/main/scripts/artifact-install.sh +++ b/tck/tck-dist/src/main/scripts/artifact-install.sh
@@ -26,7 +26,7 @@ # Parent pom mvn org.apache.maven.plugins:maven-install-plugin:3.0.0-M1:install-file \ -Dfile=jakarta.json-tck-"$VERSION".pom -DgroupId=jakarta.json \ --DartifactId=jakarta.json-tck-project -Dversion="$VERSION" -Dpackaging=pom +-DartifactId=jakarta.json-tck -Dversion="$VERSION" -Dpackaging=pom # pom mvn org.apache.maven.plugins:maven-install-plugin:3.0.0-M1:install-file \
diff --git a/tck/tck-docs/userguide/pom.xml b/tck/tck-docs/userguide/pom.xml index d52dc4d..dba6a08 100644 --- a/tck/tck-docs/userguide/pom.xml +++ b/tck/tck-docs/userguide/pom.xml
@@ -21,7 +21,7 @@ <modelVersion>4.0.0</modelVersion> <parent> <groupId>jakarta.json</groupId> - <artifactId>jakarta.json-tck-project</artifactId> + <artifactId>jakarta.json-tck</artifactId> <version>2.1.0-SNAPSHOT</version> <relativePath>../../pom.xml</relativePath> </parent> @@ -102,7 +102,7 @@ </goals> <configuration> <chapterPatterns> - [0-9]+\s.*,Preface.*,Part\s.* + [A-C0-9]+\s.*,Preface.*,Part\s.* </chapterPatterns> </configuration> </execution>
diff --git a/tck/tck-docs/userguide/src/main/jbake/content/attributes.conf b/tck/tck-docs/userguide/src/main/jbake/content/attributes.conf index 42525ec..94a791d 100644 --- a/tck/tck-docs/userguide/src/main/jbake/content/attributes.conf +++ b/tck/tck-docs/userguide/src/main/jbake/content/attributes.conf
@@ -20,18 +20,17 @@ // // The environment variable used to specify the home directory // for the technology. Used in config.inc. -:TechnologyHomeEnv: JSONP_HOME +:TechnologyTCKHomeEnv: JSONPTCK_HOME // Java SE version required. :SEversion: 11+ :JakartaEEVersion: 10.0 :MavenVersion: 3.6.3+ :JunitVersion: 5.7.2+ -:jteFileName: <TS_HOME>/bin/ts.jte :excludeListFileName: tck-docs/TCK-Exclude-List.txt :TCKPackageName: jakarta-jsonp-tck-2.1.0.zip // Directory names used in examples in using.adoc. -:sigTestDirectoryExample: jakarta/jsonp/tck/signaturetest/jsonp -:singleTestDirectoryExample: jakarta/jsonp/tck/api/jsoncoding -:subsetTestDirectoryExample: jakarta/jsonp/tck/api/ +:sigTestExample: jakarta/jsonp/tck/signaturetest/jsonp/** +:singleTestExample: jakarta/jsonp/tck/api/jsoncoding/ClientTests +:subsetTestDirectoryExample: jakarta/jsonp/tck/api/** // Define this attribute (uncomment it) if the TCK needs the rebuild appendix. // :rebuild:
diff --git a/tck/tck-docs/userguide/src/main/jbake/content/config.adoc b/tck/tck-docs/userguide/src/main/jbake/content/config.adoc index b8bcfb0..f9241b7 100644 --- a/tck/tck-docs/userguide/src/main/jbake/content/config.adoc +++ b/tck/tck-docs/userguide/src/main/jbake/content/config.adoc
@@ -61,8 +61,7 @@ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ After configuring your environment as described in this section, -continue with the instructions in link:#GBFUY[Section 4.6, "Using the -JavaTest Harness Software."] +continue with the instructions in link:#GBFWO[Chapter 5, "Executing Tests."] [NOTE] @@ -86,52 +85,83 @@ 1. Set the following environment variables in your shell environment: a. `JAVA_HOME` to the directory in which Java SE {SEversion} is installed b. `M2_HOME` to the directory in which the Apache Maven build tool is installed. - c. +{TechnologyHomeEnv}+ to the directory in which the {TechnologyShortName} - {TechnologyVersion} CI has been installed + c. +{TechnologyTCKHomeEnv}+ to the directory in which the {TechnologyShortName} + {TechnologyVersion} TCK has been installed d. `PATH` to include the following directories: `JAVA_HOME/bin`, and `M2_HOME/bin` 2. Set the following System properties: - a. `jakarta.json.provider` property is set to run the {TechnologyShortName} TCK - pluggability tests to test the SPI provider interface. - This property should only be set when running the pluggability tests. All other tests use the - provider supplied with the {TechnologyShortName} {TechnologyVersion} implementation under test. - b. `jimage.dir` property is set to extract the Java SE {SEversion} modules for running the signature tests. + a. `jsonp-impl.groupId` property is set to the Maven Group Id of the CI to test. + b. `jsonp-impl.artifactId` property is set to the Maven Artifact Id of the CI to test. + c. `jsonp-impl.version` property is set to the Maven Version of the CI to test. + d. `jimage.dir` property is set to extract the Java SE {SEversion} modules for running the signature tests. 3. Set the below jars to the classpath a. JAR file for the {TechnologyShortName} {TechnologyVersion} API. + `jakarta.json-api.jar`. - c. JUnit 5 jars ({JunitVersion}) - Maven cordinates : + b. JUnit 5 jars ({JunitVersion}) + c. sigtest-maven-plugin (1.4) to run the signature tests. + d. {TechnologyShortName} TCK tests (`jakarta.json:jakarta.json-tck-tests`) +or {TechnologyShortName} TCK pluggability tests (`jakarta.json:jakarta.json-tck-tests-pluggability`) +depending on which test suite to run. + + -[source,oac_no_warn] +.Example: Maven configuration +[source,oac_no_warn,xml] ---- - <dependency> - <groupId>org.junit</groupId> - <artifactId>junit-bom</artifactId> - <version>5.7.2</version> - <type>pom</type> - <scope>import</scope> - </dependency> ----- -+ - d. sigtest-maven-plugin (1.4) to run the signature tests. - Maven cordinates : -+ -[source,oac_no_warn] ----- - <dependency> + <dependencyManagement> + <dependencies> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck</artifactId> + <version>2.1.0</version> + <type>pom</type> + <scope>import</scope> + </dependency> + </dependencies> + </dependencyManagement> + .... + <dependencies> + <dependency> + <groupId>org.eclipse.parsson</groupId> + <artifactId>parsson</artifactId> + <version>1.1.0</version> + <scope>test</scope> + </dependency> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-api</artifactId> + <version>2.1.0</version> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.junit.jupiter</groupId> + <artifactId>junit-jupiter-api</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.junit.jupiter</groupId> + <artifactId>junit-jupiter-engine</artifactId> + <scope>test</scope> + </dependency> + <dependency> <groupId>org.netbeans.tools</groupId> <artifactId>sigtest-maven-plugin</artifactId> - <version>1.4</version> + <scope>test</scope> </dependency> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-tests</artifactId> <!-- or jakarta.json-tck-tests-pluggability --> + <scope>test</scope> + </dependency> + </dependencies> ---- + [[GCLHU]][[configuring-your-environment-to-repackage-and-run-the-tck-against-the-vendor-implementation]] -4.2 Configuring Your Environment to Repackage and Run the TCK Against the Vendor Implementation -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +4.2 Configuring Your Environment to Run the TCK Against the Vendor Implementation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ After configuring your environment as described in this section, continue with the instructions in link:#GBFWO[Chapter 5, "Executing Tests."] @@ -160,32 +190,69 @@ 1. Set the following environment variables in your shell environment: a. `JAVA_HOME` to the directory in which Java SE {SEversion} is installed b. `M2_HOME` to the directory in which the Apache Maven build tool is installed. - c. +{TechnologyHomeEnv}+ to the directory in which the {TechnologyShortName} - {TechnologyVersion} CI has been installed + c. +{TechnologyTCKHomeEnv}+ to the directory in which the {TechnologyShortName} + {TechnologyVersion} TCK has been installed d. `PATH` to include the following directories: `JAVA_HOME/bin`, and `M2_HOME/bin` 2. Set the following System properties: - a. `jakarta.json.provider` property is set to run the {TechnologyShortName} TCK - pluggability tests to test the SPI provider interface. - This property should only be set when running the pluggability tests. All other tests use the - provider supplied with the {TechnologyShortName} {TechnologyVersion} implementation under test. - b. jimage.dir property is set to extract the JDK9+ modules for running the signature tests. + a. `jsonp-api.groupId` property is set to the Maven Group Id of the VI to test. + b. `jsonp-api.artifactId` property is set to the Maven Artifact Id of the VI to test. + c. `jsonp-api.version` property is set to the Maven Version of the VI to test. + d. `jimage.dir` property is set to extract the Java SE {SEversion} modules for running the signature tests. 3. Set the below jars to the classpath - a. JAR file for the {TechnologyShortName} {TechnologyVersion} API. + - `jakarta.json-api.jar`. - c. JUnit 5 jars (5.7.2+) - Maven cordinates : + a. JAR file for the {TechnologyShortName} {TechnologyVersion} CI. + + `parsson.jar`. + b. JUnit 5 jars ({JunitVersion}) + c. sigtest-maven-plugin (1.4) to run the signature tests. + d. {TechnologyShortName} TCK tests (`jakarta.json:jakarta.json-tck-tests`) +or {TechnologyShortName} TCK pluggability tests (`jakarta.json:jakarta.json-tck-tests-pluggability`) +depending on which test suite to run. + + -[source,oac_no_warn] +.Example: Maven configuration +[source,oac_no_warn,xml] ---- - <dependency> - <groupId>org.junit</groupId> - <artifactId>junit-bom</artifactId> - <version>5.7.2</version> - <type>pom</type> - <scope>import</scope> - </dependency> + <dependencyManagement> + <dependencies> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck</artifactId> + <version>2.1.0</version> + <type>pom</type> + <scope>import</scope> + </dependency> + </dependencies> + </dependencyManagement> + .... + <dependencies> + <dependency> + <groupId>org.eclipse.parsson</groupId> + <artifactId>parsson</artifactId> + <version>1.1.0</version> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.junit.jupiter</groupId> + <artifactId>junit-jupiter-api</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.junit.jupiter</groupId> + <artifactId>junit-jupiter-engine</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.netbeans.tools</groupId> + <artifactId>sigtest-maven-plugin</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>jakarta.json</groupId> + <artifactId>jakarta.json-tck-tests</artifactId> <!-- or jakarta.json-tck-tests-pluggability --> + <scope>test</scope> + </dependency> + </dependencies> ---- +
diff --git a/tck/tck-docs/userguide/src/main/jbake/content/debug.adoc b/tck/tck-docs/userguide/src/main/jbake/content/debug.adoc index 04e1d2b..4a20ed0 100644 --- a/tck/tck-docs/userguide/src/main/jbake/content/debug.adoc +++ b/tck/tck-docs/userguide/src/main/jbake/content/debug.adoc
@@ -17,16 +17,10 @@ There are a number of reasons that tests can fail to execute properly. This chapter provides some approaches for dealing with these failures. -Please note that most of these suggestions are only relevant when -running the test harness in GUI mode. This chapter includes the following topics: * link:#GBFYP[Overview] -* link:#GBFVF[Test Tree] -* link:#GBFWI[Folder Information] -* link:#GBFVP[Test Information] -* link:#GBFVZ[Report Files] * link:#GBFYF[Configuration Failures] [[GBFYP]][[overview]]
diff --git a/tck/tck-docs/userguide/src/main/jbake/content/intro.adoc b/tck/tck-docs/userguide/src/main/jbake/content/intro.adoc index bc2ad0e..5c5e954 100644 --- a/tck/tck-docs/userguide/src/main/jbake/content/intro.adoc +++ b/tck/tck-docs/userguide/src/main/jbake/content/intro.adoc
@@ -295,11 +295,15 @@ guide. 1. Make sure that the following software has been correctly installed -on the system hosting the JavaTest harness: +on the system: ++ +-- include::req-software.inc[] * Java SE {SEversion} * A CI for {TechnologyShortName} {TechnologyVersion}. One example is {TechnologyRI}. * The {TechnologyShortName} {TechnologyVersion} Vendor Implementation (VI) + +* Any Jupiter API compatible test runner +-- See the documentation for each of these software applications for installation instructions. See link:install.html#GBFTP[Chapter 3, "Installation,"] for instructions on installing the {TechnologyShortName} TCK.
diff --git a/tck/tck-docs/userguide/src/main/jbake/content/toc.adoc b/tck/tck-docs/userguide/src/main/jbake/content/toc.adoc index 178975c..c9457ef 100644 --- a/tck/tck-docs/userguide/src/main/jbake/content/toc.adoc +++ b/tck/tck-docs/userguide/src/main/jbake/content/toc.adoc
@@ -63,7 +63,7 @@ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ** link:config.html#GBFVU[4.1 Configuring Your Environment to Run the TCK Against the Compatible Implementation] -** link:config.html#GCLHU[4.2 Configuring Your Environment to Repackage and Run the TCK Against the Vendor Implementation] +** link:config.html#GCLHU[4.2 Configuring Your Environment to Run the TCK Against the Vendor Implementation] ** link:config.html#GHGDG[4.3 Publishing the Test Applications] [[executing-tests]] @@ -71,9 +71,11 @@ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ** link:using.html#GBFUZ[5.1 Starting the tests] -*** link:using.html#GBFVW[5.1.1 To Start JavaTest in Command-Line Mode] +*** link:using.html#GBFVW[5.1.1 To Run All Tests] ** link:using.html#GBFWM[5.2 Running a Subset of the Tests] -*** link:using.html#GBFWK[5.2.1 To Run a Subset of Tests in Command-Line Mode] +*** link:using.html#GBFWK[5.2.1 To Run a Single Test] +*** link:using.html#GCMCA[5.2.2 To Run a Subset of Tests] +*** link:using.html#GCMCU[5.2.3 To Run Signature Tests] ** link:using.html#GCLRR[5.3 Running the TCK Against another CI] ** link:using.html#GCLRZ[5.4 Running the TCK Against a Vendor's Implementation] ** link:using.html#GBFVK[5.5 Test Reports] @@ -84,7 +86,11 @@ ** link:debug.html#GBFYP[6.1 Overview] ** link:debug.html#GBFYF[6.2 Configuration Failures] -* link:faq.html#GBFYD[A Frequently Asked Questions] + +[[a-frequently-asked-questions]] +link:faq.html#GBFYD[A Frequently Asked Questions] +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + ** link:faq.html#GBFYQ[A.1 Where do I start to debug a test failure?] ** link:faq.html#GBFYR[A.2 How do I restart a crashed test run?] ** link:faq.html#GBFWU[A.3 What would cause tests be added to the exclude list?]
diff --git a/tck/tck-docs/userguide/src/main/jbake/content/using-examples.inc b/tck/tck-docs/userguide/src/main/jbake/content/using-examples.inc deleted file mode 100644 index 9837b8a..0000000 --- a/tck/tck-docs/userguide/src/main/jbake/content/using-examples.inc +++ /dev/null
@@ -1,50 +0,0 @@ -/////////////////////////////////////////////////////////////////////// -NOTE TO WRITERS: -These CLI examples can be customized as necessary. -/////////////////////////////////////////////////////////////////////// - -1. Change to any subdirectory under `<TS_HOME>/src/com/sun/ts/tests`. -2. Start JavaTest using the following command: -+ --- -[source,oac_no_warn] ----- -ant runclient ----- --- - -[[GCMCU]] - -Example 5-1 {TechnologyShortName} TCK Signature Tests - -To run the {TechnologyShortName} TCK signature tests, enter the -following commands: - -[source,subs="attributes"] ----- -mvn verify -Dit.test=jakarta.jsonp.tck.signaturetest.** ----- - -[[GCMBV]] - - -Example 5-2 Single Test Directory - -To run a single test directory, enter the following commands: - -[source,subs="attributes"] ----- -mvn verify -Dit.test={singleTestDirectoryExample}.** ----- - -[[GCMCA]] - - -Example 5-3 Subset of Test Directories - -To run a subset of test directories, enter the following commands: - -[source,subs="attributes"] ----- -mvn verify -Dit.test={subsetTestDirectoryExample}.** -----
diff --git a/tck/tck-docs/userguide/src/main/jbake/content/using.adoc b/tck/tck-docs/userguide/src/main/jbake/content/using.adoc index 80fbfed..cda1ac6 100644 --- a/tck/tck-docs/userguide/src/main/jbake/content/using.adoc +++ b/tck/tck-docs/userguide/src/main/jbake/content/using.adoc
@@ -20,7 +20,7 @@ This chapter includes the following topics: -* link:#GBFUZ[Starting the tests] +* link:#GBFUZ[Running All Tests] * link:#GBFWM[Running a Subset of the Tests] * link:#GCLRR[Running the TCK Against your selected CI] * link:#GCLRZ[Running the TCK Against a Vendor's Implementation] @@ -52,7 +52,7 @@ ~~~~~~~~~~~~~~~~~~~~~~ The {TechnologyShortName} TCK can be run from the command line -in your shell environment by executing the TCK jar. +in your shell environment by executing tests from the TCK jar. [NOTE] @@ -67,10 +67,16 @@ [[GBFVW]][[to-start-javatest-in-command-line-mode]] -5.1.1 To Start JavaTest in Command-Line Mode -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +5.1.1 To Run All Tests +^^^^^^^^^^^^^^^^^^^^^^ -include::using-examples.inc[] +To run all tests, enter the following command: + +[source,subs="attributes"] +---- +cd ${TechnologyTCKHomeEnv}/bin +mvn verify +---- [[GBFWM]][[running-a-subset-of-the-tests]] @@ -79,22 +85,50 @@ Use the following modes to run a subset of the tests: -* link:#GBFWK[Section 5.2.1, "To Run a Subset of Tests in Command-Line Mode"] +* link:#GBFWK[Section 5.2.1, "To Run a Single Test"] +* link:#GCMCA[Section 5.2.2, "To Run a Subset of Tests"] +* link:#GCMCU[Section 5.2.3, "To Run Signature Tests"] -[[GBFWK]][[to-run-a-subset-of-tests-in-command-line-mode]] +[[GBFWK]][[to-run-a-single-test]] -5.2.1 To Run a Subset of Tests in Command-Line Mode -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +5.2.1 To Run a Single Test +^^^^^^^^^^^^^^^^^^^^^^^^^^ -Start the test run by executing the following command: + +To run a single test, enter the following command: [source,subs="attributes"] ---- -mvn verify -Dit.test={subsetTestDirectoryExample}.** +cd ${TechnologyTCKHomeEnv}/bin +mvn verify -Dtest={singleTestExample} ---- -The tests in the directory and its subdirectories are run. +[[GCMCA]][[to-run-a-subset-of-tests]] + +5.2.2 To Run a Subset of Tests +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To run a subset of tests, enter the following command: + +[source,subs="attributes"] +---- +cd ${TechnologyTCKHomeEnv}/bin +mvn verify -Dtest={subsetTestDirectoryExample} +---- + +[[GCMCU]][[to-run-signature-tests]] + +5.2.3 To Run Signature Tests +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To run the {TechnologyShortName} TCK Signature Tests, enter the +following command: + +[source,subs="attributes"] +---- +cd ${TechnologyTCKHomeEnv}/bin +mvn verify -Dtest={sigTestExample} +---- [[GCLRR]][[running-the-tck-against-the-ri]] @@ -111,9 +145,16 @@ link:config.html#GBFVU[Section 4.1, "Configuring Your Environment to Run the TCK Against the Compatible Implementation."] 2. Run the tests, as described in link:#GBFUZ[Section 5.1, "Starting -the tests,"] and, if desired, link:#GBFWM[Section 5.2, "Running a Subset +the Tests"], and, if desired, link:#GBFWM[Section 5.2, "Running a Subset of the Tests."] +.Example: +[source,subs="attributes"] +---- +cd ${TechnologyTCKHomeEnv}/bin +mvn verify -Djsonp-impl.groupId=org.eclipse.parsson -Djsonp-impl.artifactId=parsson -Djsonp-impl.version=1.1.0 +---- + [[GCLRZ]][[running-the-tck-against-a-vendors-implementation]] 5.4 Running the TCK Against a Vendor's Implementation @@ -124,11 +165,18 @@ 1. Verify that you have followed the configuration instructions in link:config.html#GCLHU[Section 4.2, "Configuring Your Environment to -Repackage and Run the TCK Against the Vendor Implementation."] +Run the TCK Against the Vendor Implementation."] 2. Run the tests, as described in link:#GBFUZ[Section 5.1, "Starting -JavaTest,"] and, if desired, link:#GBFWM[Section 5.2, "Running a Subset +the Tests"], and, if desired, link:#GBFWM[Section 5.2, "Running a Subset of the Tests."] +.Example: +[source,subs="attributes"] +---- +cd ${TechnologyTCKHomeEnv}/bin +mvn verify -Djsonp-api.groupId=jakarta.json -Djsonp-api.artifactId=jakarta.json-api -Djsonp-api.version=2.1.0 +---- + [[GBFVK]][[test-reports]] 5.5 Test Reports
diff --git a/tck/tck-tests-pluggability/pom.xml b/tck/tck-tests-pluggability/pom.xml index 2ed0a79..890c5e3 100644 --- a/tck/tck-tests-pluggability/pom.xml +++ b/tck/tck-tests-pluggability/pom.xml
@@ -21,7 +21,7 @@ <parent> <groupId>jakarta.json</groupId> - <artifactId>jakarta.json-tck-project</artifactId> + <artifactId>jakarta.json-tck</artifactId> <version>2.1.0-SNAPSHOT</version> <relativePath>../pom.xml</relativePath> </parent> @@ -33,7 +33,6 @@ <dependency> <groupId>jakarta.json</groupId> <artifactId>jakarta.json-tck-common</artifactId> - <scope>provided</scope> </dependency> </dependencies>
diff --git a/tck/tck-tests/pom.xml b/tck/tck-tests/pom.xml index e35bb61..ace6600 100644 --- a/tck/tck-tests/pom.xml +++ b/tck/tck-tests/pom.xml
@@ -21,7 +21,7 @@ <parent> <groupId>jakarta.json</groupId> - <artifactId>jakarta.json-tck-project</artifactId> + <artifactId>jakarta.json-tck</artifactId> <version>2.1.0-SNAPSHOT</version> <relativePath>../pom.xml</relativePath> </parent> @@ -34,7 +34,6 @@ <dependency> <groupId>jakarta.json</groupId> <artifactId>jakarta.json-tck-common</artifactId> - <scope>provided</scope> </dependency> </dependencies>