EL TCK signature test , version and documentation update (#1214)

* EL signature test , version and documentation update * extract tck zip to get signature file * update el version in parent pom * update userguide versions * remove SNAPSHOT in tck version * correct tck version in userguide
jakartaee · Jan 11, 2024 · 7d92832 · 7d92832
1 parent e0f4b12
commit 7d92832
Show file tree

Hide file tree

Showing 10 changed files with 1,036 additions and 25 deletions.
diff --git a/el/docs/userguide/pom.xml b/el/docs/userguide/pom.xml
@@ -28,18 +28,18 @@
     <groupId>org.glassfish</groupId>
     <artifactId>tck_el</artifactId>
     <packaging>pom</packaging>
-    <version>5.0.0</version>
-    <name>Eclipse Foundation Technology Compatibility Kit User's Guide for Jakarta Expression Language for Jakarta EE, Release 5.0</name>
+    <version>6.0.0</version>
+    <name>Eclipse Foundation Technology Compatibility Kit User's Guide for Jakarta Expression Language for Jakarta EE, Release 6.0</name>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <site.output.dir>${project.build.directory}/staging</site.output.dir>
         <maven.site.skip>true</maven.site.skip>
         <asciidoctorj.version>2.4.2</asciidoctorj.version>
         <asciidoctorj.diagram.version>2.1.0</asciidoctorj.diagram.version>
-        <asciidoctorj.maven.plugin.version>2.1.0</asciidoctorj.maven.plugin.version>
+        <asciidoctorj.maven.plugin.version>2.2.4</asciidoctorj.maven.plugin.version>
         <asciidoctorj.pdf.version>1.5.3</asciidoctorj.pdf.version>
-        <jbake.maven.plugin.version>0.3.3</jbake.maven.plugin.version>
+        <jbake.maven.plugin.version>2.7.0-rc.7</jbake.maven.plugin.version>
         <freemarker.version>2.3.30</freemarker.version>
         <!-- status: DRAFT, BETA, etc., or blank for final -->
         <status></status>
@@ -82,8 +82,8 @@
                         <configuration>
                             <rules>
                                 <requireJavaVersion>
-                                    <version>[1.8.0,)</version>
-                                    <message>You need JDK8 or newer</message>
+                                    <version>[17,)</version>
+                                    <message>You need JDK17 or newer</message>
                                 </requireJavaVersion>
                             </rules>
                         </configuration>

diff --git a/el/docs/userguide/src/main/jbake/content/attributes.conf b/el/docs/userguide/src/main/jbake/content/attributes.conf
@@ -26,7 +26,7 @@
 :MavenVersion: 3.6.3+
 :JakartaEEVersion: 11
 :excludeListFileName: docs/TCK-Exclude-List.txt
-:TCKPackageName: jakarta-expression-language-tck-5.0.0.zip
+:TCKPackageName: jakarta-expression-language-tck-6.0.0.zip
 // Directory names used in examples in using.adoc.
 :sigTestDirectoryExample: com/sun/ts/tests/signaturetest/el
 :singleTestDirectoryExample: com/sun/ts/tests/el/api/client

diff --git a/el/docs/userguide/src/main/jbake/content/using-examples.inc b/el/docs/userguide/src/main/jbake/content/using-examples.inc
@@ -17,13 +17,31 @@ mvn verify
 
 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=com.sun.ts.tests.el.signaturetest.**
-----
+To run the {TechnologyShortName} TCK signature tests, use the 
+sigtest-maven-plugin in the TCK runner as below.
+
+=======================================================================
+<plugin>
+    <groupId>org.netbeans.tools</groupId>
+    <artifactId>sigtest-maven-plugin</artifactId>
+    <version>1.5</version>
+    <configuration>
+        <sigfile>path-to-sig-file-provided-with-TCK</sigfile>
+        <packages>jakarta.el</packages>
+        <classes>path-to-api-jar</classes>
+        <report>target/sig-report.txt</report>
+    </configuration>
+    <executions>
+        <execution>
+        <id>sigtest</id>
+        <goals>
+            <goal>check</goal>
+        </goals>
+        <phase>verify</phase>
+        </execution>
+    </executions>
+</plugin>
+=======================================================================
 
 [[GCMBV]]
 

diff --git a/el/docs/userguide/src/main/jbake/content/using.adoc b/el/docs/userguide/src/main/jbake/content/using.adoc
@@ -15,8 +15,8 @@ Executing Tests
 5 Executing Tests
 -----------------
 
-The {TechnologyShortName} TCK uses the Junit and Jboss Arquillian 
-frameworks to execute the tests.
+The {TechnologyShortName} TCK uses the Junit 
+framework to execute the tests.
 
 This chapter includes the following topics:
 
@@ -148,9 +148,32 @@ mvn verify -DexcludedGroups={groupsExample}
 The tests in the group +{groupsExample}+ is exclued from the run. 
 Multiple groups can be separated by comma.
 
+[[GBFVK]][[Running-Signature-Test]]
+
+5.3 Running Signature Test
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+sigtest-maven-plugin is used to run the EL signature test. Please refer the 
+sample provided in the platform TCK repository.
+
+[NOTE]
+=======================================================================
+
+Use below configuration while using sigtest-maven-plugin with goal as `check`.
+
+    <configuration>
+        <sigfile>path-to-sig-file-provided-with-TCK</sigfile>
+        <packages>jakarta.el</packages>
+        <classes><path-to-api-jar</classes>
+        <report>sig-report.txt</report>
+    </configuration>
+
+=======================================================================
+
+
 [[GCLRR]][[running-the-tck-against-the-ri]]
 
-5.3 Running the TCK Against another CI
+5.4 Running the TCK Against another CI
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Some test scenarios are designed to ensure that the configuration and deployment of
@@ -169,7 +192,7 @@ of the Tests."]
 
 [[GCLRZ]][[running-the-tck-against-a-vendors-implementation]]
 
-5.4 Running the TCK Against a Vendor's Implementation
+5.5 Running the TCK Against a Vendor's Implementation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 This test scenario is one of the compatibility test phases that all
@@ -187,7 +210,7 @@ of the Tests."]
 
 [[GBFVK]][[test-reports]]
 
-5.5 Test Reports
+5.6 Test Reports
 ~~~~~~~~~~~~~~~~
 
 A set of report files is created for every test run. These report files

diff --git a/el/pom.xml b/el/pom.xml
@@ -27,12 +27,16 @@
     </parent>
 
     <artifactId>jakarta-expression-language-tck</artifactId>
-    <version>6.0.0-SNAPSHOT</version>
+    <version>6.0.0</version>
     <packaging>jar</packaging>
 
     <name>el-tck</name>
     <description>EL TCK</description>
 
+    <properties>
+        <jakarta.el-api.version>6.0.0-M1</jakarta.el-api.version>
+    </properties>
+
     <dependencies>
         <dependency>
             <groupId>${project.groupId}</groupId>

diff --git a/el/src/main/assembly/assembly.xml b/el/src/main/assembly/assembly.xml
@@ -31,6 +31,10 @@
             <source>${project.basedir}/src/main/resources/LICENSE_${license}.md</source>
             <destName>LICENSE.md</destName>
         </file>
+        <file>
+            <source>${project.basedir}/src/main/resources/jakarta.el.sig_6.0</source>
+            <destName>jakarta.el.sig_6.0</destName>
+        </file>
     </files>
     <fileSets>
         <fileSet>