Skip to content

Commit e51a67a

Browse files
akbhattaakbhatta
authored
Email recipients made nested for backward compatibility with Alerting (#83)
[Tests] Unit tests added/updated Signed-off-by: @akbhatta
1 parent cbeba12 commit e51a67a

File tree

11 files changed

+361
-141
lines changed

11 files changed

+361
-141
lines changed

‎src/main/kotlin/org/opensearch/commons/notifications/model/Email.kt‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,24 +38,21 @@ import org.opensearch.commons.notifications.NotificationConstants.EMAIL_ACCOUNT_
3838
import org.opensearch.commons.notifications.NotificationConstants.EMAIL_GROUP_ID_LIST_TAG
3939
import org.opensearch.commons.notifications.NotificationConstants.RECIPIENT_LIST_TAG
4040
import org.opensearch.commons.utils.logger
41+
import org.opensearch.commons.utils.objectList
4142
import org.opensearch.commons.utils.stringList
42-
import org.opensearch.commons.utils.validateEmail
4343
import java.io.IOException
4444

4545
/**
4646
* Data class representing Email account and default recipients.
4747
*/
4848
data class Email(
4949
val emailAccountID: String,
50-
val recipients: List<String>,
50+
val recipients: List<EmailRecipient>,
5151
val emailGroupIds: List<String>
5252
) : BaseConfigData {
5353

5454
init {
5555
require(!Strings.isNullOrEmpty(emailAccountID)) { "emailAccountID is null or empty" }
56-
recipients.forEach {
57-
validateEmail(it)
58-
}
5956
}
6057

6158
companion object {
@@ -79,7 +76,7 @@ data class Email(
7976
@Throws(IOException::class)
8077
fun parse(parser: XContentParser): Email {
8178
var emailAccountID: String? = null
82-
var recipients: List<String> = listOf()
79+
var recipients: List<EmailRecipient> = listOf()
8380
var emailGroupIds: List<String> = listOf()
8481

8582
XContentParserUtils.ensureExpectedToken(
@@ -92,7 +89,7 @@ data class Email(
9289
parser.nextToken()
9390
when (fieldName) {
9491
EMAIL_ACCOUNT_ID_TAG -> emailAccountID = parser.text()
95-
RECIPIENT_LIST_TAG -> recipients = parser.stringList()
92+
RECIPIENT_LIST_TAG -> recipients = parser.objectList { EmailRecipient.parse(it) }
9693
EMAIL_GROUP_ID_LIST_TAG -> emailGroupIds = parser.stringList()
9794
else -> {
9895
parser.skipChildren()
@@ -111,7 +108,7 @@ data class Email(
111108
*/
112109
constructor(input: StreamInput) : this(
113110
emailAccountID = input.readString(),
114-
recipients = input.readStringList(),
111+
recipients = input.readList(EmailRecipient.reader),
115112
emailGroupIds = input.readStringList()
116113
)
117114

@@ -120,7 +117,7 @@ data class Email(
120117
*/
121118
override fun writeTo(output: StreamOutput) {
122119
output.writeString(emailAccountID)
123-
output.writeStringCollection(recipients)
120+
output.writeList(recipients)
124121
output.writeStringCollection(emailGroupIds)
125122
}
126123

‎src/main/kotlin/org/opensearch/commons/notifications/model/EmailGroup.kt‎

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -35,23 +35,16 @@ import org.opensearch.common.xcontent.XContentParser
3535
import org.opensearch.common.xcontent.XContentParserUtils
3636
import org.opensearch.commons.notifications.NotificationConstants.RECIPIENT_LIST_TAG
3737
import org.opensearch.commons.utils.logger
38-
import org.opensearch.commons.utils.stringList
39-
import org.opensearch.commons.utils.validateEmail
38+
import org.opensearch.commons.utils.objectList
4039
import java.io.IOException
4140

4241
/**
4342
* Data class representing Email group.
4443
*/
4544
data class EmailGroup(
46-
val recipients: List<String>
45+
val recipients: List<EmailRecipient>
4746
) : BaseConfigData {
4847

49-
init {
50-
recipients.forEach {
51-
validateEmail(it)
52-
}
53-
}
54-
5548
companion object {
5649
private val log by logger(EmailGroup::class.java)
5750

@@ -72,7 +65,7 @@ data class EmailGroup(
7265
@JvmStatic
7366
@Throws(IOException::class)
7467
fun parse(parser: XContentParser): EmailGroup {
75-
var recipients: List<String>? = null
68+
var recipients: List<EmailRecipient>? = null
7669

7770
XContentParserUtils.ensureExpectedToken(
7871
XContentParser.Token.START_OBJECT,
@@ -83,7 +76,7 @@ data class EmailGroup(
8376
val fieldName = parser.currentName()
8477
parser.nextToken()
8578
when (fieldName) {
86-
RECIPIENT_LIST_TAG -> recipients = parser.stringList()
79+
RECIPIENT_LIST_TAG -> recipients = parser.objectList { EmailRecipient.parse(it) }
8780
else -> {
8881
parser.skipChildren()
8982
log.info("Unexpected field: $fieldName, while parsing EmailGroup")
@@ -100,14 +93,14 @@ data class EmailGroup(
10093
* @param input StreamInput stream to deserialize data from.
10194
*/
10295
constructor(input: StreamInput) : this(
103-
recipients = input.readStringList()
96+
recipients = input.readList(EmailRecipient.reader)
10497
)
10598

10699
/**
107100
* {@inheritDoc}
108101
*/
109102
override fun writeTo(output: StreamOutput) {
110-
output.writeStringCollection(recipients)
103+
output.writeList(recipients)
111104
}
112105

113106
/**

‎src/main/kotlin/org/opensearch/commons/notifications/model/EmailRecipient.kt‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
/*
2+
* SPDX-License-Identifier: Apache-2.0
3+
*
4+
* The OpenSearch Contributors require contributions made to
5+
* this file be licensed under the Apache-2.0 license or a
6+
* compatible open source license.
7+
*
8+
* Modifications Copyright OpenSearch Contributors. See
9+
* GitHub history for details.
10+
*/
11+
12+
/*
13+
* Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
14+
*
15+
* Licensed under the Apache License, Version 2.0 (the "License").
16+
* You may not use this file except in compliance with the License.
17+
* A copy of the License is located at
18+
*
19+
* http://www.apache.org/licenses/LICENSE-2.0
20+
*
21+
* or in the "license" file accompanying this file. This file is distributed
22+
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
23+
* express or implied. See the License for the specific language governing
24+
* permissions and limitations under the License.
25+
*
26+
*/
27+
package org.opensearch.commons.notifications.model
28+
29+
import org.opensearch.common.io.stream.StreamInput
30+
import org.opensearch.common.io.stream.StreamOutput
31+
import org.opensearch.common.io.stream.Writeable
32+
import org.opensearch.common.xcontent.ToXContent
33+
import org.opensearch.common.xcontent.XContentBuilder
34+
import org.opensearch.common.xcontent.XContentParser
35+
import org.opensearch.common.xcontent.XContentParserUtils
36+
import org.opensearch.commons.notifications.NotificationConstants.RECIPIENT_TAG
37+
import org.opensearch.commons.utils.logger
38+
import org.opensearch.commons.utils.validateEmail
39+
import java.io.IOException
40+
41+
/**
42+
* Data class representing Email recipient.
43+
*/
44+
data class EmailRecipient(
45+
val recipient: String
46+
) : BaseConfigData {
47+
48+
init {
49+
validateEmail(recipient)
50+
}
51+
52+
companion object {
53+
private val log by logger(EmailRecipient::class.java)
54+
55+
/**
56+
* reader to create instance of class from writable.
57+
*/
58+
val reader = Writeable.Reader { EmailRecipient(it) }
59+
60+
/**
61+
* Parser to parse xContent
62+
*/
63+
val xParser = XParser { parse(it) }
64+
65+
/**
66+
* Creator used in REST communication.
67+
* @param parser XContentParser to deserialize data from.
68+
*/
69+
@JvmStatic
70+
@Throws(IOException::class)
71+
fun parse(parser: XContentParser): EmailRecipient {
72+
var recipient: String? = null
73+
74+
XContentParserUtils.ensureExpectedToken(
75+
XContentParser.Token.START_OBJECT,
76+
parser.currentToken(),
77+
parser
78+
)
79+
while (parser.nextToken() != XContentParser.Token.END_OBJECT) {
80+
val fieldName = parser.currentName()
81+
parser.nextToken()
82+
when (fieldName) {
83+
RECIPIENT_TAG -> recipient = parser.text()
84+
else -> {
85+
parser.skipChildren()
86+
log.info("Unexpected field: $fieldName, while parsing EmailRecipient")
87+
}
88+
}
89+
}
90+
recipient ?: throw IllegalArgumentException("$RECIPIENT_TAG field absent")
91+
return EmailRecipient(recipient)
92+
}
93+
}
94+
95+
/**
96+
* Constructor used in transport action communication.
97+
* @param input StreamInput stream to deserialize data from.
98+
*/
99+
constructor(input: StreamInput) : this(
100+
recipient = input.readString()
101+
)
102+
103+
/**
104+
* {@inheritDoc}
105+
*/
106+
override fun writeTo(output: StreamOutput) {
107+
output.writeString(recipient)
108+
}
109+
110+
/**
111+
* {@inheritDoc}
112+
*/
113+
override fun toXContent(builder: XContentBuilder?, params: ToXContent.Params?): XContentBuilder {
114+
builder!!
115+
return builder.startObject()
116+
.field(RECIPIENT_TAG, recipient)
117+
.endObject()
118+
}
119+
}

‎src/test/kotlin/org/opensearch/commons/notifications/action/CreateNotificationConfigRequestTests.kt‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ import org.opensearch.commons.notifications.model.Chime
3636
import org.opensearch.commons.notifications.model.ConfigType
3737
import org.opensearch.commons.notifications.model.Email
3838
import org.opensearch.commons.notifications.model.EmailGroup
39+
import org.opensearch.commons.notifications.model.EmailRecipient
3940
import org.opensearch.commons.notifications.model.MethodType
4041
import org.opensearch.commons.notifications.model.NotificationConfig
4142
import org.opensearch.commons.notifications.model.Slack
@@ -84,7 +85,7 @@ internal class CreateNotificationConfigRequestTests {
8485
}
8586

8687
private fun createEmailGroupContentConfigObject(): NotificationConfig {
87-
val sampleEmailGroup = EmailGroup(listOf("dummy@company.com"))
88+
val sampleEmailGroup = EmailGroup(listOf(EmailRecipient("dummy@company.com")))
8889
return NotificationConfig(
8990
"name",
9091
"description",
@@ -98,7 +99,7 @@ internal class CreateNotificationConfigRequestTests {
9899
private fun createEmailContentConfigObject(): NotificationConfig {
99100
val sampleEmail = Email(
100101
emailAccountID = "sample_1@dummy.com",
101-
recipients = listOf("sample_2@dummy.com"),
102+
recipients = listOf(EmailRecipient("sample_2@dummy.com")),
102103
emailGroupIds = listOf("sample_3@dummy.com")
103104
)
104105
return NotificationConfig(
@@ -365,7 +366,7 @@ internal class CreateNotificationConfigRequestTests {
365366

366367
@Test
367368
fun `Create config should deserialize json object using parser Email Group`() {
368-
val sampleEmailGroup = EmailGroup(listOf("dummy@company.com"))
369+
val sampleEmailGroup = EmailGroup(listOf(EmailRecipient("dummy@company.com")))
369370
val config = NotificationConfig(
370371
"name",
371372
"description",
@@ -384,7 +385,7 @@ internal class CreateNotificationConfigRequestTests {
384385
"config_type":"email_group",
385386
"feature_list":["index_management"],
386387
"is_enabled":true,
387-
"email_group":{"recipient_list":["dummy@company.com"]}
388+
"email_group":{"recipient_list":[{"recipient":"dummy@company.com"}]}
388389
}
389390
}
390391
""".trimIndent()
@@ -396,7 +397,7 @@ internal class CreateNotificationConfigRequestTests {
396397
fun `Update config should deserialize json object using parser Email`() {
397398
val sampleEmail = Email(
398399
emailAccountID = "sample_1@dummy.com",
399-
recipients = listOf("sample_2@dummy.com"),
400+
recipients = listOf(EmailRecipient("sample_2@dummy.com")),
400401
emailGroupIds = listOf("sample_3@dummy.com")
401402
)
402403
val config = NotificationConfig(
@@ -417,8 +418,11 @@ internal class CreateNotificationConfigRequestTests {
417418
"config_type":"email",
418419
"feature_list":["index_management"],
419420
"is_enabled":true,
420-
"email":{"email_account_id":"sample_1@dummy.com","recipient_list":["sample_2@dummy.com"],
421-
"email_group_id_list":["sample_3@dummy.com"] }
421+
"email":{
422+
"email_account_id":"sample_1@dummy.com",
423+
"recipient_list":[{"recipient":"sample_2@dummy.com"}],
424+
"email_group_id_list":["sample_3@dummy.com"]
425+
}
422426
}
423427
}
424428
""".trimIndent()

‎src/test/kotlin/org/opensearch/commons/notifications/action/GetPluginFeaturesResponseTests.kt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ internal class GetPluginFeaturesResponseTests {
4040
actual: GetPluginFeaturesResponse
4141
) {
4242
assertEquals(expected.allowedConfigTypeList, actual.allowedConfigTypeList)
43+
assertEquals(expected.allowedConfigFeatureList, actual.allowedConfigFeatureList)
4344
assertEquals(expected.pluginFeatures, actual.pluginFeatures)
4445
}
4546

‎src/test/kotlin/org/opensearch/commons/notifications/action/UpdateNotificationConfigRequestTests.kt‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ import org.opensearch.commons.notifications.model.Chime
3636
import org.opensearch.commons.notifications.model.ConfigType
3737
import org.opensearch.commons.notifications.model.Email
3838
import org.opensearch.commons.notifications.model.EmailGroup
39+
import org.opensearch.commons.notifications.model.EmailRecipient
3940
import org.opensearch.commons.notifications.model.MethodType
4041
import org.opensearch.commons.notifications.model.NotificationConfig
4142
import org.opensearch.commons.notifications.model.Slack
@@ -84,7 +85,7 @@ internal class UpdateNotificationConfigRequestTests {
8485
}
8586

8687
private fun createEmailGroupContentConfigObject(): NotificationConfig {
87-
val sampleEmailGroup = EmailGroup(listOf("dummy@company.com"))
88+
val sampleEmailGroup = EmailGroup(listOf(EmailRecipient("dummy@company.com")))
8889
return NotificationConfig(
8990
"name",
9091
"description",
@@ -98,7 +99,7 @@ internal class UpdateNotificationConfigRequestTests {
9899
private fun createEmailContentConfigObject(): NotificationConfig {
99100
val sampleEmail = Email(
100101
emailAccountID = "sample_1@dummy.com",
101-
recipients = listOf("sample_2@dummy.com"),
102+
recipients = listOf(EmailRecipient("sample_2@dummy.com")),
102103
emailGroupIds = listOf("sample_3@dummy.com")
103104
)
104105
return NotificationConfig(
@@ -334,7 +335,7 @@ internal class UpdateNotificationConfigRequestTests {
334335

335336
@Test
336337
fun `Update config should deserialize json object using parser Email Group`() {
337-
val sampleEmailGroup = EmailGroup(listOf("dummy@company.com"))
338+
val sampleEmailGroup = EmailGroup(listOf(EmailRecipient("dummy@company.com")))
338339
val config = NotificationConfig(
339340
"name",
340341
"description",
@@ -353,7 +354,7 @@ internal class UpdateNotificationConfigRequestTests {
353354
"config_type":"email_group",
354355
"feature_list":["index_management"],
355356
"is_enabled":true,
356-
"email_group":{"recipient_list":["dummy@company.com"]}
357+
"email_group":{"recipient_list":[{"recipient":"dummy@company.com"}]}
357358
}
358359
}
359360
""".trimIndent()
@@ -366,7 +367,7 @@ internal class UpdateNotificationConfigRequestTests {
366367
fun `Update config should deserialize json object using parser Email`() {
367368
val sampleEmail = Email(
368369
emailAccountID = "sample_1@dummy.com",
369-
recipients = listOf("sample_2@dummy.com"),
370+
recipients = listOf(EmailRecipient("sample_2@dummy.com")),
370371
emailGroupIds = listOf("sample_3@dummy.com")
371372
)
372373
val config = NotificationConfig(
@@ -387,8 +388,11 @@ internal class UpdateNotificationConfigRequestTests {
387388
"config_type":"email",
388389
"feature_list":["index_management"],
389390
"is_enabled":true,
390-
"email":{"email_account_id":"sample_1@dummy.com","recipient_list":["sample_2@dummy.com"],
391-
"email_group_id_list":["sample_3@dummy.com"] }
391+
"email":{
392+
"email_account_id":"sample_1@dummy.com",
393+
"recipient_list":[{"recipient":"sample_2@dummy.com"}],
394+
"email_group_id_list":["sample_3@dummy.com"]
395+
}
392396
}
393397
}
394398
""".trimIndent()

0 commit comments

Comments
 (0)