NIFI-15022 Added Log Level Property Validator for EnrichIP Processors (#10546)

Signed-off-by: David Handermann <[email protected]>

Author: dan-s1

nifi-extension-bundles/nifi-enrich-bundle/nifi-enrich-processors/src/main/java/org/apache/nifi/processors/AbstractEnrichIP.java

@@ -20,6 +20,8 @@
 import org.apache.nifi.annotation.lifecycle.OnScheduled;
 import org.apache.nifi.annotation.lifecycle.OnStopped;
 import org.apache.nifi.components.PropertyDescriptor;
+import org.apache.nifi.components.ValidationResult;
+import org.apache.nifi.components.Validator;
 import org.apache.nifi.components.resource.ResourceCardinality;
 import org.apache.nifi.components.resource.ResourceType;
 import org.apache.nifi.expression.AttributeExpression;
@@ -43,6 +45,7 @@
 import java.util.concurrent.locks.Lock;
 import java.util.concurrent.locks.ReadWriteLock;
 import java.util.concurrent.locks.ReentrantReadWriteLock;
+import java.util.regex.Pattern;
 
 public abstract class AbstractEnrichIP extends AbstractProcessor {
 
@@ -63,11 +66,30 @@ public abstract class AbstractEnrichIP extends AbstractProcessor {
             .addValidator(StandardValidators.createAttributeExpressionLanguageValidator(AttributeExpression.ResultType.STRING))
             .build();
 
+    private static final Pattern LOG_LEVEL_PATTERN = Pattern.compile("^(?:INFO|DEBUG|WARN|ERROR)$");
+    private static final Validator LOG_LEVEL_VALIDATOR = (subject, input, context) -> {
+        final boolean matches = LOG_LEVEL_PATTERN.matcher(input).matches();
+        if (matches || context.isExpressionLanguagePresent(input)) {
+            return (new ValidationResult.Builder())
+                    .subject(subject)
+                    .input(input)
+                    .valid(true)
+                    .build();
+        } else {
+            return (new ValidationResult.Builder())
+                    .subject(subject)
+                    .valid(false)
+                    .explanation(String.format("%s must be either INFO, DEBUG, WARN or ERROR", subject))
+                    .input(input)
+                    .build();
+        }
+    };
+
     public static final PropertyDescriptor LOG_LEVEL = new PropertyDescriptor.Builder()
             .name("Log Level")
             .required(true)
             .description("The Log Level to use when an IP is not found in the database. Accepted values: INFO, DEBUG, WARN, ERROR.")
-            .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+            .addValidator(LOG_LEVEL_VALIDATOR)
             .defaultValue(MessageLogLevel.WARN.toString())
             .expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES)
             .build();

nifi-extension-bundles/nifi-enrich-bundle/nifi-enrich-processors/src/test/java/org/apache/nifi/processors/TestGeoEnrichIPRecord.java

@@ -39,13 +39,17 @@
 import org.apache.nifi.util.TestRunners;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
 
 import java.io.InputStream;
 import java.net.InetAddress;
 import java.nio.charset.StandardCharsets;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.stream.Stream;
 
 import static org.apache.nifi.processors.GeoEnrichTestUtils.getFullCityResponse;
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -90,7 +94,29 @@ public void setup() throws Exception {
         runner.enableControllerService(registry);
         runner.enableControllerService(reader);
         runner.enableControllerService(writer);
+    }
+
+    @ParameterizedTest
+    @MethodSource("logLevelArgs")
+    void testSpecifiedLogLevels(String logLevel, boolean expectValid) {
+        runner.setProperty(AbstractEnrichIP.LOG_LEVEL, logLevel);
+
+        if (expectValid) {
+            runner.assertValid();
+        } else {
+            runner.assertNotValid();
+        }
+    }
 
+    private static Stream<Arguments> logLevelArgs() {
+        return Stream.of(
+                Arguments.argumentSet("Valid Log Level Specified", "WARN", true),
+                Arguments.argumentSet("Invalid Log Level Specified", "GIBBERISH", false),
+                Arguments.argumentSet("Log Level Specified as Expression Language Expression", "${log.level}", true)
+        );
+    }
+
+    private void commonTest(String path, int not, int found, int original) {
         runner.setProperty(GeoEnrichIPRecord.GEO_CITY, "/geo/city");
         runner.setProperty(GeoEnrichIPRecord.GEO_COUNTRY, "/geo/country");
         runner.setProperty(GeoEnrichIPRecord.GEO_COUNTRY_ISO, "/geo/country_iso");
@@ -99,9 +125,7 @@ public void setup() throws Exception {
         runner.setProperty(GeoEnrichIPRecord.GEO_LONGITUDE, "/geo/lon");
         runner.setProperty(AbstractEnrichIP.LOG_LEVEL, "WARN");
         runner.assertValid();
-    }
 
-    private void commonTest(String path, int not, int found, int original) {
         Map<String, String> attrs = new HashMap<>();
         attrs.put("schema.name", "record");
         runner.enqueue(getClass().getResourceAsStream(path), attrs);