Get snapshots support for multiple repositories

elastic · May 10, 2019 · 80edff1 · 80edff1
1 parent 3647d7c
commit 80edff1
Show file tree

Hide file tree

Showing 31 changed files with 706 additions and 316 deletions.
diff --git a/client/rest-high-level/src/main/java/org/elasticsearch/client/SnapshotRequestConverters.java b/client/rest-high-level/src/main/java/org/elasticsearch/client/SnapshotRequestConverters.java
@@ -104,7 +104,7 @@ static Request createSnapshot(CreateSnapshotRequest createSnapshotRequest) throw
 
     static Request getSnapshots(GetSnapshotsRequest getSnapshotsRequest) {
         RequestConverters.EndpointBuilder endpointBuilder = new RequestConverters.EndpointBuilder().addPathPartAsIs("_snapshot")
-            .addPathPart(getSnapshotsRequest.repository());
+            .addCommaSeparatedPathParts(getSnapshotsRequest.repositories());
         String endpoint;
         if (getSnapshotsRequest.snapshots().length == 0) {
             endpoint = endpointBuilder.addPathPart("_all").build();

diff --git a/client/rest-high-level/src/test/java/org/elasticsearch/client/SnapshotIT.java b/client/rest-high-level/src/test/java/org/elasticsearch/client/SnapshotIT.java
@@ -41,14 +41,14 @@
 import org.elasticsearch.repositories.fs.FsRepository;
 import org.elasticsearch.rest.RestStatus;
 import org.elasticsearch.snapshots.RestoreInfo;
+import org.mockito.internal.util.collections.Sets;
 
 import java.io.IOException;
 import java.util.Collections;
-import java.util.stream.Collectors;
 
-import static org.hamcrest.Matchers.contains;
 import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.greaterThan;
+import static org.hamcrest.Matchers.hasSize;
 import static org.hamcrest.Matchers.is;
 
 public class SnapshotIT extends ESRestHighLevelClientTestCase {
@@ -155,39 +155,48 @@ public void testCreateSnapshot() throws IOException {
     }
 
     public void testGetSnapshots() throws IOException {
-        String repository = "test_repository";
+        String repository1 = "test_repository1";
+        String repository2 = "test_repository2";
         String snapshot1 = "test_snapshot1";
         String snapshot2 = "test_snapshot2";
 
-        AcknowledgedResponse putRepositoryResponse = createTestRepository(repository, FsRepository.TYPE, "{\"location\": \".\"}");
+        AcknowledgedResponse putRepositoryResponse =
+                createTestRepository(repository1, FsRepository.TYPE, "{\"location\": \"loc1\"}");
         assertTrue(putRepositoryResponse.isAcknowledged());
 
-        CreateSnapshotRequest createSnapshotRequest1 = new CreateSnapshotRequest(repository, snapshot1);
+        AcknowledgedResponse putRepositoryResponse2 =
+                createTestRepository(repository2, FsRepository.TYPE, "{\"location\": \"loc2\"}");
+        assertTrue(putRepositoryResponse2.isAcknowledged());
+
+        CreateSnapshotRequest createSnapshotRequest1 = new CreateSnapshotRequest(repository1, snapshot1);
         createSnapshotRequest1.waitForCompletion(true);
         CreateSnapshotResponse putSnapshotResponse1 = createTestSnapshot(createSnapshotRequest1);
-        CreateSnapshotRequest createSnapshotRequest2 = new CreateSnapshotRequest(repository, snapshot2);
+        CreateSnapshotRequest createSnapshotRequest2 = new CreateSnapshotRequest(repository2, snapshot2);
         createSnapshotRequest2.waitForCompletion(true);
         CreateSnapshotResponse putSnapshotResponse2 = createTestSnapshot(createSnapshotRequest2);
         // check that the request went ok without parsing JSON here. When using the high level client, check acknowledgement instead.
         assertEquals(RestStatus.OK, putSnapshotResponse1.status());
         assertEquals(RestStatus.OK, putSnapshotResponse2.status());
 
-        GetSnapshotsRequest request;
-        if (randomBoolean()) {
-            request = new GetSnapshotsRequest(repository);
-        } else if (randomBoolean()) {
-            request = new GetSnapshotsRequest(repository, new String[] {"_all"});
+        GetSnapshotsRequest request = new GetSnapshotsRequest(
+                randomFrom(new String[]{"_all"}, new String[]{"*"}, new String[]{repository1, repository2}),
+                randomFrom(new String[]{"_all"}, new String[]{"*"}, new String[]{snapshot1, snapshot2})
+        );
+        request.ignoreUnavailable(true);
 
-        } else {
-            request = new GetSnapshotsRequest(repository, new String[] {snapshot1, snapshot2});
-        }
         GetSnapshotsResponse response = execute(request, highLevelClient().snapshot()::get, highLevelClient().snapshot()::getAsync);
 
-        assertEquals(2, response.getSnapshots().size());
-        assertThat(response.getSnapshots().stream().map((s) -> s.snapshotId().getName()).collect(Collectors.toList()),
-            contains("test_snapshot1", "test_snapshot2"));
+        assertThat(response.isFailed(), is(false));
+        assertThat(response.getRepositories(), equalTo(Sets.newSet(repository1, repository2)));
+
+        assertThat(response.getSnapshots(repository1), hasSize(1));
+        assertThat(response.getSnapshots(repository1).get(0).snapshotId().getName(), equalTo(snapshot1));
+
+        assertThat(response.getSnapshots(repository2), hasSize(1));
+        assertThat(response.getSnapshots(repository2).get(0).snapshotId().getName(), equalTo(snapshot2));
     }
 
+
     public void testSnapshotsStatus() throws IOException {
         String testRepository = "test";
         String testSnapshot = "snapshot";

diff --git a/...est-high-level/src/test/java/org/elasticsearch/client/SnapshotRequestConvertersTests.java b/...est-high-level/src/test/java/org/elasticsearch/client/SnapshotRequestConvertersTests.java
@@ -41,7 +41,6 @@
 
 import java.io.IOException;
 import java.nio.file.Path;
-import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Locale;
 import java.util.Map;
@@ -148,15 +147,16 @@ public void testCreateSnapshot() throws IOException {
 
     public void testGetSnapshots() {
         Map<String, String> expectedParams = new HashMap<>();
-        String repository = RequestConvertersTests.randomIndicesNames(1, 1)[0];
+        String repository1 = randomAlphaOfLength(10);
+        String repository2 = randomAlphaOfLength(10);
         String snapshot1 = "snapshot1-" + randomAlphaOfLengthBetween(2, 5).toLowerCase(Locale.ROOT);
         String snapshot2 = "snapshot2-" + randomAlphaOfLengthBetween(2, 5).toLowerCase(Locale.ROOT);
 
-        String endpoint = String.format(Locale.ROOT, "/_snapshot/%s/%s,%s", repository, snapshot1, snapshot2);
+        String endpoint = String.format(Locale.ROOT, "/_snapshot/%s,%s/%s,%s", repository1, repository2, snapshot1, snapshot2);
 
         GetSnapshotsRequest getSnapshotsRequest = new GetSnapshotsRequest();
-        getSnapshotsRequest.repository(repository);
-        getSnapshotsRequest.snapshots(Arrays.asList(snapshot1, snapshot2).toArray(new String[0]));
+        getSnapshotsRequest.repositories(repository1, repository2);
+        getSnapshotsRequest.snapshots(new String[]{snapshot1, snapshot2});
         RequestConvertersTests.setRandomMasterTimeout(getSnapshotsRequest, expectedParams);
 
         if (randomBoolean()) {

diff --git a/...l/src/test/java/org/elasticsearch/client/documentation/SnapshotClientDocumentationIT.java b/...l/src/test/java/org/elasticsearch/client/documentation/SnapshotClientDocumentationIT.java
@@ -590,7 +590,7 @@ public void testSnapshotGetSnapshots() throws IOException {
         // end::get-snapshots-request
 
         // tag::get-snapshots-request-repositoryName
-        request.repository(repositoryName); // <1>
+        request.repositories(repositoryName); // <1>
         // end::get-snapshots-request-repositoryName
 
         // tag::get-snapshots-request-snapshots
@@ -616,7 +616,7 @@ public void testSnapshotGetSnapshots() throws IOException {
         // end::get-snapshots-execute
 
         // tag::get-snapshots-response
-        List<SnapshotInfo> snapshotsInfos = response.getSnapshots();
+        List<SnapshotInfo> snapshotsInfos = response.getSnapshots(repositoryName);
         SnapshotInfo snapshotInfo = snapshotsInfos.get(0);
         RestStatus restStatus = snapshotInfo.status(); // <1>
         SnapshotId snapshotId = snapshotInfo.snapshotId(); // <2>

diff --git a/docs/reference/cat/snapshots.asciidoc b/docs/reference/cat/snapshots.asciidoc
@@ -18,9 +18,9 @@ Which looks like:
 
 [source,txt]
 --------------------------------------------------
-id     status start_epoch start_time end_epoch  end_time duration indices successful_shards failed_shards total_shards
-snap1  FAILED 1445616705  18:11:45   1445616978 18:16:18     4.6m       1                 4             1            5
-snap2 SUCCESS 1445634298  23:04:58   1445634672 23:11:12     6.2m       2                10             0           10
+id     repository status start_epoch start_time end_epoch  end_time duration indices successful_shards failed_shards total_shards
+snap1  repo1      FAILED 1445616705  18:11:45   1445616978 18:16:18     4.6m       1                 4             1            5
+snap2  repo1      SUCCESS 1445634298  23:04:58   1445634672 23:11:12     6.2m       2                10             0           10
 --------------------------------------------------
 // TESTRESPONSE[s/FAILED/SUCCESS/ s/14456\d+/\\d+/ s/\d+(\.\d+)?(m|s|ms)/\\d+(\\.\\d+)?(m|s|ms)/]
 // TESTRESPONSE[s/\d+:\d+:\d+/\\d+:\\d+:\\d+/]

diff --git a/...ository-url/src/test/java/org/elasticsearch/repositories/url/URLSnapshotRestoreTests.java b/...ository-url/src/test/java/org/elasticsearch/repositories/url/URLSnapshotRestoreTests.java
@@ -88,7 +88,7 @@ public void testUrlRepository() throws Exception {
             .prepareGetSnapshots("test-repo")
             .setSnapshots("test-snap")
             .get()
-            .getSnapshots()
+            .getSnapshots("test-repo")
             .get(0)
             .state();
         assertThat(state, equalTo(SnapshotState.SUCCESS));
@@ -116,16 +116,16 @@ public void testUrlRepository() throws Exception {
 
         logger.info("--> list available shapshots");
         GetSnapshotsResponse getSnapshotsResponse = client.admin().cluster().prepareGetSnapshots("url-repo").get();
-        assertThat(getSnapshotsResponse.getSnapshots(), notNullValue());
-        assertThat(getSnapshotsResponse.getSnapshots().size(), equalTo(1));
+        assertThat(getSnapshotsResponse.getSnapshots("url-repo"), notNullValue());
+        assertThat(getSnapshotsResponse.getSnapshots("url-repo").size(), equalTo(1));
 
         logger.info("--> delete snapshot");
         AcknowledgedResponse deleteSnapshotResponse = client.admin().cluster().prepareDeleteSnapshot("test-repo", "test-snap").get();
         assertAcked(deleteSnapshotResponse);
 
         logger.info("--> list available shapshot again, no snapshots should be returned");
         getSnapshotsResponse = client.admin().cluster().prepareGetSnapshots("url-repo").get();
-        assertThat(getSnapshotsResponse.getSnapshots(), notNullValue());
-        assertThat(getSnapshotsResponse.getSnapshots().size(), equalTo(0));
+        assertThat(getSnapshotsResponse.getSnapshots("url-repo"), notNullValue());
+        assertThat(getSnapshotsResponse.getSnapshots("url-repo").size(), equalTo(0));
     }
 }
diff --git a/plugins/repository-hdfs/src/test/java/org/elasticsearch/repositories/hdfs/HdfsTests.java b/plugins/repository-hdfs/src/test/java/org/elasticsearch/repositories/hdfs/HdfsTests.java
@@ -91,7 +91,7 @@ public void testSimpleWorkflow() {
             .prepareGetSnapshots("test-repo")
             .setSnapshots("test-snap")
             .get()
-            .getSnapshots()
+            .getSnapshots("test-repo")
             .get(0)
             .state(),
             equalTo(SnapshotState.SUCCESS));

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/cat.snapshots/10_basic.yml b/rest-api-spec/src/main/resources/rest-api-spec/test/cat.snapshots/10_basic.yml
@@ -1,12 +1,17 @@
 ---
 "Help":
+  - skip:
+    version: " - 7.9.99"
+    reason: Repository field added in 8.0
+
   - do:
       cat.snapshots:
         help: true
 
   - match:
       $body: |
                /^   id                .+   \n
+                    repository        .+   \n
                     status            .+   \n
                     start_epoch       .+   \n
                     start_time        .+   \n
@@ -21,6 +26,9 @@
                $/
 ---
 "Test cat snapshots output":
+  - skip:
+      version: " - 7.9.99"
+      reason: Repository field added in 8.0
 
   - do:
       snapshot.create_repository:
@@ -74,6 +82,6 @@
 
   - match:
       $body: |
-               /^   snap1\s+ SUCCESS\s+ \d+\s+ \d\d\:\d\d\:\d\d\s+ \d+\s+ \d\d\:\d\d\:\d\d\s+ \S+\s+ 2\s+ 2\s+ 0\s+ 2\s*\n
-                    snap2\s+ SUCCESS\s+ \d+\s+ \d\d\:\d\d\:\d\d\s+ \d+\s+ \d\d\:\d\d\:\d\d\s+ \S+\s+ 2\s+ 2\s+ 0\s+ 2\s*\n
+               /^   snap1\s+ test_cat_snapshots_1\+ SUCCESS\s+ \d+\s+ \d\d\:\d\d\:\d\d\s+ \d+\s+ \d\d\:\d\d\:\d\d\s+ \S+\s+ 2\s+ 2\s+ 0\s+ 2\s*\n
+                    snap2\s+ test_cat_snapshots_1\+ SUCCESS\s+ \d+\s+ \d\d\:\d\d\:\d\d\s+ \d+\s+ \d\d\:\d\d\:\d\d\s+ \S+\s+ 2\s+ 2\s+ 0\s+ 2\s*\n
                $/
diff --git a/...java/org/elasticsearch/action/admin/cluster/repositories/get/GetRepositoriesResponse.java b/...java/org/elasticsearch/action/admin/cluster/repositories/get/GetRepositoriesResponse.java
@@ -49,6 +49,10 @@ public class GetRepositoriesResponse extends ActionResponse implements ToXConten
         this.repositories = repositories;
     }
 
+    public GetRepositoriesResponse(StreamInput in) throws IOException {
+        readFrom(in);
+    }
+
     /**
      * List of repositories to return
      *

diff --git a/...c/main/java/org/elasticsearch/action/admin/cluster/snapshots/get/GetSnapshotsRequest.java b/...c/main/java/org/elasticsearch/action/admin/cluster/snapshots/get/GetSnapshotsRequest.java
@@ -19,6 +19,7 @@
 
 package org.elasticsearch.action.admin.cluster.snapshots.get;
 
+import org.elasticsearch.Version;
 import org.elasticsearch.action.ActionRequestValidationException;
 import org.elasticsearch.action.support.master.MasterNodeRequest;
 import org.elasticsearch.common.Strings;
@@ -37,8 +38,9 @@ public class GetSnapshotsRequest extends MasterNodeRequest<GetSnapshotsRequest>
     public static final String ALL_SNAPSHOTS = "_all";
     public static final String CURRENT_SNAPSHOT = "_current";
     public static final boolean DEFAULT_VERBOSE_MODE = true;
+    public static final Version MULTIPLE_REPOSITORIES_SUPPORT_ADDED = Version.V_8_0_0;
 
-    private String repository;
+    private String[] repositories;
 
     private String[] snapshots = Strings.EMPTY_ARRAY;
 
@@ -50,28 +52,32 @@ public GetSnapshotsRequest() {
     }
 
     /**
-     * Constructs a new get snapshots request with given repository name and list of snapshots
+     * Constructs a new get snapshots request with given repository names and list of snapshots
      *
-     * @param repository repository name
+     * @param repositories repository names
      * @param snapshots  list of snapshots
      */
-    public GetSnapshotsRequest(String repository, String[] snapshots) {
-        this.repository = repository;
+    public GetSnapshotsRequest(String[] repositories, String[] snapshots) {
+        this.repositories = repositories;
         this.snapshots = snapshots;
     }
 
     /**
-     * Constructs a new get snapshots request with given repository name
+     * Constructs a new get snapshots request with given repository names
      *
-     * @param repository repository name
+     * @param repositories repository names
      */
-    public GetSnapshotsRequest(String repository) {
-        this.repository = repository;
+    public GetSnapshotsRequest(String... repositories) {
+        this.repositories = repositories;
     }
 
     public GetSnapshotsRequest(StreamInput in) throws IOException {
         super(in);
-        repository = in.readString();
+        if (in.getVersion().onOrAfter(MULTIPLE_REPOSITORIES_SUPPORT_ADDED)) {
+            repositories = in.readStringArray();
+        } else {
+            repositories = new String[]{in.readString()};
+        }
         snapshots = in.readStringArray();
         ignoreUnavailable = in.readBoolean();
         verbose = in.readBoolean();
@@ -80,7 +86,11 @@ public GetSnapshotsRequest(StreamInput in) throws IOException {
     @Override
     public void writeTo(StreamOutput out) throws IOException {
         super.writeTo(out);
-        out.writeString(repository);
+        if (out.getVersion().onOrAfter(MULTIPLE_REPOSITORIES_SUPPORT_ADDED)) {
+            out.writeStringArray(repositories);
+        } else {
+            out.writeString(repositories[0]);
+        }
         out.writeStringArray(snapshots);
         out.writeBoolean(ignoreUnavailable);
         out.writeBoolean(verbose);
@@ -89,30 +99,30 @@ public void writeTo(StreamOutput out) throws IOException {
     @Override
     public ActionRequestValidationException validate() {
         ActionRequestValidationException validationException = null;
-        if (repository == null) {
-            validationException = addValidationError("repository is missing", validationException);
+        if (repositories == null || repositories.length == 0) {
+            validationException = addValidationError("repositories are missing", validationException);
         }
         return validationException;
     }
 
     /**
-     * Sets repository name
+     * Sets repository names
      *
-     * @param repository repository name
+     * @param repositories repository names
      * @return this request
      */
-    public GetSnapshotsRequest repository(String repository) {
-        this.repository = repository;
+    public GetSnapshotsRequest repositories(String... repositories) {
+        this.repositories = repositories;
         return this;
     }
 
     /**
-     * Returns repository name
+     * Returns repository names
      *
-     * @return repository name
+     * @return repository names
      */
-    public String repository() {
-        return this.repository;
+    public String[] repositories() {
+        return this.repositories;
     }
 
     /**
@@ -176,4 +186,4 @@ public boolean verbose() {
     public void readFrom(StreamInput in) throws IOException {
         throw new UnsupportedOperationException("usage of Streamable is to be replaced by Writeable");
     }
-}
+}
diff --git a/...java/org/elasticsearch/action/admin/cluster/snapshots/get/GetSnapshotsRequestBuilder.java b/...java/org/elasticsearch/action/admin/cluster/snapshots/get/GetSnapshotsRequestBuilder.java
@@ -30,27 +30,20 @@ public class GetSnapshotsRequestBuilder extends MasterNodeOperationRequestBuilde
         GetSnapshotsResponse, GetSnapshotsRequestBuilder> {
 
     /**
-     * Constructs the new get snapshot request
+     * Constructs the new get snapshot request with specified repositories
      */
-    public GetSnapshotsRequestBuilder(ElasticsearchClient client, GetSnapshotsAction action) {
-        super(client, action, new GetSnapshotsRequest());
+    public GetSnapshotsRequestBuilder(ElasticsearchClient client, GetSnapshotsAction action, String... repositories) {
+        super(client, action, new GetSnapshotsRequest(repositories));
     }
 
     /**
-     * Constructs the new get snapshot request with specified repository
-     */
-    public GetSnapshotsRequestBuilder(ElasticsearchClient client, GetSnapshotsAction action, String repository) {
-        super(client, action, new GetSnapshotsRequest(repository));
-    }
-
-    /**
-     * Sets the repository name
+     * Sets the repository names
      *
-     * @param repository repository name
+     * @param repositories repository names
      * @return this builder
      */
-    public GetSnapshotsRequestBuilder setRepository(String repository) {
-        request.repository(repository);
+    public GetSnapshotsRequestBuilder setRepositories(String... repositories) {
+        request.repositories(repositories);
         return this;
     }