-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add backwards compatibility tests (#475)
* Add initial framework for BWC tests Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com> * Update developer guide with commands to run bwc tests Signed-off-by: Mohammad Qureshi <47198598+qreshi@users.noreply.github.com>
- Loading branch information
Showing
5 changed files
with
322 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
134 changes: 134 additions & 0 deletions
134
...ons/src/test/kotlin/org/opensearch/integtest/bwc/NotificationsBackwardsCompatibilityIT.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.integtest.bwc | ||
|
|
||
| import org.opensearch.common.settings.Settings | ||
| import org.opensearch.integtest.PluginRestTestCase | ||
| import org.opensearch.notifications.NotificationPlugin | ||
| import org.opensearch.rest.RestRequest | ||
| import org.opensearch.rest.RestStatus | ||
|
|
||
| class NotificationsBackwardsCompatibilityIT : PluginRestTestCase() { | ||
|
|
||
| companion object { | ||
| private val CLUSTER_TYPE = ClusterType.parse(System.getProperty("tests.rest.bwcsuite")) | ||
| private val CLUSTER_NAME = System.getProperty("tests.clustername") | ||
| } | ||
|
|
||
| override fun preserveIndicesUponCompletion(): Boolean = true | ||
|
|
||
| override fun preservePluginIndicesAfterTest(): Boolean = true | ||
|
|
||
| override fun restClientSettings(): Settings { | ||
| return Settings.builder() | ||
| .put(super.restClientSettings()) | ||
| // increase the timeout here to 90 seconds to handle long waits for a green | ||
| // cluster health. the waits for green need to be longer than a minute to | ||
| // account for delayed shards | ||
| .put(CLIENT_SOCKET_TIMEOUT, "90s") | ||
| .build() | ||
| } | ||
|
|
||
| @Throws(Exception::class) | ||
| @Suppress("UNCHECKED_CAST") | ||
| fun `test backwards compatibility`() { | ||
| val uri = getPluginUri() | ||
| val responseMap = getAsMap(uri)["nodes"] as Map<String, Map<String, Any>> | ||
| val configId = randomAlphaOfLength(20) | ||
| for (response in responseMap.values) { | ||
| val plugins = response["plugins"] as List<Map<String, Any>> | ||
| val pluginNames = plugins.map { plugin -> plugin["name"] }.toSet() | ||
| when (CLUSTER_TYPE) { | ||
| ClusterType.OLD -> { | ||
| assertTrue(pluginNames.contains("opensearch-notifications-core")) | ||
| assertTrue(pluginNames.contains("opensearch-notifications")) | ||
| createTestNotificationsConfig(configId) | ||
| } | ||
| ClusterType.MIXED -> { | ||
| verifyConfigsExist(setOf(configId)) | ||
| } | ||
| ClusterType.UPGRADED -> { | ||
| verifyConfigsExist(setOf(configId)) | ||
| } | ||
| } | ||
| break | ||
| } | ||
| } | ||
|
|
||
| private enum class ClusterType { | ||
| OLD, | ||
| MIXED, | ||
| UPGRADED; | ||
|
|
||
| companion object { | ||
| fun parse(value: String): ClusterType { | ||
| return when (value) { | ||
| "old_cluster" -> OLD | ||
| "mixed_cluster" -> MIXED | ||
| "upgraded_cluster" -> UPGRADED | ||
| else -> throw AssertionError("Unknown cluster type: $value") | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun getPluginUri(): String { | ||
| return when (CLUSTER_TYPE) { | ||
| ClusterType.OLD -> "_nodes/$CLUSTER_NAME-0/plugins" | ||
| ClusterType.MIXED -> { | ||
| when (System.getProperty("tests.rest.bwcsuite_round")) { | ||
| "second" -> "_nodes/$CLUSTER_NAME-1/plugins" | ||
| "third" -> "_nodes/$CLUSTER_NAME-2/plugins" | ||
| else -> "_nodes/$CLUSTER_NAME-0/plugins" | ||
| } | ||
| } | ||
| ClusterType.UPGRADED -> "_nodes/plugins" | ||
| } | ||
| } | ||
|
|
||
| // TODO: Add a utility method to create random config types instead of just Slack. | ||
| // This should be generally accessible to all integ tests. | ||
| private fun createTestNotificationsConfig(configId: String) { | ||
| val requestJsonString = """ | ||
| { | ||
| "config_id": "$configId", | ||
| "config": { | ||
| "name": "This is a sample config name $configId", | ||
| "description": "This is a sample config description $configId", | ||
| "config_type": "slack", | ||
| "is_enabled": true, | ||
| "slack": { "url": "https://slack.domain.com/sample_slack_url#$configId" } | ||
| } | ||
| } | ||
| """.trimIndent() | ||
| val createResponse = executeRequest( | ||
| RestRequest.Method.POST.name, | ||
| "${NotificationPlugin.PLUGIN_BASE_URI}/configs", | ||
| requestJsonString, | ||
| RestStatus.OK.status | ||
| ) | ||
| val createdConfigId = createResponse.get("config_id").asString | ||
| assertNotNull(createdConfigId) | ||
| Thread.sleep(100) | ||
| } | ||
|
|
||
| private fun verifyConfigsExist(idSet: Set<String>) { | ||
| val getConfigsResponse = executeRequest( | ||
| RestRequest.Method.GET.name, | ||
| "${NotificationPlugin.PLUGIN_BASE_URI}/configs", | ||
| "", | ||
| RestStatus.OK.status | ||
| ) | ||
| val configList = getConfigsResponse.get("config_list").asJsonArray | ||
| assertEquals("Expected ${idSet.size} configs but found configList.size()", idSet.size, configList.size()) | ||
| configList.forEach { | ||
| val item = it.asJsonObject | ||
| val configId = item.get("config_id").asString | ||
| assertNotNull(configId) | ||
| assertTrue(idSet.contains(configId)) | ||
| } | ||
| } | ||
| } |