[nifi] 15/15: NIFI-5821 Added Engine Name to Script Engine property descriptions

[jo...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

joewitt pushed a commit to branch support/nifi-1.15
in repository https://gitbox.apache.org/repos/asf/nifi.git

commit 4e88943e60817aac6d779cf0bf2c970e9cfdb16b
Author: exceptionfactory <ex...@apache.org>
AuthorDate: Wed Nov 17 08:53:14 2021 -0600

    NIFI-5821 Added Engine Name to Script Engine property descriptions
    
    Signed-off-by: Matthew Burgess <ma...@apache.org>
    
    This closes #5529
---
 .../nifi/script/ScriptingComponentHelper.java      | 15 +++++-
 .../script/TestScriptingComponentHelper.java       | 54 ++++++++++++++++++++++
 2 files changed, 68 insertions(+), 1 deletion(-)

diff --git a/nifi-nar-bundles/nifi-scripting-bundle/nifi-scripting-processors/src/main/java/org/apache/nifi/script/ScriptingComponentHelper.java b/nifi-nar-bundles/nifi-scripting-bundle/nifi-scripting-processors/src/main/java/org/apache/nifi/script/ScriptingComponentHelper.java
index cf92340..1db75bf 100644
--- a/nifi-nar-bundles/nifi-scripting-bundle/nifi-scripting-processors/src/main/java/org/apache/nifi/script/ScriptingComponentHelper.java
+++ b/nifi-nar-bundles/nifi-scripting-bundle/nifi-scripting-processors/src/main/java/org/apache/nifi/script/ScriptingComponentHelper.java
@@ -48,10 +48,13 @@ import java.util.concurrent.BlockingQueue;
 import java.util.concurrent.LinkedBlockingQueue;
 import java.util.concurrent.atomic.AtomicBoolean;
 
+import static org.apache.commons.lang3.StringUtils.defaultIfBlank;
+
 /**
  * This class contains variables and methods common to scripting processors, reporting tasks, etc.
  */
 public class ScriptingComponentHelper {
+    private static final String UNKNOWN_VERSION = "UNKNOWN";
 
     public PropertyDescriptor SCRIPT_ENGINE;
 
@@ -155,7 +158,8 @@ public class ScriptingComponentHelper {
             List<AllowableValue> engineList = new LinkedList<>();
             for (ScriptEngineFactory factory : scriptEngineFactories) {
                 if (!requireInvocable || factory.getScriptEngine() instanceof Invocable) {
-                    engineList.add(new AllowableValue(factory.getLanguageName()));
+                    final AllowableValue scriptEngineAllowableValue = getScriptLanguageAllowableValue(factory);
+                    engineList.add(scriptEngineAllowableValue);
                     scriptEngineFactoryMap.put(factory.getLanguageName(), factory);
                 }
             }
@@ -269,4 +273,13 @@ public class ScriptingComponentHelper {
             scriptRunnerQ.clear();
         }
     }
+
+    private AllowableValue getScriptLanguageAllowableValue(final ScriptEngineFactory factory) {
+        final String languageName = factory.getLanguageName();
+        final String languageVersion = defaultIfBlank(factory.getLanguageVersion(), UNKNOWN_VERSION);
+        final String engineVersion = defaultIfBlank(factory.getEngineVersion(), UNKNOWN_VERSION);
+
+        final String description = String.format("%s %s [%s %s]", languageName, languageVersion, factory.getEngineName(), engineVersion);
+        return new AllowableValue(languageName, languageName, description);
+    }
 }
diff --git a/nifi-nar-bundles/nifi-scripting-bundle/nifi-scripting-processors/src/test/java/org/apache/nifi/processors/script/TestScriptingComponentHelper.java b/nifi-nar-bundles/nifi-scripting-bundle/nifi-scripting-processors/src/test/java/org/apache/nifi/processors/script/TestScriptingComponentHelper.java
new file mode 100644
index 0000000..459e673
--- /dev/null
+++ b/nifi-nar-bundles/nifi-scripting-bundle/nifi-scripting-processors/src/test/java/org/apache/nifi/processors/script/TestScriptingComponentHelper.java
@@ -0,0 +1,54 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.nifi.processors.script;
+
+import org.apache.nifi.components.AllowableValue;
+import org.apache.nifi.components.PropertyDescriptor;
+import org.apache.nifi.script.ScriptingComponentHelper;
+import org.junit.jupiter.api.Test;
+
+import java.util.List;
+import java.util.Optional;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+public class TestScriptingComponentHelper {
+    private static final String SCRIPT_ENGINE_PROPERTY = "Script Engine";
+
+    @Test
+    public void testScriptEngineAllowableValuesWithDescriptions() {
+        final ScriptingComponentHelper helper = new ScriptingComponentHelper();
+        helper.createResources();
+
+        final List<PropertyDescriptor> descriptors = helper.getDescriptors();
+        final Optional<PropertyDescriptor> optionalScriptEngine = descriptors.stream().filter(
+                descriptor -> descriptor.getName().equals(SCRIPT_ENGINE_PROPERTY)
+        ).findFirst();
+
+        assertTrue(optionalScriptEngine.isPresent());
+        final PropertyDescriptor scriptEngineDescriptor = optionalScriptEngine.get();
+
+        final List<AllowableValue> allowableValues =scriptEngineDescriptor.getAllowableValues();
+        assertFalse(allowableValues.isEmpty());
+
+        for (final AllowableValue allowableValue : allowableValues) {
+            assertNotNull(allowableValue.getDescription());
+        }
+    }
+}