Creating contract-tests for successful 'CREATE DATABASE' for MySQL and Postgres.

Author: BlueLort

appsignals-tests/contract-tests/src/test/java/software/amazon/opentelemetry/appsignals/test/jdbc/JdbcContractTestBase.java

@@ -19,6 +19,7 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.TestInstance;
 import org.testcontainers.junit.jupiter.Testcontainers;
+import software.amazon.opentelemetry.appsignals.test.jdbc.operationtests.DBOperation;
 
 @Testcontainers(disabledWithoutDocker = true)
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
@@ -32,12 +33,13 @@ public class JdbcH2Test extends JdbcContractTestBase {
 
   @Test
   public void testSuccess() {
-    assertSuccess(DB_SYSTEM, DB_OPERATION, DB_USER, DB_NAME, DB_CONNECTION_STRING, null, null);
+    assertSuccess(
+        DB_SYSTEM, DBOperation.SELECT, DB_USER, DB_NAME, DB_CONNECTION_STRING, null, null);
   }
 
   @Test
   public void testFault() {
-    assertFault(DB_SYSTEM, DB_OPERATION, DB_USER, DB_NAME, DB_CONNECTION_STRING, null, null);
+    assertFault(DB_SYSTEM, DBOperation.SELECT, DB_USER, DB_NAME, DB_CONNECTION_STRING, null, null);
   }
 
   @Override

appsignals-tests/contract-tests/src/test/java/software/amazon/opentelemetry/appsignals/test/jdbc/JdbcH2Test.java

@@ -17,15 +17,19 @@
 
 import java.util.List;
 import java.util.Map;
+import java.util.stream.Stream;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.TestInstance;
 import org.junit.jupiter.api.TestInstance.Lifecycle;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.MethodSource;
 import org.testcontainers.containers.MySQLContainer;
 import org.testcontainers.containers.wait.strategy.Wait;
 import org.testcontainers.images.PullPolicy;
 import org.testcontainers.junit.jupiter.Testcontainers;
 import org.testcontainers.lifecycle.Startable;
+import software.amazon.opentelemetry.appsignals.test.jdbc.operationtests.DBOperation;
 
 @Testcontainers(disabledWithoutDocker = true)
 @TestInstance(Lifecycle.PER_CLASS)
@@ -48,11 +52,16 @@ public void afterEach() {
     mySQLContainer.stop();
   }
 
-  @Test
-  public void testSuccess() {
+  private static Stream<DBOperation> dbOperations() {
+    return Stream.of(DBOperation.SELECT, DBOperation.CREATE_DATABASE);
+  }
+
+  @ParameterizedTest
+  @MethodSource("dbOperations")
+  public void testSuccess(DBOperation operation) {
     assertSuccess(
         DB_SYSTEM,
-        DB_OPERATION,
+        operation,
         DB_USER,
         DB_NAME,
         DB_CONNECTION_STRING,
@@ -64,7 +73,7 @@ public void testSuccess() {
   public void testFault() {
     assertFault(
         DB_SYSTEM,
-        DB_OPERATION,
+        DBOperation.SELECT,
         DB_USER,
         DB_NAME,
         DB_CONNECTION_STRING,

appsignals-tests/contract-tests/src/test/java/software/amazon/opentelemetry/appsignals/test/jdbc/JdbcMySQLTest.java

@@ -17,14 +17,18 @@
 
 import java.util.List;
 import java.util.Map;
+import java.util.stream.Stream;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.TestInstance;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.MethodSource;
 import org.testcontainers.containers.PostgreSQLContainer;
 import org.testcontainers.containers.wait.strategy.Wait;
 import org.testcontainers.images.PullPolicy;
 import org.testcontainers.junit.jupiter.Testcontainers;
 import org.testcontainers.lifecycle.Startable;
+import software.amazon.opentelemetry.appsignals.test.jdbc.operationtests.DBOperation;
 
 @Testcontainers(disabledWithoutDocker = true)
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
@@ -48,11 +52,16 @@ public void afterEach() {
     postgreSqlContainer.stop();
   }
 
-  @Test
-  public void testSuccess() {
+  private static Stream<DBOperation> dbOperations() {
+    return Stream.of(DBOperation.SELECT, DBOperation.CREATE_DATABASE);
+  }
+
+  @ParameterizedTest
+  @MethodSource("dbOperations")
+  public void testSuccess(DBOperation operation) {
     assertSuccess(
         DB_SYSTEM,
-        DB_OPERATION,
+        operation,
         DB_USER,
         DB_NAME,
         DB_CONNECTION_STRING,
@@ -64,7 +73,7 @@ public void testSuccess() {
   public void testFault() {
     assertFault(
         DB_SYSTEM,
-        DB_OPERATION,
+        DBOperation.SELECT,
         DB_USER,
         DB_NAME,
         DB_CONNECTION_STRING,

appsignals-tests/contract-tests/src/test/java/software/amazon/opentelemetry/appsignals/test/jdbc/JdbcPostgresTest.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file 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 software.amazon.opentelemetry.appsignals.test.jdbc.operationtests;
+
+public enum DBOperation {
+  CREATE_DATABASE("CREATE DATABASE", "testdb2"),
+  SELECT("SELECT", "testdb");
+
+  DBOperation(String value, String targetDB) {
+    this.value = value;
+    this.targetDB = targetDB;
+  }
+
+  private final String value;
+  private final String targetDB;
+
+  public String getTargetDB() {
+    return targetDB;
+  }
+
+  @Override
+  public String toString() {
+    return value;
+  }
+}

appsignals-tests/contract-tests/src/test/java/software/amazon/opentelemetry/appsignals/test/jdbc/operationtests/DBOperation.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file 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 software.amazon.opentelemetry.appsignals.test.jdbc.operationtests;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static software.amazon.opentelemetry.appsignals.test.jdbc.operationtests.DBOperation.CREATE_DATABASE;
+
+import software.amazon.opentelemetry.appsignals.test.utils.ResourceScopeSpan;
+import software.amazon.opentelemetry.appsignals.test.utils.SemanticConventionsConstants;
+
+public class JdbcCreateDatabaseOperationTester extends JdbcOperationTester {
+
+  public JdbcCreateDatabaseOperationTester(
+      String dbSystem, String dbUser, String jdbcUrl, String dbName, String dbTable) {
+    super(dbSystem, dbUser, jdbcUrl, dbName, CREATE_DATABASE.toString(), dbTable);
+  }
+
+  @Override
+  protected void assertOperationSemanticConventions(ResourceScopeSpan resourceScopeSpan) {
+    assertThat(resourceScopeSpan.getSpan().getName()).isEqualTo(String.format("%s", this.dbName));
+
+    var attributesList = resourceScopeSpan.getSpan().getAttributesList();
+    assertThat(attributesList)
+        .satisfiesOnlyOnce(
+            attribute -> {
+              assertThat(attribute.getKey()).isEqualTo(SemanticConventionsConstants.DB_STATEMENT);
+              assertThat(attribute.getValue().getStringValue())
+                  .isEqualTo(
+                      String.format(
+                          "%s %s",
+                          CREATE_DATABASE.toString().toLowerCase(), CREATE_DATABASE.getTargetDB()));
+            });
+  }
+}