Skip to content

Unblock blocked repositories after test execution #61703

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

Closed
wants to merge 13 commits into from
Closed

Unblock blocked repositories after test execution #61703

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
8010e3b
Unblock blocked repositories after test execution.
fcofdez Aug 31, 2020
5e7e95b
Check for repository instance type
fcofdez Aug 31, 2020
bdfc369
Move repository unblock to ESIntegTestCase cluster cleanup
fcofdez Aug 31, 2020
fad2cf8
Don't unblock repositories on non internal clusters
fcofdez Aug 31, 2020
cba3bcd
Unblock repositories only when the cluster is open
fcofdez Aug 31, 2020
388d261
Merge remote-tracking branch 'origin/master' into unblock-blocked-rep…
fcofdez Aug 31, 2020
7207a56
Merge remote-tracking branch 'origin/master' into unblock-blocked-rep…
fcofdez Aug 31, 2020
60db1e3
Rename awaitNoMoreRunningSnapshotOperations
fcofdez Sep 2, 2020
9aee157
Merge remote-tracking branch 'origin/master' into unblock-blocked-rep…
fcofdez Sep 2, 2020
3b3cf8f
Keep track of blocked repos on AbstractSnapshotIntegTestCase.
fcofdez Sep 2, 2020
0d7a454
Merge remote-tracking branch 'origin/master' into unblock-blocked-rep…
fcofdez Sep 2, 2020
2849021
Use a Set instead
fcofdez Sep 2, 2020
f858059
fix checkstyle
fcofdez Sep 3, 2020
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
6 changes: 3 additions & 3 deletions server/src/internalClusterTest/java/org/elasticsearch/discovery/SnapshotDisruptionIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ public void clusterChanged(ClusterChangedEvent event) {
logger.info("--> waiting for disruption to start");
assertTrue(disruptionStarted.await(1, TimeUnit.MINUTES));

awaitNoMoreRunningOperations(dataNode);
awaitNoMoreRunningSnapshotOperations(dataNode);

logger.info("--> verify that snapshot was successful or no longer exist");
assertBusy(() -> {
Expand Down Expand Up @@ -148,7 +148,7 @@ public void clusterChanged(ClusterChangedEvent event) {
assertThat(sne.getSnapshotName(), is(snapshot));
}

awaitNoMoreRunningOperations(dataNode);
awaitNoMoreRunningSnapshotOperations(dataNode);
}

public void testDisruptionAfterShardFinalization() throws Exception {
Expand Down Expand Up @@ -237,7 +237,7 @@ public void testMasterFailOverDuringShardSnapshots() throws Exception {
unblockNode(repoName, dataNode);

networkDisruption.stopDisrupting();
awaitNoMoreRunningOperations(dataNode);
awaitNoMoreRunningSnapshotOperations(dataNode);

logger.info("--> make sure isolated master responds to snapshot request");
final SnapshotException sne =
Expand Down
2 changes: 1 addition & 1 deletion server/src/internalClusterTest/java/org/elasticsearch/snapshots/ConcurrentSnapshotsIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1234,7 +1234,7 @@ private List<String> createNSnapshots(String repoName, int count) {
}

private void awaitNoMoreRunningOperations() throws Exception {
awaitNoMoreRunningOperations(internalCluster().getMasterName());
awaitNoMoreRunningSnapshotOperations(internalCluster().getMasterName());
}

private ActionFuture<AcknowledgedResponse> startDeleteFromNonMasterClient(String repoName, String snapshotName) {
Expand Down
73 changes: 39 additions & 34 deletions test/framework/src/main/java/org/elasticsearch/snapshots/AbstractSnapshotIntegTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,12 @@
import org.elasticsearch.action.search.SearchRequest;
import org.elasticsearch.action.support.PlainActionFuture;
import org.elasticsearch.cluster.ClusterState;
import org.elasticsearch.cluster.ClusterStateObserver;
import org.elasticsearch.cluster.SnapshotDeletionsInProgress;
import org.elasticsearch.cluster.SnapshotsInProgress;
import org.elasticsearch.cluster.metadata.IndexMetadata;
import org.elasticsearch.cluster.metadata.RepositoriesMetadata;
import org.elasticsearch.cluster.metadata.RepositoryMetadata;
import org.elasticsearch.cluster.routing.allocation.decider.EnableAllocationDecider;
import org.elasticsearch.cluster.service.ClusterService;
import org.elasticsearch.common.Strings;
import org.elasticsearch.common.UUIDs;
import org.elasticsearch.common.bytes.BytesReference;
Expand All @@ -44,7 +42,6 @@
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.common.xcontent.XContentFactory;
import org.elasticsearch.common.xcontent.json.JsonXContent;
import org.elasticsearch.node.NodeClosedException;
import org.elasticsearch.plugins.Plugin;
import org.elasticsearch.repositories.RepositoriesService;
import org.elasticsearch.repositories.Repository;
Expand All @@ -56,7 +53,6 @@
import org.elasticsearch.snapshots.mockstore.MockRepository;
import org.elasticsearch.test.ESIntegTestCase;
import org.elasticsearch.test.VersionUtils;
import org.elasticsearch.threadpool.ThreadPool;
import org.junit.After;

import java.io.IOException;
Expand All @@ -70,13 +66,13 @@
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Function;
import java.util.function.Predicate;

import static org.elasticsearch.test.hamcrest.ElasticsearchAssertions.assertAcked;
import static org.hamcrest.Matchers.empty;
Expand All @@ -85,6 +81,8 @@

public abstract class AbstractSnapshotIntegTestCase extends ESIntegTestCase {

private static final Set<String> blockedRepos = new HashSet<>();

private static final String OLD_VERSION_SNAPSHOT_PREFIX = "old-version-snapshot-";

@Override
Expand All @@ -101,6 +99,20 @@ protected Collection<Class<? extends Plugin>> nodePlugins() {
return Arrays.asList(MockRepository.Plugin.class);
}

@After
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the idea of this, but I'm a little suspicious that this is the right place to put this. Many tests don't reuse the test cluster in which case the work here is unnecessary? Maybe we should make this change in the logic that cleans up the test cluster when its reused instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem is that @After hooks from AbstractSnapshotIntgetTestCase are executed before the hooks in ESIntegTestCase. Is there a way to determine the scope of a cluster? we could bypass this cleanup if the cluster is not reused?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can do a simpler thing and simply skip the repo consistency checks in case of test failure via wrapping in:

if (getSuiteFailureMarker().wasSuccessful()) {

}

That should fix all the cases because I think closing the repos upstream in the EsIntegTestCase cleanup logic should deal with unblocking and removing all the repos cleanly.
That would also make test failures easier to interpret since we get rid of failed repo verifications on failed tests?

public synchronized void unblockRepos() throws Exception {
for (String blockedRepository : blockedRepos) {
logger.info("--> unblocking blocked repository [{}] after test", blockedRepository);

for (RepositoriesService repositoriesService : internalCluster().getInstances(RepositoriesService.class)) {
((MockRepository) repositoriesService.repository(blockedRepository)).unblock();
}
}

blockedRepos.clear();
awaitNoMoreRunningSnapshotOperations(internalCluster().getMasterName());
}

@After
public void assertConsistentHistoryInLuceneIndex() throws Exception {
internalCluster().assertConsistentHistoryBetweenTranslogAndLuceneIndex();
Expand Down Expand Up @@ -229,26 +241,30 @@ public static String blockMasterFromFinalizingSnapshotOnIndexFile(final String r
final String masterName = internalCluster().getMasterName();
((MockRepository)internalCluster().getInstance(RepositoriesService.class, masterName)
.repository(repositoryName)).setBlockOnWriteIndexFile(true);
trackBlockedRepo(repositoryName);
return masterName;
}

public static void blockMasterFromDeletingIndexNFile(String repositoryName) {
final String masterName = internalCluster().getMasterName();
((MockRepository)internalCluster().getInstance(RepositoriesService.class, masterName)
.repository(repositoryName)).setBlockOnDeleteIndexFile();
trackBlockedRepo(repositoryName);
}

public static String blockMasterFromFinalizingSnapshotOnSnapFile(final String repositoryName) {
final String masterName = internalCluster().getMasterName();
((MockRepository)internalCluster().getInstance(RepositoriesService.class, masterName)
.repository(repositoryName)).setBlockAndFailOnWriteSnapFiles(true);
trackBlockedRepo(repositoryName);
return masterName;
}

public static String blockNodeWithIndex(final String repositoryName, final String indexName) {
for(String node : internalCluster().nodesInclude(indexName)) {
((MockRepository)internalCluster().getInstance(RepositoriesService.class, node).repository(repositoryName))
.blockOnDataFiles(true);
trackBlockedRepo(repositoryName);
return node;
}
fail("No nodes for the index " + indexName + " found");
Expand All @@ -258,23 +274,29 @@ public static String blockNodeWithIndex(final String repositoryName, final Strin
public static void blockNodeOnAnyFiles(String repository, String nodeName) {
((MockRepository) internalCluster().getInstance(RepositoriesService.class, nodeName)
.repository(repository)).setBlockOnAnyFiles(true);
trackBlockedRepo(repository);
}

public static void blockDataNode(String repository, String nodeName) {
((MockRepository) internalCluster().getInstance(RepositoriesService.class, nodeName)
.repository(repository)).blockOnDataFiles(true);
trackBlockedRepo(repository);
}

public static void blockAllDataNodes(String repository) {
for(RepositoriesService repositoriesService : internalCluster().getDataNodeInstances(RepositoriesService.class)) {
((MockRepository)repositoriesService.repository(repository)).blockOnDataFiles(true);
}

trackBlockedRepo(repository);
}

public static void unblockAllDataNodes(String repository) {
for(RepositoriesService repositoriesService : internalCluster().getDataNodeInstances(RepositoriesService.class)) {
((MockRepository)repositoriesService.repository(repository)).unblock();
}

unTrackBlockedRepo(repository);
}

public static void waitForBlockOnAnyDataNode(String repository, TimeValue timeout) throws InterruptedException {
Expand All @@ -294,6 +316,7 @@ public static void waitForBlockOnAnyDataNode(String repository, TimeValue timeou
public void unblockNode(final String repository, final String node) {
logger.info("--> unblocking [{}] on node [{}]", repository, node);
((MockRepository)internalCluster().getInstance(RepositoriesService.class, node).repository(repository)).unblock();
unTrackBlockedRepo(repository);
}

protected void createRepository(String repoName, String type, Settings.Builder settings) {
Expand All @@ -302,6 +325,14 @@ protected void createRepository(String repoName, String type, Settings.Builder s
.setType(type).setSettings(settings));
}

private static synchronized void trackBlockedRepo(String repositoryName) {
blockedRepos.add(repositoryName);
}

private static synchronized void unTrackBlockedRepo(String repository) {
blockedRepos.remove(repository);
}

protected void createRepository(String repoName, String type, Path location) {
createRepository(repoName, type, Settings.builder().put("location", location));
}
Expand Down Expand Up @@ -422,35 +453,9 @@ ShardGenerations.EMPTY, getRepositoryData(repoName).getGenId(), state.metadata()
SnapshotsService.OLD_SNAPSHOT_FORMAT, Function.identity(), f));
}

protected void awaitNoMoreRunningOperations(String viaNode) throws Exception {
protected void awaitNoMoreRunningSnapshotOperations(String viaNode) throws Exception {
logger.info("--> verify no more operations in the cluster state");
awaitClusterState(viaNode, state -> state.custom(SnapshotsInProgress.TYPE, SnapshotsInProgress.EMPTY).entries().isEmpty() &&
state.custom(SnapshotDeletionsInProgress.TYPE, SnapshotDeletionsInProgress.EMPTY).hasDeletionsInProgress() == false);
}

protected void awaitClusterState(String viaNode, Predicate<ClusterState> statePredicate) throws Exception {
final ClusterService clusterService = internalCluster().getInstance(ClusterService.class, viaNode);
final ThreadPool threadPool = internalCluster().getInstance(ThreadPool.class, viaNode);
final ClusterStateObserver observer = new ClusterStateObserver(clusterService, logger, threadPool.getThreadContext());
if (statePredicate.test(observer.setAndGetObservedState()) == false) {
final PlainActionFuture<Void> future = PlainActionFuture.newFuture();
observer.waitForNextChange(new ClusterStateObserver.Listener() {
@Override
public void onNewClusterState(ClusterState state) {
future.onResponse(null);
}

@Override
public void onClusterServiceClose() {
future.onFailure(new NodeClosedException(clusterService.localNode()));
}

@Override
public void onTimeout(TimeValue timeout) {
future.onFailure(new TimeoutException());
}
}, statePredicate);
future.get(30L, TimeUnit.SECONDS);
}
state.custom(SnapshotDeletionsInProgress.TYPE, SnapshotDeletionsInProgress.EMPTY).hasDeletionsInProgress() == false);
}
}
32 changes: 32 additions & 0 deletions test/framework/src/main/java/org/elasticsearch/test/ESIntegTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,15 @@
import org.elasticsearch.action.search.SearchResponse;
import org.elasticsearch.action.support.DefaultShardOperationFailedException;
import org.elasticsearch.action.support.IndicesOptions;
import org.elasticsearch.action.support.PlainActionFuture;
import org.elasticsearch.client.AdminClient;
import org.elasticsearch.client.Client;
import org.elasticsearch.client.Requests;
import org.elasticsearch.client.RestClient;
import org.elasticsearch.client.RestClientBuilder;
import org.elasticsearch.cluster.ClusterModule;
import org.elasticsearch.cluster.ClusterState;
import org.elasticsearch.cluster.ClusterStateObserver;
import org.elasticsearch.cluster.coordination.ElasticsearchNodeCommand;
import org.elasticsearch.cluster.health.ClusterHealthStatus;
import org.elasticsearch.cluster.metadata.IndexMetadata;
Expand Down Expand Up @@ -116,6 +118,7 @@
import org.elasticsearch.indices.IndicesQueryCache;
import org.elasticsearch.indices.IndicesRequestCache;
import org.elasticsearch.indices.store.IndicesStore;
import org.elasticsearch.node.NodeClosedException;
import org.elasticsearch.node.NodeMocksPlugin;
import org.elasticsearch.plugins.NetworkPlugin;
import org.elasticsearch.plugins.Plugin;
Expand All @@ -130,6 +133,7 @@
import org.elasticsearch.test.disruption.ServiceDisruptionScheme;
import org.elasticsearch.test.store.MockFSIndexStore;
import org.elasticsearch.test.transport.MockTransportService;
import org.elasticsearch.threadpool.ThreadPool;
import org.elasticsearch.transport.TransportInterceptor;
import org.elasticsearch.transport.TransportRequest;
import org.elasticsearch.transport.TransportRequestHandler;
Expand Down Expand Up @@ -168,8 +172,10 @@
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.stream.Collectors;

import static org.elasticsearch.cluster.metadata.IndexMetadata.SETTING_NUMBER_OF_REPLICAS;
Expand Down Expand Up @@ -2205,4 +2211,30 @@ public static String resolveCustomDataPath(String index) {
public static boolean inFipsJvm() {
return Boolean.parseBoolean(System.getProperty(FIPS_SYSPROP));
}

protected void awaitClusterState(String viaNode, Predicate<ClusterState> statePredicate) throws Exception {
final ClusterService clusterService = internalCluster().getInstance(ClusterService.class, viaNode);
final ThreadPool threadPool = internalCluster().getInstance(ThreadPool.class, viaNode);
final ClusterStateObserver observer = new ClusterStateObserver(clusterService, logger, threadPool.getThreadContext());
if (statePredicate.test(observer.setAndGetObservedState()) == false) {
final PlainActionFuture<Void> future = PlainActionFuture.newFuture();
observer.waitForNextChange(new ClusterStateObserver.Listener() {
@Override
public void onNewClusterState(ClusterState state) {
future.onResponse(null);
}

@Override
public void onClusterServiceClose() {
future.onFailure(new NodeClosedException(clusterService.localNode()));
}

@Override
public void onTimeout(TimeValue timeout) {
future.onFailure(new TimeoutException());
}
}, statePredicate);
future.get(30L, TimeUnit.SECONDS);
}
}
}
4 changes: 2 additions & 2 deletions ...c/internalClusterTest/java/org/elasticsearch/xpack/slm/SLMSnapshotBlockingIntegTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ public void ensureClusterNodes() {

@After
public void awaitNoMoreRunningOps() throws Exception {
awaitNoMoreRunningOperations(internalCluster().getMasterName());
awaitNoMoreRunningSnapshotOperations(internalCluster().getMasterName());
}

@Override
Expand Down Expand Up @@ -168,7 +168,7 @@ public void testRetentionWhileSnapshotInProgress() throws Exception {
}
});

awaitNoMoreRunningOperations(randomFrom(dataNodeNames));
awaitNoMoreRunningSnapshotOperations(randomFrom(dataNodeNames));

logger.info("--> indexing more docs to force new segment files");
for (int i = 0; i < docCount; i++) {
Expand Down