Skip to content

Commit

Permalink
Added tests to EsqlSessionCCSUtils for new methods moved there, such …
Browse files Browse the repository at this point in the history 
…as testReturnSuccessWithEmptyResult
  • Loading branch information
@quux00
quux00 committed Oct 30, 2024
1 parent b9d6aef commit 84163d8
Show file tree
Hide file tree
Showing 3 changed files with 111 additions and 1 deletion.
1 change: 1 addition & 0 deletions x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/action/EsqlExecutionInfo.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,7 @@ public boolean isSkipUnavailable(String clusterAlias) {
if (RemoteClusterAware.LOCAL_CLUSTER_GROUP_KEY.equals(clusterAlias)) {
return false;
}
// TODO: should first check the skipUn status of each cluster if present in clusterInfo (simplifies testing)
return skipUnavailablePredicate.test(clusterAlias);
}

Expand Down
1 change: 0 additions & 1 deletion ...k/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/session/EsqlSessionCCSUtils.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,6 @@ static boolean returnSuccessWithEmptyResult(EsqlExecutionInfo executionInfo, Exc
return false;
}

// TODO: write tests for this and method above
static void updateExecutionInfoToReturnEmptyResult(EsqlExecutionInfo executionInfo, Exception e) {
executionInfo.markEndQuery();
Exception exceptionForResponse;
Expand Down
110 changes: 110 additions & 0 deletions ...gin/esql/src/test/java/org/elasticsearch/xpack/esql/session/EsqlSessionCCSUtilsTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@

import org.apache.lucene.index.CorruptIndexException;
import org.elasticsearch.action.fieldcaps.FieldCapabilitiesFailure;
import org.elasticsearch.action.search.ShardSearchFailure;
import org.elasticsearch.common.Strings;
import org.elasticsearch.index.IndexMode;
import org.elasticsearch.test.ESTestCase;
import org.elasticsearch.transport.ConnectTransportException;
import org.elasticsearch.transport.NoSeedNodeLeftException;
import org.elasticsearch.transport.NoSuchRemoteClusterException;
import org.elasticsearch.transport.RemoteClusterAware;
Expand All @@ -29,6 +31,7 @@
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Predicate;

import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.equalTo;
Expand Down Expand Up @@ -469,4 +472,111 @@ public void testDetermineUnavailableRemoteClusters() {
assertThat(unavailableClusters.keySet(), equalTo(Set.of()));
}
}

public void testReturnSuccessWithEmptyResult() {
String localClusterAlias = RemoteClusterAware.LOCAL_CLUSTER_GROUP_KEY;
String remote1Alias = "remote1";
String remote2Alias = "remote2";
String remote3Alias = "remote3";
NoClustersToSearchException noClustersException = new NoClustersToSearchException();
Predicate<String> skipUnPredicate = s -> {
if (s.equals("remote2") || s.equals("remote3")) {
return true;
}
return false;
};

EsqlExecutionInfo.Cluster localCluster = new EsqlExecutionInfo.Cluster(localClusterAlias, "logs*", false);
EsqlExecutionInfo.Cluster remote1 = new EsqlExecutionInfo.Cluster(remote1Alias, "logs*", false);
EsqlExecutionInfo.Cluster remote2 = new EsqlExecutionInfo.Cluster(remote2Alias, "logs*", true);
EsqlExecutionInfo.Cluster remote3 = new EsqlExecutionInfo.Cluster(remote3Alias, "logs*", true);

// not a cross-cluster cluster search, so do not return empty result
{
EsqlExecutionInfo executionInfo = new EsqlExecutionInfo(skipUnPredicate, randomBoolean());
executionInfo.swapCluster(localClusterAlias, (k, v) -> localCluster);
assertFalse(EsqlSessionCCSUtils.returnSuccessWithEmptyResult(executionInfo, noClustersException));
}

// local cluster is present, so do not return empty result
{
EsqlExecutionInfo executionInfo = new EsqlExecutionInfo(skipUnPredicate, randomBoolean());
executionInfo.swapCluster(localClusterAlias, (k, v) -> localCluster);
executionInfo.swapCluster(remote1Alias, (k, v) -> remote1);
// TODO: this logic will be added in the follow-on PR that handles missing indices
// assertFalse(EsqlSessionCCSUtils.returnSuccessWithEmptyResult(executionInfo, noClustersException));
}

// remote-only, one cluster is skip_unavailable=false, so do not return empty result
{
EsqlExecutionInfo executionInfo = new EsqlExecutionInfo(skipUnPredicate, randomBoolean());
executionInfo.swapCluster(remote1Alias, (k, v) -> remote1);
executionInfo.swapCluster(remote2Alias, (k, v) -> remote2);
assertFalse(EsqlSessionCCSUtils.returnSuccessWithEmptyResult(executionInfo, noClustersException));
}

// remote-only, all clusters are skip_unavailable=true, so should return empty result with
// NoSuchClustersException or "remote unavailable" type exception
{
EsqlExecutionInfo executionInfo = new EsqlExecutionInfo(skipUnPredicate, randomBoolean());
executionInfo.swapCluster(remote2Alias, (k, v) -> remote2);
executionInfo.swapCluster(remote3Alias, (k, v) -> remote3);
Exception e = randomFrom(
new NoSuchRemoteClusterException("foo"),
noClustersException,
new NoSeedNodeLeftException("foo"),
new IllegalStateException("unknown host")
);
assertTrue(EsqlSessionCCSUtils.returnSuccessWithEmptyResult(executionInfo, e));
}

// remote-only, all clusters are skip_unavailable=true, but exception is not "remote unavailable" so return false
// Note: this functionality may change in follow-on PRs, so remove this test in that case
{
EsqlExecutionInfo executionInfo = new EsqlExecutionInfo(skipUnPredicate, randomBoolean());
executionInfo.swapCluster(remote2Alias, (k, v) -> remote2);
executionInfo.swapCluster(remote3Alias, (k, v) -> remote3);
assertFalse(EsqlSessionCCSUtils.returnSuccessWithEmptyResult(executionInfo, new NullPointerException()));
}
}

public void testUpdateExecutionInfoToReturnEmptyResult() {
String localClusterAlias = RemoteClusterAware.LOCAL_CLUSTER_GROUP_KEY;
String remote1Alias = "remote1";
String remote2Alias = "remote2";
String remote3Alias = "remote3";
ConnectTransportException transportEx = new ConnectTransportException(null, "foo");
Predicate<String> skipUnPredicate = s -> {
if (s.startsWith("remote")) {
return true;
}
return false;
};

EsqlExecutionInfo.Cluster localCluster = new EsqlExecutionInfo.Cluster(localClusterAlias, "logs*", false);
EsqlExecutionInfo.Cluster remote1 = new EsqlExecutionInfo.Cluster(remote1Alias, "logs*", true);
EsqlExecutionInfo.Cluster remote2 = new EsqlExecutionInfo.Cluster(remote2Alias, "logs*", true);
EsqlExecutionInfo.Cluster remote3 = new EsqlExecutionInfo.Cluster(remote3Alias, "logs*", true);

EsqlExecutionInfo executionInfo = new EsqlExecutionInfo(skipUnPredicate, randomBoolean());
executionInfo.swapCluster(localCluster.getClusterAlias(), (k, v) -> localCluster);
executionInfo.swapCluster(remote1.getClusterAlias(), (k, v) -> remote1);
executionInfo.swapCluster(remote2.getClusterAlias(), (k, v) -> remote2);
executionInfo.swapCluster(remote3.getClusterAlias(), (k, v) -> remote3);

assertNull(executionInfo.overallTook());

EsqlSessionCCSUtils.updateExecutionInfoToReturnEmptyResult(executionInfo, transportEx);

assertNotNull(executionInfo.overallTook());
assertThat(executionInfo.getCluster(localClusterAlias).getStatus(), equalTo(EsqlExecutionInfo.Cluster.Status.SUCCESSFUL));
assertThat(executionInfo.getCluster(localClusterAlias).getFailures().size(), equalTo(0));

for (String remoteAlias : Set.of(remote1Alias, remote2Alias, remote3Alias)) {
assertThat(executionInfo.getCluster(remoteAlias).getStatus(), equalTo(EsqlExecutionInfo.Cluster.Status.SKIPPED));
List<ShardSearchFailure> remoteFailures = executionInfo.getCluster(remoteAlias).getFailures();
assertThat(remoteFailures.size(), equalTo(1));
assertThat(remoteFailures.get(0).reason(), containsString("unable to connect to remote cluster"));
}
}
}

0 comments on commit 84163d8

Please sign in to comment.