From c54d5438604c4fc516779704747ee6ebc215fa10 Mon Sep 17 00:00:00 2001 From: Alwin Joseph <44426046+alwin-joseph@users.noreply.github.com> Date: Fri, 23 Feb 2024 00:55:47 +0530 Subject: [PATCH] Sample TCK runner with Glassfish moved to bundle and Userguide changes (#131) --- tck/docs/CAJ3.0-ReleaseNotes.html | 4 +- tck/docs/TCK-Exclude-List.txt | 2 +- tck/docs/index.html | 2 +- {tck-runner => tck/docs/tck-runner}/README | 9 +- {tck-runner => tck/docs/tck-runner}/pom.xml | 1 - tck/docs/userguide/pom.xml | 6 +- .../src/main/jbake/content/attributes.conf | 18 +- .../src/main/jbake/content/config.adoc | 326 +----------------- .../src/main/jbake/content/config.inc | 59 ++-- .../src/main/jbake/content/debug.adoc | 124 +------ .../userguide/src/main/jbake/content/faq.adoc | 16 +- .../src/main/jbake/content/install.adoc | 21 +- .../src/main/jbake/content/intro.adoc | 78 +---- .../src/main/jbake/content/platforms.inc | 2 +- .../src/main/jbake/content/preface.adoc | 7 +- .../src/main/jbake/content/tck-packages.inc | 7 - .../src/main/jbake/content/using-examples.inc | 16 +- .../src/main/jbake/content/using.adoc | 235 ++----------- tck/src/main/assembly/assembly.xml | 6 +- .../signaturetest}/CAJSigTestIT.java | 4 +- .../signaturetest}/PackageList.java | 2 +- .../annotations/signaturetest}/SigTest.java | 2 +- .../signaturetest}/SigTestData.java | 2 +- .../signaturetest}/SigTestDriver.java | 2 +- .../signaturetest}/SigTestResult.java | 2 +- .../signaturetest}/SignatureTestDriver.java | 2 +- .../SignatureTestDriverFactory.java | 2 +- .../signaturetest}/jakarta.annotation.sig_3.0 | 0 .../signaturetest}/sig-test-pkg-list.txt | 0 .../annotations/signaturetest}/sig-test.map | 0 30 files changed, 167 insertions(+), 790 deletions(-) rename {tck-runner => tck/docs/tck-runner}/README (69%) rename {tck-runner => tck/docs/tck-runner}/pom.xml (99%) rename tck/src/main/java/{com/sun/ts/tests/annotations => ee/jakarta/tck/annotations/signaturetest}/CAJSigTestIT.java (99%) rename tck/src/main/java/{com/sun/ts/tests/annotations => ee/jakarta/tck/annotations/signaturetest}/PackageList.java (99%) rename tck/src/main/java/{com/sun/ts/tests/annotations => ee/jakarta/tck/annotations/signaturetest}/SigTest.java (99%) rename tck/src/main/java/{com/sun/ts/tests/annotations => ee/jakarta/tck/annotations/signaturetest}/SigTestData.java (96%) rename tck/src/main/java/{com/sun/ts/tests/annotations => ee/jakarta/tck/annotations/signaturetest}/SigTestDriver.java (99%) rename tck/src/main/java/{com/sun/ts/tests/annotations => ee/jakarta/tck/annotations/signaturetest}/SigTestResult.java (98%) rename tck/src/main/java/{com/sun/ts/tests/annotations => ee/jakarta/tck/annotations/signaturetest}/SignatureTestDriver.java (99%) rename tck/src/main/java/{com/sun/ts/tests/annotations => ee/jakarta/tck/annotations/signaturetest}/SignatureTestDriverFactory.java (97%) rename tck/src/main/resources/{com/sun/ts/tests/annotations => ee/jakarta/tck/annotations/signaturetest}/jakarta.annotation.sig_3.0 (100%) rename tck/src/main/resources/{com/sun/ts/tests/annotations => ee/jakarta/tck/annotations/signaturetest}/sig-test-pkg-list.txt (100%) rename tck/src/main/resources/{com/sun/ts/tests/annotations => ee/jakarta/tck/annotations/signaturetest}/sig-test.map (100%) diff --git a/tck/docs/CAJ3.0-ReleaseNotes.html b/tck/docs/CAJ3.0-ReleaseNotes.html index ac12b15..c1ec9a5 100644 --- a/tck/docs/CAJ3.0-ReleaseNotes.html +++ b/tck/docs/CAJ3.0-ReleaseNotes.html @@ -58,8 +58,8 @@

Platform Notes

Installing, Setting Up, and Running the Jakarta Annotations TCK

-

Refer to the Jakarta Annotations for Jakarta EE TCK 3.0 User's - Guide for complete instructions on installing, setting up, and +

Refer to the Jakarta Annotations for Jakarta EE TCK 3.0 User's + Guide for complete instructions on installing, setting up, and running the Jakarta Annotations TCK.

diff --git a/tck/docs/TCK-Exclude-List.txt b/tck/docs/TCK-Exclude-List.txt index 837a2bc..5d0a80e 100644 --- a/tck/docs/TCK-Exclude-List.txt +++ b/tck/docs/TCK-Exclude-List.txt @@ -16,4 +16,4 @@ # This file lists the excluded tests from Jakarta Annotations TCK. # This is intended only for documentation purpose and is not used to exclude any tests. -# +# No tests are excluded in this version diff --git a/tck/docs/index.html b/tck/docs/index.html index a27feff..8624cd5 100644 --- a/tck/docs/index.html +++ b/tck/docs/index.html @@ -47,7 +47,7 @@

Guide to Jakarta Annotations TCK 3.0 Documentation

-
Copyright (c) 2016, 2021 Oracle and/or its affiliates. All +
Copyright (c) 2016, 2024 Oracle and/or its affiliates. All rights reserved.

diff --git a/tck-runner/README b/tck/docs/tck-runner/README similarity index 69% rename from tck-runner/README rename to tck/docs/tck-runner/README index 1c97aa4..2f96ab3 100644 --- a/tck-runner/README +++ b/tck/docs/tck-runner/README @@ -11,14 +11,13 @@ Below are the instructions to run the Jakarta Annotations TCK 3. SET PATH : add M2_HOME/bin, JAVA_HOME/bin eg: export PATH=$ANT_HOME/bin:$M2_HOME/bin:$JAVA_HOME/bin: -4. Install the tck jar jakarta-annotations-tck-.jar available inside \ -jakarta-annotations-tck-.zip built from jakartaee/common-annotations-api project -in this repository using below mvn install command: +4. Install the tck jar jakarta-annotations-tck-.jar available at artifacts folder in \ +jakarta-annotations-tck-.zip using below mvn install command: `mvn install:install-file -DcreateChecksum=true -Dpackaging=jar --Dfile=jakarta-annotations-tck-.jar -DgroupId=jakarta.3tck +-Dfile=jakarta-annotations-tck-.jar -DgroupId=jakarta.tck -DartifactId=jakarta-annotations-tck -Dversion=` -5. Use the sample tck-runner/pom.xml available in jakartaee/common-annotations-api project, +5. Use the sample tck-runner/pom.xml available in the annotations-tck/, to run the test with Glassfish, verify the system properties set. Run `mvn clean verify` from the current directory. diff --git a/tck-runner/pom.xml b/tck/docs/tck-runner/pom.xml similarity index 99% rename from tck-runner/pom.xml rename to tck/docs/tck-runner/pom.xml index 9d12662..855f44c 100644 --- a/tck-runner/pom.xml +++ b/tck/docs/tck-runner/pom.xml @@ -153,7 +153,6 @@ ${project.build.directory}/jdk11-bundle ${project.build.directory}/${glassfish.toplevel.dir}/glassfish/modules/jakarta.annotation-api.jar:${project.build.directory}/jdk11-bundle/java.base:${project.build.directory}/jdk11-bundle/java.rmi:${project.build.directory}/jdk11-bundle/java.sql:${project.build.directory}/jdk11-bundle/java.naming true - false true true true diff --git a/tck/docs/userguide/pom.xml b/tck/docs/userguide/pom.xml index c8f8aa4..8186506 100644 --- a/tck/docs/userguide/pom.xml +++ b/tck/docs/userguide/pom.xml @@ -35,10 +35,10 @@ UTF-8 ${project.build.directory}/staging true - 2.4.2 - 2.1.0 + 2.5.6 + 2.2.1 2.2.4 - 1.5.3 + 1.6.2 2.7.0-rc.7 2.3.30 diff --git a/tck/docs/userguide/src/main/jbake/content/attributes.conf b/tck/docs/userguide/src/main/jbake/content/attributes.conf index 8d25cbf..d61f333 100644 --- a/tck/docs/userguide/src/main/jbake/content/attributes.conf +++ b/tck/docs/userguide/src/main/jbake/content/attributes.conf @@ -7,7 +7,7 @@ :CopyrightDates: 2018, 2024 :TechnologyRIURL: https://projects.eclipse.org/projects/ee4j.ca :SpecificationURL: https://jakarta.ee/specifications/annotations/3.0/ -:TCKInquiryList: mailto:jakartaee-tck-dev@eclipse.org[jakartaee-tck-dev@eclipse.org] +:TCKInquiryList: mailto:ca-dev@eclipse.org[ca-dev@eclipse.org] :SpecificationInquiryList: mailto:ca-dev@eclipse.org[ca-dev@eclipse.org] :techID: Annotations // Define this attribute (uncomment it) if the TCK includes no API tests. (Rare.) @@ -22,16 +22,16 @@ // for the technology. Used in config.inc. :TechnologyHomeEnv: CAJ_HOME // Java SE version required. -:SEversion: 17 -:AntVersion: 1.10+ +:SEversion: 17+ +:MavenVersion: 3.6.3+ :JakartaEEVersion: 11 :JavaTestVersion: 5.0 -:jteFileName: /bin/ts.jte -:jtxFileName: /bin/ts.jtx -:TCKPackageName: jakarta-annotations-tck-3.0.0.zip + +:excludeListFileName: TCK-Exclude-List.txt +:TCKPackageName: jakarta-annotations-tck-x.y.z.zip // Directory names used in examples in using.adoc. -:sigTestDirectoryExample: /src/com/sun/ts/tests/signaturetest/caj -:singleTestDirectoryExample: /src/com/sun/ts/tests/caj/api/client -:subsetTestDirectoryExample: /src/com/sun/ts/tests/caj/api +:sigTestDirectoryExample: ee.jakarta.tck.annotations.signaturetest +:singleTestDirectoryExample: ee.jakarta.tck.annotations.signaturetest +:subsetTestDirectoryExample: ee.jakarta.tck.annotations.signaturetest // Define this attribute (uncomment it) if the TCK needs the rebuild appendix. // :rebuild: diff --git a/tck/docs/userguide/src/main/jbake/content/config.adoc b/tck/docs/userguide/src/main/jbake/content/config.adoc index ff8b863..7f43a03 100644 --- a/tck/docs/userguide/src/main/jbake/content/config.adoc +++ b/tck/docs/userguide/src/main/jbake/content/config.adoc @@ -25,8 +25,8 @@ those vendors for specific TCK setup and operational guidance. ==== -This chapter describes how to set up the {TechnologyShortName} TCK and -JavaTest harness software. Before proceeding with the instructions in +This chapter describes how to set up the {TechnologyShortName} TCK. +Before proceeding with the instructions in this chapter, be sure to install all required software, as described in link:install.html#GBFTP[Chapter 3, "Installation."] @@ -34,320 +34,14 @@ After completing the instructions in this chapter, proceed to link:using.html#GBFWO[Chapter 5, "Executing Tests,"] for instructions on running the {TechnologyShortName} TCK. -include::config.inc[] - -[[GHGDH]][[custom-configuration-handlers]] - -4.4 Custom Configuration Handlers -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Configuration handlers are used to configure and unconfigure a -{TechnologyShortName} {TechnologyVersion} implementation during the -certification process. These are similar to deployment handlers but -used for configuration. A configuration handler is an Ant build file -that contains at least the required targets listed below: - - * `config.vi` - to configure the vendor implementation - * `clean.vi` - to unconfigure the vendor implementation - -These targets are called from the `/bin/build.xml` file and -call down into the implementation-specific configuration handlers. - -To provide your own configuration handler, create a config.vi.xml file -with the necessary configuration steps for your implementation and place -the file under the `/bin/xml/impl/` directory. - -For more information, you may wish to view `/bin/xml/impl/glassfish/config.vi.xml`, -the configuration file for Jakarta EE {JakartaEEVersion} Compatible Implementation, Eclipse GlassFish. - -[[GBFWG]][[custom-deployment-handlers]] - -4.5 Custom Deployment Handlers -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Deployment handlers are used to deploy and undeploy the WAR files that -contain the tests to be run during the certification process. A deployment -handler is an Ant build file that contains at least the required targets -listed in the table below. - -The {TechnologyShortName} TCK provides these deployment handlers: - -* `/bin/xml/impl/none/deploy.xml` -* `/bin/xml/impl/glassfish/deploy.xml` -* `/bin/xml/impl/tomcat/deploy.xml` - -The `deploy.xml` files in each of these directories are used to control -deployment to a specific container (no deployment, deployment to -the Eclipse GlassFish Web container, deployment to the Tomcat Web container) -denoted by the name of the directory in which each `deploy.xml` file -resides. The primary `build.xml` file in the `/bin` directory -has a target to invoke any of the required targets (`-deploy`, `-undeploy`, -`-deploy.all`, `-undeploy.all`). - -[[GBFVA]][[create-custom-deployment-handler]] - -4.5.1 To Create a Custom Deployment Handler -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -To deploy tests to another {TechnologyShortName} implementation, you -must create a custom handler. - -1. Create a new directory in the `/bin/xml/impl` directory tree. - For example, create the `/bin/xml/impl/my_deployment_handler` directory. - Replace my_deployment_handler with the value of the impl.vi - property that you set in Step 5 of the configuration procedure - described in Section 4.2, "Configuring Your Environment to Repackage - and Run the TCK Against the Vendor Implementation". - -2. Copy the deploy.xml file from the `/bin/xml/impl/none` - directory to the directory that you created. - -3. Modify the required targets in the `deploy.xml` file. This is what - the `deploy.xml` file for the "none" deployment handler looks like. - -+ -[source,oac_no_warn] ----- - - - - - - - - - - - - - - - ----- -+ -Although this example just echoes messages, it does include the four -required Ant targets (`-deploy`, `-undeploy`, `-deploy.all`, `-undeploy.all`) -that your custom `deploy.xml` file must contain. With this as your -starting point, look at the required targets in the `deploy.xml` files -in the Tomcat and Eclipse Glassfish directories for guidance as you create -the same targets for the Web container in which you will run your -implementation of {TechnologyShortName}. - -The following Ant targets can be called from anywhere under the -`/src` directory: - -* `deploy` -* `undeploy` -* `deploy.all` -* `undeploy.all` - -The `deploy.all` and `undeploy.all` targets can also be called from the -`/bin` directory. - [NOTE] -======================================================================= -The targets in the `deploy.xml` file are never called directly. -They are called indirectly by the targets listed above. -======================================================================= - -[[GBFUY]][[using-the-javatest-harness-software]] - -4.6 Using the JavaTest Harness Software -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -There are two general ways to run the {TechnologyShortName} TCK test -suite using the JavaTest harness software: - -* Through the JavaTest GUI; if using this method, please continue on to -link:#GBFWG[Section 4.7, "Using the JavaTest Harness Configuration -GUI."] -* In JavaTest batch mode, from the command line in your shell -environment; if using this method, please proceed directly to -link:using.html#GBFWO[Chapter 5, "Executing Tests."] - -[[GBFWG]][[using-the-javatest-harness-configuration-gui]] - -4.7 Using the JavaTest Harness Configuration GUI -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can use the JavaTest harness GUI to modify general test settings and -to quickly get started with the default {TechnologyShortName} TCK test -environment. This section covers the following topics: - -* link:#GBFVA[Configuration GUI Overview] -* link:#GBFVD[Starting the Configuration GUI] -* link:#GBFVX[To Configure the JavaTest Harness to Run the -{TechnologyShortName} TCK Tests] -* link:#GBFUU[Modifying the Default Test Configuration] - - -[NOTE] -======================================================================= - -It is only necessary to proceed with this section if you want to run the -JavaTest harness in GUI mode. If you plan to run the JavaTest harness in -command-line mode, skip the remainder of this chapter, and continue with -link:using.html#GBFWO[Chapter 5, "Executing Tests."] - -======================================================================= - - -[[GBFVA]][[configuration-gui-overview]] - -4.7.1 Configuration GUI Overview -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -In order for the JavaTest harness to execute the test suite, it requires -information about how your computing environment is configured. The -JavaTest harness requires two types of configuration information: - -* Test environment: This is data used by the tests. For example, the -path to the Java runtime, how to start the product being tested, network -resources, and other information required by the tests in order to run. -This information does not change frequently and usually stays constant -from test run to test run. -* Test parameters: This is information used by the JavaTest harness to -run the tests. Test parameters are values used by the JavaTest harness -that determine which tests in the test suite are run, how the tests -should be run, and where the test reports are stored. This information -often changes from test run to test run. - -The first time you run the JavaTest harness software, you are asked to -specify the test suite and work directory that you want to use. (These -parameters can be changed later from within the JavaTest harness GUI.) - -Once the JavaTest harness GUI is displayed, whenever you choose Start, -then Run Tests to begin a test run, the JavaTest harness determines -whether all of the required configuration information has been supplied: - -* If the test environment and parameters have been completely -configured, the test run starts immediately. -* If any required configuration information is missing, the -configuration editor displays a series of questions asking you the -necessary information. This is called the configuration interview. When -you have entered the configuration data, you are asked if you wish to -proceed with running the test. - -[[GBFVD]][[starting-the-configuration-gui]] - -4.7.2 Starting the Configuration GUI -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Before you start the JavaTest harness software, you must have a valid -test suite and Java SE {SEversion} installed on your system. - -The {TechnologyShortName} TCK includes an Ant script that is used to execute the -JavaTest harness from the `` directory. Using this Ant script -to start the JavaTest harness is part of the procedure described in -link:#GBFVX[Section 4.7.3, "To Configure the JavaTest Harness to Run the -TCK Tests."] - -When you execute the JavaTest harness software for the first time, the -JavaTest harness displays a Welcome dialog box that guides you through -the initial startup configuration. - -* If it is able to open a test suite, the JavaTest harness displays a -Welcome to JavaTest dialog box that guides you through the process of -either opening an existing work directory or creating a new work -directory as described in the JavaTest online help. -* If the JavaTest harness is unable to open a test suite, it displays a -Welcome to JavaTest dialog box that guides you through the process of -opening both a test suite and a work directory as described in the -JavaTest documentation. - -After you specify a work directory, you can use the Test Manager to -configure and run tests as described in link:#GBFVX[Section 4.7.3, "To -Configure the JavaTest Harness to Run the TCK Tests."] - -[[GBFVX]][[to-configure-the-javatest-harness-to-run-the-tck-tests]] - -4.7.3 To Configure the JavaTest Harness to Run the TCK Tests -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The answers you give to some of the configuration interview questions -are specific to your site. For example, the name of the host on which -the JavaTest harness is running. Other configuration parameters can be -set however you wish. For example, where you want test report files to -be stored. - -Note that you only need to complete all these steps the first time you -start the JavaTest test harness. After you complete these steps, you can -either run all of the tests by completing the steps in -link:using.html#GBFUZ[Section 5.1, "Starting JavaTest,"] or run a subset -of the tests by completing the steps in link:using.html#GBFWM[Section -5.2, "Running a Subset of the Tests."] - -1. Change to the `/bin` directory and start the JavaTest test -harness: + -`cd /bin` + -`ant gui` -2. From the File menu, click *Open Quick Start Wizard*. + -The Welcome screen displays. -3. Select *Start a new test run*, and then click *Next*. + -You are prompted to create a new configuration or use a configuration -template. -4. Select *Create a new configuration*, and then click *Next*. + -You are prompted to select a test suite. -5. Accept the default suite (`/src`), and then click *Next*. + -You are prompted to specify a work directory to use to store your test -results. -6. Type a work directory name or use the *Browse* button to select a work -directory, and then click *Next*. + -You are prompted to start the configuration editor or start a test run. -At this point, the {TechnologyShortName} TCK is configured to run the -default test suite. -7. Deselect the *Start the configuration editor* option, and then click -*Finish*. -8. Click *Run Tests*, then click *Start*. + -The JavaTest harness starts running the tests. -9. To reconfigure the JavaTest test harness, do one of the following: -* Click *Configuration*, then click *New Configuration*. -* Click *Configuration*, then click *Change Configuration*. -10. Click *Report*, and then click *Create Report*. -11. Specify the directory in which the JavaTest test harness will write -the report, and then click *OK*. + -A report is created, and you are asked whether you want to view it. -12. Click *Yes* to view the report. - -[[GBFUU]][[modifying-the-default-test-configuration]] - -4.7.4 Modifying the Default Test Configuration -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The JavaTest GUI enables you to configure numerous test options. These -options are divided into two general dialog box groups: - -* Group 1: Available from the JavaTest *Configure/Change Configuration* -submenus, the following options are displayed in a tabbed dialog box: - -** *Tests to Run* - -** *Exclude List* - -** *Keywords* - -** *Prior Status* - -** *Test Environment* - -** *Concurrency* - -** *Timeout Factor* -* Group 2: Available from the JavaTest *Configure/Change -Configuration/Other Values* submenu, or by pressing `Ctrl+E`, the following -options are displayed in a paged dialog box: - -** *Environment Files* - -** *Test Environment* - -** *Specify Tests to Run* - -** *Specify an Exclude List* - -Note that there is some overlap between the functions in these two -dialog boxes; for those functions use the dialog box that is most -convenient for you. Please refer to the JavaTest Harness documentation -or the online help for complete information about these various options. +==== +The {TechnologyShortName} TCK is not depended on any particular build +tool to run the tests. It will be convenient and advisable to create a +Apache Maven project to setup and run the TCK. +This chapter will henceforth use instructions and steps to provide setup +with Apache Maven as a build tool. +==== +include::config.inc[] diff --git a/tck/docs/userguide/src/main/jbake/content/config.inc b/tck/docs/userguide/src/main/jbake/content/config.inc index 6fe83c7..3d9b3ba 100644 --- a/tck/docs/userguide/src/main/jbake/content/config.inc +++ b/tck/docs/userguide/src/main/jbake/content/config.inc @@ -13,19 +13,18 @@ as toc.adoc. [[GBFVU]][[configuring-your-environment-to-run-the-tck-against-the-reference-implementation]] 4.1 Configuring Your Environment to Run the TCK Against a Compatible Implementation -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ After configuring your environment as described in this section, -continue with the instructions in link:#GBFUY[Section 4.4, "Using the -JavaTest Harness Software."] +continue with the instructions in link:using.html#GBFWO[Chapter 5, "Executing Tests."] [NOTE] ======================================================================= In these instructions, variables in angle brackets need to be expanded -for each platform. For example, `` becomes `$TS_HOME` on -Solaris/Linux and `%TS_HOME%` on Windows. In addition, the forward +for each platform. For example, `` becomes `$JAVA_HOME` on +Solaris/Linux and `%JAVA_HOME%` on Windows. In addition, the forward slashes (`/`) used in all of the examples need to be replaced with backslashes (`\`) for Windows. Finally, be sure to use the appropriate separator for your operating system when specifying multiple path @@ -39,20 +38,15 @@ slashes as a path separator instead. 1. Set the following environment variables in your shell environment: - a. `JAVA_HOME` to the directory in which Java SE 8 is installed - b. `TS_HOME` to the directory in which the {TechnologyShortName} TCK - {TechnologyVersion} software is installed + 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. `PATH` to include the following directories: `JAVA_HOME/bin`, - +{TechnologyHomeEnv}/bin+, and `ANT_HOME/bin` -2. Copy /bin/ts.jte.jdk11 as /bin/ts.jte if JAVA_HOME is Java SE 11. -Edit your `/bin/ts.jte` file and set the following -environment variables: - a. Set the `local.classes` + and `M2_HOME/bin` +2. Set the following System properties: + a. Set the `sigTestClassPath` property to point to a Jakarta Annotations CI classes/jars that contain the annotations being supported in Step link:#BABJHHAJ[c], below. - b. Set the `endorsed.dirs` - property to the location of the CI API jars for those technologies you - wish to override that exist within the JDK. + b. Set the `jimage.dir` property to the location where JDK modules will be extracted. c. [[BABJHHAJ]] Depending on the annotations that are supported or unsupported in your Jakarta Annotations implementation, the following properties should be set to `true` or `false` respectively. + @@ -62,9 +56,6 @@ environment variables: #jakarta.annotation.Generated ca.sig.generated=true -#jakarta.annotation.ManagedBean -ca.sig.managedbean=true - #jakarta.annotation.PostConstruct ca.sig.postconstruct=true @@ -100,8 +91,34 @@ ca.sig.sqldatasourcedefinition=true #jakarta.annotation.sql.DataSourceDefinitions ca.sig.sqldatasourcedefinitions=true ---- - d. Run the JavaTest harness in GUI or command-line mode, as described -in link:#GBFUY[Section 4.4, "Using the JavaTest Harness Software."] +3. Set the below jars to the classpath + a. JAR file for the {TechnologyShortName} {TechnologyVersion} API. + + eg. `${web.home}/modules/jakarta.annotations-api.jar`. + b. JUnit 5 jars (5.9.1+) + Maven cordinates : ++ +[source,oac_no_warn] +---- + + org.junit + junit-bom + 5.9.1 + pom + import + +---- ++ + c. sigtest-maven-plugin (2.1) to run the signature tests. + Maven cordinates : ++ +[source,oac_no_warn] +---- + + jakarta.tck + sigtest-maven-plugin + 2.1 + +---- [[GCLHU]][[configuring-your-environment-to-repackage-and-run-the-tck-against-the-vendor-implementation]] diff --git a/tck/docs/userguide/src/main/jbake/content/debug.adoc b/tck/docs/userguide/src/main/jbake/content/debug.adoc index 5208c40..3601aab 100644 --- a/tck/docs/userguide/src/main/jbake/content/debug.adoc +++ b/tck/docs/userguide/src/main/jbake/content/debug.adoc @@ -17,16 +17,12 @@ Debugging Test Problems 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]] @@ -39,136 +35,38 @@ filtered out to have passing results. If the root test suite folder contains tests with errors or failing results, you must troubleshoot and correct the cause to satisfactorily complete the test run. -* Errors: Tests with errors could not be executed by the JavaTest -harness. These errors usually occur because the test environment is not +* Errors: Tests with errors could not be executed by the JUnit +framework. These errors usually occur because the test environment is not properly configured. * Failures: Tests that fail were executed but had failing results. -The Test Manager GUI provides you with a number of tools for effectively -troubleshooting a test run. See the JavaTest User's Guide and JavaTest -online help for detailed descriptions of the tools described in this -chapter. Ant test execution tasks provide command-line users with -immediate test execution feedback to the display. Available JTR report -files and log files can also help command-line users troubleshoot test -run problems. - -For every test run, the JavaTest harness creates a set of report files -in the reports directory, which you specified by setting the -`report.dir` property in the +{jteFileName}+ file. The report files contain -information about the test description, environment, messages, -properties used by the test, status of the test, and test result. After -a test run is completed, the JavaTest harness writes HTML reports for -the test run. You can view these files in the JavaTest ReportBrowser -when running in GUI mode, or in the Web browser of your choice outside -the JavaTest interface. To see all of the HTML report files, enter the -URL of the `report.html` file. This file is the root file that links to -all of the other HTML reports. - -The JavaTest harness also creates a `summary.txt` file in the report -directory that you can open in any text editor. The `summary.txt` file -contains a list of all tests that were run, their test results, and -their status messages. - -The work directory, which you specified by setting the `work.dir` -property in the +{jteFileName}+ file, contains several files that were -deposited there during test execution: `harness.trace`, `log.txt`, -`lastRun.txt`, and `testsuite`. Most of these files provide information -about the harness and environment in which the tests were executed. - -[NOTE] -======================================================================= - -You can set `harness.log.traceflag=true` in +{jteFileName}+ to -get more debugging information. - -======================================================================= + +For every test run, the JUnit framework creates a set of report files +in the target directory. + If a large number of tests failed, you should read link:#GBFYF[Configuration Failures] to see if a configuration issue is the cause of the failures. -[[GBFVF]][[test-tree]] - -6.2 Test Tree -~~~~~~~~~~~~~ - -Use the test tree in the JavaTest GUI to identify specific folders and -tests that had errors or failing results. Color codes are used to -indicate status as follows: - -* Green: Passed -* Blue: Test Error -* Red: Failed to pass test -* White: Test not run -* Gray: Test filtered out (not run) - -[[GBFWI]][[folder-information]] - -6.3 Folder Information -~~~~~~~~~~~~~~~~~~~~~~ - -Click a folder in the test tree in the JavaTest GUI to display its tabs. - -Choose the Error and the Failed tabs to view the lists of all tests in -and under a folder that were not successfully run. You can double-click -a test in the lists to view its test information. [[GBFVP]][[test-information]] -6.4 Test Information +6.2 Test Information ~~~~~~~~~~~~~~~~~~~~ -To display information about a test in the JavaTest GUI, click its icon -in the test tree or double-click its name in a folder status tab. The -tab contains detailed information about the test run and, at the bottom -of the window, a brief status message identifying the type of failure or -error. This message may be sufficient for you to identify the cause of -the error or failure. - If you need more information to identify the cause of the error or -failure, use the following tabs listed in order of importance: - -* Test Run Messages contains a Message list and a Message section that -display the messages produced during the test run. -* Test Run Details contains a two-column table of name/value pairs -recorded when the test was run. -* Configuration contains a two-column table of the test environment -name/value pairs derived from the configuration data actually used to -run the test. - - -[NOTE] -======================================================================= - -You can set `harness.log.traceflag=true` in +{jteFileName}+ to -get more debugging information. - -======================================================================= - - -[[GBFVZ]][[report-files]] - -6.5 Report Files -~~~~~~~~~~~~~~~~ +failure, use the JUnit reports generated after running the tests. -Report files are another good source of troubleshooting information. You -may view the individual test results of a batch run in the JavaTest -Summary window, but there are also a wide range of HTML report files -that you can view in the JavaTest ReportBrowser or in the external -browser or your choice following a test run. See -link:using.html#GBFVK[Section 5.5, "Test Reports,"] for more information. [[GBFYF]][[configuration-failures]] -6.6 Configuration Failures +6.3 Configuration Failures ~~~~~~~~~~~~~~~~~~~~~~~~~~ Configuration failures are easily recognized because many tests fail the same way. When all your tests begin to fail, you may want to stop the -run immediately and start viewing individual test output. However, in -the case of full-scale launching problems where no tests are actually -processed, report files are usually not created (though sometimes a -small `harness.trace` file in the report directory is written). +run immediately and start viewing individual test output. include::debug-tips.inc[] diff --git a/tck/docs/userguide/src/main/jbake/content/faq.adoc b/tck/docs/userguide/src/main/jbake/content/faq.adoc index 97ca394..d863ed5 100644 --- a/tck/docs/userguide/src/main/jbake/content/faq.adoc +++ b/tck/docs/userguide/src/main/jbake/content/faq.adoc @@ -26,8 +26,6 @@ This appendix contains the following questions. A.1 Where do I start to debug a test failure? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -From the JavaTest GUI, you can view recently run tests using the Test -Results Summary, by selecting the red Failed tab or the blue Error tab. See link:debug.html#GBFUV[Chapter 6, "Debugging Test Problems,"] for more information. @@ -37,22 +35,16 @@ A.2 How do I restart a crashed test run? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you need to restart a test run, you can figure out which test crashed -the test suite by looking at the `harness.trace` file. The -`harness.trace` file is in the report directory that you supplied to the -JavaTest GUI or parameter file. Examine this trace file, then change the -JavaTest GUI initial files to that location or to a directory location -below that file, and restart. This will overwrite only `.jtr` files that -you rerun. As long as you do not change the value of the GUI work -directory, you can continue testing and then later compile a complete -report to include results from all such partial runs. +the test suite by looking at the logs. [[GBFWU]][[a.3-what-would-cause-tests-be-added-to-the-exclude-list]] A.3 What would cause tests be added to the exclude list? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The JavaTest exclude file (+{jtxFileName}+) contains all tests that are not -required to be run. The following is a list of reasons for a test to be +The exclude file (+{excludeListFileName}+) contains all tests that are not +required to be run. The file is used only for documentation purpose. The tests are excluded using +@Disabled tag in JUnit when necessary. The following is a list of reasons for a test to be included in the Exclude List: * An error in a Compatible Implementation that does not allow the test to diff --git a/tck/docs/userguide/src/main/jbake/content/install.adoc b/tck/docs/userguide/src/main/jbake/content/install.adoc index a3b93e7..c897459 100644 --- a/tck/docs/userguide/src/main/jbake/content/install.adoc +++ b/tck/docs/userguide/src/main/jbake/content/install.adoc @@ -41,11 +41,10 @@ install and set up the following software components: include::req-software.inc[] * Java SE {SEversion} -* Apache Ant {AntVersion} * A CI for {TechnologyShortName} {TechnologyVersion}, one example is {TechnologyRI} -* {TechnologyShortName} TCK version {TechnologyVersion}, which includes: -include::tck-packages.inc[] +* {TechnologyShortName} TCK version {TechnologyVersion} * The {TechnologyShortName} {TechnologyVersion} Vendor Implementation (VI) +* Any Jupiter API compatible test runner (eg. Apache Maven {MavenVersion}) Follow these steps: @@ -54,14 +53,11 @@ Download and install the Java SE {SEversion} software from http://www.oracle.com/technetwork/java/javase/downloads/index.html. Refer to the installation instructions that accompany the software for additional information. -. Install the Apache Ant {AntVersion} software, if it is not already installed. + -Download and install Apache Ant {AntVersion} software from Apache Ant -Project. For complete information about Ant, refer to the extensive documentation -on the Apache Ant Project site. The Apache Ant Manual is available at -`http://ant.apache.org/manual/index.html`. -Apache Ant is protected under the Apache Software, License 2.0, which is -is available on the Apache Ant Project license page at -`http://ant.apache.org/license.html`. + +. Install the build tool that will be used to run the TCK, if it is not already installed. + +It will be convenient to use Apache Maven {MavenVersion} for running the tests. The test kit +is not depended on Maven, any build tool compatible with Jupiter API is suffitient. + . Install the {TechnologyShortName} TCK {TechnologyVersion} software. a. Copy or download the {TechnologyShortName} TCK software to your local system. + @@ -70,8 +66,7 @@ is available on the Apache Ant Project license page at b. Use the `unzip` command to extract the bundle in the directory of your choice: + +unzip {TCKPackageName}+ + - This creates the TCK directory. The TCK is the test suite home, - ``. + include::install-server.inc[] . Install a {TechnologyShortName} {TechnologyVersion} Compatible Implementation. + diff --git a/tck/docs/userguide/src/main/jbake/content/intro.adoc b/tck/docs/userguide/src/main/jbake/content/intro.adoc index 774adfd..2929c4c 100644 --- a/tck/docs/userguide/src/main/jbake/content/intro.adoc +++ b/tck/docs/userguide/src/main/jbake/content/intro.adoc @@ -164,9 +164,6 @@ restrictions, and so on. The {TechnologyShortName} TCK {TechnologyVersion} includes the following components: -* JavaTest harness version {JavaTestVersion} and related documentation. See -link:https://wiki.openjdk.java.net/display/CodeTools/JT+Harness[JT Harness web site] -for additional information. * {TechnologyShortName} TCK signature tests; check that all public APIs are supported and/or defined as specified in the {TechnologyShortName} Version {TechnologyVersion} implementation under test. @@ -185,44 +182,15 @@ The {TechnologyShortName} TCK tests run on the following platforms: include::platforms.inc[] -[[GBFSA]][[javatest-harness]] - -1.2.3 JavaTest Harness -^^^^^^^^^^^^^^^^^^^^^^ - -The JavaTest harness version {JavaTestVersion} is a set of tools -designed to run and manage test suites on different Java platforms. -To JavaTest, Jakarta EE can be considered another platform. -The JavaTest harness can be described as both a Java application and a set -of compatibility testing tools. It can run tests on different kinds of -Java platforms and it allows the results to be browsed online within -the JavaTest GUI, or offline in the HTML reports that the JavaTest -harness generates. - -The JavaTest harness includes the applications and tools that are used -for test execution and test suite management. It supports the following -features: - -* Sequencing of tests, allowing them to be loaded and executed automatically -* Graphic user interface (GUI) for ease of use -* Automated reporting capability to minimize manual errors -* Failure analysis -* Test result auditing and auditable test specification framework -* Distributed testing environment support - -To run tests using the JavaTest harness, you specify which tests in the -test suite to run, how to run them, and where to put the results as -described in link:config.html#GBFVV[Chapter 4, "Setup and -Configuration."] [[GBFRA]][[tck-compatibility-test-suite]] -1.2.4 TCK Compatibility Test Suite +1.2.3 TCK Compatibility Test Suite ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The test suite is the collection of tests used by the JavaTest harness +The test suite is the collection of tests to test a particular technology implementation. In this case, it is the -collection of tests used by the {TechnologyShortName} TCK +collection of JUnit tests used by the {TechnologyShortName} TCK {TechnologyVersion} to test a {TechnologyShortName} {TechnologyVersion} implementation. The tests are designed to verify that a vendor's runtime implementation of the technology complies with the appropriate @@ -230,34 +198,31 @@ specification. The individual tests correspond to assertions of the specification. The tests that make up the TCK compatibility test suite are precompiled -and indexed within the TCK test directory structure. When a test run is -started, the JavaTest harness scans through the set of tests that are -located under the directories that have been selected. While scanning, -the JavaTest harness selects the appropriate tests according to any -matches with the filters you are using and queues them up for execution. +and indexed within the TCK jar directory structure. [[GBFSH]][[exclude-lists]] -1.2.5 Exclude Lists +1.2.4 Exclude Lists ^^^^^^^^^^^^^^^^^^^ -Each version of a TCK includes an Exclude List contained in a `.jtx` +Each version of a TCK includes an Exclude List contained in a `TCK-Exclude-List.txt` file. This is a list of test file URLs that identify tests which do not have to be run for the specific version of the TCK being used. -Whenever tests are run, the JavaTest harness automatically excludes -any test on the Exclude List from being executed. +Whenever tests are run, the JUnit framework automatically excludes +these tests from being executed as those are disabled using '@Disabled' tag in JUnit. A vendor's compatible implementation is not required to pass or run any test on the Exclude List. -The Exclude List file, +{jtxFileName}+, is included in the -{TechnologyShortName} TCK. +The Exclude List file, +{excludeListFileName}+, is documented in the +{TechnologyShortName} TCK. Please note this file is not parsed to exclude any test and is only +for documentation purpose. [NOTE] ======================================================================= From time to time, updates to the Exclude List are made available. -The exclude list is included in the Jakarta TCK ZIP archive. +The exclude list is included in the TCK ZIP archive. Each time an update is approved and released, the version number will be incremented. You should always make sure you are using an up-to-date copy of the @@ -274,8 +239,7 @@ does not allow the test to execute properly. * An error in the specification that was used as the basis of the test has been discovered. * An error in the test itself has been discovered. -* The test fails due to a bug in the tools (such as the JavaTest -harness, for example). +* The test fails due to a bug in the tools used to run the test. In addition, all tests are run against the compatible implementations. Any tests that fail when run on a compatible Jakarta platform are put on the @@ -297,12 +261,11 @@ link:rules.html#CJAJEAEI[Section 2.3.1, "TCK Test Appeals Steps."] [[GBFRR]][[tck-configuration]] -1.2.6 TCK Configuration +1.2.5 TCK Configuration ^^^^^^^^^^^^^^^^^^^^^^^ -You need to set several variables in your test environment, modify -properties in the +{jteFileName}+ file, and then use the JavaTest -harness to configure and run the {TechnologyShortName} tests, as described in +You need to set several variables in your test environment, +and run the {TechnologyShortName} tests, as described in link:config.html#GBFVV[Chapter 4, "Setup and Configuration."] include::intro.inc[] @@ -327,13 +290,11 @@ steps are explained in more detail in subsequent chapters of this 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} -* Apache Ant {AntVersion} * A CI for {TechnologyShortName} {TechnologyVersion}. One example is {TechnologyRI}. -* {TechnologyShortName} TCK version {TechnologyVersion}, which includes: -include::tck-packages.inc[] +* {TechnologyShortName} TCK version {TechnologyVersion} * The {TechnologyShortName} {TechnologyVersion} Vendor Implementation (VI) + See the documentation for each of these software applications for installation instructions. See link:install.html#GBFTP[Chapter 3, @@ -342,8 +303,7 @@ installation instructions. See link:install.html#GBFTP[Chapter 3, See link:config.html#GBFVV[Chapter 4, "Setup and Configuration,"] for details about the following steps. a. Set up your shell environment. - b. Modify the required properties in the +{jteFileName}+ file. - c. Configure the JavaTest harness. + b. Set the required System properties. 3. Test the {TechnologyShortName} {TechnologyVersion} implementation. + Test the {TechnologyShortName} implementation installation by running the test suite. See link:using.html#GBFWO[Chapter 5, "Executing Tests."] diff --git a/tck/docs/userguide/src/main/jbake/content/platforms.inc b/tck/docs/userguide/src/main/jbake/content/platforms.inc index 236beed..1afa2d2 100644 --- a/tck/docs/userguide/src/main/jbake/content/platforms.inc +++ b/tck/docs/userguide/src/main/jbake/content/platforms.inc @@ -1 +1 @@ -* CentOS Linux 7 \ No newline at end of file +* Debian GNU/Linux 10 \ No newline at end of file diff --git a/tck/docs/userguide/src/main/jbake/content/preface.adoc b/tck/docs/userguide/src/main/jbake/content/preface.adoc index ea10c28..d011e0b 100644 --- a/tck/docs/userguide/src/main/jbake/content/preface.adoc +++ b/tck/docs/userguide/src/main/jbake/content/preface.adoc @@ -23,8 +23,7 @@ The {TechnologyShortName} TCK is a portable, configurable automated test suite for verifying the compatibility of a vendor's implementation of the {TechnologyShortName} {TechnologyVersion} Specification (hereafter referred to as the vendor implementation or VI). -The {TechnologyShortName} TCK uses the JavaTest harness version -{JavaTestVersion} to run the test suite +The {TechnologyShortName} TCK uses the JUnit framework to run the test suite. [NOTE] @@ -74,10 +73,6 @@ You should be familiar with the {TechnologyShortName} {TechnologyVersion}, version {TechnologyVersion} Specification, which can be found at {SpecificationURL}. -Before running the tests in the {TechnologyShortName} TCK, you should -familiarize yourself with the JavaTest documentation which can be -accessed at the -link:https://wiki.openjdk.java.net/display/CodeTools/JT+Harness[JT Harness web site]. [[TCJRS00036]][[GBFWF]] diff --git a/tck/docs/userguide/src/main/jbake/content/tck-packages.inc b/tck/docs/userguide/src/main/jbake/content/tck-packages.inc index 5ca5003..e69de29 100644 --- a/tck/docs/userguide/src/main/jbake/content/tck-packages.inc +++ b/tck/docs/userguide/src/main/jbake/content/tck-packages.inc @@ -1,7 +0,0 @@ -** JDOM 1.1.3 - -** Apache Commons HTTP Client 3.1 - -** Apache Commons Logging 1.1.3 - -** Apache Commons Codec 1.9 diff --git a/tck/docs/userguide/src/main/jbake/content/using-examples.inc b/tck/docs/userguide/src/main/jbake/content/using-examples.inc index b47962f..be33bb7 100644 --- a/tck/docs/userguide/src/main/jbake/content/using-examples.inc +++ b/tck/docs/userguide/src/main/jbake/content/using-examples.inc @@ -3,13 +3,12 @@ NOTE TO WRITERS: These CLI examples can be customized as necessary. /////////////////////////////////////////////////////////////////////// -1. Change to any subdirectory under `/src/com/sun/ts/tests`. -2. Start JavaTest using the following command: -+ +Start the JUnit tests using the following command: + -- [source,oac_no_warn] ---- -ant runclient +mvn verify ---- -- @@ -22,8 +21,7 @@ following commands: [source,subs="attributes"] ---- -cd {sigTestDirectoryExample} -ant runclient +mvn verify -Dit.test=ee.jakarta.tck.annotations.signaturetest.** ---- [[GCMBV]] @@ -35,8 +33,7 @@ To run a single test directory, enter the following commands: [source,subs="attributes"] ---- -cd {singleTestDirectoryExample} -ant runclient +mvn verify -Dit.test={singleTestDirectoryExample}.** ---- [[GCMCA]] @@ -48,6 +45,5 @@ To run a subset of test directories, enter the following commands: [source,subs="attributes"] ---- -cd {subsetTestDirectoryExample} -ant runclient +mvn verify -Dit.test={subsetTestDirectoryExample}.** ---- diff --git a/tck/docs/userguide/src/main/jbake/content/using.adoc b/tck/docs/userguide/src/main/jbake/content/using.adoc index b0a41c5..719164e 100644 --- a/tck/docs/userguide/src/main/jbake/content/using.adoc +++ b/tck/docs/userguide/src/main/jbake/content/using.adoc @@ -15,14 +15,12 @@ Executing Tests 5 Executing Tests ----------------- -The {TechnologyShortName} TCK uses the JavaTest harness to execute the -tests in the test suite. For detailed instructions that explain how to -run and use JavaTest, see the JavaTest User's Guide and Reference in -the documentation bundle. +The {TechnologyShortName} TCK uses the JUnit framework +to execute the tests. This chapter includes the following topics: -* link:#GBFUZ[Starting JavaTest] +* link:#GBFUZ[Starting the 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] @@ -47,48 +45,44 @@ Files With VI-Specific Information,"] the {TechnologyShortName} TCK introduces the concept of repackaging the TCK tests. endif::rebuild[] +[NOTE] +======================================================================= + +The Jakarta REST TCK is not depended on any particular build tool to +run the tests. It will be convenient and advisable to create a +Apache Maven project to setup and run the TCK. This chapter will +henceforth use instructions and steps to provide setup with Apache +Maven as a build tool. + +======================================================================= + -[[GBFUZ]][[starting-javatest]] -5.1 Starting JavaTest -~~~~~~~~~~~~~~~~~~~~~ +[[GBFUZ]][[starting-javatest]] -There are two general ways to run the {TechnologyShortName} TCK using -the JavaTest harness software: +5.1 Starting the tests +~~~~~~~~~~~~~~~~~~~~~~ -* Through the JavaTest GUI -* From the command line in your shell environment +The {TechnologyShortName} TCK can be run from the command line +in your shell environment by executing the TCK jar. [NOTE] ======================================================================= -The `ant` command referenced in the following -two procedures and elsewhere in this guide is the Apache Ant +The `mvn` command referenced in the following +two procedures and elsewhere in this guide is the Apache Maven build tool, which will need to be downloaded separately. -The `build.xml` file in `/bin` contains the various Ant -targets for the {TechnologyShortName} TCK test suite. ======================================================================= -[[GBFWH]][[to-start-javatest-in-gui-mode]] - -5.1.1 To Start JavaTest in GUI Mode -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Execute the following commands: - -[source,oac_no_warn] ----- -cd /bin -ant gui ----- [[GBFVW]][[to-start-javatest-in-command-line-mode]] -5.1.2 To Start JavaTest in Command-Line Mode -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +5.1.1 To Start Tests in Command-Line Mode +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ include::using-examples.inc[] @@ -99,79 +93,23 @@ include::using-examples.inc[] Use the following modes to run a subset of the tests: -* link:#GBFVT[Section 5.2.1, "To Run a Subset of Tests in GUI Mode"] -* link:#GBFWK[Section 5.2.2, "To Run a Subset of Tests in Command-Line Mode"] -* link:#GBFVL[Section 5.2.3, "To Run a Subset of Tests in Batch Mode -Based on Prior Result Status"] - -[[GBFVT]][[to-run-a-subset-of-tests-in-gui-mode]] - -5.2.1 To Run a Subset of Tests in GUI Mode -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -1. From the JavaTest main menu, click *Configure*, then click *Change -Configuration*, and then click *Tests to Run*. + -The tabbed Configuration Editor dialog box is displayed. -2. Click *Specify* from the option list on the left. -3. Select the tests you want to run from the displayed test tree, and -then click *Done*. + -You can select entire branches of the test tree, or use `Ctrl+Click` or -`Shift+Click` to select multiple tests or ranges of tests, respectively, -or select just a single test. -4. Click *Save File*. -5. Click *Run Tests*, and then click *Start* to run the tests you selected. + -Alternatively, you can `right-click` the test you want from the test tree -in the left section of the JavaTest main window, and choose *Execute -These Tests* from the menu. -6. Click *Report*, and then click *Create Report*. -7. Specify the directory in which the JavaTest test harness will write -the report, and then click *OK* + -A report is created, and you are asked whether you want to view it. -8. Click *Yes* to view the report. +* link:#GBFWK[Section 5.2.1, "To Run a Subset of Tests in Command-Line Mode"] + [[GBFWK]][[to-run-a-subset-of-tests-in-command-line-mode]] -5.2.2 To Run a Subset of Tests in Command-Line Mode +5.2.1 To Run a Subset of Tests in Command-Line Mode ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -1. Change to the directory containing the tests you want to run. -2. Start the test run by executing the following command: + -+ -[source] ----- -ant runclient ----- -+ -The tests in the directory and its subdirectories are run. - -[[GBFVL]][[to-run-a-subset-of-tests-in-batch-mode-based-on-prior-result-status]] - -5.2.3 To Run a Subset of Tests in Batch Mode Based on Prior Result Status -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -You can run certain tests in batch mode based on the test's prior run -status by specifying the `priorStatus` system property when invoking -`ant` - -Invoke `ant` with the `priorStatus` property. - -The accepted values for the `priorStatus` property are any combination -of the following: +Start the test run by executing the following command: + -* `fail` -* `pass` -* `error` -* `notRun` - -For example, you could run all the {TechnologyShortName} tests with a -status of failed and error by invoking the following commands: - -[source,oac_no_warn] +[source,subs="attributes"] ---- -ant -DpriorStatus="fail,error" runclient +mvn verify -Dit.test={subsetTestDirectoryExample}.** ---- -Note that multiple `priorStatus` values must be separated by commas. +The tests in the directory and its subdirectories are run. + [[GCLRR]][[running-the-tck-against-the-ri]] @@ -189,7 +127,7 @@ the TCK Against the Compatible Implementation."] 2. If required, verify that you have completed the steps in link:config.html#GCLIW[Section 4.3.2, "Deploying the Prebuilt Archives."] 3. 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."] [[GCLRZ]][[running-the-tck-against-a-vendors-implementation]] @@ -207,7 +145,7 @@ Repackage and Run the TCK Against the Vendor Implementation."] link:config.html#GCLIL[Section 4.3.3, "Deploying the Test Applications Against the Vendor Implementation."] 3. 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."] [[GBFVK]][[test-reports]] @@ -216,108 +154,5 @@ of the Tests."] ~~~~~~~~~~~~~~~~ A set of report files is created for every test run. These report files -can be found in the report directory you specify. After a test run is -completed, the JavaTest harness writes HTML reports for the test run. -You can view these files in the JavaTest ReportBrowser when running in -GUI mode, or in the web browser of your choice outside the JavaTest -interface. - -To see all of the HTML report files, enter the URL of the `report.html` -file. This file is the root file that links to all of the other HTML -reports. - -The JavaTest harness also creates a `summary.txt` file in the report -directory that you can open in any text editor. The `summary.txt` file -contains a list of all tests that were run, their test results, and -their status messages. - -[[GBFWD]][[creating-test-reports]] - -5.5.1 Creating Test Reports -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Use the following modes to create test reports: - -* link:#GBFVH[Section 5.5.1.1, "To Create a Test Report in GUI Mode"] -* link:#GBFVC[Section 5.5.1.2, "To Create a Test Report in Command-Line Mode"] - -[[GBFVH]][[to-create-a-test-report-in-gui-mode]] - -5.5.1.1 To Create a Test Report in GUI Mode -+++++++++++++++++++++++++++++++++++++++++++ - -1. From the JavaTest main menu, click *Report*, then click *Create Report*. + -You are prompted to specify a directory to use for your test reports. -2. Specify the directory you want to use for your reports, and then -click *OK*. + -Use the Filter list to specify whether you want to generate reports for -the current configuration, all tests, or a custom set of tests. + -You are asked whether you want to view report now. -3. Click *Yes* to display the new report in the JavaTest ReportBrowser. - -[[GBFVC]][[to-create-a-test-report-in-command-line-mode]] - -5.5.1.2 To Create a Test Report in Command-Line Mode -++++++++++++++++++++++++++++++++++++++++++++++++++++ - -1. Specify where you want to create the test report. -a. To specify the report directory from the command line at runtime, -use: -+ -[source] ----- -ant -Dreport.dir="report_dir" ----- -+ -Reports are written for the last test run to the directory you specify. -2. To specify the default report directory, set the `report.dir` -property in +{jteFileName}+. + -For example: -+ -[source] ----- -report.dir="/home/josephine/reports" ----- -+ -3. To disable reporting, set the `report.dir` property to `"none"`, -either on the command line or in +{jteFileName}+. + -For example: -+ -[source] ----- -ant -Dreport.dir="none" ----- -+ - -[[GBFVB]][[viewing-an-existing-test-report]] - -5.5.2 Viewing an Existing Test Report -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Use the following modes to view an existing test report: - -* link:#GBFVO[Section 5.5.2.1, "To View an Existing Report in GUI Mode"] -* link:#GBFWB[Section 5.5.2.2, "To View an Existing Report in -Command-Line Mode"] - -[[GBFVO]][[to-view-an-existing-report-in-gui-mode]] - -5.5.2.1 To View an Existing Report in GUI Mode -++++++++++++++++++++++++++++++++++++++++++++++ - -1. From the JavaTest main menu, click *Report*, then click *Open Report*. + -You are prompted to specify the directory containing the report you want -to open. -2. Select the report directory you want to open, and then click *Open*. + -The selected report set is opened in the JavaTest ReportBrowser. - -[[GBFWB]][[to-view-an-existing-report-in-command-line-mode]] - -5.5.2.2 To View an Existing Report in Command-Line Mode -+++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -Use the Web browser of your choice to view the `report.html` file in the -report directory you specified from the command line or in +{jteFileName}+. - -include::using.inc[] - +can be found in the target directory that the test is run. After a test run is +completed, the JUnit framework writes reports for the test run. diff --git a/tck/src/main/assembly/assembly.xml b/tck/src/main/assembly/assembly.xml index a5eda07..d707bab 100644 --- a/tck/src/main/assembly/assembly.xml +++ b/tck/src/main/assembly/assembly.xml @@ -50,11 +50,15 @@ docs 755 - assertions *.html *.txt + + ${project.basedir}/docs/tck-runner + tck-runner + 755 + ${project.basedir}/docs/userguide/target/generated-docs docs/pdf-usersguide diff --git a/tck/src/main/java/com/sun/ts/tests/annotations/CAJSigTestIT.java b/tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/CAJSigTestIT.java similarity index 99% rename from tck/src/main/java/com/sun/ts/tests/annotations/CAJSigTestIT.java rename to tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/CAJSigTestIT.java index 1b80ee9..7521cd1 100644 --- a/tck/src/main/java/com/sun/ts/tests/annotations/CAJSigTestIT.java +++ b/tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/CAJSigTestIT.java @@ -14,7 +14,7 @@ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 */ -package com.sun.ts.tests.annotations; +package ee.jakarta.tck.annotations.signaturetest; import java.util.ArrayList; import java.util.Properties; @@ -180,7 +180,7 @@ protected String[] getClasses() { /* * @class.setup_props: ts_home; sigTestClasspath, Location of ca jar files; - * ca.sig.generated; ca.sig.managedbean; ca.sig.postconstruct; + * ca.sig.generated; ca.sig.postconstruct; * ca.sig.priority; ca.sig.predestroy; ca.sig.resource; ca.sig.resources; * ca.sig.securitydeclareroles; ca.sig.securitydenyall; * ca.sig.securitypermitall; ca.sig.securityrolesallowed; diff --git a/tck/src/main/java/com/sun/ts/tests/annotations/PackageList.java b/tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/PackageList.java similarity index 99% rename from tck/src/main/java/com/sun/ts/tests/annotations/PackageList.java rename to tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/PackageList.java index 8129964..9c99a01 100644 --- a/tck/src/main/java/com/sun/ts/tests/annotations/PackageList.java +++ b/tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/PackageList.java @@ -18,7 +18,7 @@ * $Id$ */ -package com.sun.ts.tests.annotations; +package ee.jakarta.tck.annotations.signaturetest; import java.io.BufferedReader; import java.io.BufferedWriter; diff --git a/tck/src/main/java/com/sun/ts/tests/annotations/SigTest.java b/tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/SigTest.java similarity index 99% rename from tck/src/main/java/com/sun/ts/tests/annotations/SigTest.java rename to tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/SigTest.java index 873bb06..fec8952 100644 --- a/tck/src/main/java/com/sun/ts/tests/annotations/SigTest.java +++ b/tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/SigTest.java @@ -19,7 +19,7 @@ * $Id$ */ -package com.sun.ts.tests.annotations; +package ee.jakarta.tck.annotations.signaturetest; import java.io.BufferedReader; import java.io.File; diff --git a/tck/src/main/java/com/sun/ts/tests/annotations/SigTestData.java b/tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/SigTestData.java similarity index 96% rename from tck/src/main/java/com/sun/ts/tests/annotations/SigTestData.java rename to tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/SigTestData.java index 7e07b7a..fc02f33 100644 --- a/tck/src/main/java/com/sun/ts/tests/annotations/SigTestData.java +++ b/tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/SigTestData.java @@ -18,7 +18,7 @@ * $Id$ */ -package com.sun.ts.tests.annotations; +package ee.jakarta.tck.annotations.signaturetest; import java.util.Properties; diff --git a/tck/src/main/java/com/sun/ts/tests/annotations/SigTestDriver.java b/tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/SigTestDriver.java similarity index 99% rename from tck/src/main/java/com/sun/ts/tests/annotations/SigTestDriver.java rename to tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/SigTestDriver.java index f564d4e..4a4d14a 100644 --- a/tck/src/main/java/com/sun/ts/tests/annotations/SigTestDriver.java +++ b/tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/SigTestDriver.java @@ -14,7 +14,7 @@ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 */ -package com.sun.ts.tests.annotations; +package ee.jakarta.tck.annotations.signaturetest; import java.io.ByteArrayOutputStream; import java.io.File; diff --git a/tck/src/main/java/com/sun/ts/tests/annotations/SigTestResult.java b/tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/SigTestResult.java similarity index 98% rename from tck/src/main/java/com/sun/ts/tests/annotations/SigTestResult.java rename to tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/SigTestResult.java index bfe007f..515970b 100644 --- a/tck/src/main/java/com/sun/ts/tests/annotations/SigTestResult.java +++ b/tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/SigTestResult.java @@ -17,7 +17,7 @@ /* * $Id$ */ -package com.sun.ts.tests.annotations; +package ee.jakarta.tck.annotations.signaturetest; import java.io.Serializable; import java.util.ArrayList; diff --git a/tck/src/main/java/com/sun/ts/tests/annotations/SignatureTestDriver.java b/tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/SignatureTestDriver.java similarity index 99% rename from tck/src/main/java/com/sun/ts/tests/annotations/SignatureTestDriver.java rename to tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/SignatureTestDriver.java index 9f7e0f6..7eb62f8 100644 --- a/tck/src/main/java/com/sun/ts/tests/annotations/SignatureTestDriver.java +++ b/tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/SignatureTestDriver.java @@ -15,7 +15,7 @@ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 */ -package com.sun.ts.tests.annotations; +package ee.jakarta.tck.annotations.signaturetest; import java.io.File; import java.io.FileInputStream; diff --git a/tck/src/main/java/com/sun/ts/tests/annotations/SignatureTestDriverFactory.java b/tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/SignatureTestDriverFactory.java similarity index 97% rename from tck/src/main/java/com/sun/ts/tests/annotations/SignatureTestDriverFactory.java rename to tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/SignatureTestDriverFactory.java index f8ff45a..708ddaa 100644 --- a/tck/src/main/java/com/sun/ts/tests/annotations/SignatureTestDriverFactory.java +++ b/tck/src/main/java/ee/jakarta/tck/annotations/signaturetest/SignatureTestDriverFactory.java @@ -18,7 +18,7 @@ * $Id$ */ -package com.sun.ts.tests.annotations; +package ee.jakarta.tck.annotations.signaturetest; /** *

diff --git a/tck/src/main/resources/com/sun/ts/tests/annotations/jakarta.annotation.sig_3.0 b/tck/src/main/resources/ee/jakarta/tck/annotations/signaturetest/jakarta.annotation.sig_3.0 similarity index 100% rename from tck/src/main/resources/com/sun/ts/tests/annotations/jakarta.annotation.sig_3.0 rename to tck/src/main/resources/ee/jakarta/tck/annotations/signaturetest/jakarta.annotation.sig_3.0 diff --git a/tck/src/main/resources/com/sun/ts/tests/annotations/sig-test-pkg-list.txt b/tck/src/main/resources/ee/jakarta/tck/annotations/signaturetest/sig-test-pkg-list.txt similarity index 100% rename from tck/src/main/resources/com/sun/ts/tests/annotations/sig-test-pkg-list.txt rename to tck/src/main/resources/ee/jakarta/tck/annotations/signaturetest/sig-test-pkg-list.txt diff --git a/tck/src/main/resources/com/sun/ts/tests/annotations/sig-test.map b/tck/src/main/resources/ee/jakarta/tck/annotations/signaturetest/sig-test.map similarity index 100% rename from tck/src/main/resources/com/sun/ts/tests/annotations/sig-test.map rename to tck/src/main/resources/ee/jakarta/tck/annotations/signaturetest/sig-test.map