Apache
/
nifi
mirror of https://github.com/apache/nifi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NIFI-5821 Added Engine Name to Script Engine property descriptions 

Signed-off-by: Matthew Burgess <mattyb149@apache.org>

This closes #5529
This commit is contained in:
exceptionfactory 2021-11-17 08:53:14 -06:00 committed by Matthew Burgess
parent 0cf515c9c0
commit d66219739b
No known key found for this signature in database
GPG Key ID: 05D3DEB8126DAD24
2 changed files with 68 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
nifi-nar-bundles/nifi-scripting-bundle/nifi-scripting-processors/src/main/java/org/apache/nifi/script/ScriptingComponentHelper.java
View File

@ -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);
}
}

54
nifi-nar-bundles/nifi-scripting-bundle/nifi-scripting-processors/src/test/java/org/apache/nifi/processors/script/TestScriptingComponentHelper.java Normal file
View File

@ -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());
}
}
}