Merge remote-tracking branch 'apache/main' into feature/main/remove-b…

…ridges

.github/generate-email.sh

@@ -38,10 +38,10 @@ fail_for_invalid_args() {
 # Constants
 PROJECT_NAME="Apache Log4j"
 PROJECT_ID="log4j"
-PROJECT_SITE="https://logging.apache.org/log4j/3.x"
+PROJECT_VERSION="$2"
+PROJECT_SITE="https://logging.apache.org/$PROJECT_ID"
 PROJECT_STAGING_SITE="${PROJECT_SITE/apache.org/staged.apache.org}"
 PROJECT_REPO="https://github.com/apache/logging-log4j2"
-PROJECT_VERSION="$2"
 COMMIT_ID="$3"
 PROJECT_DIST_URL="https://dist.apache.org/repos/dist/dev/logging/$PROJECT_ID/$PROJECT_VERSION"
 
@@ -54,8 +54,8 @@ RELEASE_NOTES_FILE="$SCRIPT_DIR/../target/generated-site/antora/modules/ROOT/pag
 
 dump_release_notes() {
     awk "f{print} /^Release date::/{f=1}" "$RELEASE_NOTES_FILE" \
-        | sed -r -e 's|'$PROJECT_REPO'/(issues|pull)/[0-9]+\[([0-9]+)\]|#\2|g
-                     s|https://github.com/([^/]+)/([^/]+)/(pull|issues)/([0-9]+)\[(\1/\2#\4)\]|\5|g'
+        | sed -r -e 's!'$PROJECT_REPO'/(issues|pull)/[0-9]+\[([0-9]+)\]!#\2!g
+                     s!https://github.com/([^/]+)/([^/]+)/(pull|issues)/([0-9]+)\[(\1/\2#\4)\]!\5!g'
 }
 
 case $1 in
@@ -67,13 +67,13 @@ Title: [VOTE] Release $PROJECT_NAME \`$PROJECT_VERSION\`
 
 This is a vote to release the $PROJECT_NAME \`$PROJECT_VERSION\`.
 
-Website: $PROJECT_STAGING_SITE-$PROJECT_VERSION
+Website: $PROJECT_STAGING_SITE/$PROJECT_VERSION/index.html
 GitHub: $PROJECT_REPO
 Commit: $COMMIT_ID
 Distribution: $PROJECT_DIST_URL
 Nexus: https://repository.apache.org/content/repositories/orgapachelogging-<FIXME>
 Signing key: 0x077e8893a6dcc33dd4a4d5b256e73ba9a0b592d0
-Review kit: https://s.apache.org/logging-parent-release-review-kit
+Review kit: https://logging.apache.org/logging-parent/release-review-instructions.html
 
 Please download, test, and cast your votes on this mailing list.
 
@@ -103,7 +103,7 @@ and components to assist the deployment for various use cases.
 For further information (support, download, etc.) see the project
 website[1].
 
-[1] $PROJECT_SITE
+[1] $PROJECT_SITE/3.x/index.html
 
 == Release Notes
 EOF

.github/workflows/build.yaml

@@ -30,7 +30,7 @@ jobs:
 
   build:
     if: github.actor != 'dependabot[bot]'
-    uses: apache/logging-parent/.github/workflows/build-reusable.yaml@rel/11.2.0
+    uses: apache/logging-parent/.github/workflows/build-reusable.yaml@rel/11.3.0
     secrets:
       DV_ACCESS_TOKEN: ${{ ! startsWith(github.ref_name, 'release/') && secrets.GE_ACCESS_TOKEN }}
     with:
@@ -41,7 +41,7 @@ jobs:
   deploy-snapshot:
     needs: build
     if: github.repository == 'apache/logging-log4j2' && github.ref_name == 'main'
-    uses: apache/logging-parent/.github/workflows/deploy-snapshot-reusable.yaml@rel/11.2.0
+    uses: apache/logging-parent/.github/workflows/deploy-snapshot-reusable.yaml@rel/11.3.0
     # Secrets for deployments
     secrets:
       NEXUS_USERNAME: ${{ secrets.NEXUS_USER }}
@@ -50,7 +50,7 @@ jobs:
   deploy-release:
     needs: build
     if: github.repository == 'apache/logging-log4j2' && startsWith(github.ref_name, 'release/')
-    uses: apache/logging-parent/.github/workflows/deploy-release-reusable.yaml@rel/11.2.0
+    uses: apache/logging-parent/.github/workflows/deploy-release-reusable.yaml@rel/11.3.0
     # Secrets for deployments
     secrets:
       GPG_SECRET_KEY: ${{ secrets.LOGGING_GPG_SECRET_KEY }}

.github/workflows/codeql-analysis.yaml

@@ -30,7 +30,7 @@ permissions: read-all
 jobs:
 
   analyze:
-    uses: apache/logging-parent/.github/workflows/codeql-analysis-reusable.yaml@rel/11.2.0
+    uses: apache/logging-parent/.github/workflows/codeql-analysis-reusable.yaml@rel/11.3.0
     with:
       java-version: 17
     # Permissions required to publish Security Alerts

.github/workflows/deploy-site.yaml

@@ -33,7 +33,7 @@ jobs:
 
   deploy-site-stg:
     if: github.repository == 'apache/logging-log4j2' && github.ref_name == 'main'
-    uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@rel/11.2.0
+    uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@rel/11.3.0
     # Secrets for committing the generated site
     secrets:
       GPG_SECRET_KEY: ${{ secrets.LOGGING_GPG_SECRET_KEY }}
@@ -51,7 +51,7 @@ jobs:
 
   deploy-site-pro:
     if: github.repository == 'apache/logging-log4j2' && github.ref_name == 'main-site-pro'
-    uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@rel/11.2.0
+    uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@rel/11.3.0
     # Secrets for committing the generated site
     secrets:
       GPG_SECRET_KEY: ${{ secrets.LOGGING_GPG_SECRET_KEY }}
@@ -81,7 +81,7 @@ jobs:
 
   deploy-site-rel:
     needs: export-version
-    uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@rel/11.2.0
+    uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@rel/11.3.0
     # Secrets for committing the generated site
     secrets:
       GPG_SECRET_KEY: ${{ secrets.LOGGING_GPG_SECRET_KEY }}

.github/workflows/develocity-publish-build-scans.yaml

@@ -29,10 +29,12 @@ jobs:
       actions: write
       pull-requests: write
     steps:
+
       - name: Setup Build Scan link capture
-        uses: gradle/develocity-actions/maven-setup@v1
+        uses: gradle/develocity-actions/maven-setup@9f1bf05334de7eb619731d5466c35a153742311d   # 1.2
+
       - name: Publish Build Scans
-        uses: gradle/develocity-actions/maven-publish-build-scan@v1
+        uses: gradle/develocity-actions/maven-publish-build-scan@9f1bf05334de7eb619731d5466c35a153742311d   # 1.2
         with:
           develocity-url: 'https://ge.apache.org'
           develocity-access-key: ${{ secrets.GE_ACCESS_TOKEN }}

.github/workflows/merge-dependabot.yaml

@@ -30,7 +30,7 @@ jobs:
 
   build:
     if: github.repository == 'apache/logging-log4j2' && github.event_name == 'pull_request_target' && github.actor == 'dependabot[bot]'
-    uses: apache/logging-parent/.github/workflows/build-reusable.yaml@rel/11.2.0
+    uses: apache/logging-parent/.github/workflows/build-reusable.yaml@rel/11.3.0
     secrets:
       DV_ACCESS_TOKEN: ${{ secrets.GE_ACCESS_TOKEN }}
     with:
@@ -39,7 +39,7 @@ jobs:
 
   merge-dependabot:
     needs: build
-    uses: apache/logging-parent/.github/workflows/merge-dependabot-reusable.yaml@rel/11.2.0
+    uses: apache/logging-parent/.github/workflows/merge-dependabot-reusable.yaml@rel/11.3.0
     permissions:
       contents: write                                             # to push changelog commits
       pull-requests: write                                        # to close the PR

BUILDING.adoc

@@ -52,6 +52,13 @@ To remedy this, you can execute the following:
 printf '127.0.0.1 %s\n::1 %s\n' `hostname` `hostname` | sudo tee -a /etc/hosts
 ----
 
+[#docker]
+=== Docker tests
+
+Certain tests use Docker to spawn necessary external services.
+Docker tests are configured using the `docker` Maven profile, which is activated by default for the CI environment.
+You can locally enable this profile by passing a `-P docker` argument to your `./mvnw` commands.
+
 [#website]
 == Building the website
 
@@ -108,23 +115,32 @@ You can follow below steps for casual development needs:
 ./mvnw verify -DskipTests -pl :log4j-core,:log4j-core-test
 ----
 
-[TIP]
-====
+[#development-ide-debug]
+=== Debugging `./mvnw test` with IDE
+
 You can connect your IDE to a `./mvnw test` run by
 
 . Run `./mvnw test -pl :log4j-core-test -Dtest=FooBarTest -Dmaven.surefire.debug`
 . Use _"Run > Attach to process"_ in IntelliJ IDEA
-====
 
-[#development-faq]
-=== F.A.Q
+[#development-ci]
+=== Activating CI profiles
+
+There are certain Maven profiles activated only for CI.
+As a consequence of this, you can observe certain CI failures that you can't reproduce locally.
+To work around this, you can activate CI profiles by running Maven commands as follows:
+
+[source,bash]
+----
+CI=true ./mvnw ...
+----
 
 [#development-faq-idea-plugin-not-found]
-==== Compilation in IntelliJ IDEA fails with `java: plug-in not found: ErrorProne`
+=== Compilation in IntelliJ IDEA fails with `java: plug-in not found: ErrorProne`
 
 Try removing all _"Override compiler parameters per-module"_ entries in _"Settings > Build, Execution, Deployment > Compiler > Java Compiler"_.
 
 [#development-faq-idea-package-plugins]
-==== Compilation in IntelliJ IDEA fails with `java: package org.apache.logging.log4j.plugins.test.validation.plugins does not exist`
+=== Compilation in IntelliJ IDEA fails with `java: package org.apache.logging.log4j.plugins.test.validation.plugins does not exist`
 
 We don't know how to fix this.

log4j-async-logger/src/test/java/org/apache/logging/log4j/async/logger/AsyncLoggerConfigTest.java

@@ -111,7 +111,8 @@ public void testSingleFilterInvocation() {
         disruptor.start();
         try {
             config.log(FQCN, FQCN, null, Level.INFO, new SimpleMessage(), null);
-            verify(appender, timeout(100).times(1)).append(any());
+            // If this fails, the log event might not have reached the asynchronous thread yet
+            verify(appender, timeout(1000).times(1)).append(any());
             verify(filter, times(1)).filter(any());
         } finally {
             disruptor.stop();

log4j-compress/.log4j-plugin-processing-activator

@@ -0,0 +1 @@
+This file is here to activate the `plugin-processing` Maven profile.

log4j-compress/pom.xml

@@ -0,0 +1,177 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Licensed to the Apache Software Foundation (ASF) under one or more
+  ~ contributor license agreements.  See the NOTICE file distributed with
+  ~ this work for additional information regarding copyright ownership.
+  ~ The ASF licenses this file to you under the Apache License, Version 2.0
+  ~ (the "License"); you may not use this file except in compliance with
+  ~ the License.  You may obtain a copy of the License at
+  ~
+  ~      http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>org.apache.logging.log4j</groupId>
+    <artifactId>log4j</artifactId>
+    <version>${revision}</version>
+    <relativePath>../log4j-parent</relativePath>
+  </parent>
+
+  <artifactId>log4j-compress</artifactId>
+  <name>Apache Log4j Core: Extended Compression Support</name>
+  <description>Add additional compression formats to Log4j Core.</description>
+
+  <properties>
+    <commons-compress.version>1.27.1</commons-compress.version>
+    <jimfs.version>1.3.0</jimfs.version>
+    <xz.version>1.10</xz.version>
+    <zstd.version>1.5.6-6</zstd.version>
+  </properties>
+
+  <dependencyManagement>
+    <dependencies>
+
+      <!-- Dummy dependency to force Dependabot to upgrade this entry -->
+      <dependency>
+        <groupId>org.tukaani</groupId>
+        <artifactId>xz</artifactId>
+        <version>${xz.version}</version>
+      </dependency>
+
+      <!-- Dummy dependency to force Dependabot to upgrade this entry -->
+      <dependency>
+        <groupId>com.github.luben</groupId>
+        <artifactId>zstd-jni</artifactId>
+        <version>${zstd.version}</version>
+      </dependency>
+
+    </dependencies>
+  </dependencyManagement>
+
+  <dependencies>
+
+    <dependency>
+      <groupId>org.apache.commons</groupId>
+      <artifactId>commons-compress</artifactId>
+      <version>${commons-compress.version}</version>
+    </dependency>
+
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-api</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-core</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-plugins</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>org.assertj</groupId>
+      <artifactId>assertj-core</artifactId>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-api</artifactId>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-params</artifactId>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>com.google.jimfs</groupId>
+      <artifactId>jimfs</artifactId>
+      <version>${jimfs.version}</version>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-api-test</artifactId>
+      <scope>test</scope>
+    </dependency>
+
+  </dependencies>
+
+  <build>
+    <plugins>
+
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>default-test</id>
+            <configuration>
+              <excludes>
+                <exclude>org/apache/logging/log4j/compress/commons/xz/*</exclude>
+                <exclude>org/apache/logging/log4j/compress/commons/zstd/*</exclude>
+              </excludes>
+            </configuration>
+          </execution>
+          <!--
+            ~ The XZ algorithm requires additional Commons Compress dependencies
+            -->
+          <execution>
+            <id>test-xz</id>
+            <goals>
+              <goal>test</goal>
+            </goals>
+            <configuration>
+              <additionalClasspathDependencies>
+                <dependency>
+                  <groupId>org.tukaani</groupId>
+                  <artifactId>xz</artifactId>
+                  <version>${xz.version}</version>
+                </dependency>
+              </additionalClasspathDependencies>
+              <includes>
+                <include>org/apache/logging/log4j/compress/commons/xz/*Test.class</include>
+              </includes>
+            </configuration>
+          </execution>
+          <!--
+  ~ The XZ algorithm requires additional Commons Compress dependencies
+  -->
+          <execution>
+            <id>test-zstd</id>
+            <goals>
+              <goal>test</goal>
+            </goals>
+            <configuration>
+              <additionalClasspathDependencies>
+                <dependency>
+                  <groupId>com.github.luben</groupId>
+                  <artifactId>zstd-jni</artifactId>
+                  <version>${zstd.version}</version>
+                </dependency>
+              </additionalClasspathDependencies>
+              <includes>
+                <include>org/apache/logging/log4j/compress/commons/zstd/*Test.class</include>
+              </includes>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+
+    </plugins>
+  </build>
+</project>