Review fixes for mongo-4.0:javaagent (#18212)

Co-authored-by: otelbot <197425009+otelbot@users.noreply.github.com>
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>

Author: otelbot[bot]

instrumentation/mongo/mongo-4.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/mongo/v4_0/Mongo4ReactiveClientTest.java

@@ -29,7 +29,6 @@
 import org.bson.BsonDocument;
 import org.bson.BsonString;
 import org.bson.Document;
-import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.extension.RegisterExtension;
 import org.reactivestreams.Subscriber;
@@ -47,13 +46,7 @@ class Mongo4ReactiveClientTest extends AbstractMongoClientTest<MongoCollection<D
   @BeforeAll
   void setup() {
     client = MongoClients.create("mongodb://" + host + ":" + port);
-  }
-
-  @AfterAll
-  void cleanup() {
-    if (client != null) {
-      client.close();
-    }
+    cleanup.deferAfterAll(client);
   }
 
   @Override
@@ -62,15 +55,16 @@ protected InstrumentationExtension testing() {
   }
 
   @Override
-  public void createCollection(String dbName, String collectionName) throws InterruptedException {
+  protected void createCollection(String dbName, String collectionName)
+      throws InterruptedException {
     MongoDatabase db = client.getDatabase(dbName);
     CountDownLatch latch = new CountDownLatch(1);
     db.createCollection(collectionName).subscribe(toSubscriber(o -> latch.countDown()));
     latch.await(30, SECONDS);
   }
 
   @Override
-  public void createCollectionNoDescription(String dbName, String collectionName)
+  protected void createCollectionNoDescription(String dbName, String collectionName)
       throws InterruptedException {
     MongoClient tmpClient = MongoClients.create("mongodb://" + host + ":" + port);
     cleanup.deferCleanup(tmpClient);
@@ -81,12 +75,13 @@ public void createCollectionNoDescription(String dbName, String collectionName)
   }
 
   @Override
-  public void createCollectionWithAlreadyBuiltClientOptions(String dbName, String collectionName) {
+  protected void createCollectionWithAlreadyBuiltClientOptions(
+      String dbName, String collectionName) {
     abort("not tested on 4.0");
   }
 
   @Override
-  public void createCollectionCallingBuildTwice(String dbName, String collectionName)
+  protected void createCollectionCallingBuildTwice(String dbName, String collectionName)
       throws InterruptedException {
     MongoClientSettings.Builder settings =
         MongoClientSettings.builder()
@@ -102,7 +97,7 @@ public void createCollectionCallingBuildTwice(String dbName, String collectionNa
   }
 
   @Override
-  public long getCollection(String dbName, String collectionName)
+  protected long getCollection(String dbName, String collectionName)
       throws ExecutionException, InterruptedException, TimeoutException {
     MongoDatabase db = client.getDatabase(dbName);
     CompletableFuture<Long> count = new CompletableFuture<>();
@@ -113,7 +108,7 @@ public long getCollection(String dbName, String collectionName)
   }
 
   @Override
-  public MongoCollection<Document> setupInsert(String dbName, String collectionName)
+  protected MongoCollection<Document> setupInsert(String dbName, String collectionName)
       throws InterruptedException {
     MongoCollection<Document> collection =
         testing()
@@ -132,7 +127,7 @@ public MongoCollection<Document> setupInsert(String dbName, String collectionNam
   }
 
   @Override
-  public long insert(MongoCollection<Document> collection) throws Exception {
+  protected long insert(MongoCollection<Document> collection) throws Exception {
     CompletableFuture<Long> count = new CompletableFuture<>();
     collection
         .insertOne(new Document("password", "SECRET"))
@@ -146,7 +141,7 @@ public long insert(MongoCollection<Document> collection) throws Exception {
   }
 
   @Override
-  public MongoCollection<Document> setupUpdate(String dbName, String collectionName)
+  protected MongoCollection<Document> setupUpdate(String dbName, String collectionName)
       throws InterruptedException {
     MongoCollection<Document> collection =
         testing()
@@ -170,7 +165,7 @@ public MongoCollection<Document> setupUpdate(String dbName, String collectionNam
   }
 
   @Override
-  public long update(MongoCollection<Document> collection) throws Exception {
+  protected long update(MongoCollection<Document> collection) throws Exception {
     CompletableFuture<UpdateResult> result = new CompletableFuture<>();
     CompletableFuture<Long> count = new CompletableFuture<>();
     collection
@@ -189,7 +184,7 @@ public long update(MongoCollection<Document> collection) throws Exception {
   }
 
   @Override
-  public MongoCollection<Document> setupDelete(String dbName, String collectionName)
+  protected MongoCollection<Document> setupDelete(String dbName, String collectionName)
       throws InterruptedException {
     MongoCollection<Document> collection =
         testing()
@@ -213,7 +208,7 @@ public MongoCollection<Document> setupDelete(String dbName, String collectionNam
   }
 
   @Override
-  public long delete(MongoCollection<Document> collection)
+  protected long delete(MongoCollection<Document> collection)
       throws ExecutionException, InterruptedException, TimeoutException {
     CompletableFuture<DeleteResult> result = new CompletableFuture<>();
     CompletableFuture<Long> count = new CompletableFuture<>();
@@ -231,17 +226,17 @@ public long delete(MongoCollection<Document> collection)
   }
 
   @Override
-  public MongoCollection<Document> setupGetMore(String dbName, String collectionName) {
+  protected MongoCollection<Document> setupGetMore(String dbName, String collectionName) {
     return abort("not tested on reactive");
   }
 
   @Override
-  public void getMore(MongoCollection<Document> collection) {
+  protected void getMore(MongoCollection<Document> collection) {
     abort("not tested on reactive");
   }
 
   @Override
-  public void error(String dbName, String collectionName) throws Throwable {
+  protected void error(String dbName, String collectionName) throws Throwable {
     MongoCollection<Document> collection =
         testing()
             .runWithSpan(

instrumentation/mongo/mongo-4.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/mongo/v4_0/MongoClientTest.java

@@ -18,13 +18,13 @@
 import com.mongodb.client.result.DeleteResult;
 import com.mongodb.client.result.UpdateResult;
 import io.opentelemetry.instrumentation.mongo.testing.AbstractMongoClientTest;
+import io.opentelemetry.instrumentation.testing.internal.AutoCleanupExtension;
 import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
 import java.util.ArrayList;
 import org.bson.BsonDocument;
 import org.bson.BsonString;
 import org.bson.Document;
-import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.extension.RegisterExtension;
 
@@ -33,18 +33,14 @@ class MongoClientTest extends AbstractMongoClientTest<MongoCollection<Document>>
   @RegisterExtension
   static final InstrumentationExtension testing = AgentInstrumentationExtension.create();
 
+  @RegisterExtension static final AutoCleanupExtension cleanup = AutoCleanupExtension.create();
+
   private MongoClient client;
 
   @BeforeAll
   void setup() {
     client = MongoClients.create("mongodb://" + host + ":" + port);
-  }
-
-  @AfterAll
-  void cleanup() {
-    if (client != null) {
-      client.close();
-    }
+    cleanup.deferAfterAll(client);
   }
 
   @Override
@@ -53,41 +49,44 @@ protected InstrumentationExtension testing() {
   }
 
   @Override
-  public void createCollection(String dbName, String collectionName) {
+  protected void createCollection(String dbName, String collectionName) {
     MongoDatabase db = client.getDatabase(dbName);
     db.createCollection(collectionName);
   }
 
   @Override
-  public void createCollectionNoDescription(String dbName, String collectionName) {
-    MongoDatabase db = MongoClients.create("mongodb://" + host + ":" + port).getDatabase(dbName);
-    db.createCollection(collectionName);
+  protected void createCollectionNoDescription(String dbName, String collectionName) {
+    try (MongoClient mongoClient = MongoClients.create("mongodb://" + host + ":" + port)) {
+      mongoClient.getDatabase(dbName).createCollection(collectionName);
+    }
   }
 
   @Override
-  public void createCollectionWithAlreadyBuiltClientOptions(String dbName, String collectionName) {
+  protected void createCollectionWithAlreadyBuiltClientOptions(
+      String dbName, String collectionName) {
     abort("not tested on 4.0");
   }
 
   @Override
-  public void createCollectionCallingBuildTwice(String dbName, String collectionName) {
+  protected void createCollectionCallingBuildTwice(String dbName, String collectionName) {
     MongoClientSettings.Builder settings =
         MongoClientSettings.builder()
             .applyToClusterSettings(
                 builder -> builder.hosts(singletonList(new ServerAddress(host, port))));
     settings.build();
-    MongoDatabase db = MongoClients.create(settings.build()).getDatabase(dbName);
-    db.createCollection(collectionName);
+    try (MongoClient mongoClient = MongoClients.create(settings.build())) {
+      mongoClient.getDatabase(dbName).createCollection(collectionName);
+    }
   }
 
   @Override
-  public long getCollection(String dbName, String collectionName) {
+  protected long getCollection(String dbName, String collectionName) {
     MongoDatabase db = client.getDatabase(dbName);
     return db.getCollection(collectionName).estimatedDocumentCount();
   }
 
   @Override
-  public MongoCollection<Document> setupInsert(String dbName, String collectionName) {
+  protected MongoCollection<Document> setupInsert(String dbName, String collectionName) {
     MongoCollection<Document> collection =
         testing()
             .runWithSpan(
@@ -102,13 +101,13 @@ public MongoCollection<Document> setupInsert(String dbName, String collectionNam
   }
 
   @Override
-  public long insert(MongoCollection<Document> collection) {
+  protected long insert(MongoCollection<Document> collection) {
     collection.insertOne(new Document("password", "SECRET"));
     return collection.estimatedDocumentCount();
   }
 
   @Override
-  public MongoCollection<Document> setupUpdate(String dbName, String collectionName) {
+  protected MongoCollection<Document> setupUpdate(String dbName, String collectionName) {
     MongoCollection<Document> collection =
         testing()
             .runWithSpan(
@@ -125,7 +124,7 @@ public MongoCollection<Document> setupUpdate(String dbName, String collectionNam
   }
 
   @Override
-  public long update(MongoCollection<Document> collection) {
+  protected long update(MongoCollection<Document> collection) {
     UpdateResult result =
         collection.updateOne(
             new BsonDocument("password", new BsonString("OLDPW")),
@@ -135,7 +134,7 @@ public long update(MongoCollection<Document> collection) {
   }
 
   @Override
-  public MongoCollection<Document> setupDelete(String dbName, String collectionName) {
+  protected MongoCollection<Document> setupDelete(String dbName, String collectionName) {
     MongoCollection<Document> collection =
         testing()
             .runWithSpan(
@@ -152,15 +151,15 @@ public MongoCollection<Document> setupDelete(String dbName, String collectionNam
   }
 
   @Override
-  public long delete(MongoCollection<Document> collection) {
+  protected long delete(MongoCollection<Document> collection) {
     DeleteResult result =
         collection.deleteOne(new BsonDocument("password", new BsonString("SECRET")));
     collection.estimatedDocumentCount();
     return result.getDeletedCount();
   }
 
   @Override
-  public MongoCollection<Document> setupGetMore(String dbName, String collectionName) {
+  protected MongoCollection<Document> setupGetMore(String dbName, String collectionName) {
     MongoCollection<Document> collection =
         testing()
             .runWithSpan(
@@ -178,7 +177,7 @@ public MongoCollection<Document> setupGetMore(String dbName, String collectionNa
   }
 
   @Override
-  public void getMore(MongoCollection<Document> collection) {
+  protected void getMore(MongoCollection<Document> collection) {
     collection
         .find()
         .filter(new Document("_id", new Document("$gte", 0)))
@@ -187,7 +186,7 @@ public void getMore(MongoCollection<Document> collection) {
   }
 
   @Override
-  public void error(String dbName, String collectionName) {
+  protected void error(String dbName, String collectionName) {
     MongoCollection<Document> collection =
         testing()
             .runWithSpan(