Improve SnapshotInfo serialization tests (#71677)

Today we have no tests that directly verify that `SnapshotInfo`
correctly round-trips through its in-repository `XContent`-based
representation. We do have tests that verify that it correctly
round-trips through the wire format, but these tests always use an empty
collection for `featureStates`.

This commit strengthens the wire format round-trip tests to use
nontrivial `featureStates`, and generalizes these tests to also verify
that the `XContent` representation is faithful.

Author: DaveCTurner

server/src/internalClusterTest/java/org/elasticsearch/cluster/ClusterStateDiffIT.java

@@ -45,7 +45,7 @@
 import org.elasticsearch.index.shard.ShardId;
 import org.elasticsearch.snapshots.Snapshot;
 import org.elasticsearch.snapshots.SnapshotId;
-import org.elasticsearch.snapshots.SnapshotInfoTests;
+import org.elasticsearch.snapshots.SnapshotInfoTestUtils;
 import org.elasticsearch.snapshots.SnapshotsInProgressSerializationTests;
 import org.elasticsearch.test.ESIntegTestCase;
 
@@ -713,7 +713,7 @@ public ClusterState.Custom randomCreate(String name) {
                                 Math.abs(randomLong()), randomIntBetween(0, 1000),
                                 ImmutableOpenMap.of(),
                                 null,
-                                SnapshotInfoTests.randomUserMetadata(),
+                                SnapshotInfoTestUtils.randomUserMetadata(),
                                 randomVersion(random()))));
                     case 1:
                         return new RestoreInProgress.Builder().add(

server/src/test/java/org/elasticsearch/action/admin/cluster/snapshots/create/CreateSnapshotRequestTests.java

@@ -32,7 +32,7 @@
 import java.util.List;
 import java.util.Map;
 
-import static org.elasticsearch.snapshots.SnapshotInfoTests.randomUserMetadata;
+import static org.elasticsearch.snapshots.SnapshotInfoTestUtils.randomUserMetadata;
 import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.hasSize;
 

server/src/test/java/org/elasticsearch/action/admin/cluster/snapshots/create/CreateSnapshotResponseTests.java

@@ -14,7 +14,7 @@
 import org.elasticsearch.snapshots.SnapshotFeatureInfoTests;
 import org.elasticsearch.snapshots.SnapshotId;
 import org.elasticsearch.snapshots.SnapshotInfo;
-import org.elasticsearch.snapshots.SnapshotInfoTests;
+import org.elasticsearch.snapshots.SnapshotInfoTestUtils;
 import org.elasticsearch.snapshots.SnapshotShardFailure;
 import org.elasticsearch.test.AbstractXContentTestCase;
 
@@ -65,7 +65,7 @@ protected CreateSnapshotResponse createTestInstance() {
 
         return new CreateSnapshotResponse(
             new SnapshotInfo(snapshotId, indices, dataStreams, featureStates, reason, endTime, totalShards, shardFailures,
-                globalState, SnapshotInfoTests.randomUserMetadata(), startTime
+                globalState, SnapshotInfoTestUtils.randomUserMetadata(), startTime
             ));
     }
 

server/src/test/java/org/elasticsearch/action/admin/cluster/snapshots/get/GetSnapshotsResponseTests.java

@@ -15,7 +15,7 @@
 import org.elasticsearch.snapshots.SnapshotFeatureInfo;
 import org.elasticsearch.snapshots.SnapshotId;
 import org.elasticsearch.snapshots.SnapshotInfo;
-import org.elasticsearch.snapshots.SnapshotInfoTests;
+import org.elasticsearch.snapshots.SnapshotInfoTestUtils;
 import org.elasticsearch.snapshots.SnapshotShardFailure;
 import org.elasticsearch.test.AbstractSerializingTestCase;
 
@@ -47,7 +47,7 @@ protected GetSnapshotsResponse createTestInstance() {
             List<SnapshotFeatureInfo> featureInfos = randomList(0, () -> randomSnapshotFeatureInfo());
             snapshots.add(new SnapshotInfo(snapshotId, Arrays.asList("index1", "index2"), Collections.singletonList("ds"),
                 featureInfos, reason, System.currentTimeMillis(), randomIntBetween(2, 3), shardFailures, randomBoolean(),
-                SnapshotInfoTests.randomUserMetadata(), System.currentTimeMillis()
+                SnapshotInfoTestUtils.randomUserMetadata(), System.currentTimeMillis()
             ));
         }
         return new GetSnapshotsResponse(snapshots);

server/src/test/java/org/elasticsearch/cluster/metadata/MetadataDeleteIndexServiceTests.java

@@ -22,7 +22,7 @@
 import org.elasticsearch.snapshots.Snapshot;
 import org.elasticsearch.snapshots.SnapshotId;
 import org.elasticsearch.snapshots.SnapshotInProgressException;
-import org.elasticsearch.snapshots.SnapshotInfoTests;
+import org.elasticsearch.snapshots.SnapshotInfoTestUtils;
 import org.elasticsearch.test.ESTestCase;
 import org.elasticsearch.test.VersionUtils;
 import org.hamcrest.core.IsNull;
@@ -74,7 +74,7 @@ public void testDeleteSnapshotting() {
             org.elasticsearch.common.collect.List.of(new SnapshotsInProgress.Entry(snapshot, true, false,
                 SnapshotsInProgress.State.INIT, singletonList(new IndexId(index, "doesn't matter")),
                 Collections.emptyList(), Collections.emptyList(), System.currentTimeMillis(), (long) randomIntBetween(0, 1000),
-                ImmutableOpenMap.of(), null, SnapshotInfoTests.randomUserMetadata(), VersionUtils.randomVersion(random()))));
+                ImmutableOpenMap.of(), null, SnapshotInfoTestUtils.randomUserMetadata(), VersionUtils.randomVersion(random()))));
         ClusterState state = ClusterState.builder(clusterState(index))
                 .putCustom(SnapshotsInProgress.TYPE, snaps)
                 .build();

server/src/test/java/org/elasticsearch/cluster/metadata/MetadataIndexStateServiceTests.java

@@ -36,7 +36,7 @@
 import org.elasticsearch.snapshots.Snapshot;
 import org.elasticsearch.snapshots.SnapshotId;
 import org.elasticsearch.snapshots.SnapshotInProgressException;
-import org.elasticsearch.snapshots.SnapshotInfoTests;
+import org.elasticsearch.snapshots.SnapshotInfoTestUtils;
 import org.elasticsearch.test.ESTestCase;
 import org.elasticsearch.test.VersionUtils;
 
@@ -411,7 +411,7 @@ private static ClusterState addSnapshotIndex(final String index, final int numSh
         final SnapshotsInProgress.Entry entry =
             new SnapshotsInProgress.Entry(snapshot, randomBoolean(), false, SnapshotsInProgress.State.INIT,
                 Collections.singletonList(new IndexId(index, index)), Collections.emptyList(), Collections.emptyList(),
-                randomNonNegativeLong(), randomLong(), shardsBuilder.build(), null, SnapshotInfoTests.randomUserMetadata(),
+                randomNonNegativeLong(), randomLong(), shardsBuilder.build(), null, SnapshotInfoTestUtils.randomUserMetadata(),
                 VersionUtils.randomVersion(random())
             );
         return ClusterState.builder(newState).putCustom(SnapshotsInProgress.TYPE,

server/src/test/java/org/elasticsearch/snapshots/SnapshotInfoBlobSerializationTests.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+package org.elasticsearch.snapshots;
+
+import org.elasticsearch.Version;
+import org.elasticsearch.action.ActionListener;
+import org.elasticsearch.action.support.PlainActionFuture;
+import org.elasticsearch.common.util.BigArrays;
+import org.elasticsearch.common.xcontent.NamedXContentRegistry;
+import org.elasticsearch.repositories.blobstore.BlobStoreRepository;
+import org.elasticsearch.test.AbstractWireTestCase;
+
+import java.io.IOException;
+
+public class SnapshotInfoBlobSerializationTests extends AbstractWireTestCase<SnapshotInfo> {
+
+    @Override
+    protected SnapshotInfo createTestInstance() {
+        return SnapshotInfoTestUtils.createRandomSnapshotInfo();
+    }
+
+    @Override
+    protected SnapshotInfo mutateInstance(SnapshotInfo instance) throws IOException {
+        return SnapshotInfoTestUtils.mutateSnapshotInfo(instance);
+    }
+
+    @Override
+    protected SnapshotInfo copyInstance(SnapshotInfo instance, Version version) throws IOException {
+        final PlainActionFuture<SnapshotInfo> future = new PlainActionFuture<>();
+        BlobStoreRepository.SNAPSHOT_FORMAT.serialize(instance, "test", randomBoolean(), BigArrays.NON_RECYCLING_INSTANCE,
+                bytes -> ActionListener.completeWith(future,
+                        () -> BlobStoreRepository.SNAPSHOT_FORMAT.deserialize("test", NamedXContentRegistry.EMPTY, bytes)));
+        return future.actionGet();
+    }
+
+}