added logging functionality

Author: scmacdon

kotlin/services/cloudwatch/build.gradle.kts

@@ -40,6 +40,8 @@ dependencies {
     implementation("com.fasterxml.jackson.core:jackson-databind:2.14.2")
     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/cloudwatch/src/test/kotlin/CloudWatchTest.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
@@ -27,10 +26,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(OrderAnnotation::class)
 class CloudWatchTest {
+    private val logger: Logger = LoggerFactory.getLogger(CloudWatchTest::class.java)
     private var logGroup = ""
     private var alarmName = ""
     private var streamName = ""
@@ -79,137 +81,110 @@ class CloudWatchTest {
             dashboardAddSc = values.dashboardAddSc.toString()
             settingsSc = values.settingsSc.toString()
             metricImageSc = values.metricImageSc.toString()
-
-            // 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()
-        prop.load(input)
-        logGroup = prop.getProperty("logGroup")
-        alarmName = prop.getProperty("alarmName")
-        streamName = prop.getProperty("streamName")
-        ruleResource = prop.getProperty("ruleResource")
-        metricId = prop.getProperty("metricId")
-        filterName = prop.getProperty("filterName")
-        destinationArn = prop.getProperty("destinationArn")
-        roleArn = prop.getProperty("roleArn")
-        filterPattern = prop.getProperty("filterPattern")
-        instanceId = prop.getProperty("instanceId")
-        ruleName = prop.getProperty("ruleName")
-        ruleArn = prop.getProperty("ruleArn")
-        namespace = prop.getProperty("namespace")
-        myDateSc = prop.getProperty("myDateSc")
-        costDateWeekSc = prop.getProperty("costDateWeekSc")
-        dashboardNameSc = prop.getProperty("dashboardNameSc")
-        dashboardJsonSc = prop.getProperty("dashboardJsonSc")
-        dashboardAddSc = prop.getProperty("dashboardAddSc")
-        settingsSc = prop.getProperty("settingsSc")
-        metricImageSc = prop.getProperty("metricImageSc")
-         */
         }
 
     @Test
     @Order(1)
     fun createAlarmTest() =
         runBlocking {
             putAlarm(alarmName, instanceId)
-            println("Test 1 passed")
+            logger.info("Test 1 passed")
         }
 
     @Test
     @Order(2)
     fun describeAlarmsTest() =
         runBlocking {
             desCWAlarms()
-            println("Test 2 passed")
+            logger.info("Test 2 passed")
         }
 
     @Test
     @Order(3)
     fun createSubscriptionFiltersTest() =
         runBlocking {
             putSubFilters(filterName, filterPattern, logGroup, destinationArn)
-            println("Test 3 passed")
+            logger.info("Test 3 passed")
         }
 
     @Test
     @Order(4)
     fun describeSubscriptionFiltersTest() =
         runBlocking {
             describeFilters(logGroup)
-            println("Test 4 passed")
+            logger.info("Test 4 passed")
         }
 
     @Test
     @Order(5)
     fun disableAlarmActionsTest() =
         runBlocking {
             disableActions(alarmName)
-            println("Test 5 passed")
+            logger.info("Test 5 passed")
         }
 
     @Test
     @Order(6)
     fun enableAlarmActionsTest() =
         runBlocking {
             enableActions(alarmName)
-            println("Test 6 passed")
+            logger.info("Test 6 passed")
         }
 
     @Test
     @Order(7)
     fun getLogEventsTest() =
         runBlocking {
             getCWLogEvents(logGroup, streamName)
-            println("Test 7 passed")
+            logger.info("Test 7 passed")
         }
 
     @Test
     @Order(8)
     fun putCloudWatchEventTest() =
         runBlocking {
             putCWEvents(ruleResource)
-            println("Test 8 passed")
+            logger.info("Test 8 passed")
         }
 
     @Test
     @Order(9)
     fun getMetricDataTest() =
         runBlocking {
             getMetData()
-            println("Test 9 passed")
+            logger.info("Test 9 passed")
         }
 
     @Test
     @Order(10)
     fun deleteSubscriptionFilterTest() =
         runBlocking {
             deleteSubFilter(filterName, logGroup)
-            println("Test 10 passed")
+            logger.info("Test 10 passed")
         }
 
     @Test
     @Order(11)
     fun putRuleTest() =
         runBlocking {
             putCWRule(ruleName, ruleArn)
-            println("Test 11 passed")
+            logger.info("Test 11 passed")
         }
 
     @Test
     @Order(12)
     fun putLogEvents() =
         runBlocking {
             putCWLogEvents(logGroup, streamName)
-            println("Test 12 passed")
+            logger.info("Test 12 passed")
         }
 
     @Test
     @Order(13)
     fun deleteCWAlarmTest() =
         runBlocking {
             deleteCWAlarm(alarmName)
-            println("Test 13 passed")
+            logger.info("Test 13 passed")
         }
 
     private suspend fun getSecretValues(): String {
@@ -220,7 +195,6 @@ class CloudWatchTest {
             }
         SecretsManagerClient {
             region = "us-east-1"
-            credentialsProvider = EnvironmentCredentialsProvider()
         }.use { secretClient ->
             val valueResponse = secretClient.getSecretValue(valueRequest)
             return valueResponse.secretString.toString()

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