You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by al...@apache.org on 2017/08/10 04:20:59 UTC
nifi git commit: NIFI-4278 - add error message to invalid FFs in
ValidateXml
Repository: nifi
Updated Branches:
refs/heads/master 9f1267e94 -> 6ff8321cf
NIFI-4278 - add error message to invalid FFs in ValidateXml
This closes #2069.
Signed-off-by: Andy LoPresto <al...@apache.org>
Project: http://git-wip-us.apache.org/repos/asf/nifi/repo
Commit: http://git-wip-us.apache.org/repos/asf/nifi/commit/6ff8321c
Tree: http://git-wip-us.apache.org/repos/asf/nifi/tree/6ff8321c
Diff: http://git-wip-us.apache.org/repos/asf/nifi/diff/6ff8321c
Branch: refs/heads/master
Commit: 6ff8321cf71fb07a5d961a30b035e31c48829c91
Parents: 9f1267e
Author: Pierre Villard <pi...@gmail.com>
Authored: Wed Aug 9 12:34:24 2017 +0200
Committer: Andy LoPresto <al...@apache.org>
Committed: Wed Aug 9 21:20:08 2017 -0700
----------------------------------------------------------------------
.../nifi/processors/standard/ValidateXml.java | 19 +++++++++++++++----
.../processors/standard/TestValidateXml.java | 13 ++++++++++++-
2 files changed, 27 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/nifi/blob/6ff8321c/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/ValidateXml.java
----------------------------------------------------------------------
diff --git a/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/ValidateXml.java b/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/ValidateXml.java
index d9f9b50..1c38dfd 100644
--- a/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/ValidateXml.java
+++ b/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/ValidateXml.java
@@ -37,6 +37,8 @@ import org.apache.nifi.annotation.behavior.InputRequirement;
import org.apache.nifi.annotation.behavior.InputRequirement.Requirement;
import org.apache.nifi.annotation.behavior.SideEffectFree;
import org.apache.nifi.annotation.behavior.SupportsBatching;
+import org.apache.nifi.annotation.behavior.WritesAttribute;
+import org.apache.nifi.annotation.behavior.WritesAttributes;
import org.apache.nifi.annotation.documentation.CapabilityDescription;
import org.apache.nifi.annotation.documentation.Tags;
import org.apache.nifi.annotation.lifecycle.OnScheduled;
@@ -57,9 +59,15 @@ import org.xml.sax.SAXException;
@SupportsBatching
@InputRequirement(Requirement.INPUT_REQUIRED)
@Tags({"xml", "schema", "validation", "xsd"})
+@WritesAttributes({
+ @WritesAttribute(attribute = "validatexml.invalid.error", description = "If the flow file is routed to the invalid relationship "
+ + "the attribute will contain the error message resulting from the validation failure.")
+})
@CapabilityDescription("Validates the contents of FlowFiles against a user-specified XML Schema file")
public class ValidateXml extends AbstractProcessor {
+ public static final String ERROR_ATTRIBUTE_KEY = "validatexml.invalid.error";
+
public static final PropertyDescriptor SCHEMA_FILE = new PropertyDescriptor.Builder()
.name("Schema File")
.description("The path to the Schema file that is to be used for validation")
@@ -127,8 +135,10 @@ public class ValidateXml extends AbstractProcessor {
final Validator validator = schema.newValidator();
final ComponentLog logger = getLogger();
- for (final FlowFile flowFile : flowFiles) {
+ for (FlowFile flowFile : flowFiles) {
final AtomicBoolean valid = new AtomicBoolean(true);
+ final AtomicReference<Exception> exception = new AtomicReference<Exception>(null);
+
session.read(flowFile, new InputStreamCallback() {
@Override
public void process(final InputStream in) throws IOException {
@@ -136,17 +146,18 @@ public class ValidateXml extends AbstractProcessor {
validator.validate(new StreamSource(in));
} catch (final IllegalArgumentException | SAXException e) {
valid.set(false);
- logger.debug("Failed to validate {} against schema due to {}", new Object[]{flowFile, e});
+ exception.set(e);
}
}
});
if (valid.get()) {
- logger.info("Successfully validated {} against schema; routing to 'valid'", new Object[]{flowFile});
+ logger.debug("Successfully validated {} against schema; routing to 'valid'", new Object[]{flowFile});
session.getProvenanceReporter().route(flowFile, REL_VALID);
session.transfer(flowFile, REL_VALID);
} else {
- logger.info("Failed to validate {} against schema; routing to 'invalid'", new Object[]{flowFile});
+ flowFile = session.putAttribute(flowFile, ERROR_ATTRIBUTE_KEY, exception.get().getLocalizedMessage());
+ logger.info("Failed to validate {} against schema due to {}; routing to 'invalid'", new Object[]{flowFile, exception.get().getLocalizedMessage()});
session.getProvenanceReporter().route(flowFile, REL_INVALID);
session.transfer(flowFile, REL_INVALID);
}
http://git-wip-us.apache.org/repos/asf/nifi/blob/6ff8321c/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/test/java/org/apache/nifi/processors/standard/TestValidateXml.java
----------------------------------------------------------------------
diff --git a/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/test/java/org/apache/nifi/processors/standard/TestValidateXml.java b/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/test/java/org/apache/nifi/processors/standard/TestValidateXml.java
index 7dfe5b6..d7b2e39 100644
--- a/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/test/java/org/apache/nifi/processors/standard/TestValidateXml.java
+++ b/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/test/java/org/apache/nifi/processors/standard/TestValidateXml.java
@@ -21,7 +21,6 @@ import java.nio.file.Paths;
import org.apache.nifi.util.TestRunner;
import org.apache.nifi.util.TestRunners;
-
import org.junit.Test;
import org.xml.sax.SAXException;
@@ -38,4 +37,16 @@ public class TestValidateXml {
runner.assertAllFlowFilesTransferred(ValidateXml.REL_VALID, 1);
}
+ @Test
+ public void testInvalid() throws IOException, SAXException {
+ final TestRunner runner = TestRunners.newTestRunner(new ValidateXml());
+ runner.setProperty(ValidateXml.SCHEMA_FILE, "src/test/resources/TestXml/XmlBundle.xsd");
+
+ runner.enqueue("<this>is an invalid</xml>");
+ runner.run();
+
+ runner.assertAllFlowFilesTransferred(ValidateXml.REL_INVALID, 1);
+ runner.assertAllFlowFilesContainAttribute(ValidateXml.REL_INVALID, ValidateXml.ERROR_ATTRIBUTE_KEY);
+ }
+
}