-
Notifications
You must be signed in to change notification settings - Fork 331
Bug fix: Fixing partial cache update post snapshot restore #5478
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.
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
Open
nagarajg17
wants to merge
1
commit into
opensearch-project:main
Choose a base branch
from
nagarajg17:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+201
−21
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
189 changes: 189 additions & 0 deletions
189
src/integrationTest/java/org/opensearch/security/SecurityIndexSnapshotRestoreTests.java
This file contains hidden or 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,189 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| * | ||
| * Modifications Copyright OpenSearch Contributors. See | ||
| * GitHub history for details. | ||
| */ | ||
|
|
||
| package org.opensearch.security; | ||
|
|
||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.concurrent.ExecutionException; | ||
|
|
||
| import org.apache.logging.log4j.LogManager; | ||
| import org.apache.logging.log4j.Logger; | ||
| import org.junit.After; | ||
| import org.junit.Before; | ||
| import org.junit.ClassRule; | ||
| import org.junit.Test; | ||
|
|
||
| import org.opensearch.OpenSearchStatusException; | ||
| import org.opensearch.action.admin.cluster.repositories.delete.DeleteRepositoryRequest; | ||
| import org.opensearch.action.admin.cluster.repositories.put.PutRepositoryRequest; | ||
| import org.opensearch.action.admin.cluster.snapshots.restore.RestoreSnapshotRequest; | ||
| import org.opensearch.action.admin.cluster.snapshots.restore.RestoreSnapshotResponse; | ||
| import org.opensearch.action.admin.indices.create.CreateIndexRequest; | ||
| import org.opensearch.action.admin.indices.create.CreateIndexResponse; | ||
| import org.opensearch.action.admin.indices.delete.DeleteIndexRequest; | ||
| import org.opensearch.action.get.GetRequest; | ||
| import org.opensearch.action.get.GetResponse; | ||
| import org.opensearch.action.index.IndexRequest; | ||
| import org.opensearch.action.support.WriteRequest; | ||
| import org.opensearch.client.RequestOptions; | ||
| import org.opensearch.client.RestHighLevelClient; | ||
| import org.opensearch.common.xcontent.XContentType; | ||
| import org.opensearch.core.rest.RestStatus; | ||
| import org.opensearch.security.api.AbstractApiIntegrationTest; | ||
| import org.opensearch.security.support.ConfigConstants; | ||
| import org.opensearch.test.framework.TestSecurityConfig; | ||
| import org.opensearch.test.framework.cluster.ClusterManager; | ||
| import org.opensearch.test.framework.cluster.LocalCluster; | ||
| import org.opensearch.test.framework.cluster.TestRestClient; | ||
| import org.opensearch.transport.client.Client; | ||
|
|
||
| import static org.hamcrest.MatcherAssert.assertThat; | ||
| import static org.opensearch.security.CrossClusterSearchTests.TYPE_ATTRIBUTE; | ||
| import static org.opensearch.security.SearchOperationTest.TEST_SNAPSHOT_REPOSITORY_NAME; | ||
| import static org.opensearch.security.support.ConfigConstants.SECURITY_BACKGROUND_INIT_IF_SECURITYINDEX_NOT_EXIST; | ||
| import static org.opensearch.security.support.ConfigConstants.SECURITY_RESTAPI_ROLES_ENABLED; | ||
| import static org.opensearch.test.framework.TestSecurityConfig.AuthcDomain.AUTHC_HTTPBASIC_INTERNAL; | ||
| import static org.opensearch.test.framework.TestSecurityConfig.Role.ALL_ACCESS; | ||
| import static org.opensearch.test.framework.TestSecurityConfig.User.USER_ADMIN; | ||
| import static org.opensearch.test.framework.matcher.GetResponseMatchers.containDocument; | ||
| import static org.junit.Assert.assertEquals; | ||
| import static org.junit.Assert.assertTrue; | ||
|
|
||
| public class SecurityIndexSnapshotRestoreTests extends AbstractApiIntegrationTest { | ||
| private static final Logger log = LogManager.getLogger(SecurityIndexSnapshotRestoreTests.class); | ||
|
|
||
| private static final String TEST_INDEX_NAME = "my_index_001"; | ||
| private static final String DOC_ID = "doc_id"; | ||
|
|
||
| private static final TestSecurityConfig.User ADMIN_USER = new TestSecurityConfig.User("admin").roles(ALL_ACCESS) | ||
| .attr(TYPE_ATTRIBUTE, "administrative"); | ||
|
|
||
| private static final TestSecurityConfig.User LIMITED_READ_USER_1 = new TestSecurityConfig.User("limited_read_user").roles( | ||
| new TestSecurityConfig.Role("limited-reader").indexPermissions("indices:data/read*").on(TEST_INDEX_NAME) | ||
| ); | ||
|
|
||
| private static final TestSecurityConfig.User LIMITED_READ_USER_2 = new TestSecurityConfig.User("user2"); | ||
|
|
||
| private static final TestSecurityConfig.Role LIMITED_READ_USER_2_ROLE = new TestSecurityConfig.Role("limited-reader_2") | ||
| .indexPermissions("indices:data/read*") | ||
| .on(TEST_INDEX_NAME); | ||
|
|
||
| private String securityIndex; | ||
|
|
||
| @ClassRule | ||
| public static LocalCluster cluster = new LocalCluster.Builder().clusterManager(ClusterManager.THREE_CLUSTER_MANAGERS) | ||
| .authc(AUTHC_HTTPBASIC_INTERNAL) | ||
| .users(ADMIN_USER, LIMITED_READ_USER_1) | ||
| .anonymousAuth(false) | ||
| .nodeSettings( | ||
| Map.of( | ||
| SECURITY_RESTAPI_ROLES_ENABLED, | ||
| List.of("user_" + USER_ADMIN.getName() + "__" + ALL_ACCESS.getName()), | ||
| SECURITY_BACKGROUND_INIT_IF_SECURITYINDEX_NOT_EXIST, | ||
| false | ||
| ) | ||
| ) | ||
| .build(); | ||
|
|
||
| @Before | ||
| public void setUp() throws Exception { | ||
| securityIndex = ConfigConstants.OPENDISTRO_SECURITY_DEFAULT_CONFIG_INDEX; | ||
|
|
||
| try (Client client = cluster.getInternalNodeClient()) { | ||
| client.admin() | ||
| .cluster() | ||
| .putRepository( | ||
| new PutRepositoryRequest(TEST_SNAPSHOT_REPOSITORY_NAME).type("fs") | ||
| .settings(Map.of("location", cluster.getSnapshotDirPath())) | ||
| ) | ||
| .actionGet(); | ||
|
|
||
| CreateIndexResponse createIndexResponse = client.admin().indices().create(new CreateIndexRequest(TEST_INDEX_NAME)).actionGet(); | ||
| assertTrue(createIndexResponse.isAcknowledged()); | ||
|
|
||
| client.index( | ||
| new IndexRequest(TEST_INDEX_NAME).id(DOC_ID) | ||
| .source("{\"message\": \"test document 1\"}", XContentType.JSON) | ||
| .setRefreshPolicy(WriteRequest.RefreshPolicy.IMMEDIATE) | ||
| ).actionGet(); | ||
| } | ||
| } | ||
|
|
||
| @After | ||
| public void cleanData() throws ExecutionException, InterruptedException { | ||
| try (Client client = cluster.getInternalNodeClient()) { | ||
| client.admin().indices().delete(new DeleteIndexRequest(TEST_INDEX_NAME)).actionGet(); | ||
|
|
||
| client.admin().cluster().deleteRepository(new DeleteRepositoryRequest(TEST_SNAPSHOT_REPOSITORY_NAME)).actionGet(); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testSecurityCacheReloadAfterRestore() throws Exception { | ||
| // 1. Read data in custom index with LIMITED_READ_USER_1 | ||
| try (RestHighLevelClient restHighLevelClient = cluster.getRestHighLevelClient(LIMITED_READ_USER_1)) { | ||
| GetResponse response = restHighLevelClient.get(new GetRequest(TEST_INDEX_NAME, DOC_ID), RequestOptions.DEFAULT); | ||
| assertThat(response, containDocument(TEST_INDEX_NAME, DOC_ID)); | ||
| } | ||
|
|
||
| // 2. Create snapshot of security index | ||
| try (RestHighLevelClient restHighLevelClient = cluster.getRestHighLevelClient(ADMIN_USER)) { | ||
| SnapshotSteps steps = new SnapshotSteps(restHighLevelClient); | ||
| steps.createSnapshot(TEST_SNAPSHOT_REPOSITORY_NAME, "test-snap", securityIndex); | ||
| steps.waitForSnapshotCreation(TEST_SNAPSHOT_REPOSITORY_NAME, "test-snap"); | ||
| } | ||
|
|
||
| // 3. Add new role and user to security index (This is not in snapshot created above) | ||
| try (TestRestClient client = cluster.getRestClient(ADMIN_USER)) { | ||
| client.createRole(LIMITED_READ_USER_2_ROLE.getName(), LIMITED_READ_USER_2_ROLE).assertStatusCode(201); | ||
| client.createUser(LIMITED_READ_USER_2.getName(), LIMITED_READ_USER_2).assertStatusCode(201); | ||
| client.assignRoleToUser(LIMITED_READ_USER_2.getName(), "limited-reader_2").assertStatusCode(200); | ||
| } | ||
|
|
||
| // 4. Read data in custom index with LIMITED_READ_USER_2 | ||
| try (RestHighLevelClient restHighLevelClient = cluster.getRestHighLevelClient(LIMITED_READ_USER_2)) { | ||
| GetResponse response = restHighLevelClient.get(new GetRequest(TEST_INDEX_NAME, DOC_ID), RequestOptions.DEFAULT); | ||
| assertThat(response, containDocument(TEST_INDEX_NAME, DOC_ID)); | ||
| } | ||
|
|
||
| // 5. Delete security index | ||
| try (Client client = cluster.getInternalNodeClient()) { | ||
| DeleteIndexRequest deleteRequest = new DeleteIndexRequest(securityIndex); | ||
| client.admin().indices().delete(deleteRequest).actionGet(); | ||
| } | ||
|
|
||
| // 6. Restore security index | ||
| try (Client client = cluster.getInternalNodeClient()) { | ||
| RestoreSnapshotRequest restoreRequest = new RestoreSnapshotRequest(TEST_SNAPSHOT_REPOSITORY_NAME, "test-snap") | ||
| .waitForCompletion(true) | ||
| .indices(securityIndex); // restore security index | ||
|
|
||
| RestoreSnapshotResponse restoreResponse = client.admin().cluster().restoreSnapshot(restoreRequest).actionGet(); | ||
|
|
||
| // Verify restore was successful | ||
| assertEquals(RestStatus.OK, restoreResponse.status()); | ||
| } | ||
|
|
||
| // 7. Read data in custom index with LIMITED_READ_USER_1 because it was in snapshot | ||
| try (RestHighLevelClient restHighLevelClient = cluster.getRestHighLevelClient(LIMITED_READ_USER_1)) { | ||
| GetResponse response = restHighLevelClient.get(new GetRequest(TEST_INDEX_NAME, DOC_ID), RequestOptions.DEFAULT); | ||
| assertThat(response, containDocument(TEST_INDEX_NAME, DOC_ID)); | ||
| } | ||
|
|
||
| // 8. Should get 401 error to read custom index with LIMITED_READ_USER_2 because it was not in snapshot | ||
| try (RestHighLevelClient restHighLevelClient = cluster.getRestHighLevelClient(LIMITED_READ_USER_2)) { | ||
| restHighLevelClient.get(new GetRequest(TEST_INDEX_NAME, DOC_ID), RequestOptions.DEFAULT); | ||
| } catch (OpenSearchStatusException exception) { | ||
| assertEquals(RestStatus.UNAUTHORIZED, exception.status()); // Verify it's a 401 | ||
| } | ||
| } | ||
| } |
This file contains hidden or 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 hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nagarajg17 can you fix the CHANGELOG here? Otherwise this looks good to me.