fix security-analytics to alerting integration (opensearch-project#294)

Signed-off-by: Subhobrata Dey <sbcd90@gmail.com>

Author: sbcd90

src/main/kotlin/org/opensearch/commons/alerting/action/GetFindingsResponse.kt

@@ -10,6 +10,7 @@ import org.opensearch.rest.RestStatus
 import java.io.IOException
 
 class GetFindingsResponse : BaseResponse {
+    private var status: RestStatus
     var totalFindings: Int?
     var findings: List<FindingWithDocs>
 
@@ -18,29 +19,43 @@ class GetFindingsResponse : BaseResponse {
         totalFindings: Int?,
         findings: List<FindingWithDocs>
     ) : super() {
+        this.status = status
         this.totalFindings = totalFindings
         this.findings = findings
     }
 
     @Throws(IOException::class)
-    constructor(sin: StreamInput) : this(
-        status = RestStatus.OK,
-        totalFindings = sin.readOptionalInt(),
-        findings = sin.readList((FindingWithDocs)::readFrom)
-    )
+    constructor(sin: StreamInput) {
+        this.status = sin.readEnum(RestStatus::class.java)
+        val findings = mutableListOf<FindingWithDocs>()
+        this.totalFindings = sin.readOptionalInt()
+        var currentSize = sin.readInt()
+        for (i in 0 until currentSize) {
+            findings.add(FindingWithDocs.readFrom(sin))
+        }
+        this.findings = findings
+    }
 
     @Throws(IOException::class)
     override fun writeTo(out: StreamOutput) {
+        out.writeEnum(status)
         out.writeOptionalInt(totalFindings)
-        out.writeCollection(findings)
+        out.writeInt(findings.size)
+        for (finding in findings) {
+            finding.writeTo(out)
+        }
     }
 
     @Throws(IOException::class)
     override fun toXContent(builder: XContentBuilder, params: ToXContent.Params): XContentBuilder {
         builder.startObject()
             .field("total_findings", totalFindings)
-            .field("findings", findings.toTypedArray())
+            .field("findings", findings)
 
         return builder.endObject()
     }
+
+    override fun getStatus(): RestStatus {
+        return this.status
+    }
 }

src/main/kotlin/org/opensearch/commons/alerting/model/FindingDocument.kt

@@ -3,21 +3,21 @@ package org.opensearch.commons.alerting.model
 import org.apache.logging.log4j.LogManager
 import org.opensearch.common.io.stream.StreamInput
 import org.opensearch.common.io.stream.StreamOutput
+import org.opensearch.common.io.stream.Writeable
 import org.opensearch.common.xcontent.ToXContent
 import org.opensearch.common.xcontent.XContentBuilder
 import org.opensearch.common.xcontent.XContentParser
 import org.opensearch.common.xcontent.XContentParserUtils
-import org.opensearch.commons.notifications.model.BaseModel
 import java.io.IOException
 
 private val log = LogManager.getLogger(FindingDocument::class.java)
 
-data class FindingDocument(
+class FindingDocument(
     val index: String,
     val id: String,
     val found: Boolean,
     val document: String
-) : BaseModel {
+) : Writeable, ToXContent {
 
     @Throws(IOException::class)
     constructor(sin: StreamInput) : this(
@@ -52,7 +52,7 @@ data class FindingDocument(
         const val NO_ID = ""
         const val NO_INDEX = ""
 
-        @JvmStatic
+        @JvmStatic @JvmOverloads
         @Throws(IOException::class)
         fun parse(xcp: XContentParser, id: String = NO_ID, index: String = NO_INDEX): FindingDocument {
             var found = false

src/main/kotlin/org/opensearch/commons/alerting/model/FindingWithDocs.kt

@@ -3,26 +3,19 @@ package org.opensearch.commons.alerting.model
 import org.apache.logging.log4j.LogManager
 import org.opensearch.common.io.stream.StreamInput
 import org.opensearch.common.io.stream.StreamOutput
+import org.opensearch.common.io.stream.Writeable
 import org.opensearch.common.xcontent.ToXContent
 import org.opensearch.common.xcontent.XContentBuilder
 import org.opensearch.common.xcontent.XContentParser
 import org.opensearch.common.xcontent.XContentParserUtils
-import org.opensearch.commons.notifications.model.BaseModel
 import java.io.IOException
 
 private val log = LogManager.getLogger(Finding::class.java)
 
-class FindingWithDocs : BaseModel {
-    var finding: Finding
-    var documents: List<FindingDocument>
-
-    constructor(
-        finding: Finding,
-        documents: List<FindingDocument>
-    ) : super() {
-        this.finding = finding
-        this.documents = documents
-    }
+class FindingWithDocs(
+    val finding: Finding,
+    val documents: List<FindingDocument>
+) : Writeable, ToXContent {
 
     @Throws(IOException::class)
     constructor(sin: StreamInput) : this(
@@ -38,10 +31,8 @@ class FindingWithDocs : BaseModel {
 
     override fun toXContent(builder: XContentBuilder, params: ToXContent.Params): XContentBuilder {
         builder.startObject()
-            .startObject("finding_with_docs")
             .field(FINDING_FIELD, finding)
-            .field(DOCUMENTS_FIELD, documents.toTypedArray())
-            .endObject()
+            .field(DOCUMENTS_FIELD, documents)
         builder.endObject()
         return builder
     }

src/test/kotlin/org/opensearch/commons/alerting/action/GetFindingsResponseTests.kt

@@ -0,0 +1,61 @@
+package org.opensearch.commons.alerting.action
+
+import org.junit.jupiter.api.Assertions
+import org.junit.jupiter.api.Test
+import org.opensearch.common.io.stream.BytesStreamOutput
+import org.opensearch.common.io.stream.StreamInput
+import org.opensearch.commons.alerting.model.DocLevelQuery
+import org.opensearch.commons.alerting.model.Finding
+import org.opensearch.commons.alerting.model.FindingDocument
+import org.opensearch.commons.alerting.model.FindingWithDocs
+import org.opensearch.rest.RestStatus
+import java.time.Instant
+import java.util.List
+
+internal class GetFindingsResponseTests {
+
+    @Test
+    fun `test get findings response`() {
+
+        // Alerting GetFindingsResponse mock #1
+        val finding1 = Finding(
+            "1",
+            listOf("doc1", "doc2", "doc3"),
+            "monitor_id1",
+            "monitor_name1",
+            "test_index1",
+            listOf(DocLevelQuery("1", "myQuery", "fieldA:valABC", List.of())),
+            Instant.now()
+        )
+        val findingDocument1 = FindingDocument("test_index1", "doc1", true, "document 1 payload")
+        val findingDocument2 = FindingDocument("test_index1", "doc2", true, "document 2 payload")
+        val findingDocument3 = FindingDocument("test_index1", "doc3", true, "document 3 payload")
+
+        val findingWithDocs1 = FindingWithDocs(finding1, listOf(findingDocument1, findingDocument2, findingDocument3))
+
+        // Alerting GetFindingsResponse mock #2
+
+        // Alerting GetFindingsResponse mock #2
+        val finding2 = Finding(
+            "1",
+            listOf("doc21", "doc22"),
+            "monitor_id2",
+            "monitor_name2",
+            "test_index2",
+            listOf(DocLevelQuery("1", "myQuery", "fieldA:valABC", List.of())),
+            Instant.now()
+        )
+        val findingDocument21 = FindingDocument("test_index2", "doc21", true, "document 21 payload")
+        val findingDocument22 = FindingDocument("test_index2", "doc22", true, "document 22 payload")
+
+        val findingWithDocs2 = FindingWithDocs(finding2, listOf(findingDocument21, findingDocument22))
+
+        val req = GetFindingsResponse(RestStatus.OK, 2, listOf(findingWithDocs1, findingWithDocs2))
+        Assertions.assertNotNull(req)
+
+        val out = BytesStreamOutput()
+        req.writeTo(out)
+        val sin = StreamInput.wrap(out.bytes().toBytesRef().bytes)
+        val newReq = GetFindingsResponse(sin)
+    }
+}