Skip to content

Commit

Permalink
[7.x] Tweak error message when pipeline cannot be deleted (#79357)
Browse files Browse the repository at this point in the history
  • Loading branch information
@danhermann
danhermann authored Oct 18, 2021
1 parent 60e8292 commit 322a5c3
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 45 deletions.
38 changes: 26 additions & 12 deletions server/src/main/java/org/elasticsearch/ingest/IngestService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.message.ParameterizedMessage;
import org.apache.logging.log4j.util.Strings;
import org.elasticsearch.ElasticsearchParseException;
import org.elasticsearch.ExceptionsHelper;
import org.elasticsearch.ResourceNotFoundException;
Expand Down Expand Up @@ -62,6 +63,7 @@
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
Expand Down Expand Up @@ -314,18 +316,30 @@ static void validateNotInUse(String pipeline, ImmutableOpenMap<String, IndexMeta
}

if (defaultPipelineIndices.size() > 0 || finalPipelineIndices.size() > 0) {
throw new IllegalArgumentException(
"pipeline ["
+ pipeline
+ "] cannot be deleted because it is the default pipeline for "
+ defaultPipelineIndices.size()
+ " indices including ["
+ defaultPipelineIndices.stream().limit(3).collect(Collectors.joining(","))
+ "] and the final pipeline for "
+ finalPipelineIndices.size()
+ " indices including ["
+ finalPipelineIndices.stream().limit(3).collect(Collectors.joining(","))
+ "]"
throw new IllegalArgumentException(String.format(
Locale.ROOT,
"pipeline [%s] cannot be deleted because it is %s%s%s",
pipeline,
defaultPipelineIndices.size() > 0
? String.format(
Locale.ROOT,
"the default pipeline for %s index(es) including [%s]",
defaultPipelineIndices.size(),
defaultPipelineIndices.stream().sorted().limit(3).collect(Collectors.joining(","))
)
: Strings.EMPTY,
defaultPipelineIndices.size() > 0 && finalPipelineIndices.size() > 0
? " and "
: Strings.EMPTY,
finalPipelineIndices.size() > 0
? String.format(
Locale.ROOT,
"the final pipeline for %s index(es) including [%s]",
finalPipelineIndices.size(),
finalPipelineIndices.stream().sorted().limit(3).collect(Collectors.joining(","))
)
: Strings.EMPTY
)
);
}
}
Expand Down
84 changes: 51 additions & 33 deletions server/src/test/java/org/elasticsearch/ingest/IngestServiceTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,13 @@

import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.concurrent.CountDownLatch;
Expand Down Expand Up @@ -320,49 +322,65 @@ public void testValidateNoIngestInfo() throws Exception {
public void testValidateNotInUse() {
String pipeline = "pipeline";
ImmutableOpenMap.Builder<String, IndexMetadata> indices = ImmutableOpenMap.builder();
int defaultPipelineCount = 0;
int finalPipelineCount = 0;
int indicesCount = randomIntBetween(5, 10);
for (int i = 0; i < indicesCount; i++) {
IndexMetadata.Builder builder = IndexMetadata.builder("index" + i).numberOfShards(1).numberOfReplicas(1);
int defaultIndicesCount = randomIntBetween(0, 4);
List<String> defaultIndices = new ArrayList<>();
for (int i = 0; i < defaultIndicesCount; i++) {
String indexName = "index" + i;
defaultIndices.add(indexName);
IndexMetadata.Builder builder = IndexMetadata.builder(indexName);
Settings.Builder settingsBuilder = settings(Version.CURRENT);
if (randomBoolean()) {
settingsBuilder.put(IndexSettings.DEFAULT_PIPELINE.getKey(), pipeline);
defaultPipelineCount++;
}

if (randomBoolean()) {
settingsBuilder.put(IndexSettings.FINAL_PIPELINE.getKey(), pipeline);
finalPipelineCount++;
}
settingsBuilder.put(IndexSettings.DEFAULT_PIPELINE.getKey(), pipeline);
builder.settings(settingsBuilder);
IndexMetadata indexMetadata = builder.settings(settingsBuilder).numberOfShards(1).numberOfReplicas(1).build();
indices.put(indexName, indexMetadata);
}

int finalIndicesCount = randomIntBetween(defaultIndicesCount > 0 ? 0 : 1, 4);
List<String> finalIndices = new ArrayList<>();
for (int i = defaultIndicesCount; i < (finalIndicesCount + defaultIndicesCount); i++) {
String indexName = "index" + i;
finalIndices.add(indexName);
IndexMetadata.Builder builder = IndexMetadata.builder(indexName);
Settings.Builder settingsBuilder = settings(Version.CURRENT);
settingsBuilder.put(IndexSettings.FINAL_PIPELINE.getKey(), pipeline);
builder.settings(settingsBuilder);
IndexMetadata indexMetadata = builder.settings(settingsBuilder).numberOfShards(1).numberOfReplicas(1).build();
indices.put(indexMetadata.getIndex().getName(), indexMetadata);
indices.put(indexName, indexMetadata);
}

IllegalArgumentException e = expectThrows(
IllegalArgumentException.class,
() -> IngestService.validateNotInUse(pipeline, indices.build())
);
assertThat(e.getMessage(), containsString("default pipeline for " + defaultPipelineCount + " indices including"));
assertThat(e.getMessage(), containsString("final pipeline for " + finalPipelineCount + " indices including"));
if (defaultPipelineCount >= 3) {
// assert index limit
String content = "default pipeline for " + defaultPipelineCount + " indices including [";
int start = e.getMessage().indexOf(content) + content.length();
int end = e.getMessage().indexOf("] and the final pipeline");
// indices content length, eg: index0,index1,index2
assertEquals(end - start, (6 + 1 + 6 + 1 + 6));

if (defaultIndices.size() > 0) {
assertThat(
e.getMessage(),
containsString(String.format(
Locale.ROOT,
"default pipeline for %s index(es) including [%s]",
defaultIndices.size(),
defaultIndices.stream().sorted().limit(3).collect(Collectors.joining(","))
)
)
);
}

if (finalPipelineCount >= 3) {
// assert index limit
String content = "final pipeline for " + finalPipelineCount + " indices including [";
int start = e.getMessage().indexOf(content) + content.length();
int end = e.getMessage().lastIndexOf("]");
// indices content length, eg: index0,index1,index2
assertEquals(end - start, (6 + 1 + 6 + 1 + 6));
if (defaultIndices.size() > 0 && finalIndices.size() > 0) {
assertThat(e.getMessage(), containsString(" and "));
}

if (finalIndices.size() > 0) {
assertThat(
e.getMessage(),
containsString(String.format(
Locale.ROOT,
"final pipeline for %s index(es) including [%s]",
finalIndices.size(),
finalIndices.stream().sorted().limit(3).collect(Collectors.joining(","))
)
)
);
}
}

Expand Down Expand Up @@ -662,7 +680,7 @@ public void testDeleteWithIndexUsePipeline() {
IllegalArgumentException.class,
() -> IngestService.innerDelete(deleteRequest, finalClusterState)
);
assertThat(e.getMessage(), containsString("default pipeline for 1 indices including [pipeline-index]"));
assertThat(e.getMessage(), containsString("default pipeline for 1 index(es) including [pipeline-index]"));
}

{
Expand All @@ -679,7 +697,7 @@ public void testDeleteWithIndexUsePipeline() {
IllegalArgumentException.class,
() -> IngestService.innerDelete(deleteRequest, finalClusterState)
);
assertThat(e.getMessage(), containsString("final pipeline for 1 indices including [pipeline-index]"));
assertThat(e.getMessage(), containsString("final pipeline for 1 index(es) including [pipeline-index]"));
}

// Delete pipeline:
Expand Down

0 comments on commit 322a5c3

Please sign in to comment.