adamdebreceni commented on a change in pull request #1168: URL: https://github.com/apache/nifi-minifi-cpp/pull/1168#discussion_r707996215
########## File path: extensions/standard-processors/tests/unit/RouteTextTests.cpp ########## @@ -0,0 +1,488 @@ +/** + * + * 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. + */ + +#include "TestBase.h" +#include "processors/RouteText.h" + +struct RouteTextController : public TestController { + struct FlowFilePattern { + FlowFilePattern& attr(const std::string& name, const std::optional<std::string>& value) { + required_attributes_[name] = value; + return *this; + } + FlowFilePattern& content(const std::string& content) { + required_content_ = content; + return *this; + } + + std::map<std::string, std::optional<std::string>> required_attributes_; + std::optional<std::string> required_content_; + }; + + struct FlowFilePatternVec : std::vector<FlowFilePattern> { + FlowFilePatternVec() = default; + FlowFilePatternVec(std::initializer_list<std::string> args) { + for (const auto& arg : args) { + push_back(FlowFilePattern().content(arg)); + } + } + FlowFilePatternVec(std::initializer_list<FlowFilePattern> patterns) { + for (const auto& pattern : patterns) { + push_back(pattern); + } + } + }; + + RouteTextController() { + plan_ = createPlan(); + plan_->addProcessor(proc_, "RouteText"); + input_ = plan_->addConnection(nullptr, {"success", ""}, proc_); + createOutput(processors::RouteText::Original); + createOutput(processors::RouteText::Unmatched); + createOutput(processors::RouteText::Matched); + } + + void createOutput(const core::Relationship& rel) { + outputs_[rel.getName()] = plan_->addConnection(proc_, rel, nullptr); + } + + void verifyOutputRelationship(const std::string& rel_name, const FlowFilePatternVec& patterns) { + size_t pattern_idx = 0; + std::set<std::shared_ptr<core::FlowFile>> expired; + while (auto flow_file = outputs_.at(rel_name)->poll(expired)) { + REQUIRE(expired.empty()); + // more flowfiles than patterns + REQUIRE(pattern_idx < patterns.size()); + const auto& pattern = patterns[pattern_idx++]; + for (const auto& attr : pattern.required_attributes_) { + auto attr_value = flow_file->getAttribute(attr.first); + REQUIRE(attr_value == attr.second); + } + if (pattern.required_content_) { + REQUIRE(pattern.required_content_.value() == plan_->getContent(flow_file)); + } + } + // must use all patterns + REQUIRE(pattern_idx == patterns.size()); + } + + void verifyAllOutput(const std::map<std::string, FlowFilePatternVec>& patterns) { + FlowFilePatternVec all; + for (const auto& [rel, files] : patterns) { + for (const auto& file : files) { + all.push_back(file); + } + verifyOutputRelationship(rel, files); + } + if (patterns.find("original") == patterns.end()) { + // expectations on "original" were implicit + verifyOutputRelationship("original", all); + } + } + + void run() { + while (!input_->isEmpty()) { + plan_->runProcessor(proc_); + } + } + + void putFlowFile(const std::map<std::string, std::string>& attributes, const std::string& content) { + auto flow_file = std::make_shared<minifi::FlowFileRecord>(); + for (const auto& attr : attributes) { + flow_file->setAttribute(attr.first, attr.second); + } + auto content_session = plan_->getContentRepo()->createSession(); + auto claim = content_session->create(); + auto stream = content_session->write(claim); + stream->write(reinterpret_cast<const uint8_t*>(content.c_str()), content.length()); + flow_file->setResourceClaim(claim); + flow_file->setSize(stream->size()); + flow_file->setOffset(0); + + stream->close(); + content_session->commit(); + input_->put(flow_file); + } + + std::shared_ptr<TestPlan> plan_ = createPlan(); + std::shared_ptr<core::Processor> proc_ = std::make_shared<processors::RouteText>("RouteText"); + std::map<std::string, std::shared_ptr<minifi::Connection>> outputs_; + std::shared_ptr<minifi::Connection> input_; +}; + +TEST_CASE_METHOD(RouteTextController, "RouteText correctly handles Matching Strategies") { + proc_->setProperty(processors::RouteText::RoutingStrategy, "Dynamic Routing"); + + std::map<std::string, FlowFilePatternVec> expected{ + {"here", {}}, + {"matched", {}}, + {"unmatched", {}} + }; + + SECTION("Starts With") { + proc_->setProperty(processors::RouteText::MatchingStrategy, "Starts With"); + proc_->setDynamicProperty("here", "se"); + SECTION("Case sensitive") { + expected["here"] = {"seven"}; + expected["unmatched"] = {"Seven", "even"}; + } + SECTION("Case insensitive") { + proc_->setProperty(processors::RouteText::IgnoreCase, "true"); + expected["here"] = {"seven", "Seven"}; + expected["unmatched"] = {"even"}; + } + } + SECTION("Ends With") { + proc_->setProperty(processors::RouteText::MatchingStrategy, "Ends With"); + proc_->setDynamicProperty("here", "ven"); + SECTION("Case sensitive") { + expected["here"] = {"seven"}; + expected["unmatched"] = {"SeveN", "seten"}; + } + SECTION("Case insensitive") { + proc_->setProperty(processors::RouteText::IgnoreCase, "true"); + expected["here"] = {"seven", "SeveN"}; + expected["unmatched"] = {"seten"}; + } + } + SECTION("Contains") { + proc_->setProperty(processors::RouteText::MatchingStrategy, "Contains"); + proc_->setDynamicProperty("here", "eve"); + SECTION("Case sensitive") { + expected["here"] = {"seven"}; + expected["unmatched"] = {"SeVeN", "seren"}; + } + SECTION("Case insensitive") { + proc_->setProperty(processors::RouteText::IgnoreCase, "true"); + expected["here"] = {"seven", "SeVeN"}; + expected["unmatched"] = {"seren"}; + } + } + SECTION("Equals") { + proc_->setProperty(processors::RouteText::MatchingStrategy, "Equals"); + proc_->setDynamicProperty("here", "seven"); + SECTION("Case sensitive") { + expected["here"] = {"seven"}; + expected["unmatched"] = {"Seven", "seven1"}; + } + SECTION("Case insensitive") { + proc_->setProperty(processors::RouteText::IgnoreCase, "true"); + expected["here"] = {"seven", "Seven"}; + expected["unmatched"] = {"seven1"}; + } + } + SECTION("Matches Regex") { + proc_->setProperty(processors::RouteText::MatchingStrategy, "Matches Regex"); + proc_->setDynamicProperty("here", "se.en"); + SECTION("Case sensitive") { + expected["here"] = {"seven"}; + expected["unmatched"] = {"Seven", "sevena"}; + } + SECTION("Case insensitive") { + proc_->setProperty(processors::RouteText::IgnoreCase, "true"); + expected["here"] = {"seven", "Seven"}; + expected["unmatched"] = {"sevena"}; + } + } + SECTION("Contains Regex") { + proc_->setProperty(processors::RouteText::MatchingStrategy, "Contains Regex"); + proc_->setDynamicProperty("here", ".ve"); + SECTION("Case sensitive") { + expected["here"] = {"seven"}; + expected["unmatched"] = {"SeVeN", "ven"}; + } + SECTION("Case insensitive") { + proc_->setProperty(processors::RouteText::IgnoreCase, "true"); + expected["here"] = {"seven", "SeVeN"}; + expected["unmatched"] = {"ven"}; + } + } + SECTION("Satisfies Expression") { + proc_->setProperty(processors::RouteText::MatchingStrategy, "Satisfies Expression"); + proc_->setDynamicProperty("here", "${segment:equals('seven')}"); + // case sensitivity does not matter here + SECTION("Case sensitive") { + expected["here"] = {"seven"}; + expected["unmatched"] = {"SeVeN", "ven"}; + } + SECTION("Case insensitive") { + proc_->setProperty(processors::RouteText::IgnoreCase, "true"); + expected["here"] = {"seven"}; + expected["unmatched"] = {"SeVeN", "ven"}; + } + } + + createOutput({"here", ""}); + + for (const auto& route : expected) { + for (const auto& ff : route.second) { + putFlowFile({}, ff.required_content_.value()); + } + } + + run(); + + verifyAllOutput(expected); +} + +TEST_CASE_METHOD(RouteTextController, "RouteText correctly handles Routing Strategies") { + proc_->setProperty(processors::RouteText::MatchingStrategy, "Contains"); + proc_->setDynamicProperty("one", "apple"); + proc_->setDynamicProperty("two", "banana"); + + createOutput({"one", ""}); + createOutput({"two", ""}); + + std::map<std::string, FlowFilePatternVec> expected{ + {"one", {}}, + {"two", {}}, + {"matched", {}}, + {"unmatched", {}} + }; + + SECTION("Dynamic Routing") { + proc_->setProperty(processors::RouteText::RoutingStrategy, "Dynamic Routing"); + + expected["one"] = {"apple"}; + expected["two"] = {"banana"}; + expected["unmatched"] = {"other"}; + } + SECTION("Route On All") { + proc_->setProperty(processors::RouteText::RoutingStrategy, "Route On All"); + + expected["matched"] = {"apple-banana"}; + expected["unmatched"] = {"apple", "none"}; + } + SECTION("Route On Any") { + proc_->setProperty(processors::RouteText::RoutingStrategy, "Route On Any"); + + expected["matched"] = {"apple", "banana", "apple-banana"}; + expected["unmatched"] = {"none"}; + } + + for (const auto& route : expected) { + for (const auto& ff : route.second) { + putFlowFile({}, ff.required_content_.value()); + } + } + + run(); + + verifyAllOutput(expected); +} + +TEST_CASE_METHOD(RouteTextController, "RouteText 'Per Line' segmentation") { + proc_->setProperty(processors::RouteText::SegmentationStrategy, "Per Line"); + proc_->setProperty(processors::RouteText::MatchingStrategy, "Equals"); + proc_->setDynamicProperty("A", "A"); + proc_->setDynamicProperty("B", "B"); + + createOutput({"A", ""}); + createOutput({"B", ""}); + + std::string content = "A\nB\r A \r\n\r\rA"; + // '\r' is a line terminator iff a non-'\n' character follows it + putFlowFile({}, content); + + std::map<std::string, FlowFilePatternVec> expected{ + {"A", {}}, + {"B", {}}, + {"matched", {}}, + {"unmatched", {}}, + {"original", {content}} + }; + + + SECTION("Without trim") { + proc_->setProperty(processors::RouteText::TrimWhitespace, "false"); + expected["A"] = {"A\nA"}; + expected["B"] = {"B\r"}; + expected["unmatched"] = {" A \r\n\r\r"}; + } + + SECTION("With trim") { + proc_->setProperty(processors::RouteText::TrimWhitespace, "true"); + expected["A"] = {"A\n A \r\nA"}; + expected["B"] = {"B\r"}; + expected["unmatched"] = {"\r\r"}; + } + + run(); + + verifyAllOutput(expected); +} + +TEST_CASE_METHOD(RouteTextController, "RouteText 'Per Line' segmentation ignores trailing empty line") { + proc_->setProperty(processors::RouteText::SegmentationStrategy, "Per Line"); + proc_->setProperty(processors::RouteText::RoutingStrategy, "Route On All"); + proc_->setProperty(processors::RouteText::MatchingStrategy, "Equals"); + proc_->setDynamicProperty("A", "A"); + + std::string content; + + SECTION("Windows line ending") { + content = "A\r\n"; + } + SECTION("Simple line ending") { + content = "A\n"; + } + SECTION("Not a line ending but a single non-terminated line") { Review comment: it was not a line ending, not even in the "legacy" implementation, if the `\r` is at the end of the text (not like we could differentiate between treating `"a\r"` as a single non-terminated line or as a single terminated line followed by nothing :) ) as we have decided to drop support for `\r`, removed this section -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
