Verify repository before cluster update

modules/repository-s3/src/internalClusterTest/java/org/elasticsearch/repositories/s3/S3BlobStoreRepositoryTests.java

@@ -304,7 +304,7 @@ public void testMetrics() throws Exception {
     }
 
     public void testRequestStatsWithOperationPurposes() throws IOException {
-        final String repoName = createRepository(randomRepositoryName());
+        final String repoName = createRepository(randomRepositoryName(), true);
         final RepositoriesService repositoriesService = internalCluster().getCurrentMasterNodeInstance(RepositoriesService.class);
         final BlobStoreRepository repository = (BlobStoreRepository) repositoriesService.repository(repoName);
         final BlobStoreWrapper blobStore = asInstanceOf(BlobStoreWrapper.class, repository.blobStore());

server/src/internalClusterTest/java/org/elasticsearch/snapshots/RepositoriesIT.java

@@ -302,7 +302,10 @@ public void testRepositoryConflict() throws Exception {
         logger.info("--> try updating the repository, should fail because the deletion of the snapshot is in progress");
         RepositoryConflictException e2 = expectThrows(
             RepositoryConflictException.class,
-            clusterAdmin().preparePutRepository(repo).setType("mock").setSettings(Settings.builder().put("location", randomRepoPath()))
+            clusterAdmin().preparePutRepository(repo)
+                .setVerify(false)
+                .setType("mock")
+                .setSettings(Settings.builder().put("location", randomRepoPath()))
         );
         assertThat(e2.status(), equalTo(RestStatus.CONFLICT));
         assertThat(e2.getMessage(), containsString("trying to modify or unregister repository that is currently used"));

server/src/internalClusterTest/java/org/elasticsearch/snapshots/SharedClusterSnapshotRestoreIT.java

@@ -959,6 +959,7 @@ public void testDeleteRepositoryWhileSnapshotting() throws Exception {
             client.admin()
                 .cluster()
                 .preparePutRepository("test-repo")
+                .setVerify(false)
                 .setType("fs")
                 .setSettings(Settings.builder().put("location", repositoryLocation.resolve("test")))
                 .get();

server/src/main/java/org/elasticsearch/repositories/RepositoriesService.java

@@ -161,10 +161,7 @@ record RegisterRepositoryTaskResult(AcknowledgedResponse ackResponse, boolean ch
         SubscribableListener
 
             // Trying to create the new repository on master to make sure it works
-            .<Void>newForked(validationStep -> ActionListener.completeWith(validationStep, () -> {
-                validateRepositoryCanBeCreated(request);
-                return null;
-            }))
+            .<Void>newForked(validationStep -> validatePutRepositoryRequest(request, validationStep))
 
             // When publication has completed (and all acks received or timed out) then verify the repository.
             // (if acks timed out then acknowledgementStep completes before the master processes this cluster state, hence why we have
@@ -353,6 +350,29 @@ public void validateRepositoryCanBeCreated(final PutRepositoryRequest request) {
         closeRepository(createRepository(newRepositoryMetadata));
     }
 
+    private void validatePutRepositoryRequest(final PutRepositoryRequest request, ActionListener<Void> resultListener) {
+        final RepositoryMetadata newRepositoryMetadata = new RepositoryMetadata(request.name(), request.type(), request.settings());
+        try {
+            final var repository = createRepository(newRepositoryMetadata);
+            if (request.verify()) {
+                // verify repository on local node only, different from verifyRepository method that runs on other cluster nodes
+                threadPool.executor(ThreadPool.Names.SNAPSHOT)
+                    .execute(ActionRunnable.run(ActionListener.runBefore(resultListener, () -> closeRepository(repository)), () -> {
+                        final var token = repository.startVerification();
+                        if (token != null) {
+                            repository.verify(token, clusterService.localNode());
+                            repository.endVerification(token);
+                        }
+                    }));
+            } else {
+                closeRepository(repository);
+                resultListener.onResponse(null);
+            }
+        } catch (Exception e) {
+            resultListener.onFailure(e);
+        }
+    }
+
     private void submitUnbatchedTask(@SuppressWarnings("SameParameterValue") String source, ClusterStateUpdateTask task) {
         submitUnbatchedTask(clusterService, source, task);
     }

server/src/test/java/org/elasticsearch/repositories/RepositoriesServiceTests.java

@@ -48,8 +48,6 @@
 import org.elasticsearch.transport.Transport;
 import org.elasticsearch.transport.TransportService;
 import org.elasticsearch.xcontent.NamedXContentRegistry;
-import org.junit.AfterClass;
-import org.junit.BeforeClass;
 
 import java.util.Arrays;
 import java.util.Collection;
@@ -65,28 +63,16 @@
 
 public class RepositoriesServiceTests extends ESTestCase {
 
-    private static ThreadPool threadPool;
-
     private ClusterService clusterService;
     private RepositoriesService repositoriesService;
-
-    @BeforeClass
-    public static void createThreadPool() {
-        threadPool = new TestThreadPool(RepositoriesService.class.getName());
-    }
-
-    @AfterClass
-    public static void terminateThreadPool() {
-        if (threadPool != null) {
-            threadPool.shutdownNow();
-            threadPool = null;
-        }
-    }
+    private ThreadPool threadPool;
 
     @Override
     public void setUp() throws Exception {
         super.setUp();
 
+        threadPool = new TestThreadPool(RepositoriesService.class.getName());
+
         final TransportService transportService = new TransportService(
             Settings.EMPTY,
             mock(Transport.class),
@@ -113,6 +99,8 @@ public void setUp() throws Exception {
             TestRepository::new,
             UnstableRepository.TYPE,
             UnstableRepository::new,
+            VerificationFailRepository.TYPE,
+            VerificationFailRepository::new,
             MeteredRepositoryTypeA.TYPE,
             metadata -> new MeteredRepositoryTypeA(metadata, clusterService),
             MeteredRepositoryTypeB.TYPE,
@@ -135,6 +123,10 @@ public void setUp() throws Exception {
     @Override
     public void tearDown() throws Exception {
         super.tearDown();
+        if (threadPool != null) {
+            threadPool.shutdownNow();
+            threadPool = null;
+        }
         clusterService.stop();
         repositoriesService.stop();
     }
@@ -181,6 +173,26 @@ public void testRegisterRejectsInvalidRepositoryNames() {
         }
     }
 
+    public void testPutRepositoryVerificationFails() {
+        var repoName = randomAlphaOfLengthBetween(10, 25);
+        var request = new PutRepositoryRequest().name(repoName).type(VerificationFailRepository.TYPE).verify(true);
+        var resultListener = new SubscribableListener<AcknowledgedResponse>();
+        repositoriesService.registerRepository(request, resultListener);
+        var failure = safeAwaitFailure(resultListener);
+        assertThat(failure, isA(RepositoryVerificationException.class));
+        // also make sure that cluster state does not include failed repo
+        assertThrows(RepositoryMissingException.class, () -> { repositoriesService.repository(repoName); });
+    }
+
+    public void testPutRepositorySkipVerification() {
+        var repoName = randomAlphaOfLengthBetween(10, 25);
+        var request = new PutRepositoryRequest().name(repoName).type(VerificationFailRepository.TYPE).verify(false);
+        var resultListener = new SubscribableListener<AcknowledgedResponse>();
+        repositoriesService.registerRepository(request, resultListener);
+        var ackResponse = safeAwait(resultListener);
+        assertTrue(ackResponse.isAcknowledged());
+    }
+
     public void testRepositoriesStatsCanHaveTheSameNameAndDifferentTypeOverTime() {
         String repoName = "name";
         expectThrows(RepositoryMissingException.class, () -> repositoriesService.repository(repoName));
@@ -502,6 +514,19 @@ private UnstableRepository(RepositoryMetadata metadata) {
         }
     }
 
+    private static class VerificationFailRepository extends TestRepository {
+        public static final String TYPE = "verify-fail";
+
+        private VerificationFailRepository(RepositoryMetadata metadata) {
+            super(metadata);
+        }
+
+        @Override
+        public String startVerification() {
+            throw new RepositoryVerificationException(TYPE, "failed to validate repository");
+        }
+    }
+
     private static class MeteredRepositoryTypeA extends MeteredBlobStoreRepository {
         private static final String TYPE = "type-a";
         private static final RepositoryStats STATS = new RepositoryStats(Map.of("GET", 10L));

test/framework/src/main/java/org/elasticsearch/repositories/blobstore/ESBlobStoreRepositoryIntegTestCase.java

@@ -91,8 +91,13 @@ protected Settings repositorySettings(String repoName) {
         return Settings.builder().put("compress", randomBoolean()).build();
     }
 
+    /**
+     * Create a repository without verification, assuming the repository is perfectly valid.
+     * If the repository can be invalid, use another method
+     * {@link ESBlobStoreRepositoryIntegTestCase#createRepository(String repoName, boolean verify)}
+     */
     protected final String createRepository(final String name) {
-        return createRepository(name, true);
+        return createRepository(name, false);
     }
 
     protected final String createRepository(final String name, final boolean verify) {

test/framework/src/main/java/org/elasticsearch/test/ESTestCase.java

@@ -41,6 +41,7 @@
 import org.elasticsearch.TransportVersion;
 import org.elasticsearch.action.ActionFuture;
 import org.elasticsearch.action.RequestBuilder;
+import org.elasticsearch.action.support.ActionTestUtils;
 import org.elasticsearch.action.support.PlainActionFuture;
 import org.elasticsearch.action.support.SubscribableListener;
 import org.elasticsearch.bootstrap.BootstrapForTesting;
@@ -2178,6 +2179,14 @@ public static <T> T safeGet(Future<T> future) {
         }
     }
 
+    public static Exception safeAwaitFailure(SubscribableListener<?> listener) {
+        return safeAwait(
+            SubscribableListener.newForked(
+                exceptionListener -> listener.addListener(ActionTestUtils.assertNoSuccessListener(exceptionListener::onResponse))
+            )
+        );
+    }
+
     public static void safeSleep(long millis) {
         try {
             Thread.sleep(millis);