Start unit tests for the OpenSearch sink testing the document_version…

… error cases (opensearch-project#3599)

Signed-off-by: Taylor Gray <[email protected]>

data-prepper-api/src/main/java/org/opensearch/dataprepper/expression/ExpressionEvaluator.java

@@ -35,5 +35,5 @@ default Boolean evaluateConditional(final String statement, final Event context)
 
     Boolean isValidExpressionStatement(final String statement);
 
-    Boolean isValidFormatExpressions(final String format);
+    Boolean isValidFormatExpression(final String format);
 }

data-prepper-api/src/test/java/org/opensearch/dataprepper/expression/ExpressionEvaluatorTest.java

@@ -25,7 +25,7 @@ public Boolean isValidExpressionStatement(final String statement) {
         }
 
         @Override
-        public Boolean isValidFormatExpressions(String format) {
+        public Boolean isValidFormatExpression(String format) {
             return true;
         }
     }

data-prepper-expression/src/main/java/org/opensearch/dataprepper/expression/GenericExpressionEvaluator.java

@@ -55,7 +55,7 @@ public Boolean isValidExpressionStatement(final String statement) {
     }
 
     @Override
-    public Boolean isValidFormatExpressions(final String format) {
+    public Boolean isValidFormatExpression(final String format) {
         int fromIndex = 0;
         int position = 0;
         while ((position = format.indexOf("${", fromIndex)) != -1) {

data-prepper-expression/src/test/java/org/opensearch/dataprepper/expression/GenericExpressionEvaluatorTest.java

@@ -132,14 +132,14 @@ void isValidExpressionStatement_returns_false_when_parse_throws() {
             "abc-${invalid, false"
     })
     void isValidFormatExpressionsReturnsCorrectResult(final String format, final Boolean expectedResult) {
-        assertThat(statementEvaluator.isValidFormatExpressions(format), equalTo(expectedResult));
+        assertThat(statementEvaluator.isValidFormatExpression(format), equalTo(expectedResult));
     }
 
     @ParameterizedTest
     @ValueSource(strings = {"abc-${anyS(=tring}"})
     void isValidFormatExpressionsReturnsFalseWhenIsValidKeyAndValidExpressionIsFalse(final String format) {
         doThrow(RuntimeException.class).when(parser).parse(anyString());
-        assertThat(statementEvaluator.isValidFormatExpressions(format), equalTo(false));
+        assertThat(statementEvaluator.isValidFormatExpression(format), equalTo(false));
     }
 
 }

data-prepper-plugins/opensearch/src/integrationTest/java/org/opensearch/dataprepper/plugins/sink/opensearch/OpenSearchSinkIT.java

@@ -682,7 +682,7 @@ public void testOpenSearchBulkActionsCreateWithExpression() throws IOException,
         Event event = (Event) testRecords.get(0).getData();
         event.getMetadata().setAttribute("action", "create");
         final String actionFormatExpression = "${getMetadata(\"action\")}";
-        when(expressionEvaluator.isValidFormatExpressions(actionFormatExpression)).thenReturn(true);
+        when(expressionEvaluator.isValidFormatExpression(actionFormatExpression)).thenReturn(true);
         when(expressionEvaluator.isValidExpressionStatement("getMetadata(\"action\")")).thenReturn(true);
         when(expressionEvaluator.evaluate("getMetadata(\"action\")", event)).thenReturn(event.getMetadata().getAttribute("action"));
         pluginSetting.getSettings().put(IndexConfiguration.ACTION, actionFormatExpression);
@@ -715,7 +715,7 @@ public void testOpenSearchBulkActionsCreateWithInvalidExpression() throws IOExce
         Event event = (Event) testRecords.get(0).getData();
         event.getMetadata().setAttribute("action", "unknown");
         final String actionFormatExpression = "${getMetadata(\"action\")}";
-        when(expressionEvaluator.isValidFormatExpressions(actionFormatExpression)).thenReturn(true);
+        when(expressionEvaluator.isValidFormatExpression(actionFormatExpression)).thenReturn(true);
         when(expressionEvaluator.isValidExpressionStatement("getMetadata(\"action\")")).thenReturn(true);
         when(expressionEvaluator.evaluate("getMetadata(\"action\")", event)).thenReturn(event.getMetadata().getAttribute("action"));
         pluginSetting.getSettings().put(IndexConfiguration.ACTION, actionFormatExpression);

data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/OpenSearchSink.java

@@ -371,12 +371,17 @@ public void doOutput(final Collection<Record<Event>> records) {
           versionExpressionEvaluationResult = event.formatString(versionExpression, expressionEvaluator);
           version = Long.valueOf(event.formatString(versionExpression, expressionEvaluator));
         } catch (final NumberFormatException e) {
-          LOG.warn("Unable to convert the result of evaluating document_version '{}' to Long for an Event. The evaluation result '{}' must be a valid Long type", versionExpression, versionExpressionEvaluationResult);
-          logFailureForDlqObjects(List.of(createDlqObjectFromEvent(event, indexName, e.getMessage())), e);
+          final String errorMessage = String.format(
+                  "Unable to convert the result of evaluating document_version '%s' to Long for an Event. The evaluation result '%s' must be a valid Long type", versionExpression, versionExpressionEvaluationResult
+          );
+          LOG.error(errorMessage);
+          logFailureForDlqObjects(List.of(createDlqObjectFromEvent(event, indexName, errorMessage)), e);
           dynamicDocumentVersionDroppedEvents.increment();
         } catch (final RuntimeException e) {
-          LOG.error("There was an exception when evaluating the document_version '{}'. Check the dlq if configured to see details about the affected Event: {}", versionExpression, e.getMessage());
-          logFailureForDlqObjects(List.of(createDlqObjectFromEvent(event, indexName, e.getMessage())), e);
+          final String errorMessage = String.format(
+                  "There was an exception when evaluating the document_version '%s': %s", versionExpression, e.getMessage());
+          LOG.error(errorMessage + " Check the dlq if configured to see more details about the affected Event");
+          logFailureForDlqObjects(List.of(createDlqObjectFromEvent(event, indexName, errorMessage)), e);
           dynamicDocumentVersionDroppedEvents.increment();
         }
       }

data-prepper-plugins/opensearch/src/main/java/org/opensearch/dataprepper/plugins/sink/opensearch/index/IndexConfiguration.java

@@ -232,7 +232,7 @@ public static IndexConfiguration readIndexConfig(final PluginSetting pluginSetti
         final String versionType = pluginSetting.getStringOrDefault(DOCUMENT_VERSION_TYPE, null);
 
         builder = builder.withVersionExpression(versionExpression);
-        if (versionExpression != null && (!expressionEvaluator.isValidFormatExpressions(versionExpression))) {
+        if (versionExpression != null && (!expressionEvaluator.isValidFormatExpression(versionExpression))) {
             throw new InvalidPluginConfigurationException("document_version {} is not a valid format expression.");
         }
 
@@ -546,7 +546,7 @@ public Builder withIsmPolicyFile(final String ismPolicyFile) {
 
         public Builder withAction(final String action, final ExpressionEvaluator expressionEvaluator) {
             checkArgument((EnumUtils.isValidEnumIgnoreCase(OpenSearchBulkActions.class, action) ||
-                    (action.contains("${") && expressionEvaluator.isValidFormatExpressions(action))), "action \"" + action + "\" is invalid. action must be one of the following: " + Arrays.stream(OpenSearchBulkActions.values()).collect(Collectors.toList()));
+                    (action.contains("${") && expressionEvaluator.isValidFormatExpression(action))), "action \"" + action + "\" is invalid. action must be one of the following: " + Arrays.stream(OpenSearchBulkActions.values()).collect(Collectors.toList()));
             this.action = action;
             return this;
         }
@@ -556,7 +556,7 @@ public Builder withActions(final List<Map<String, Object>> actions, final Expres
                 String action = (String)actionMap.get("type");
                 if (action != null) {
                     checkArgument((EnumUtils.isValidEnumIgnoreCase(OpenSearchBulkActions.class, action) ||
-                            (action.contains("${") && expressionEvaluator.isValidFormatExpressions(action))), "action \"" + action + "\". action must be one of the following: " + Arrays.stream(OpenSearchBulkActions.values()).collect(Collectors.toList()));
+                            (action.contains("${") && expressionEvaluator.isValidFormatExpression(action))), "action \"" + action + "\". action must be one of the following: " + Arrays.stream(OpenSearchBulkActions.values()).collect(Collectors.toList()));
                 }
             }
             this.actions = actions;

data-prepper-plugins/opensearch/src/test/java/org/opensearch/dataprepper/plugins/sink/opensearch/OpenSearchSinkConfigurationTests.java

@@ -142,7 +142,7 @@ public void testReadESConfigWithBulkActionCreateExpression() {
         pluginSetting.setPipelineName(PIPELINE_NAME);
 
         expressionEvaluator = mock(ExpressionEvaluator.class);
-        when(expressionEvaluator.isValidFormatExpressions(actionFormatExpression)).thenReturn(true);
+        when(expressionEvaluator.isValidFormatExpression(actionFormatExpression)).thenReturn(true);
         final OpenSearchSinkConfiguration openSearchSinkConfiguration =
                 OpenSearchSinkConfiguration.readESConfig(pluginSetting, expressionEvaluator);