Add a method to fetch test issues from FTL (#74)

* Add a method to fetch test issues from FTL

* Add doc

* Addressing feedback

Author: rnakade

AndroidXCI/lib/src/main/kotlin/dev/androidx/ci/testRunner/TestRunnerService.kt

@@ -124,6 +124,14 @@ interface TestRunnerService {
         gcsPath: GcsPath
     ): ResultFileResource?
 
+    /**
+     * Gets the testIssues encountered while running [testMatrix] in FTL.
+     * If no severe issues were observed, returns an emptyList.
+     */
+    suspend fun getTestMatrixTestIssues(
+        testMatrix: TestMatrix
+    ): List<TestIssue>
+
     companion object {
         /**
          * Creates an implementation of [TestRunnerService].
@@ -345,4 +353,22 @@ interface TestRunnerService {
             const val TEXTPROTO = "textproto"
         }
     }
+
+    /**
+     * Represents the issue detected while running tests in a testMatrix in FTL
+     */
+    data class TestIssue(
+        /**
+         * Error message describing the issue
+         */
+        val errorMessage: String,
+        /**
+         * Severity of issue
+         */
+        val severity: String?,
+        /**
+         * Type of issue
+         */
+        val type: String?
+    )
 }

AndroidXCI/lib/src/main/kotlin/dev/androidx/ci/testRunner/TestRunnerServiceImpl.kt

@@ -26,6 +26,7 @@ import dev.androidx.ci.generated.ftl.ClientInfo
 import dev.androidx.ci.generated.ftl.ShardingOption
 import dev.androidx.ci.generated.ftl.TestEnvironmentCatalog
 import dev.androidx.ci.generated.ftl.TestMatrix
+import dev.androidx.ci.generated.testResults.TestIssue
 import dev.androidx.ci.testRunner.vo.DeviceSetup
 import dev.androidx.ci.testRunner.vo.RemoteApk
 import dev.androidx.ci.testRunner.vo.UploadedApk
@@ -280,6 +281,21 @@ internal class TestRunnerServiceImpl internal constructor(
         }
     }
 
+    override suspend fun getTestMatrixTestIssues(testMatrix: TestMatrix): List<TestRunnerService.TestIssue> {
+        val steps = testExecutionStore.getTestExecutionSteps(testMatrix)
+        val testIssues = steps.flatMap {
+            it.testExecutionStep?.testIssues ?: emptyList()
+        }.map {
+            TestRunnerService.TestIssue(
+                errorMessage = it.errorMessage ?: "error message not set",
+                severity = it.severity?.name ?: "unspecifiedSeverity",
+                type = it.type?.name
+            )
+        }
+
+        return testIssues
+    }
+
     suspend fun getTestMatrixResults(
         testMatrixId: String
     ): List<TestRunnerService.TestRunResult>? {

AndroidXCI/lib/src/test/kotlin/dev/androidx/ci/testRunner/TestRunnerServiceImplTest.kt

@@ -19,6 +19,7 @@ import dev.androidx.ci.generated.testResults.FileReference
 import dev.androidx.ci.generated.testResults.Step
 import dev.androidx.ci.generated.testResults.TestCaseReference
 import dev.androidx.ci.generated.testResults.TestExecutionStep
+import dev.androidx.ci.generated.testResults.TestIssue
 import dev.androidx.ci.generated.testResults.ToolExecution
 import dev.androidx.ci.generated.testResults.ToolOutputReference
 import dev.androidx.ci.testRunner.vo.DeviceSetup
@@ -1410,6 +1411,58 @@ class TestRunnerServiceImplTest {
         )
     }
 
+    @Test
+    fun getTestIssues() = runBlocking {
+        val testMatrix = fakeBackend.fakeFirebaseTestLabApi.createTestMatrix(
+            projectId = fakeBackend.firebaseProjectId,
+            requestId = "requestId",
+            testMatrix = TestMatrix(
+                resultStorage = ResultStorage(
+                    googleCloudStorage = GoogleCloudStorage(
+                        "${fakeBackend.fakeGoogleCloudApi.rootGcsPath}/my-test-matrix-results"
+                    ),
+                    toolResultsExecution = ToolResultsExecution(
+                        executionId = "test_executionId",
+                        historyId = "test_historyId"
+                    )
+                ),
+                projectId = fakeBackend.firebaseProjectId,
+                environmentMatrix = EnvironmentMatrix(),
+                testSpecification = TestSpecification()
+            )
+        )
+        assertThat(
+            subject.getTestMatrixTestIssues(testMatrix)
+        ).isEmpty()
+
+        fakeToolsResultApi.addStep(
+            projectId = fakeBackend.firebaseProjectId,
+            executionId = "test_executionId",
+            historyId = "test_historyId",
+            step = Step(
+                stepId = UUID.randomUUID().toString(),
+                testExecutionStep = TestExecutionStep(
+                    testIssues = listOf(
+                        TestIssue(
+                            errorMessage = "test module error",
+                            severity = TestIssue.Severity.severe
+                        )
+                    )
+                )
+            )
+        )
+        val testIssues = subject.getTestMatrixTestIssues(testMatrix)
+        assertThat(
+            testIssues
+        ).isNotEmpty()
+
+        assertThat(
+            testIssues.first().errorMessage
+        ).isEqualTo(
+            "test module error"
+        )
+    }
+
     private fun TestRunnerService.ResultFileResource.readFully() = openInputStream().use {
         it.readAllBytes()
     }