Feature/2.x/mongodb next gg (#2486)

* Add module log4j-mongodb to track the current MongoDB driver (currently
version 5)

- Work around `PluginProcessor` restrictions.
- The `PluginProcessor` assumes that the factory method of a
`@Plugin`-annotated class returns an instance of the class itself.
- We workaround the problem adding an `implements NoSqlProvider` clause
to
the `MongoDbProvider` class.

* Deprecate the log4j-mongodb4 module in favor of log4j-mongodb

* Remove module log4j-mongodb3, use log4j-mongodb instead

Note: log4j-mongodb4 is deprecated for removal

* Deprecate the log4j-mongodb4 module in favor of log4j-mongodb

* Bump MongoDB version to test from 4.4 to 7.0.8

Co-authored-by: Piotr P. Karwasz <[email protected]>

* Update package-info.java

* Fix compilation

* Bump tests from MongoDB Server 4.4 to 7.0

* Use AB order in modules

---------

Co-authored-by: Piotr P. Karwasz <[email protected]>

Author: garydgregory

log4j-mongodb3/.log4j-plugin-processing-activator log4j-mongodb/.log4j-plugin-processing-activator

@@ -16,69 +16,57 @@
   ~ 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-mongodb3</artifactId>
-
-  <name>Apache Log4j MongoDB 3</name>
-  <description>MongoDB appender for Log4j using the MongoDB 3 driver API.</description>
-
+  <artifactId>log4j-mongodb</artifactId>
+  <name>Apache Log4j MongoDB Appender</name>
+  <description>MongoDB appender for Log4j using the MongoDB 5 driver API.</description>
   <properties>
-
-    <!--
-      ~ OSGi and JPMS options
-      -->
-    <bnd-extra-module-options>
-      <!-- Filebased module names: MUST be static -->
-      mongodb.driver.legacy;substitute="mongodb-driver-legacy";static=true;transitive=false
-    </bnd-extra-module-options>
+    <!-- OSGi and JPMS options -->
     <Fragment-Host>org.apache.logging.log4j.core</Fragment-Host>
-
     <!-- Dependency versions -->
-    <mongodb3.version>3.12.14</mongodb3.version>
+    <mongodb5.version>5.0.1</mongodb5.version>
+    <!-- TODO: Remove in next release after 2.24.0. -->
+    <bnd.baseline.fail.on.missing>false</bnd.baseline.fail.on.missing>
+    <bnd.baseline.skip>true</bnd.baseline.skip>
   </properties>
-
   <dependencyManagement>
     <dependencies>
       <dependency>
         <groupId>org.mongodb</groupId>
         <artifactId>bson</artifactId>
-        <version>${mongodb3.version}</version>
+        <version>${mongodb5.version}</version>
       </dependency>
       <dependency>
         <groupId>org.mongodb</groupId>
         <artifactId>mongodb-driver-core</artifactId>
-        <version>${mongodb3.version}</version>
+        <version>${mongodb5.version}</version>
       </dependency>
       <dependency>
         <groupId>org.mongodb</groupId>
         <artifactId>mongodb-driver-legacy</artifactId>
-        <version>${mongodb3.version}</version>
+        <version>${mongodb5.version}</version>
       </dependency>
       <dependency>
         <groupId>org.mongodb</groupId>
         <artifactId>mongodb-driver-sync</artifactId>
-        <version>${mongodb3.version}</version>
+        <version>${mongodb5.version}</version>
       </dependency>
     </dependencies>
   </dependencyManagement>
-
   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j</groupId>
       <artifactId>log4j-api</artifactId>
     </dependency>
     <dependency>
       <groupId>org.apache.logging.log4j</groupId>
-      <artifactId>log4j-core</artifactId>
+      <artifactId>log4j-mongodb4</artifactId>
     </dependency>
     <dependency>
       <groupId>org.mongodb</groupId>
@@ -88,10 +76,6 @@
       <groupId>org.mongodb</groupId>
       <artifactId>mongodb-driver-core</artifactId>
     </dependency>
-    <dependency>
-      <groupId>org.mongodb</groupId>
-      <artifactId>mongodb-driver-legacy</artifactId>
-    </dependency>
     <dependency>
       <groupId>org.mongodb</groupId>
       <artifactId>mongodb-driver-sync</artifactId>
@@ -144,10 +128,8 @@
       <scope>test</scope>
     </dependency>
   </dependencies>
-
   <build>
     <plugins>
-
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-surefire-plugin</artifactId>
@@ -163,8 +145,6 @@
           </dependency>
         </dependencies>
       </plugin>
-
     </plugins>
   </build>
-
 </project>

log4j-mongodb3/pom.xml log4j-mongodb/pom.xml

@@ -0,0 +1,46 @@
+/*
+ * 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.
+ */
+package org.apache.logging.log4j.mongodb;
+
+import org.apache.logging.log4j.core.Core;
+import org.apache.logging.log4j.core.appender.nosql.NoSqlProvider;
+import org.apache.logging.log4j.core.config.plugins.Plugin;
+import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;
+import org.apache.logging.log4j.mongodb4.MongoDb4Connection;
+import org.apache.logging.log4j.mongodb4.MongoDb4Provider;
+import org.apache.logging.log4j.mongodb4.MongoDb4Provider.Builder;
+
+/**
+ * Delegates to {@link MongoDb4Provider} under the name {@code MongoDb}.
+ */
+/*
+ * TODO: Currently the
+ *   {@link org.apache.logging.log4j.core.config.plugins.processor.PluginProcessor}
+ *   assumes that the class generated by the plugin is the same as the annotated class.
+ *   To work around this we declare this class abstract and let it implement
+ *   {@link NoSqlProvider}.
+ */
+@Plugin(name = "MongoDb", category = Core.CATEGORY_NAME, printObject = true)
+public abstract class MongoDbProvider implements NoSqlProvider<MongoDb4Connection> {
+
+    private MongoDbProvider() {}
+
+    @PluginBuilderFactory
+    public static <B extends Builder<B>> B newBuilder() {
+        return MongoDb4Provider.newBuilder();
+    }
+}

log4j-mongodb/src/main/java/org/apache/logging/log4j/mongodb/MongoDbProvider.java

@@ -15,12 +15,13 @@
  * limitations under the license.
  */
 /**
- * The classes in this package contain the MongoDB provider for the NoSQL Appender.
+ * The classes in this package contain the MongoDB provider for the NoSQL
+ * Appender.
  */
 @Export
 @Open("org.apache.logging.log4j.core")
-@Version("2.20.1")
-package org.apache.logging.log4j.mongodb3;
+@Version("2.24.0")
+package org.apache.logging.log4j.mongodb;
 
 import aQute.bnd.annotation.jpms.Open;
 import org.osgi.annotation.bundle.Export;

log4j-mongodb3/src/main/java/org/apache/logging/log4j/mongodb3/package-info.java log4j-mongodb/src/main/java/org/apache/logging/log4j/mongodb/package-info.java

@@ -14,29 +14,26 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.logging.log4j.mongodb3;
+package org.apache.logging.log4j.mongodb;
 
-import com.mongodb.MongoClient;
+import com.mongodb.client.MongoClient;
 import com.mongodb.client.MongoCollection;
 import com.mongodb.client.MongoDatabase;
 import org.apache.logging.log4j.Logger;
 import org.apache.logging.log4j.core.LoggerContext;
-import org.apache.logging.log4j.core.test.junit.LoggerContextSource;
 import org.bson.Document;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 
-@UsingMongoDb3
-@LoggerContextSource("log4j2-mongodb-capped.xml")
-public class MongoDb3CappedTest {
+public abstract class AbstractMongoDbCappedTest {
 
     @Test
     public void test(final LoggerContext ctx, final MongoClient mongoClient) {
-        final Logger logger = ctx.getLogger(MongoDb3CappedTest.class);
+        final Logger logger = ctx.getLogger(AbstractMongoDbCappedTest.class);
         logger.info("Hello log");
-        final MongoDatabase database = mongoClient.getDatabase(MongoDb3TestConstants.DATABASE_NAME);
+        final MongoDatabase database = mongoClient.getDatabase(MongoDbTestConstants.DATABASE_NAME);
         Assertions.assertNotNull(database);
-        final MongoCollection<Document> collection = database.getCollection(MongoDb3TestConstants.COLLECTION_NAME);
+        final MongoCollection<Document> collection = database.getCollection(MongoDbTestConstants.COLLECTION_NAME);
         Assertions.assertNotNull(collection);
         final Document first = collection.find().first();
         Assertions.assertNotNull(first);

log4j-mongodb3/src/test/java/org/apache/logging/log4j/mongodb3/MongoDb3CappedTest.java log4j-mongodb/src/test/java/org/apache/logging/log4j/mongodb/AbstractMongoDbCappedTest.java

@@ -14,13 +14,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.logging.log4j.mongodb3;
+package org.apache.logging.log4j.mongodb;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 
-import com.mongodb.MongoClient;
 import com.mongodb.client.FindIterable;
+import com.mongodb.client.MongoClient;
 import com.mongodb.client.MongoCollection;
 import com.mongodb.client.MongoDatabase;
 import org.apache.logging.log4j.Logger;
@@ -29,18 +29,18 @@
 import org.bson.Document;
 import org.junit.jupiter.api.Test;
 
-@UsingMongoDb3
+@UsingMongoDb
 @LoggerContextSource("log4j2-mongodb-additional-fields.xml")
-public class MongoDb3AdditionalFieldsTest {
+public class MongoDbAdditionalFieldsTest {
 
     @Test
     public void test(final LoggerContext ctx, final MongoClient mongoClient) {
-        final Logger logger = ctx.getLogger(MongoDb3AdditionalFieldsTest.class);
+        final Logger logger = ctx.getLogger(MongoDbAdditionalFieldsTest.class);
         logger.info("Hello log 1");
         logger.info("Hello log 2", new RuntimeException("Hello ex 2"));
-        final MongoDatabase database = mongoClient.getDatabase(MongoDb3TestConstants.DATABASE_NAME);
+        final MongoDatabase database = mongoClient.getDatabase(MongoDbTestConstants.DATABASE_NAME);
         assertNotNull(database);
-        final MongoCollection<Document> collection = database.getCollection(MongoDb3TestConstants.COLLECTION_NAME);
+        final MongoCollection<Document> collection = database.getCollection(MongoDbTestConstants.COLLECTION_NAME);
         assertNotNull(collection);
         final FindIterable<Document> found = collection.find();
         final Document first = found.first();

log4j-mongodb3/src/test/java/org/apache/logging/log4j/mongodb3/MongoDb3AdditionalFieldsTest.java log4j-mongodb/src/test/java/org/apache/logging/log4j/mongodb/MongoDbAdditionalFieldsTest.java

@@ -14,12 +14,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.logging.log4j.mongodb3;
+package org.apache.logging.log4j.mongodb;
 
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertNull;
 
-import com.mongodb.MongoClient;
+import com.mongodb.client.MongoClient;
 import com.mongodb.client.MongoCollection;
 import com.mongodb.client.MongoDatabase;
 import org.apache.logging.log4j.Logger;
@@ -28,17 +28,17 @@
 import org.bson.Document;
 import org.junit.jupiter.api.Test;
 
-@UsingMongoDb3
+@UsingMongoDb
 @LoggerContextSource("log4j2-mongodb-auth-failure.xml")
-public class MongoDb3AuthFailureTest {
+public class MongoDbAuthFailureTest {
 
     @Test
     public void test(final LoggerContext ctx, final MongoClient mongoClient) {
-        final Logger logger = ctx.getLogger(MongoDb3AuthFailureTest.class);
+        final Logger logger = ctx.getLogger(MongoDbAuthFailureTest.class);
         logger.info("Hello log");
-        final MongoDatabase database = mongoClient.getDatabase(MongoDb3TestConstants.DATABASE_NAME);
+        final MongoDatabase database = mongoClient.getDatabase(MongoDbTestConstants.DATABASE_NAME);
         assertNotNull(database);
-        final MongoCollection<Document> collection = database.getCollection(MongoDb3TestConstants.DATABASE_NAME);
+        final MongoCollection<Document> collection = database.getCollection(MongoDbTestConstants.DATABASE_NAME);
         assertNotNull(collection);
         final Document first = collection.find().first();
         assertNull(first);

log4j-mongodb3/src/test/java/org/apache/logging/log4j/mongodb3/MongoDb3AuthFailureTest.java log4j-mongodb/src/test/java/org/apache/logging/log4j/mongodb/MongoDbAuthFailureTest.java

@@ -0,0 +1,26 @@
+/*
+ * 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.
+ */
+package org.apache.logging.log4j.mongodb;
+
+import org.apache.logging.log4j.core.test.junit.LoggerContextSource;
+
+@UsingMongoDb
+@LoggerContextSource("log4j2-mongodb-capped-int.xml")
+public class MongoDbCappedIntTest extends AbstractMongoDbCappedTest {
+
+    // test is in superclass
+}

log4j-mongodb/src/test/java/org/apache/logging/log4j/mongodb/MongoDbCappedIntTest.java

@@ -0,0 +1,26 @@
+/*
+ * 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.
+ */
+package org.apache.logging.log4j.mongodb;
+
+import org.apache.logging.log4j.core.test.junit.LoggerContextSource;
+
+@UsingMongoDb
+@LoggerContextSource("log4j2-mongodb-capped-long.xml")
+public class MongoDbCappedLongTest extends AbstractMongoDbCappedTest {
+
+    // test is in superclass
+}

log4j-mongodb/src/test/java/org/apache/logging/log4j/mongodb/MongoDbCappedLongTest.java

@@ -14,9 +14,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.logging.log4j.mongodb3;
+package org.apache.logging.log4j.mongodb;
 
-import com.mongodb.MongoClient;
+import com.mongodb.client.MongoClient;
 import com.mongodb.client.MongoCollection;
 import com.mongodb.client.MongoDatabase;
 import org.apache.logging.log4j.Logger;
@@ -27,20 +27,20 @@
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 
-@UsingMongoDb3
+@UsingMongoDb
 @LoggerContextSource("log4j2-mongodb-map-message.xml")
-public class MongoDb3MapMessageTest {
+public class MongoDbMapMessageTest {
 
     @Test
     public void test(final LoggerContext ctx, final MongoClient mongoClient) {
-        final Logger logger = ctx.getLogger(MongoDb3MapMessageTest.class);
+        final Logger logger = ctx.getLogger(MongoDbMapMessageTest.class);
         final MapMessage<?, Object> mapMessage = new MapMessage<>();
         mapMessage.with("SomeName", "SomeValue");
         mapMessage.with("SomeInt", 1);
         logger.info(mapMessage);
-        final MongoDatabase database = mongoClient.getDatabase(MongoDb3TestConstants.DATABASE_NAME);
+        final MongoDatabase database = mongoClient.getDatabase(MongoDbTestConstants.DATABASE_NAME);
         Assertions.assertNotNull(database);
-        final MongoCollection<Document> collection = database.getCollection(MongoDb3TestConstants.COLLECTION_NAME);
+        final MongoCollection<Document> collection = database.getCollection(MongoDbTestConstants.COLLECTION_NAME);
         Assertions.assertNotNull(collection);
         final Document first = collection.find().first();
         Assertions.assertNotNull(first);