Feature findings enhancemnt (#596) (#606)

* added support for param in Finding API * added detectionType as param for Findings API enhancements * adding addiional params findingIds, startTime and endTime * fix klint errors --------- (cherry picked from commit 892c34f) Signed-off-by: Riya Saxena <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-project · Mar 9, 2024 · d936c8f · d936c8f
1 parent 53f7dcc
commit d936c8f
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 6 deletions.
diff --git a/src/main/kotlin/org/opensearch/commons/alerting/action/GetFindingsRequest.kt b/src/main/kotlin/org/opensearch/commons/alerting/action/GetFindingsRequest.kt
@@ -6,26 +6,42 @@ import org.opensearch.commons.alerting.model.Table
 import org.opensearch.core.common.io.stream.StreamInput
 import org.opensearch.core.common.io.stream.StreamOutput
 import java.io.IOException
+import java.time.Instant
 
 class GetFindingsRequest : ActionRequest {
     val findingId: String?
     val table: Table
     val monitorId: String?
     val monitorIds: List<String>?
     val findingIndex: String?
+    val severity: String?
+    val detectionType: String?
+    val findingIds: List<String>?
+    val startTime: Instant?
+    val endTime: Instant?
 
     constructor(
         findingId: String?,
         table: Table,
         monitorId: String? = null,
         findingIndexName: String? = null,
-        monitorIds: List<String>? = null
+        monitorIds: List<String>? = null,
+        severity: String? = null,
+        detectionType: String? = null,
+        findingIds: List<String>? = null,
+        startTime: Instant? = null,
+        endTime: Instant? = null
     ) : super() {
         this.findingId = findingId
         this.table = table
         this.monitorId = monitorId
         this.findingIndex = findingIndexName
         this.monitorIds = monitorIds
+        this.severity = severity
+        this.detectionType = detectionType
+        this.findingIds = findingIds
+        this.startTime = startTime
+        this.endTime = endTime
     }
 
     @Throws(IOException::class)
@@ -34,7 +50,12 @@ class GetFindingsRequest : ActionRequest {
         table = Table.readFrom(sin),
         monitorId = sin.readOptionalString(),
         findingIndexName = sin.readOptionalString(),
-        monitorIds = sin.readOptionalStringList()
+        monitorIds = sin.readOptionalStringList(),
+        severity = sin.readOptionalString(),
+        detectionType = sin.readOptionalString(),
+        findingIds = sin.readOptionalStringList(),
+        startTime = sin.readOptionalInstant(),
+        endTime = sin.readOptionalInstant()
     )
 
     override fun validate(): ActionRequestValidationException? {
@@ -48,5 +69,10 @@ class GetFindingsRequest : ActionRequest {
         out.writeOptionalString(monitorId)
         out.writeOptionalString(findingIndex)
         out.writeOptionalStringCollection(monitorIds)
+        out.writeOptionalString(severity)
+        out.writeOptionalString(detectionType)
+        out.writeOptionalStringCollection(findingIds)
+        out.writeOptionalInstant(startTime)
+        out.writeOptionalInstant(endTime)
     }
 }
diff --git a/src/test/kotlin/org/opensearch/commons/alerting/action/GetFindingsRequestTests.kt b/src/test/kotlin/org/opensearch/commons/alerting/action/GetFindingsRequestTests.kt
@@ -8,14 +8,14 @@ import org.junit.jupiter.api.Test
 import org.opensearch.common.io.stream.BytesStreamOutput
 import org.opensearch.commons.alerting.model.Table
 import org.opensearch.core.common.io.stream.StreamInput
+import java.time.Instant
 
 internal class GetFindingsRequestTests {
 
     @Test
     fun `test get findings request`() {
         val table = Table("asc", "sortString", null, 1, 0, "")
-
-        val req = GetFindingsRequest("2121", table, "1", "finding_index_name", listOf("1", "2"))
+        val req = GetFindingsRequest("2121", table, "1", "finding_index_name", listOf("1", "2"), "severity", "detectionType", listOf("id1", "id2"), Instant.now(), Instant.now().plusSeconds(30000))
         assertNotNull(req)
 
         val out = BytesStreamOutput()
@@ -26,16 +26,20 @@ internal class GetFindingsRequestTests {
         assertEquals("1", newReq.monitorId)
         assertEquals("2121", newReq.findingId)
         assertEquals("finding_index_name", newReq.findingIndex)
+        assertEquals("severity", newReq.severity)
+        assertEquals("detectionType", newReq.detectionType)
         assertEquals(table, newReq.table)
         assertTrue(newReq.monitorIds!!.contains("1"))
         assertTrue(newReq.monitorIds!!.contains("2"))
+        assertTrue(newReq.findingIds!!.contains("id1"))
+        assertTrue(newReq.findingIds!!.contains("id2"))
+        assertTrue(newReq.startTime!! < newReq.endTime, "startTime less than endTime")
     }
 
     @Test
     fun `test validate returns null`() {
         val table = Table("asc", "sortString", null, 1, 0, "")
-
-        val req = GetFindingsRequest("2121", table, "1", "active")
+        val req = GetFindingsRequest("2121", table, "1", "active", listOf("1", "2"), "severity", "detectionType", listOf("id1", "id2"), Instant.now(), Instant.now().plusSeconds(30000))
         assertNotNull(req)
         assertNull(req.validate())
     }