From dd6bcc74850daf8f5d7a8621aacd6140eedd4001 Mon Sep 17 00:00:00 2001 From: Matthew Burgess Date: Mon, 3 Feb 2020 09:45:08 -0500 Subject: [PATCH] NIFI-7054: Add RecordSinkServiceLookup for dynamic sink routing (#4020) * NIFI-7054: Add RecordSinkServiceLookup for dynamic sink routing * NIFI-7054: Incorporated review comments --- nifi-assembly/pom.xml | 6 + .../nifi-record-sink-service-nar/pom.xml | 43 ++++ .../src/main/resources/META-INF/LICENSE | 209 ++++++++++++++++++ .../nifi-record-sink-service/pom.xml | 63 ++++++ .../sink/lookup/RecordSinkServiceLookup.java | 84 +++++++ ...g.apache.nifi.controller.ControllerService | 15 ++ .../sink/lookup/MockRecordSinkService.java | 106 +++++++++ .../record/sink/lookup/TestProcessor.java | 46 ++++ .../lookup/TestRecordSinkServiceLookup.java | 209 ++++++++++++++++++ .../nifi-record-sink-service-bundle/pom.xml | 30 +++ .../nifi-standard-services/pom.xml | 1 + 11 files changed, 812 insertions(+) create mode 100644 nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service-nar/pom.xml create mode 100644 nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service-nar/src/main/resources/META-INF/LICENSE create mode 100644 nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/pom.xml create mode 100644 nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/main/java/org/apache/nifi/record/sink/lookup/RecordSinkServiceLookup.java create mode 100644 nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/main/resources/META-INF/services/org.apache.nifi.controller.ControllerService create mode 100644 nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/test/java/org/apache/nifi/record/sink/lookup/MockRecordSinkService.java create mode 100644 nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/test/java/org/apache/nifi/record/sink/lookup/TestProcessor.java create mode 100644 nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/test/java/org/apache/nifi/record/sink/lookup/TestRecordSinkServiceLookup.java create mode 100644 nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/pom.xml diff --git a/nifi-assembly/pom.xml b/nifi-assembly/pom.xml index 453fa7dc1963..ef8d3d0f370c 100644 --- a/nifi-assembly/pom.xml +++ b/nifi-assembly/pom.xml @@ -721,6 +721,12 @@ language governing permissions and limitations under the License. --> 1.12.0-SNAPSHOT nar + + org.apache.nifi + nifi-record-sink-service-nar + 1.12.0-SNAPSHOT + nar + diff --git a/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service-nar/pom.xml b/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service-nar/pom.xml new file mode 100644 index 000000000000..72b9fa2033e5 --- /dev/null +++ b/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service-nar/pom.xml @@ -0,0 +1,43 @@ + + + 4.0.0 + + org.apache.nifi + nifi-record-sink-service-bundle + 1.12.0-SNAPSHOT + + + nifi-record-sink-service-nar + nar + + true + true + + + + + org.apache.nifi + nifi-standard-services-api-nar + 1.12.0-SNAPSHOT + nar + + + org.apache.nifi + nifi-record-sink-service + 1.12.0-SNAPSHOT + + + diff --git a/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service-nar/src/main/resources/META-INF/LICENSE b/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service-nar/src/main/resources/META-INF/LICENSE new file mode 100644 index 000000000000..6effaa89d393 --- /dev/null +++ b/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service-nar/src/main/resources/META-INF/LICENSE @@ -0,0 +1,209 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. + +APACHE NIFI SUBCOMPONENTS: + +The Apache NiFi project contains subcomponents with separate copyright +notices and license terms. Your use of the source code for the these +subcomponents is subject to the terms and conditions of the following +licenses. \ No newline at end of file diff --git a/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/pom.xml b/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/pom.xml new file mode 100644 index 000000000000..80b96b68bf6f --- /dev/null +++ b/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/pom.xml @@ -0,0 +1,63 @@ + + + 4.0.0 + + org.apache.nifi + nifi-record-sink-service-bundle + 1.12.0-SNAPSHOT + + + nifi-record-sink-service + jar + + + + org.apache.nifi + nifi-api + + + org.apache.nifi + nifi-utils + 1.12.0-SNAPSHOT + + + org.apache.nifi + nifi-record-sink-api + + + org.apache.nifi + nifi-record-serialization-service-api + + + org.apache.nifi + nifi-record + + + org.apache.nifi + nifi-service-utils + 1.12.0-SNAPSHOT + + + org.apache.nifi + nifi-properties + + + org.apache.nifi + nifi-mock + test + + + diff --git a/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/main/java/org/apache/nifi/record/sink/lookup/RecordSinkServiceLookup.java b/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/main/java/org/apache/nifi/record/sink/lookup/RecordSinkServiceLookup.java new file mode 100644 index 000000000000..143cb7f8e26c --- /dev/null +++ b/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/main/java/org/apache/nifi/record/sink/lookup/RecordSinkServiceLookup.java @@ -0,0 +1,84 @@ +/* + * 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.record.sink.lookup; + +import org.apache.nifi.annotation.behavior.DynamicProperty; +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.expression.ExpressionLanguageScope; +import org.apache.nifi.processor.exception.ProcessException; +import org.apache.nifi.record.sink.RecordSinkService; +import org.apache.nifi.serialization.WriteResult; +import org.apache.nifi.serialization.record.RecordSet; +import org.apache.nifi.service.lookup.AbstractSingleAttributeBasedControllerServiceLookup; + +import java.io.IOException; +import java.util.Map; + + +@Tags({"record", "sink", "lookup"}) +@CapabilityDescription("Provides a RecordSinkService that can be used to dynamically select another RecordSinkService. This service " + + "requires an attribute named 'record.sink.name' to be passed in when asking for a connection, and will throw an exception " + + "if the attribute is missing. The value of 'record.sink.name' will be used to select the RecordSinkService that has been " + + "registered with that name. This will allow multiple RecordSinkServices to be defined and registered, and then selected " + + "dynamically at runtime by tagging flow files with the appropriate 'record.sink.name' attribute. Note that this controller service " + + "is not intended for use in reporting tasks that employ RecordSinkService instances, such as QueryNiFiReportingTask.") +@DynamicProperty(name = "The name to register the specified RecordSinkService", value = "The RecordSinkService", + description = "If '" + RecordSinkServiceLookup.RECORD_SINK_NAME_ATTRIBUTE + "' attribute contains " + + "the name of the dynamic property, then the RecordSinkService (registered in the value) will be selected.", + expressionLanguageScope = ExpressionLanguageScope.NONE) +public class RecordSinkServiceLookup + extends AbstractSingleAttributeBasedControllerServiceLookup implements RecordSinkService { + + public static final String RECORD_SINK_NAME_ATTRIBUTE = "record.sink.name"; + + RecordSinkService recordSinkService; + + @Override + protected String getLookupAttribute() { + return RECORD_SINK_NAME_ATTRIBUTE; + } + + @Override + public Class getServiceType() { + return RecordSinkService.class; + } + + @Override + public WriteResult sendData(RecordSet recordSet, Map attributes, boolean sendZeroResults) throws IOException { + try { + RecordSinkService recordSink = lookupService(attributes); + if (recordSinkService != recordSink) { + // Save for later reset(), and do a reset now since it has changed + recordSinkService = recordSink; + recordSinkService.reset(); + } + return recordSinkService.sendData(recordSet, attributes, sendZeroResults); + } catch (ProcessException pe) { + // Lookup was unsuccessful, wrap the exception in an IOException to honor the contract + throw new IOException(pe); + } + } + + @Override + public void reset() { + // By convention, calling reset() before sendData should be a no-op, so we can just delegate the reset() call after sendData() has been called once + if (recordSinkService != null) { + recordSinkService.reset(); + } + } +} diff --git a/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/main/resources/META-INF/services/org.apache.nifi.controller.ControllerService b/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/main/resources/META-INF/services/org.apache.nifi.controller.ControllerService new file mode 100644 index 000000000000..240c2e6df249 --- /dev/null +++ b/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/main/resources/META-INF/services/org.apache.nifi.controller.ControllerService @@ -0,0 +1,15 @@ +# 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. +org.apache.nifi.record.sink.lookup.RecordSinkServiceLookup diff --git a/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/test/java/org/apache/nifi/record/sink/lookup/MockRecordSinkService.java b/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/test/java/org/apache/nifi/record/sink/lookup/MockRecordSinkService.java new file mode 100644 index 000000000000..dfb0acb6589e --- /dev/null +++ b/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/test/java/org/apache/nifi/record/sink/lookup/MockRecordSinkService.java @@ -0,0 +1,106 @@ +/* + * 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.record.sink.lookup; + +import org.apache.nifi.components.AbstractConfigurableComponent; +import org.apache.nifi.controller.ControllerServiceInitializationContext; +import org.apache.nifi.record.sink.RecordSinkService; +import org.apache.nifi.record.sink.RetryableIOException; +import org.apache.nifi.reporting.InitializationException; +import org.apache.nifi.serialization.WriteResult; +import org.apache.nifi.serialization.record.Record; +import org.apache.nifi.serialization.record.RecordSchema; +import org.apache.nifi.serialization.record.RecordSet; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +public class MockRecordSinkService extends AbstractConfigurableComponent implements RecordSinkService { + + private List> rows = new ArrayList<>(); + private boolean transmitted = false; + private boolean failWithRetryableError = false; + private String name; + private int resetCount = 0; + + public MockRecordSinkService(String name) { + this.name = name; + } + + public MockRecordSinkService(String name, boolean failWithRetryableError) { + this(name); + this.failWithRetryableError = failWithRetryableError; + } + + @Override + public WriteResult sendData(RecordSet recordSet, Map attributes, boolean sendZeroResults) throws IOException { + if (failWithRetryableError) { + throw new RetryableIOException("Retryable"); + } + int numRecordsWritten = 0; + RecordSchema recordSchema = recordSet.getSchema(); + Record record; + while ((record = recordSet.next()) != null) { + Map row = new HashMap<>(); + final Record finalRecord = record; + recordSchema.getFieldNames().forEach((fieldName) -> row.put(fieldName, finalRecord.getValue(fieldName))); + rows.add(row); + numRecordsWritten++; + } + + if (numRecordsWritten > 0 || sendZeroResults) { + transmitted = true; + } + + Map returnAttributes = new HashMap<>(attributes); + returnAttributes.put("my.name", name); + return WriteResult.of(numRecordsWritten, returnAttributes); + } + + @Override + public void reset() { + resetCount++; + } + + @Override + public String getIdentifier() { + return name; + } + + @Override + public void initialize(ControllerServiceInitializationContext context) throws InitializationException { + } + + public List> getRows() { + return rows; + } + + public boolean isTransmitted() { + return transmitted; + } + + public int getResetCount() { + return resetCount; + } + + public void setFailWithRetryableError(boolean failWithRetryableError) { + this.failWithRetryableError = failWithRetryableError; + } +} diff --git a/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/test/java/org/apache/nifi/record/sink/lookup/TestProcessor.java b/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/test/java/org/apache/nifi/record/sink/lookup/TestProcessor.java new file mode 100644 index 000000000000..d7bd69f8b00b --- /dev/null +++ b/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/test/java/org/apache/nifi/record/sink/lookup/TestProcessor.java @@ -0,0 +1,46 @@ +/* + * 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.record.sink.lookup; + +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.processor.AbstractProcessor; +import org.apache.nifi.processor.ProcessContext; +import org.apache.nifi.processor.ProcessSession; +import org.apache.nifi.processor.exception.ProcessException; +import org.apache.nifi.record.sink.RecordSinkService; + +import java.util.ArrayList; +import java.util.List; + +public class TestProcessor extends AbstractProcessor { + + @Override + public void onTrigger(ProcessContext context, ProcessSession session) throws ProcessException { + } + + @Override + protected List getSupportedPropertyDescriptors() { + List propDescs = new ArrayList<>(); + propDescs.add(new PropertyDescriptor.Builder() + .name("RecordSinkService test processor") + .description("RecordSinkService test processor") + .identifiesControllerService(RecordSinkService.class) + .required(true) + .build()); + return propDescs; + } +} diff --git a/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/test/java/org/apache/nifi/record/sink/lookup/TestRecordSinkServiceLookup.java b/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/test/java/org/apache/nifi/record/sink/lookup/TestRecordSinkServiceLookup.java new file mode 100644 index 000000000000..ed6dfc594e64 --- /dev/null +++ b/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/nifi-record-sink-service/src/test/java/org/apache/nifi/record/sink/lookup/TestRecordSinkServiceLookup.java @@ -0,0 +1,209 @@ +/* + * 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.record.sink.lookup; + + +import org.apache.nifi.reporting.InitializationException; +import org.apache.nifi.serialization.SimpleRecordSchema; +import org.apache.nifi.serialization.WriteResult; +import org.apache.nifi.serialization.record.MapRecord; +import org.apache.nifi.serialization.record.Record; +import org.apache.nifi.serialization.record.RecordField; +import org.apache.nifi.serialization.record.RecordFieldType; +import org.apache.nifi.serialization.record.RecordSchema; +import org.apache.nifi.serialization.record.RecordSet; +import org.apache.nifi.util.TestRunner; +import org.apache.nifi.util.TestRunners; +import org.junit.Before; +import org.junit.Test; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.fail; + +public class TestRecordSinkServiceLookup { + + private MockRecordSinkServiceLookup sinkLookup; + private TestRunner runner; + private MockRecordSinkService sinkA, sinkB; + private RecordSet recordSet; + + @Before + public void setup() throws InitializationException { + sinkA = new MockRecordSinkService("a"); + sinkB = new MockRecordSinkService("b"); + sinkLookup = new MockRecordSinkServiceLookup(); + + runner = TestRunners.newTestRunner(TestProcessor.class); + + final String sinkServiceAIdentifier = "a"; + runner.addControllerService(sinkServiceAIdentifier, sinkA); + + final String sinkServiceBIdentifier = "b"; + runner.addControllerService(sinkServiceBIdentifier, sinkB); + + runner.addControllerService("sink-lookup", sinkLookup); + runner.setProperty(sinkLookup, "a", sinkServiceAIdentifier); + runner.setProperty(sinkLookup, "b", sinkServiceBIdentifier); + + runner.enableControllerService(sinkA); + runner.enableControllerService(sinkB); + runner.enableControllerService(sinkLookup); + + final List fields = new ArrayList<>(); + fields.add(new RecordField("a", RecordFieldType.STRING.getDataType())); + fields.add(new RecordField("b", RecordFieldType.BOOLEAN.getDataType())); + + final RecordSchema schema = new SimpleRecordSchema(fields); + + final Map valueMap1 = new HashMap<>(); + valueMap1.put("a", "Hello"); + valueMap1.put("b", true); + final Record record1 = new MapRecord(schema, valueMap1); + + final Map valueMap2 = new HashMap<>(); + valueMap2.put("a", "World"); + valueMap2.put("b", false); + final Record record2 = new MapRecord(schema, valueMap2); + + recordSet = RecordSet.of(schema, record1, record2); + } + + @Test + public void testLookupServiceA() { + final Map attributes = new HashMap<>(); + attributes.put(RecordSinkServiceLookup.RECORD_SINK_NAME_ATTRIBUTE, "a"); + + try { + final WriteResult writeResult = sinkLookup.sendData(recordSet, attributes, false); + assertNotNull(writeResult); + assertEquals(2, writeResult.getRecordCount()); + String returnedName = writeResult.getAttributes().get("my.name"); + assertEquals("a", returnedName); + } catch (IOException ioe) { + fail("Should have completed successfully"); + } + } + + @Test + public void testLookupServiceB() { + final Map attributes = new HashMap<>(); + attributes.put(RecordSinkServiceLookup.RECORD_SINK_NAME_ATTRIBUTE, "b"); + + try { + final WriteResult writeResult = sinkLookup.sendData(recordSet, attributes, false); + assertNotNull(writeResult); + assertEquals(2, writeResult.getRecordCount()); + String returnedName = writeResult.getAttributes().get("my.name"); + assertEquals("b", returnedName); + } catch (IOException ioe) { + fail("Should have completed successfully"); + } + } + + @Test + public void testLookupServiceAThenB() { + final Map attributes = new HashMap<>(); + attributes.put(RecordSinkServiceLookup.RECORD_SINK_NAME_ATTRIBUTE, "a"); + + try { + final WriteResult writeResult = sinkLookup.sendData(recordSet, attributes, false); + String returnedName = writeResult.getAttributes().get("my.name"); + assertEquals("a", returnedName); + assertEquals(1, sinkA.getResetCount()); + } catch (IOException ioe) { + fail("Should have completed successfully"); + } + + attributes.put(RecordSinkServiceLookup.RECORD_SINK_NAME_ATTRIBUTE, "b"); + + try { + final WriteResult writeResult = sinkLookup.sendData(recordSet, attributes, false); + String returnedName = writeResult.getAttributes().get("my.name"); + assertEquals("b", returnedName); + assertEquals(1, sinkB.getResetCount()); + } catch (IOException ioe) { + fail("Should have completed successfully"); + } + // reset() was called on the retrieved sinks (not the lookup itself) in sendData() when the sink changed + assertEquals(0, sinkLookup.getResetCount()); + sinkLookup.reset(); + assertEquals(1, sinkLookup.getResetCount()); + } + + @Test + public void testLookupServiceAThenA() { + final Map attributes = new HashMap<>(); + attributes.put(RecordSinkServiceLookup.RECORD_SINK_NAME_ATTRIBUTE, "a"); + + try { + WriteResult writeResult = sinkLookup.sendData(recordSet, attributes, false); + String returnedName = writeResult.getAttributes().get("my.name"); + assertEquals("a", returnedName); + assertEquals(1, sinkA.getResetCount()); + writeResult = sinkLookup.sendData(recordSet, attributes, false); + returnedName = writeResult.getAttributes().get("my.name"); + assertEquals("a", returnedName); + assertEquals(1, sinkA.getResetCount()); + + } catch (IOException ioe) { + fail("Should have completed successfully"); + } + + // reset() was called on the retrieved sinks (not the lookup itself) in sendData() when the sink changed + assertEquals(0, sinkLookup.getResetCount()); + sinkLookup.reset(); + assertEquals(1, sinkLookup.getResetCount()); + } + + @Test(expected = IOException.class) + public void testLookupWithoutAttributes() throws IOException { + sinkLookup.sendData(recordSet, Collections.emptyMap(), false); + } + + @Test(expected = IOException.class) + public void testLookupMissingRecordSinkNameAttribute() throws IOException { + sinkLookup.sendData(recordSet, Collections.emptyMap(), false); + } + + @Test(expected = IOException.class) + public void testLookupWithDatabaseNameThatDoesNotExist() throws IOException { + final Map attributes = new HashMap<>(); + attributes.put(RecordSinkServiceLookup.RECORD_SINK_NAME_ATTRIBUTE, "DOES-NOT-EXIST"); + sinkLookup.sendData(recordSet, attributes, false); + } + + public static class MockRecordSinkServiceLookup extends RecordSinkServiceLookup { + private int resetCount = 0; + + @Override + public void reset() { + resetCount++; + } + + public int getResetCount() { + return resetCount; + } + } +} \ No newline at end of file diff --git a/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/pom.xml b/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/pom.xml new file mode 100644 index 000000000000..a37065a0cd7c --- /dev/null +++ b/nifi-nar-bundles/nifi-standard-services/nifi-record-sink-service-bundle/pom.xml @@ -0,0 +1,30 @@ + + + 4.0.0 + + org.apache.nifi + nifi-standard-services + 1.12.0-SNAPSHOT + + + nifi-record-sink-service-bundle + pom + + + nifi-record-sink-service + nifi-record-sink-service-nar + + diff --git a/nifi-nar-bundles/nifi-standard-services/pom.xml b/nifi-nar-bundles/nifi-standard-services/pom.xml index 1bdd499c38df..2ee9228bdc1f 100644 --- a/nifi-nar-bundles/nifi-standard-services/pom.xml +++ b/nifi-nar-bundles/nifi-standard-services/pom.xml @@ -48,5 +48,6 @@ nifi-proxy-configuration-bundle nifi-rules-engine-service-api nifi-record-sink-api + nifi-record-sink-service-bundle