Skip to content

[Backport 2.x] GET SM policies return empty list when ism config index does not exist #1078

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 25, 2024
Merged

[Backport 2.x] GET SM policies return empty list when ism config index does not exist #1078

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76da35e
GET SM policies return empty list when ism config index does not exis…
github-actions[bot] Jan 24, 2024
b5cece6
Merge branch '2.x' into backport/backport-1072-to-2.x
bowenlan-amzn Jan 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions ...arch/indexmanagement/snapshotmanagement/api/transport/get/TransportGetSMPoliciesAction.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import org.opensearch.common.settings.Settings
import org.opensearch.common.util.concurrent.ThreadContext
import org.opensearch.commons.authuser.User
import org.opensearch.index.IndexNotFoundException
import org.opensearch.ExceptionsHelper
import org.opensearch.index.query.BoolQueryBuilder
import org.opensearch.index.query.ExistsQueryBuilder
import org.opensearch.index.query.Operator
Expand Down Expand Up @@ -69,12 +70,18 @@ class TransportGetSMPoliciesAction @Inject constructor(

private suspend fun getAllPolicies(searchParams: SearchParams, user: User?): Pair<List<SMPolicy>, Long> {
val searchRequest = getAllPoliciesRequest(searchParams, user)
val searchResponse: SearchResponse = try {
client.suspendUntil { search(searchRequest, it) }
} catch (e: IndexNotFoundException) {
throw OpenSearchStatusException("Snapshot management config index not found", RestStatus.NOT_FOUND)
return try {
val searchResponse = client.suspendUntil { search(searchRequest, it) }
parseGetAllPoliciesResponse(searchResponse)
} catch (e: Exception) {
val unwrappedException = ExceptionsHelper.unwrapCause(e) as Exception
if (unwrappedException is IndexNotFoundException) {
// config index hasn't been initialized, catch this here and show empty result for policies
Pair(emptyList(), 0L)
} else {
throw unwrappedException
}
}
return parseGetAllPoliciesResponse(searchResponse)
}

private fun getAllPoliciesRequest(searchParams: SearchParams, user: User?): SearchRequest {
Expand Down
14 changes: 14 additions & 0 deletions .../opensearch/indexmanagement/snapshotmanagement/resthandler/RestGetSnapshotManagementIT.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,20 @@ class RestGetSnapshotManagementIT : SnapshotManagementRestTestCase() {
}
}

@Throws(Exception::class)
@Suppress("UNCHECKED_CAST")
fun `test getting all snapshot management policies when config index doesn't exist`() {
val response = client().makeRequest(
"GET", IndexManagementPlugin.SM_POLICIES_URI, null,
BasicHeader(HttpHeaders.CONTENT_TYPE, "application/json")
)
val map = response.asMap()
val totalPolicies = map["total_policies"] as Int
val responsePolicies = map["policies"] as List<Map<String, Any?>>
assertTrue("Total policies is 0", totalPolicies == 0)
assertTrue("Response list of policies is empty", responsePolicies.isEmpty())
}

@Throws(Exception::class)
@Suppress("UNCHECKED_CAST")
fun `test getting all snapshot management policies with search params`() {
Expand Down