Skip to content
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

Fix system_repository setting is restored after cluster metadata recovery from local disk #10556

Merged
merged 3 commits into from
Oct 12, 2023
Merged

Fix system_repository setting is restored after cluster metadata recovery from local disk #10556

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b10367b
Fix system_repository setting is restored after cluster metadata reco…
linuxpi Oct 11, 2023
ae52cb2
add Integ Tests
linuxpi Oct 11, 2023
b3860c3
rename test method
linuxpi Oct 11, 2023
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
19 changes: 19 additions & 0 deletions ...ernalClusterTest/java/org/opensearch/remotestore/RemoteStoreRepositoryRegistrationIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,31 @@

package org.opensearch.remotestore;

import org.opensearch.action.admin.cluster.repositories.get.GetRepositoriesAction;
import org.opensearch.action.admin.cluster.repositories.get.GetRepositoriesRequest;
import org.opensearch.action.admin.cluster.repositories.get.GetRepositoriesResponse;
import org.opensearch.client.Client;
import org.opensearch.cluster.metadata.RepositoryMetadata;
import org.opensearch.common.settings.Settings;
import org.opensearch.common.xcontent.XContentType;
import org.opensearch.core.common.unit.ByteSizeValue;
import org.opensearch.core.xcontent.MediaTypeRegistry;
import org.opensearch.core.xcontent.ToXContent;
import org.opensearch.core.xcontent.XContentBuilder;
import org.opensearch.plugins.Plugin;
import org.opensearch.test.OpenSearchIntegTestCase;
import org.opensearch.test.disruption.NetworkDisruption;
import org.opensearch.test.transport.MockTransportService;

import java.io.IOException;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;
import java.util.stream.Collectors;

import static org.opensearch.repositories.blobstore.BlobStoreRepository.SYSTEM_REPOSITORY_SETTING;

@OpenSearchIntegTestCase.ClusterScope(scope = OpenSearchIntegTestCase.Scope.TEST, numDataNodes = 0)
public class RemoteStoreRepositoryRegistrationIT extends RemoteStoreBaseIntegTestCase {

Expand Down Expand Up @@ -162,4 +172,13 @@ public void testNodeRestartPostNonRestrictedSettingsUpdate() throws Exception {

ensureStableCluster(4);
}

public void testSystemRepositorySettingIsHiddenForGetRepositoriesRequest() throws IOException {
GetRepositoriesRequest request = new GetRepositoriesRequest(new String[] { REPOSITORY_NAME });
GetRepositoriesResponse repositoriesResponse = client().execute(GetRepositoriesAction.INSTANCE, request).actionGet();
XContentBuilder builder = MediaTypeRegistry.contentBuilder(randomFrom(XContentType.JSON));
XContentBuilder xContentBuilder = repositoriesResponse.toXContent(builder, ToXContent.EMPTY_PARAMS);
repositoriesResponse = GetRepositoriesResponse.fromXContent(createParser(xContentBuilder));
assertEquals(false, SYSTEM_REPOSITORY_SETTING.get(repositoriesResponse.repositories().get(0).settings()));
}
}
7 changes: 5 additions & 2 deletions ...in/java/org/opensearch/action/admin/cluster/repositories/get/GetRepositoriesResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@
import org.opensearch.core.xcontent.XContentParser;

import java.io.IOException;
import java.util.Collections;
import java.util.List;
import java.util.Map;

import static org.opensearch.core.xcontent.XContentParserUtils.ensureExpectedToken;

Expand Down Expand Up @@ -83,7 +83,10 @@
builder.startObject();
repositories.toXContent(
builder,
new DelegatingMapParams(Collections.singletonMap(RepositoriesMetadata.HIDE_GENERATIONS_PARAM, "true"), params)
new DelegatingMapParams(
Map.of(RepositoriesMetadata.HIDE_GENERATIONS_PARAM, "true", RepositoriesMetadata.HIDE_SYSTEM_REPOSITORY_SETTING, "true"),

Check warning on line 87 in server/src/main/java/org/opensearch/action/admin/cluster/repositories/get/GetRepositoriesResponse.java

View check run for this annotation

Codecov / codecov/patch

server/src/main/java/org/opensearch/action/admin/cluster/repositories/get/GetRepositoriesResponse.java#L87 

Added line #L87 was not covered by tests
params
)
);
builder.endObject();
return builder;
Expand Down
3 changes: 2 additions & 1 deletion server/src/main/java/org/opensearch/cluster/metadata/RepositoriesMetadata.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ public class RepositoriesMetadata extends AbstractNamedDiffable<Custom> implemen
* in {@link org.opensearch.action.admin.cluster.repositories.get.GetRepositoriesResponse}.
*/
public static final String HIDE_GENERATIONS_PARAM = "hide_generations";
public static final String HIDE_SYSTEM_REPOSITORY_SETTING = "hide_system_repository_setting";

private final List<RepositoryMetadata> repositories;

Expand Down Expand Up @@ -291,7 +292,7 @@ public static void toXContent(RepositoryMetadata repository, XContentBuilder bui
repository.cryptoMetadata().toXContent(repository.cryptoMetadata(), builder, params);
}
Settings settings = repository.settings();
if (SYSTEM_REPOSITORY_SETTING.get(settings)) {
if (SYSTEM_REPOSITORY_SETTING.get(settings) && params.paramAsBoolean(HIDE_SYSTEM_REPOSITORY_SETTING, false)) {
linuxpi marked this conversation as resolved.
Show resolved Hide resolved
settings = repository.settings().filter(s -> !s.equals(SYSTEM_REPOSITORY_SETTING.getKey()));
}
builder.startObject("settings");
Expand Down
Loading