added logging functionality

Author: scmacdon

kotlin/services/kms/build.gradle.kts

@@ -35,6 +35,8 @@ dependencies {
     implementation("com.google.code.gson:gson:2.10")
     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/kms/src/test/kotlin/KMSKotlinTest.kt

@@ -1,7 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import aws.sdk.kotlin.runtime.auth.credentials.EnvironmentCredentialsProvider
 import aws.sdk.kotlin.services.secretsmanager.SecretsManagerClient
 import aws.sdk.kotlin.services.secretsmanager.model.GetSecretValueRequest
 import com.google.gson.Gson
@@ -28,10 +27,13 @@ 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
 
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
 @TestMethodOrder(MethodOrderer.OrderAnnotation::class)
 class KMSKotlinTest {
+    private val logger: Logger = LoggerFactory.getLogger(KMSKotlinTest::class.java)
     private var keyId = "" // gets set in test 2
     private var keyDesc = ""
     private var granteePrincipal = ""
@@ -50,16 +52,6 @@ class KMSKotlinTest {
             operation = values.operation.toString()
             aliasName = values.aliasName.toString()
             granteePrincipal = values.granteePrincipal.toString()
-
-        /*
-        val input: InputStream = this.javaClass.getClassLoader().getResourceAsStream("config.properties")
-        val prop = Properties()
-        prop.load(input)
-        keyDesc = prop.getProperty("keyDesc")
-        granteePrincipal = prop.getProperty("granteePrincipal")
-        operation = prop.getProperty("operation")
-        aliasName = prop.getProperty("aliasName")
-         */
         }
 
     @Test
@@ -68,98 +60,98 @@ class KMSKotlinTest {
         runBlocking {
             keyId = createKey(keyDesc).toString()
             Assertions.assertTrue(!keyId.isEmpty())
-            println("Test 2 passed")
+            logger.info("Test 2 passed")
         }
 
     @Test
-    @Order(3)
+    @Order(2)
     fun encryptDataKeyTest() =
         runBlocking {
             val plaintext = "Hello, AWS KMS!"
             val encryptData = encryptData(keyId)
             decryptData(encryptData, keyId)
-            println("Test 3 passed")
+            logger.info("Test 2 passed")
         }
 
     @Test
-    @Order(4)
+    @Order(3)
     fun disableCustomerKeyTest() =
         runBlocking {
             disableKey(keyId)
-            println("Test 4 passed")
+            logger.info("Test 3 passed")
         }
 
     @Test
-    @Order(5)
+    @Order(4)
     fun enableCustomerKeyTest() =
         runBlocking {
             enableKey(keyId)
-            println("Test 5 passed")
+            logger.info("Test 4 passed")
         }
 
     @Test
-    @Order(6)
+    @Order(5)
     fun createGrantTest() =
         runBlocking {
             grantId = createNewGrant(keyId, granteePrincipal, operation).toString()
             Assertions.assertTrue(!grantId.isEmpty())
-            println("Test 6 passed")
+            logger.info("Test 5 passed")
         }
 
     @Test
-    @Order(7)
+    @Order(6)
     fun listGrantsTest() =
         runBlocking {
             displayGrantIds(keyId)
-            println("Test 7 passed")
+            logger.info("Test 6 passed")
         }
 
     @Test
-    @Order(8)
+    @Order(7)
     fun revokeGrantsTest() =
         runBlocking {
             revokeKeyGrant(keyId, grantId)
-            println("Test 8 passed")
+            logger.info("Test 7 passed")
         }
 
     @Test
     @Order(9)
     fun describeKeyTest() =
         runBlocking {
             describeSpecifcKey(keyId)
-            println("Test 9 passed")
+            logger.info("Test 8 passed")
         }
 
     @Test
-    @Order(10)
+    @Order(9)
     fun createAliasTest() =
         runBlocking {
             createCustomAlias(keyId, aliasName)
-            println("Test 10 passed")
+            logger.info("Test 9 passed")
         }
 
     @Test
-    @Order(11)
+    @Order(10)
     fun listAliasesTest() =
         runBlocking {
             listAllAliases()
-            println("Test 11 passed")
+            logger.info("Test 10 passed")
         }
 
     @Test
-    @Order(12)
+    @Order(11)
     fun deleteAliasTest() =
         runBlocking {
             deleteSpecificAlias(aliasName)
-            println("Test 12 passed")
+            logger.info("Test 11 passed")
         }
 
     @Test
-    @Order(13)
+    @Order(12)
     fun listKeysTest() =
         runBlocking {
             listAllKeys()
-            println("Test 13 passed")
+            logger.info("Test 12 passed")
         }
 
     private suspend fun getSecretValues(): String {
@@ -170,7 +162,6 @@ class KMSKotlinTest {
             }
         SecretsManagerClient {
             region = "us-east-1"
-            credentialsProvider = EnvironmentCredentialsProvider()
         }.use { secretClient ->
             val valueResponse = secretClient.getSecretValue(valueRequest)
             return valueResponse.secretString.toString()

kotlin/services/kms/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>