Get snapshots support for multiple repositories

client/rest-high-level/src/main/java/org/elasticsearch/client/SnapshotRequestConverters.java

@@ -108,7 +108,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();

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";

client/rest-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()) {

client/rest-high-level/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>

docs/reference/cat/snapshots.asciidoc

@@ -1,5 +1,5 @@
 [[cat-snapshots]]
-== cat snapshots
+== Cat single repository snapshots
 
 The `snapshots` command shows all snapshots that belong to a specific repository.
 To find a list of available repositories to query, the command `/_cat/repositories` can be used.
@@ -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+/]
@@ -32,3 +32,18 @@ Each snapshot contains information about when it was started and stopped.
 Start and stop timestamps are available in two formats.
 The `HH:MM:SS` output is simply for quick human consumption.
 The epoch time retains more information, including date, and is machine sortable if the snapshot process spans days.
+
+== Cat multiple repositories snapshots
+It is also possible to get the list of snapshots from multiple repositories.
+Here are some examples:
+
+[source,js]
+--------------------------------------------------
+GET /_cat/snapshots/_all
+GET /_cat/snapshots/repo1,repo2
+GET /_cat/snapshots/repo*
+--------------------------------------------------
+// CONSOLE
+// TEST[skip:no repo2]
+
+Please note that if one of the repositories fails during the request you will get an exception instead of the table.

docs/reference/migration/migrate_8_0/snapshots.asciidoc

@@ -9,6 +9,11 @@
 
 // end::notable-breaking-changes[]
 
+[float]
+=== Get snapshots response format is changed
+It's possible to get snapshots from multiple repositories in one go. The response format has changed
+and now contains separate response for each repository. See <<modules-snapshots>> for more information.
+
 [float]
 ==== Deprecated node level compress setting removed
 

docs/reference/modules/snapshots.asciidoc

@@ -465,6 +465,16 @@ that setting `verbose` to `false` will omit all other information about the snap
 such as status information, the number of snapshotted shards, etc.  The default
 value of the `verbose` parameter is `true`.
 
+It is also possible to retrieve snapshots for multiple repositories in one go, for example:
+[source,sh]
+-----------------------------------
+GET /_snapshot/_all
+GET /_snapshot/my_backup,my_fs_backup
+GET /_snapshot/my*/snap*
+-----------------------------------
+// CONSOLE
+// TEST[skip:no my_fs_backup]
+
 A currently running snapshot can be retrieved using the following command:
 
 [source,sh]

modules/repository-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));
     }
 }

modules/repository-url/src/test/resources/rest-api-spec/test/repository_url/10_basic.yml

@@ -112,6 +112,9 @@ teardown:
 
 ---
 "Restore with repository-url using http://":
+  - skip:
+      version: " - 7.9.99"
+      reason: "8.0 changes get snapshots response format"
 
   # Ensure that the URL repository is registered
   - do:
@@ -126,9 +129,9 @@ teardown:
         repository: repository-url
         snapshot: snapshot-one,snapshot-two
 
-  - is_true: snapshots
-  - match: { snapshots.0.state : SUCCESS }
-  - match: { snapshots.1.state : SUCCESS }
+  - is_true: responses.0.snapshots
+  - match: { responses.0.snapshots.0.state : SUCCESS }
+  - match: { responses.0.snapshots.1.state : SUCCESS }
 
   # Delete the index
   - do:
@@ -174,6 +177,9 @@ teardown:
 
 ---
 "Restore with repository-url using file://":
+  - skip:
+      version: " - 7.9.99"
+      reason: "8.0 changes get snapshots response format"
 
   # Ensure that the URL repository is registered
   - do:
@@ -188,9 +194,9 @@ teardown:
         repository: repository-file
         snapshot: snapshot-one,snapshot-two
 
-  - is_true: snapshots
-  - match: { snapshots.0.state : SUCCESS }
-  - match: { snapshots.1.state : SUCCESS }
+  - is_true: responses.0.snapshots
+  - match: { responses.0.snapshots.0.state : SUCCESS }
+  - match: { responses.0.snapshots.1.state : SUCCESS }
 
   # Delete the index
   - do:
@@ -236,13 +242,18 @@ teardown:
 
 ---
 "Get a non existing snapshot":
+  - skip:
+      version: " - 7.9.99"
+      reason: "8.0 changes get snapshots response format"
 
   - do:
-      catch: /snapshot_missing_exception/
       snapshot.get:
         repository: repository-url
         snapshot: missing
 
+  - is_true: responses.0.error
+  - match: { responses.0.error.type: snapshot_missing_exception }
+
 ---
 "Delete a non existing snapshot":
 

plugins/repository-azure/qa/microsoft-azure-storage/src/test/resources/rest-api-spec/test/repository_azure/10_repository.yml

@@ -15,6 +15,9 @@ setup:
 
 ---
 "Snapshot/Restore with repository-azure":
+  - skip:
+      version: " - 7.9.99"
+      reason: "8.0 changes get snapshots response format"
 
   # Get repository
   - do:
@@ -121,9 +124,9 @@ setup:
         repository: repository
         snapshot: snapshot-one,snapshot-two
 
-  - is_true: snapshots
-  - match: { snapshots.0.state : SUCCESS }
-  - match: { snapshots.1.state : SUCCESS }
+  - is_true: responses.0.snapshots
+  - match: { responses.0.snapshots.0.state: SUCCESS }
+  - match: { responses.0.snapshots.1.state: SUCCESS }
 
   # Delete the index
   - do:
@@ -203,13 +206,18 @@ setup:
 
 ---
 "Get a non existing snapshot":
+  - skip:
+      version: " - 7.9.99"
+      reason: "8.0 changes get snapshots response format"
 
   - do:
-      catch: /snapshot_missing_exception/
       snapshot.get:
         repository: repository
         snapshot: missing
 
+  - is_true: responses.0.error
+  - match: { responses.0.error.type: snapshot_missing_exception }
+
 ---
 "Delete a non existing snapshot":
 

plugins/repository-gcs/qa/google-cloud-storage/src/test/resources/rest-api-spec/test/repository_gcs/10_repository.yml

@@ -28,6 +28,9 @@ setup:
 
 ---
 "Snapshot/Restore with repository-gcs":
+  - skip:
+      version: " - 7.9.99"
+      reason: "8.0 changes get snapshots response format"
 
   # Get repository
   - do:
@@ -134,9 +137,9 @@ setup:
         repository: repository
         snapshot: snapshot-one,snapshot-two
 
-  - is_true: snapshots
-  - match: { snapshots.0.state : SUCCESS }
-  - match: { snapshots.1.state : SUCCESS }
+  - is_true: responses.0.snapshots
+  - match: { responses.0.snapshots.0.state : SUCCESS }
+  - match: { responses.0.snapshots.1.state : SUCCESS }
 
   # Delete the index
   - do:
@@ -213,13 +216,18 @@ setup:
 
 ---
 "Get a non existing snapshot":
+  - skip:
+      version: " - 7.9.99"
+      reason: "8.0 changes get snapshots response format"
 
   - do:
-      catch: /snapshot_missing_exception/
       snapshot.get:
         repository: repository
         snapshot: missing
 
+  - is_true: responses.0.error
+  - match: { responses.0.error.type: snapshot_missing_exception }
+
 ---
 "Delete a non existing snapshot":
 

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));