Enforces extension action parsers have custom flag (#306) (#308)

* Enforces extension action parsers have custom flag Signed-off-by: Clay Downs <[email protected]> * Updates release notes Signed-off-by: Clay Downs <[email protected]> (cherry picked from commit 6d93359) Co-authored-by: Clay Downs <[email protected]>
opensearch-project · Mar 15, 2022 · bdeeee9 · bdeeee9
1 parent dce7f9f
commit bdeeee9
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 7 deletions.
diff --git a/release-notes/opensearch-index-management.release-notes-1.3.0.0.md b/release-notes/opensearch-index-management.release-notes-1.3.0.0.md
@@ -24,6 +24,7 @@ Compatible with OpenSearch 1.3.0
 * Fixes flaky continuous transforms test ([#276](https://github.com/opensearch-project/index-management/pull/276))
 * Porting additional missing logic ([#275](https://github.com/opensearch-project/index-management/pull/275))
 * Fixes test failures with security enabled ([#292](https://github.com/opensearch-project/index-management/pull/292))
+* Enforces extension action parsers have custom flag ([#306](https://github.com/opensearch-project/index-management/pull/306))
 
 ### Infrastructure
 * Add support for codeowners to repo ([#195](https://github.com/opensearch-project/index-management/pull/195))

diff --git a/src/main/kotlin/org/opensearch/indexmanagement/IndexManagementPlugin.kt b/src/main/kotlin/org/opensearch/indexmanagement/IndexManagementPlugin.kt
@@ -251,7 +251,7 @@ class IndexManagementPlugin : JobSchedulerExtension, NetworkPlugin, ActionPlugin
         indexManagementExtensions.forEach { extension ->
             val extensionName = extension.getExtensionName()
             if (extensionName in extensions) {
-                throw IllegalStateException("Mutliple extensions of IndexManagement have same name $extensionName - not supported")
+                throw IllegalStateException("Multiple extensions of IndexManagement have same name $extensionName - not supported")
             }
             extension.getISMActionParsers().forEach { parser ->
                 ISMActionsParser.instance.addParser(parser, extensionName)

diff --git a/src/main/kotlin/org/opensearch/indexmanagement/indexstatemanagement/ISMActionsParser.kt b/src/main/kotlin/org/opensearch/indexmanagement/indexstatemanagement/ISMActionsParser.kt
@@ -50,10 +50,16 @@ class ISMActionsParser private constructor() {
 
     val customActionExtensionMap = mutableMapOf<String, String>()
 
+    /*
+     * This method is used for adding custom action parsers. Action parsers from ISM should be added directly
+     * to the parsers list.
+     */
     fun addParser(parser: ActionParser, extensionName: String) {
         if (parsers.map { it.getActionType() }.contains(parser.getActionType())) {
             throw IllegalArgumentException(getDuplicateActionTypesMessage(parser.getActionType()))
         }
+        // Set the parser as custom to make sure that the custom actions are written with the "custom" wrapper
+        parser.customAction = true
         parsers.add(parser)
         customActionExtensionMap[parser.getActionType()] = extensionName
     }

diff --git a/...in/org/opensearch/indexmanagement/indexstatemanagement/extension/ISMActionsParserTests.kt b/...in/org/opensearch/indexmanagement/indexstatemanagement/extension/ISMActionsParserTests.kt
@@ -31,7 +31,6 @@ class ISMActionsParserTests : OpenSearchTestCase() {
 
     fun `test duplicate action names fail`() {
         val customActionParser = SampleCustomActionParser()
-        customActionParser.customAction = true
         // Duplicate custom parser names should fail
         ISMActionsParser.instance.addParser(customActionParser, extensionName)
         assertFailsWith<IllegalArgumentException>("Expected IllegalArgumentException for duplicate action names") {
@@ -46,7 +45,6 @@ class ISMActionsParserTests : OpenSearchTestCase() {
 
     fun `test custom action parsing`() {
         val customActionParser = SampleCustomActionParser()
-        customActionParser.customAction = true
         ISMActionsParser.instance.addParser(customActionParser, extensionName)
         val customAction = SampleCustomActionParser.SampleCustomAction(randomInt(), 0)
         val builder = XContentFactory.jsonBuilder()
@@ -62,7 +60,6 @@ class ISMActionsParserTests : OpenSearchTestCase() {
 
     fun `test parsing custom action without custom flag`() {
         val customActionParser = SampleCustomActionParser()
-        customActionParser.customAction = true
         ISMActionsParser.instance.addParser(customActionParser, extensionName)
         val customAction = SampleCustomActionParser.SampleCustomAction(randomInt(), 0)
         customAction.customAction = true

diff --git a/...indexmanagement/indexstatemanagement/transport/action/getpolicy/GetPolicyResponseTests.kt b/...indexmanagement/indexstatemanagement/transport/action/getpolicy/GetPolicyResponseTests.kt
@@ -57,7 +57,6 @@ class GetPolicyResponseTests : OpenSearchTestCase() {
     @Suppress("UNCHECKED_CAST")
     fun `test get policy response custom action`() {
         val customActionParser = SampleCustomActionParser()
-        customActionParser.customAction = true
         val extensionName = "testExtension"
         ISMActionsParser.instance.addParser(customActionParser, extensionName)
         val id = "id"

diff --git a/...exmanagement/indexstatemanagement/transport/action/indexpolicy/IndexPolicyRequestTests.kt b/...exmanagement/indexstatemanagement/transport/action/indexpolicy/IndexPolicyRequestTests.kt
@@ -111,7 +111,6 @@ class IndexPolicyRequestTests : OpenSearchTestCase() {
 
     fun `test index policy request custom action`() {
         val customActionParser = SampleCustomActionParser()
-        customActionParser.customAction = true
         val extensionName = "testExtension"
         ISMActionsParser.instance.addParser(customActionParser, extensionName)
         val policyID = "policyID"

diff --git a/...xmanagement/indexstatemanagement/transport/action/indexpolicy/IndexPolicyResponseTests.kt b/...xmanagement/indexstatemanagement/transport/action/indexpolicy/IndexPolicyResponseTests.kt
@@ -62,7 +62,6 @@ class IndexPolicyResponseTests : OpenSearchTestCase() {
     @Suppress("UNCHECKED_CAST")
     fun `test index policy response custom action`() {
         val customActionParser = SampleCustomActionParser()
-        customActionParser.customAction = true
         val extensionName = "testExtension"
         ISMActionsParser.instance.addParser(customActionParser, extensionName)
         val id = "id"