Skip to content

NIFI-10095 Use Allowable Value Display Name for Default Value when found #6103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
exceptionfactory wants to merge 1 commit into from
Closed

NIFI-10095 Use Allowable Value Display Name for Default Value when found #6103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion ...cumentation/src/main/java/org/apache/nifi/documentation/html/HtmlDocumentationWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,7 +516,7 @@ protected void writeProperties(final ConfigurableComponent configurableComponent
}

xmlStreamWriter.writeEndElement();
writeSimpleElement(xmlStreamWriter, "td", property.getDefaultValue(), false, "default-value");
writeSimpleElement(xmlStreamWriter, "td", getDefaultValue(property), false, "default-value");
xmlStreamWriter.writeStartElement("td");
xmlStreamWriter.writeAttribute("id", "allowable-values");
writeValidValues(xmlStreamWriter, property);
Expand Down Expand Up @@ -674,6 +674,25 @@ protected void writeProperties(final ConfigurableComponent configurableComponent
}
}

private String getDefaultValue(final PropertyDescriptor propertyDescriptor) {
final String defaultValue;

final String descriptorDefaultValue = propertyDescriptor.getDefaultValue();

final List<AllowableValue> allowableValues = propertyDescriptor.getAllowableValues();
if (allowableValues != null) {
defaultValue = allowableValues.stream()
.filter(allowableValue -> allowableValue.getValue().equals(descriptorDefaultValue))
.findFirst()
.map(AllowableValue::getDisplayName)
.orElse(descriptorDefaultValue);
} else {
defaultValue = descriptorDefaultValue;
}

return defaultValue;
}

/**
* Indicates whether or not the component contains at least one sensitive property.
*
Expand Down
4 changes: 2 additions & 2 deletions ...ntation/src/test/java/org/apache/nifi/documentation/example/FullyDocumentedProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ public class FullyDocumentedProcessor extends AbstractProcessor {
.description("Indicates whether or not to pull files from subdirectories")
.required(true)
.allowableValues(
new AllowableValue("true", "true", "Should pull from sub directories"),
new AllowableValue("false", "false", "Should not pull from sub directories")
new AllowableValue("true", "Enabled", "Should pull from sub directories"),
new AllowableValue("false", "Disabled", "Should not pull from sub directories")
)
.defaultValue("true")
.build();
Expand Down
4 changes: 4 additions & 0 deletions ...on/src/test/java/org/apache/nifi/documentation/html/ProcessorDocumentationWriterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,10 @@ public void testFullyDocumentedProcessor() throws IOException {
assertContains(results, "Supports Expression Language: true (will be evaluated using variable registry only)");
assertContains(results, "Supports Expression Language: true (undefined scope)");

// Check Property Values
assertContains(results, "Enabled");
assertContains(results, "0 sec");

// verify dynamic properties
assertContains(results, "Routes FlowFiles to relationships based on XPath");

Expand Down