Prepare for the 4.1.0.RC1 release (#562)

* Drop the unused eclipse ide sections in doc * add logging to weld embedded profile of tck runner * Fix the wildfly updater pom * Towards RC1, updated dist build docs and cleaned up the TCK reference guide * Rename the Configuration CdiLiteMode to CoreMode Fixes #561 * Allow the distribution license to be specified via license.file property * Remove unused lib dir * Update to cdi.api.version 4.1.0.RC1 --------- Signed-off-by: Scott M Stark <[email protected]>
jakartaee · Mar 1, 2024 · 3e192dd · 3e192dd
1 parent 56df9db
commit 3e192dd
Show file tree

Hide file tree

Showing 30 changed files with 172 additions and 429 deletions.
diff --git a/api/src/main/java/org/jboss/cdi/tck/api/Configuration.java b/api/src/main/java/org/jboss/cdi/tck/api/Configuration.java
@@ -29,14 +29,14 @@
  * Porting package property names are the FQCN of the SPI class. Other property names (one for each non-porting package SPI
  * configuration option) are specified here.
  *
- * The TCK may also be configured programatically through this interface.
+ * The TCK may also be configured programmatically through this interface.
  *
  * @author Pete Muir
  * @author Martin Kouba
  */
 public interface Configuration {
 
-    public static final String CDI_LITE_MODE = "org.jboss.cdi.tck.cdiLiteMode";
+    public static final String CDI_CORE_MODE = "org.jboss.cdi.tck.cdiCoreMode";
 
     public static final String LIBRARY_DIRECTORY_PROPERTY_NAME = "org.jboss.cdi.tck.libraryDirectory";
 
@@ -64,9 +64,9 @@ public interface Configuration {
      *
      * @return true if running in a CDI Lite environment
      */
-    public Boolean getCdiLiteMode();
+    public Boolean getCoreMode();
 
-    public void setCdiLiteMode(Boolean cdiLiteMode);
+    public void setCoreMode(Boolean cdiLiteMode);
 
     /**
      * The implementation of {@link Beans} in use.

diff --git a/dist-build/HOW-TO-BUILD.adoc b/dist-build/HOW-TO-BUILD.adoc
@@ -1,2 +1,21 @@
 = Jakarta CDI TCK dist-build
-This document describes how the dist-build functions to produce the CDI TCK distribution zip bundle.
+This document describes how the dist-build functions to produce the CDI TCK distribution zip bundle. In the description below, CDI_TCK_DIST refers to the root directory of the CDI TCK distribution zip after being unpacked. For example, for the 4.1.0 release it would be cdi-tck-4.1.0.
+
+== Files in dist-build
+- The src/main/assembly/assembly.xml defines how the distribution zip is put together from contents in the CDI TCK repo, and the Weld artifacts
+- The src/test/* tree is copied to the CDI_TCK_DIST/weld/jboss-tck-runner/src/test and is related to running the TCK against Weld and WildFly/Weld.
+- artifact-install.pom is installed as CDI_TCK_DIST/artifacts/pom.xml along with the TCK artifacts and its dependencies to allow one to install the TCK into a local maven repository.
+- jboss-as-updater.pom is bundled as CDI_TCK_DIST/weld/jboss-as/pom.xml and can be used to update a bare WildFly installation with the Weld version and Jakarta API artifacts that correspond to the versions used by the TCK.
+- jboss-runner.pom is bundled as CDI_TCK_DIST/weld/jboss-tck-runner/pom.xml and contains the profiles used to run the TCK against, Weld in embedded and se modes as well as inside of the WildFly container.
+- pom.xml - defines the distribution dependencies and the maven-assembly-plugin configuration
+- README.adoc is the CDI_TCK_DIST top level readme file that describes the distribution contents
+
+== Running the build
+To create the distribution, run the following from the project root:
+
+[source, console]
+----
+mvn -Drelease install
+----
+
+The distribution zip file will be found in the dist-build/target directory.
diff --git a/dist-build/README.adoc b/dist-build/README.adoc
@@ -3,9 +3,7 @@
 Jakarta Contexts and Dependency Injection (CDI) is a Jakarta standard for
 dependency injection and contextual lifecycle management. This is the TCK for CDI.
 
-This distribution, as a whole, is licensed under the terms of the Apache Public
-License, while the final distribution used for compatibility testing is under the EFTL. The
-bundled LICENSE file will dictate which license applies to the TCK distribution.
+This distribution, as a whole, is licensed under the terms of the Apache Public License, while the final distribution used for compatibility testing is under the EFTL. The bundled LICENSE file will dictate which license applies to the TCK distribution.
 
 This distribution consists of:
 
@@ -20,19 +18,15 @@ doc/
 
  – A detailed reference guide for the current version of TCK in both pdf and html formats
 
-lib/
-
- – Maven project to get all TCK dependencies
-
 weld/
 
- – TCK runner for using Weld (the CDI RI) with JBoss AS
+ – subdirectory for the sample TCK runner for using Weld (the CDI ratifying compatible implementation) standalone and with WildFly
 
-jboss-tck-runner/
+weld/jboss-tck-runner/
 
- – maven-based TCK runner for WildFly
+ – maven-based TCK runner for standalone Weld and with WildFly
 
-lang-model-tck-runner/
+weld/lang-model-tck-runner/
 
  - maven-based Language Model TCK runner for Weld and WildFly
 

diff --git a/dist-build/jboss-as-updater.pom b/dist-build/jboss-as-updater.pom
@@ -68,17 +68,17 @@
         <dependency>
             <groupId>jakarta.enterprise</groupId>
             <artifactId>jakarta.enterprise.cdi-api</artifactId>
-            <version>${cdi.tck.version}</version>
+            <version>${cdi.api.version}</version>
         </dependency>
         <dependency>
             <groupId>jakarta.enterprise</groupId>
             <artifactId>jakarta.enterprise.cdi-el-api</artifactId>
-            <version>${cdi.tck.version}</version>
+            <version>${cdi.api.version}</version>
         </dependency>
         <dependency>
             <groupId>jakarta.enterprise</groupId>
             <artifactId>jakarta.enterprise.lang-model</artifactId>
-            <version>${cdi.tck.version}</version>
+            <version>${cdi.api.version}</version>
         </dependency>
         <dependency>
             <groupId>jakarta.interceptor</groupId>
@@ -233,7 +233,7 @@
 
                                             Updating CDI module and Interceptors API module
 
-                                            CDI version: ${cdi.tck.version}
+                                            CDI version: ${cdi.api.version}
                                             Interceptors version: ${interceptors.api.version}
 
                                             JBOSS_HOME: ${jboss.home}
@@ -248,9 +248,9 @@
                                         <property name="module.dir" value="${jboss.home}/modules//system/layers/base/jakarta/enterprise/api" />
                                         <property name="module.interceptor.dir" value="${jboss.home}/modules//system/layers/base/jakarta/interceptor/api" />
 
-                                        <property name="cdi.api.file" value="jakarta.enterprise.cdi-api-${cdi.tck.version}.jar" />
-                                        <property name="cdi.el.api.file" value="jakarta.enterprise.cdi-el-api-${cdi.tck.version}.jar" />
-                                        <property name="cdi.lang.model.file" value="jakarta.enterprise.lang-model-${cdi.tck.version}.jar" />
+                                        <property name="cdi.api.file" value="jakarta.enterprise.cdi-api-${cdi.api.version}.jar" />
+                                        <property name="cdi.el.api.file" value="jakarta.enterprise.cdi-el-api-${cdi.api.version}.jar" />
+                                        <property name="cdi.lang.model.file" value="jakarta.enterprise.lang-model-${cdi.api.version}.jar" />
                                         <property name="interceptor.api.file" value="jakarta.interceptor-api-${interceptors.api.version}.jar" />
 
                                         <delete>

diff --git a/dist-build/jboss-runner.pom b/dist-build/jboss-runner.pom
@@ -319,6 +319,11 @@
           <groupId>org.wildfly.arquillian</groupId>
           <artifactId>wildfly-arquillian-common</artifactId>
         </dependency>
+        <dependency>
+          <groupId>org.jboss.logmanager</groupId>
+          <artifactId>jboss-logmanager</artifactId>
+          <version>3.0.4.Final</version>
+        </dependency>
       </dependencies>
       <build>
         <resources>
@@ -336,12 +341,10 @@
               <systemPropertyVariables>
                 <arquillian.launch>weld</arquillian.launch>
                 <arquillian.xml>weld-embedded-arquillian.xml</arquillian.xml>
+                <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
                 <!-- Specified system properties are not
                     available during in-container test execution -->
                 <org.jboss.cdi.tck.libraryDirectory>target/dependency/lib</org.jboss.cdi.tck.libraryDirectory>
-                <org.jboss.cdi.tck.testDataSource>java:jboss/datasources/ExampleDS</org.jboss.cdi.tck.testDataSource>
-                <!-- Travis CI build workaround -->
-                <argLine>${travis.surefire.argLine}</argLine>
               </systemPropertyVariables>
               <suiteXmlFiles>
                 <suiteXmlFile>target/suites/tck-core-suite.xml</suiteXmlFile>
@@ -472,10 +475,6 @@
           <version>${arquillian.version}</version>
           <scope>test</scope>
         </dependency>
-        <dependency>
-          <groupId>log4j</groupId>
-          <artifactId>log4j</artifactId>
-        </dependency>
       </dependencies>
       <build>
         <resources>
@@ -540,10 +539,6 @@
                 <!-- Specified system properties are not
                     available during in-container test execution -->
                 <org.jboss.cdi.tck.libraryDirectory>target/dependency/lib</org.jboss.cdi.tck.libraryDirectory>
-                <org.jboss.cdi.tck.testDataSource>java:jboss/datasources/ExampleDS</org.jboss.cdi.tck.testDataSource>
-                <org.jboss.cdi.tck.testJmsConnectionFactory>java:/ConnectionFactory</org.jboss.cdi.tck.testJmsConnectionFactory>
-                <org.jboss.cdi.tck.testJmsQueue>java:/queue/test</org.jboss.cdi.tck.testJmsQueue>
-                <org.jboss.cdi.tck.testJmsTopic>java:/topic/test</org.jboss.cdi.tck.testJmsTopic>
                 <jacoco.agent>${jacoco.agent}</jacoco.agent>
                 <!-- Specifiy any garbage collection related args here -->
                 <gc.args />

diff --git a/dist-build/lang-model-tck-runner/pom.xml b/dist-build/lang-model-tck-runner/pom.xml
@@ -6,7 +6,7 @@
     <description>An example pom for running the lang model against Weld and WildFly</description>
     <groupId>org.jboss.weld</groupId>
     <artifactId>lang-model-tck-runner</artifactId>
-    <version>4.0.5-SNAPSHOT</version>
+    <version>${cdi.tck.version}</version>
 
     <properties>
         <maven.compiler.source>11</maven.compiler.source>
@@ -19,7 +19,7 @@
             <dependency>
                 <groupId>jakarta.enterprise</groupId>
                 <artifactId>cdi-tck-lang-model</artifactId>
-                <version>${project.version}</version>
+                <version>${cdi.api.version}</version>
             </dependency>
             <dependency>
                 <groupId>org.jboss.weld</groupId>
@@ -51,7 +51,7 @@
             <dependency>
                 <groupId>org.wildfly.arquillian</groupId>
                 <artifactId>wildfly-arquillian-container-managed</artifactId>
-                <version>5.0.0.Alpha3</version>
+                <version>5.0.1.Final</version>
             </dependency>
             <dependency>
                 <groupId>org.jboss.arquillian.protocol</groupId>
@@ -83,7 +83,6 @@
         <dependency>
             <groupId>org.jboss.arquillian.junit</groupId>
             <artifactId>arquillian-junit-container</artifactId>
-            <version>${arquillian.version}</version>
             <scope>test</scope>
         </dependency>
 
@@ -170,9 +169,6 @@
             </dependencies>
             <build>
                 <resources>
-                    <resource>
-                        <directory>src/test/resources</directory>
-                    </resource>
                     <resource>
                         <directory>src/test/wildfly</directory>
                     </resource>
@@ -216,7 +212,6 @@
                             </argLine>
                             <properties>
                                 <property>
-                                    <!-- Note a 7.4.0 issue results in NPEs and useless output if you go higher than 1 here -->
                                     <name>surefire.testng.verbose</name>
                                     <value>0</value>
                                 </property>
@@ -228,7 +223,6 @@
                                 <!-- Specified system properties are not
                                 available during in-container test execution -->
                                 <org.jboss.cdi.tck.libraryDirectory>target/dependency/lib</org.jboss.cdi.tck.libraryDirectory>
-                                <org.jboss.cdi.tck.testDataSource>java:jboss/datasources/ExampleDS</org.jboss.cdi.tck.testDataSource>
                             </systemPropertyVariables>
                             <systemProperties>
                                 <jacoco.agent>${jacoco.agent}</jacoco.agent>
@@ -241,30 +235,6 @@
                             </systemProperties>
                         </configuration>
                     </plugin>
-                    <plugin>
-                        <groupId>org.apache.maven.plugins</groupId>
-                        <artifactId>maven-resources-plugin</artifactId>
-                        <executions>
-                            <execution>
-                                <id>copy-resources</id>
-                                <!-- perform this any time before the tests are executed -->
-                                <phase>validate</phase>
-                                <goals>
-                                    <goal>copy-resources</goal>
-                                </goals>
-                                <configuration>
-                                    <outputDirectory>${JBOSS_HOME}/standalone/configuration</outputDirectory>
-                                    <resources>
-                                        <resource>
-                                            <directory>${JBOSS_HOME}/docs/examples/configs</directory>
-                                            <includes>standalone-activemq-embedded.xml</includes>
-                                        </resource>
-                                    </resources>
-                                </configuration>
-                            </execution>
-                        </executions>
-                    </plugin>
-
                 </plugins>
             </build>
         </profile>

diff --git a/dist-build/lang-model-tck-runner/src/test/wildfly/arquillian.xml b/dist-build/lang-model-tck-runner/src/test/wildfly/arquillian.xml
@@ -10,8 +10,7 @@
 
     <container qualifier="wildfly-23" default="true">
         <configuration>
-            <!-- This config file includes embedded JMS broker and is copied into WFLY dir from ${JBOSS_HOME}/docs/examples/configs -->
-            <property name="serverConfig">standalone-activemq-embedded.xml</property>
+            <property name="serverConfig">standalone.xml</property>
             <property name="javaVmArguments">-Xms128m -Xmx1g -ea -DcdiTckExcludeDummy=true ${gc.args} ${additional.vm.args} ${jacoco.agent}</property>
             <property name="outputToConsole">false</property>
             <property name="allowConnectingToRunningServer">true</property>

diff --git a/dist-build/pom.xml b/dist-build/pom.xml
@@ -13,7 +13,14 @@
    <name>CDI TCK Distribution</name>
 
    <properties>
+      <!-- This property is used by the impl/src/resources/sigtest-weld-pom.xml file to allow the signature test
+            file to be set to the signature test file artifact included in the TCK distribution. When the
+            sigtest-weld-pom.xml is copied to the distribution artifacts/sigtest-weld-pom.xml this is used to
+            match the sigtest-maven-plugin sigfile configuration value to the generated sigtest artifact.
+      -->
       <sigtest.filename>cdi-tck-core-impl-${project.version}-sigtest-jdk17.sig</sigtest.filename>
+      <!-- Default to the apache license. Final builds should set this to EFTL.txt -->
+      <license.file>apl.txt</license.file>
    </properties>
 
    <dependencies>

diff --git a/dist-build/src/main/assembly/assembly.xml b/dist-build/src/main/assembly/assembly.xml
@@ -8,10 +8,11 @@
       <format>zip</format>
    </formats>
 
+   <!-- The files section is used for individual files and those files that need filter applied -->
    <files>
-      <!-- This is the final EFTL license -->
+      <!-- This is the license to use in the dist -->
       <file>
-         <source>EFTL.txt</source>
+         <source>${license.file}</source>
          <destName>LICENSE</destName>
       </file>
       <!-- The root artifact-install.pom gets installed as /artifacts/pom.xml in the dist to allow one to install
@@ -23,12 +24,15 @@
          <destName>pom.xml</destName>
          <filtered>true</filtered>
       </file>
+      <!-- Install the example signature test pom that validates that the Weld version referenced by the
+            TCK passes the signature tests.
+      -->
       <file>
          <source>${project.basedir}/../impl/src/main/resources/sigtest-weld-pom.xml</source>
          <outputDirectory>artifacts</outputDirectory>
          <filtered>true</filtered>
       </file>
-      <!--
+      <!-- Install the Weld and Weld/WildFly sample TCK runner pom with filtering to pickup the correct versions
       -->
       <file>
          <source>jboss-runner.pom</source>
@@ -51,14 +55,17 @@
       </file>
    </files>
 
+   <!-- The fileSets are for bulk copying that does not need filtering -->
    <fileSets>
+      <!-- The distribution root README file -->
       <fileSet>
          <directory>${project.basedir}</directory>
          <outputDirectory>/</outputDirectory>
          <includes>
             <include>README.adoc</include>
          </includes>
       </fileSet>
+      <!-- Copy the sample lang model TCK runner project. The pom.xml was added above with filtering. -->
       <fileSet>
          <directory>${project.basedir}/lang-model-tck-runner</directory>
          <outputDirectory>weld/lang-model-tck-runner</outputDirectory>
@@ -86,15 +93,6 @@
          <outputDirectory>artifacts</outputDirectory>
          <useProjectArtifact>false</useProjectArtifact>
       </dependencySet>
-      <dependencySet>
-         <includes>
-            <include>jakarta.enterprise:cdi-tck-dist-libs</include>
-         </includes>
-         <useTransitiveDependencies>false</useTransitiveDependencies>
-         <outputDirectory>/lib</outputDirectory>
-         <useProjectArtifact>false</useProjectArtifact>
-         <unpack>true</unpack>
-      </dependencySet>
       <dependencySet>
          <includes>
             <include>jakarta.enterprise:cdi-tck-reference-guide:zip</include>

diff --git a/dist-build/src/test/resources/logging.properties b/dist-build/src/test/resources/logging.properties
@@ -0,0 +1,36 @@
+# Additional loggers to configure (the root logger is always configured)
+loggers=org.jboss.weld,org.jboss.weld.Bootstrap
+
+logger.level=INFO
+logger.handlers=FILE,CONSOLE
+
+logger.org.jboss.weld.level=INFO
+logger.org.jboss.weld.useParentHandlers=true
+
+logger.org.jboss.weld.Bootstrap.level=INFO
+logger.org.jboss.weld.Bootstrap.useParentHandlers=true
+
+handler.CONSOLE=org.jboss.logmanager.handlers.ConsoleHandler
+handler.CONSOLE.level=INFO
+handler.CONSOLE.formatter=COLOR-PATTERN
+handler.CONSOLE.properties=autoFlush,target
+handler.CONSOLE.autoFlush=true
+handler.CONSOLE.target=SYSTEM_OUT
+
+handler.FILE=org.jboss.logmanager.handlers.PeriodicRotatingFileHandler
+handler.FILE.level=ALL
+handler.FILE.formatter=PATTERN
+handler.FILE.properties=autoFlush,append,fileName,suffix
+handler.FILE.constructorProperties=fileName,append
+handler.FILE.autoFlush=true
+handler.FILE.append=true
+handler.FILE.fileName=tck.log
+handler.FILE.suffix=.yyyy-MM-dd
+
+formatter.PATTERN=org.jboss.logmanager.formatters.PatternFormatter
+formatter.PATTERN.properties=pattern
+formatter.PATTERN.pattern=%d{yyyy-MM-dd HH\:mm\:ss,SSS} %-5p [%c] (%t) %s%e%n
+
+formatter.COLOR-PATTERN=org.jboss.logmanager.formatters.PatternFormatter
+formatter.COLOR-PATTERN.properties=pattern
+formatter.COLOR-PATTERN.pattern=%K{level}%d{HH\:mm\:ss,SSS} %-5p [%c] (%t) %s%e%n