added logging functionality

Author: scmacdon

kotlin/services/rds/build.gradle.kts

@@ -35,6 +35,8 @@ dependencies {
     implementation("com.google.code.gson:gson:2.10.1")
     testImplementation("org.junit.jupiter:junit-jupiter:5.9.2")
     implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4")
+    implementation("org.slf4j:slf4j-api:2.0.15")
+    implementation("org.slf4j:slf4j-simple:2.0.15")
 }
 tasks.withType<KotlinCompile> {
     kotlinOptions.jvmTarget = "17"

kotlin/services/rds/src/test/kotlin/RDSTest.kt

@@ -32,6 +32,8 @@ import org.junit.jupiter.api.Order
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.TestInstance
 import org.junit.jupiter.api.TestMethodOrder
+import org.slf4j.Logger
+import org.slf4j.LoggerFactory
 import java.util.Random
 import java.util.UUID
 
@@ -42,6 +44,7 @@ import java.util.UUID
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
 @TestMethodOrder(OrderAnnotation::class)
 class RDSTest {
+    private val logger: Logger = LoggerFactory.getLogger(RDSTest::class.java)
     private var dbInstanceIdentifier = ""
     private var dbSnapshotIdentifier = ""
     private var dbName = ""
@@ -75,116 +78,76 @@ class RDSTest {
             dbInstanceIdentifierSc = values.dbInstanceIdentifierSc + UUID.randomUUID()
             dbSnapshotIdentifierSc = values.dbSnapshotIdentifierSc + UUID.randomUUID()
             dbNameSc = values.dbNameSc + randomNum
-
-// Uncomment this code block if you prefer using a config.properties file to retrieve AWS values required for these tests.
-
-        /*
-                val input: InputStream = this.javaClass.getClassLoader().getResourceAsStream("config.properties")
-                val prop = Properties()
-
-                // Load the properties file.
-                prop.load(input)
-                dbInstanceIdentifier = prop.getProperty("dbInstanceIdentifier")
-                dbSnapshotIdentifier = prop.getProperty("dbSnapshotIdentifier")
-                dbName = prop.getProperty("dbName")
-                masterUsername = prop.getProperty("masterUsername")
-                masterUserPassword = prop.getProperty("masterUserPassword")
-                newMasterUserPassword = prop.getProperty("newMasterUserPassword")
-                dbGroupNameSc = prop.getProperty("dbGroupNameSc")
-                dbParameterGroupFamilySc = prop.getProperty("dbParameterGroupFamilySc")
-                dbInstanceIdentifierSc = prop.getProperty("dbInstanceIdentifierSc")
-                masterUsernameSc = prop.getProperty("masterUsernameSc")
-                masterUserPasswordSc = prop.getProperty("masterUserPasswordSc")
-                dbSnapshotIdentifierSc = prop.getProperty("dbSnapshotIdentifierSc")
-                dbNameSc = prop.getProperty("dbNameSc")
-         */
         }
 
     @Test
-    @Order(2)
+    @Order(1)
     fun createDBInstanceTest() =
         runBlocking {
             createDatabaseInstance(dbInstanceIdentifier, dbName, masterUsername, masterUserPassword)
-            println("Test 2 passed")
+            logger.info("Test 1 passed")
         }
 
     @Test
-    @Order(3)
+    @Order(2)
     fun waitForInstanceReadyTest() =
         runBlocking {
             waitForInstanceReady(dbInstanceIdentifier)
-            println("Test 3 passed")
+            logger.info("Test 2 passed")
         }
 
     @Test
-    @Order(4)
+    @Order(3)
     fun describeAccountAttributesTest() =
         runBlocking {
             getAccountAttributes()
-            println("Test 4 passed")
+            logger.info("Test 3 passed")
         }
 
     @Test
-    @Order(5)
+    @Order(4)
     fun describeDBInstancesTest() =
         runBlocking {
             describeInstances()
-            println("Test 5 passed")
+            logger.info("Test 4 passed")
         }
 
     @Test
-    @Order(6)
+    @Order(5)
     fun modifyDBInstanceTest() =
         runBlocking {
             updateIntance(dbInstanceIdentifier, newMasterUserPassword)
-            println("Test 6 passed")
+            logger.info("Test 5 passed")
         }
 
     @Test
-    @Order(7)
+    @Order(6)
     fun createDBSnapshotTest() =
         runBlocking {
             createSnapshot(dbInstanceIdentifier, dbSnapshotIdentifier)
-            println("Test 7 passed")
+            logger.info("Test 6 passed")
         }
 
     @Test
-    @Order(8)
+    @Order(7)
     fun deleteDBInstanceTest() =
         runBlocking {
             deleteDatabaseInstance(dbInstanceIdentifier)
-            println("Test 8 passed")
+            logger.info("Test 7 passed")
         }
 
     @Test
-    @Order(9)
+    @Order(8)
     fun scenarioTest() =
         runBlocking {
-            println("1. Return a list of the available DB engines")
             describeDBEngines()
-
-            println("2. Create a custom parameter group")
             createDBParameterGroup(dbGroupNameSc, dbParameterGroupFamilySc)
-
-            println("3. Get the parameter groups")
             describeDbParameterGroups(dbGroupNameSc)
-
-            println("4. Get the parameters in the group")
             describeDbParameters(dbGroupNameSc, 0)
-
-            println("5. Modify the auto_increment_offset parameter")
             modifyDBParas(dbGroupNameSc)
-
-            println("6. Display the updated value")
             describeDbParameters(dbGroupNameSc, -1)
-
-            println("7. Get a list of allowed engine versions")
             getAllowedEngines(dbParameterGroupFamilySc)
-
-            println("8. Get a list of micro instance classes available for the selected engine")
             getMicroInstances()
-
-            println("9. Create an RDS database instance that contains a MySql database and uses the parameter group")
             val dbARN =
                 createDatabaseInstance(
                     dbGroupNameSc,
@@ -193,25 +156,14 @@ class RDSTest {
                     masterUsername,
                     masterUserPassword,
                 )
-            println("The ARN of the new database is $dbARN")
-
-            println("10. Wait for DB instance to be ready")
             waitForDbInstanceReady(dbInstanceIdentifierSc)
-
-            println("11. Create a snapshot of the DB instance")
             createDbSnapshot(dbInstanceIdentifierSc, dbSnapshotIdentifierSc)
-
-            println("12. Wait for DB snapshot to be ready")
             waitForSnapshotReady(dbInstanceIdentifierSc, dbSnapshotIdentifierSc)
-
-            println("13. Delete the DB instance")
             deleteDbInstance(dbInstanceIdentifierSc)
-
-            println("14. Delete the parameter group")
             if (dbARN != null) {
                 deleteParaGroup(dbGroupNameSc, dbARN)
             }
-            println("The Scenario has successfully completed.")
+            logger.info("Test 8 passed.")
         }
 
     suspend fun getSecretValues(): String? {

kotlin/services/rds/src/test/resources/logback.xml

@@ -0,0 +1,11 @@
+<configuration>
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
+        </encoder>
+    </appender>
+
+    <root level="info">
+        <appender-ref ref="STDOUT"/>
+    </root>
+</configuration>