-
Notifications
You must be signed in to change notification settings - Fork 141
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Extract validation logic from FlintIndexMetadataServiceImpl (#2944)
Signed-off-by: Tomoyuki Morita <[email protected]>
- Loading branch information
Showing
3 changed files
with
179 additions
and
68 deletions.
There are no files selected for viewing
88 changes: 88 additions & 0 deletions
88
...-query-core/src/main/java/org/opensearch/sql/spark/flint/FlintIndexMetadataValidator.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.sql.spark.flint; | ||
|
|
||
| import static org.opensearch.sql.spark.dispatcher.model.FlintIndexOptions.AUTO_REFRESH; | ||
| import static org.opensearch.sql.spark.dispatcher.model.FlintIndexOptions.CHECKPOINT_LOCATION; | ||
| import static org.opensearch.sql.spark.dispatcher.model.FlintIndexOptions.INCREMENTAL_REFRESH; | ||
| import static org.opensearch.sql.spark.dispatcher.model.FlintIndexOptions.WATERMARK_DELAY; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Arrays; | ||
| import java.util.HashMap; | ||
| import java.util.LinkedHashSet; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
| import org.apache.commons.lang3.StringUtils; | ||
| import org.apache.logging.log4j.LogManager; | ||
| import org.apache.logging.log4j.Logger; | ||
|
|
||
| public class FlintIndexMetadataValidator { | ||
| private static final Logger LOGGER = LogManager.getLogger(FlintIndexMetadataValidator.class); | ||
|
|
||
| public static final Set<String> ALTER_TO_FULL_REFRESH_ALLOWED_OPTIONS = | ||
| new LinkedHashSet<>(Arrays.asList(AUTO_REFRESH, INCREMENTAL_REFRESH)); | ||
| public static final Set<String> ALTER_TO_INCREMENTAL_REFRESH_ALLOWED_OPTIONS = | ||
| new LinkedHashSet<>( | ||
| Arrays.asList(AUTO_REFRESH, INCREMENTAL_REFRESH, WATERMARK_DELAY, CHECKPOINT_LOCATION)); | ||
|
|
||
| /** | ||
| * Validate if the flint index options contain valid key/value pairs. Throws | ||
| * IllegalArgumentException with description about invalid options. | ||
| */ | ||
| public static void validateFlintIndexOptions( | ||
| String kind, Map<String, Object> existingOptions, Map<String, String> newOptions) { | ||
| if ((newOptions.containsKey(INCREMENTAL_REFRESH) | ||
| && Boolean.parseBoolean(newOptions.get(INCREMENTAL_REFRESH))) | ||
| || ((!newOptions.containsKey(INCREMENTAL_REFRESH) | ||
| && Boolean.parseBoolean((String) existingOptions.get(INCREMENTAL_REFRESH))))) { | ||
| validateConversionToIncrementalRefresh(kind, existingOptions, newOptions); | ||
| } else { | ||
| validateConversionToFullRefresh(newOptions); | ||
| } | ||
| } | ||
|
|
||
| private static void validateConversionToFullRefresh(Map<String, String> newOptions) { | ||
| if (!ALTER_TO_FULL_REFRESH_ALLOWED_OPTIONS.containsAll(newOptions.keySet())) { | ||
| throw new IllegalArgumentException( | ||
| String.format( | ||
| "Altering to full refresh only allows: %s options", | ||
| ALTER_TO_FULL_REFRESH_ALLOWED_OPTIONS)); | ||
| } | ||
| } | ||
|
|
||
| private static void validateConversionToIncrementalRefresh( | ||
| String kind, Map<String, Object> existingOptions, Map<String, String> newOptions) { | ||
| if (!ALTER_TO_INCREMENTAL_REFRESH_ALLOWED_OPTIONS.containsAll(newOptions.keySet())) { | ||
| throw new IllegalArgumentException( | ||
| String.format( | ||
| "Altering to incremental refresh only allows: %s options", | ||
| ALTER_TO_INCREMENTAL_REFRESH_ALLOWED_OPTIONS)); | ||
| } | ||
| HashMap<String, Object> mergedOptions = new HashMap<>(); | ||
| mergedOptions.putAll(existingOptions); | ||
| mergedOptions.putAll(newOptions); | ||
| List<String> missingAttributes = new ArrayList<>(); | ||
| if (!mergedOptions.containsKey(CHECKPOINT_LOCATION) | ||
| || StringUtils.isEmpty((String) mergedOptions.get(CHECKPOINT_LOCATION))) { | ||
| missingAttributes.add(CHECKPOINT_LOCATION); | ||
| } | ||
| if (kind.equals("mv") | ||
| && (!mergedOptions.containsKey(WATERMARK_DELAY) | ||
| || StringUtils.isEmpty((String) mergedOptions.get(WATERMARK_DELAY)))) { | ||
| missingAttributes.add(WATERMARK_DELAY); | ||
| } | ||
| if (missingAttributes.size() > 0) { | ||
| String errorMessage = | ||
| "Conversion to incremental refresh index cannot proceed due to missing attributes: " | ||
| + String.join(", ", missingAttributes) | ||
| + "."; | ||
| LOGGER.error(errorMessage); | ||
| throw new IllegalArgumentException(errorMessage); | ||
| } | ||
| } | ||
| } |
90 changes: 90 additions & 0 deletions
90
...ry-core/src/test/java/org/opensearch/sql/spark/flint/FlintIndexMetadataValidatorTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.sql.spark.flint; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertThrows; | ||
| import static org.opensearch.sql.spark.dispatcher.model.FlintIndexOptions.AUTO_REFRESH; | ||
| import static org.opensearch.sql.spark.dispatcher.model.FlintIndexOptions.CHECKPOINT_LOCATION; | ||
| import static org.opensearch.sql.spark.dispatcher.model.FlintIndexOptions.INCREMENTAL_REFRESH; | ||
| import static org.opensearch.sql.spark.dispatcher.model.FlintIndexOptions.WATERMARK_DELAY; | ||
|
|
||
| import com.google.common.collect.ImmutableMap; | ||
| import java.util.Map; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| class FlintIndexMetadataValidatorTest { | ||
| @Test | ||
| public void conversionToIncrementalRefreshWithValidOption() { | ||
| Map<String, Object> existingOptions = | ||
| ImmutableMap.<String, Object>builder().put(INCREMENTAL_REFRESH, "false").build(); | ||
| Map<String, String> newOptions = | ||
| ImmutableMap.<String, String>builder() | ||
| .put(INCREMENTAL_REFRESH, "true") | ||
| .put(CHECKPOINT_LOCATION, "checkpoint_location") | ||
| .put(WATERMARK_DELAY, "1") | ||
| .build(); | ||
|
|
||
| FlintIndexMetadataValidator.validateFlintIndexOptions("mv", existingOptions, newOptions); | ||
| } | ||
|
|
||
| @Test | ||
| public void conversionToIncrementalRefreshWithMissingOptions() { | ||
| Map<String, Object> existingOptions = | ||
| ImmutableMap.<String, Object>builder().put(AUTO_REFRESH, "true").build(); | ||
| Map<String, String> newOptions = | ||
| ImmutableMap.<String, String>builder().put(INCREMENTAL_REFRESH, "true").build(); | ||
|
|
||
| assertThrows( | ||
| IllegalArgumentException.class, | ||
| () -> | ||
| FlintIndexMetadataValidator.validateFlintIndexOptions( | ||
| "mv", existingOptions, newOptions)); | ||
| } | ||
|
|
||
| @Test | ||
| public void conversionToIncrementalRefreshWithInvalidOption() { | ||
| Map<String, Object> existingOptions = | ||
| ImmutableMap.<String, Object>builder().put(INCREMENTAL_REFRESH, "false").build(); | ||
| Map<String, String> newOptions = | ||
| ImmutableMap.<String, String>builder() | ||
| .put(INCREMENTAL_REFRESH, "true") | ||
| .put("INVALID_OPTION", "1") | ||
| .build(); | ||
|
|
||
| assertThrows( | ||
| IllegalArgumentException.class, | ||
| () -> | ||
| FlintIndexMetadataValidator.validateFlintIndexOptions( | ||
| "mv", existingOptions, newOptions)); | ||
| } | ||
|
|
||
| @Test | ||
| public void conversionToFullRefreshWithValidOption() { | ||
| Map<String, Object> existingOptions = | ||
| ImmutableMap.<String, Object>builder().put(AUTO_REFRESH, "false").build(); | ||
| Map<String, String> newOptions = | ||
| ImmutableMap.<String, String>builder().put(AUTO_REFRESH, "true").build(); | ||
|
|
||
| FlintIndexMetadataValidator.validateFlintIndexOptions("mv", existingOptions, newOptions); | ||
| } | ||
|
|
||
| @Test | ||
| public void conversionToFullRefreshWithInvalidOption() { | ||
| Map<String, Object> existingOptions = | ||
| ImmutableMap.<String, Object>builder().put(AUTO_REFRESH, "false").build(); | ||
| Map<String, String> newOptions = | ||
| ImmutableMap.<String, String>builder() | ||
| .put(AUTO_REFRESH, "true") | ||
| .put(WATERMARK_DELAY, "1") | ||
| .build(); | ||
|
|
||
| assertThrows( | ||
| IllegalArgumentException.class, | ||
| () -> | ||
| FlintIndexMetadataValidator.validateFlintIndexOptions( | ||
| "mv", existingOptions, newOptions)); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters