blob: cfc9e46740458aa2c2c7b22a360958a2c0a0220e [file] [log] [blame]
/**
*
* 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 <memory>
#include <string>
#include "core/Core.h"
#include "DatabaseContentRepository.h"
#include "FlowFileRecord.h"
#include "properties/Configure.h"
#include "provenance/Provenance.h"
#include "unit/TestBase.h"
#include "unit/Catch.h"
#include "unit/ProvenanceTestHelper.h"
#include "unit/ContentRepositoryDependentTests.h"
#include "unit/TestUtils.h"
class TestDatabaseContentRepository : public core::repository::DatabaseContentRepository {
public:
void invalidate() {
stop();
db_.reset();
}
};
TEST_CASE("Write Claim", "[TestDBCR1]") {
TestController testController;
auto dir = testController.createTempDirectory();
auto content_repo = std::make_shared<TestDatabaseContentRepository>();
auto configuration = std::make_shared<org::apache::nifi::minifi::ConfigureImpl>();
configuration->setHome(dir);
configuration->set(minifi::Configure::nifi_dbcontent_repository_directory_default, dir.string());
REQUIRE(content_repo->initialize(configuration));
auto claim = std::make_shared<minifi::ResourceClaimImpl>(content_repo);
auto stream = content_repo->write(*claim);
const std::string content = "well hello there";
stream->write(as_bytes(std::span(content)));
REQUIRE(content_repo->size(*claim) == content.length());
stream->close();
content_repo->invalidate();
// reclaim the memory
content_repo = nullptr;
content_repo = std::make_shared<TestDatabaseContentRepository>();
configuration = std::make_shared<org::apache::nifi::minifi::ConfigureImpl>();
configuration->setHome(dir);
configuration->set(minifi::Configure::nifi_dbcontent_repository_directory_default, dir.string());
REQUIRE(content_repo->initialize(configuration));
auto read_stream = content_repo->read(*claim);
std::string read_content;
read_content.resize(content.length());
read_stream->read(as_writable_bytes(std::span(read_content)));
REQUIRE(read_content == content);
// should not be able to write to the read stream
// -1 will indicate that we were not able to write any data
REQUIRE(minifi::io::isError(read_stream->write("other value")));
}
TEST_CASE("Delete Claim", "[TestDBCR2]") {
TestController testController;
LogTestController::getInstance().setDebug<core::repository::DatabaseContentRepository>();
auto dir = testController.createTempDirectory();
auto content_repo = std::make_shared<TestDatabaseContentRepository>();
auto configuration = std::make_shared<org::apache::nifi::minifi::ConfigureImpl>();
configuration->setHome(dir);
configuration->set(minifi::Configure::nifi_dbcontent_repository_directory_default, dir.string());
REQUIRE(content_repo->initialize(configuration));
auto claim = std::make_shared<minifi::ResourceClaimImpl>(content_repo);
auto stream = content_repo->write(*claim);
stream->write("well hello there");
stream->close();
content_repo->invalidate();
// reclaim the memory
content_repo = nullptr;
content_repo = std::make_shared<TestDatabaseContentRepository>();
configuration = std::make_shared<org::apache::nifi::minifi::ConfigureImpl>();
configuration->setHome(dir);
configuration->set(minifi::Configure::nifi_dbcontent_repository_directory_default, dir.string());
std::string readstr;
SECTION("Sync") {
configuration->set(minifi::Configure::nifi_dbcontent_repository_purge_period, "0");
REQUIRE(content_repo->initialize(configuration));
content_repo->remove(*claim);
auto read_stream = content_repo->read(*claim);
// error tells us we have an invalid stream
REQUIRE(minifi::io::isError(read_stream->read(readstr)));
}
SECTION("Async") {
configuration->set(minifi::Configure::nifi_dbcontent_repository_purge_period, "100 ms");
REQUIRE(content_repo->initialize(configuration));
content_repo->start();
content_repo->remove(*claim);
// an immediate read will still be able to access the content
REQUIRE_FALSE(minifi::io::isError(content_repo->read(*claim)->read(readstr)));
REQUIRE(minifi::test::utils::verifyEventHappenedInPollTime(1s, [&] {
return minifi::io::isError(content_repo->read(*claim)->read(readstr));
}));
}
}
TEST_CASE("Append Claim", "[TestDBCR1]") {
TestController testController;
auto dir = testController.createTempDirectory();
auto content_repo = std::make_shared<TestDatabaseContentRepository>();
auto configuration = std::make_shared<org::apache::nifi::minifi::ConfigureImpl>();
configuration->setHome(dir);
configuration->set(minifi::Configure::nifi_dbcontent_repository_directory_default, dir.string());
REQUIRE(content_repo->initialize(configuration));
const std::string content = "well hello there";
auto claim = std::make_shared<minifi::ResourceClaimImpl>(content_repo);
content_repo->write(*claim)->write(as_bytes(std::span(content)));
// requesting append before content end fails
CHECK(content_repo->lockAppend(*claim, 0) == nullptr);
auto lock = content_repo->lockAppend(*claim, content.length());
// trying to append to the end succeeds
CHECK(lock != nullptr);
// simultaneously trying to append to the same claim fails
CHECK(content_repo->lockAppend(*claim, content.length()) == nullptr);
// manually deleting append lock
lock.reset();
// appending after lock is released succeeds
lock = content_repo->lockAppend(*claim, content.length());
CHECK(lock != nullptr);
const std::string appended = "General Kenobi!";
content_repo->write(*claim, true)->write(as_bytes(std::span(appended)));
lock.reset();
// size has changed
CHECK(content_repo->lockAppend(*claim, content.length()) == nullptr);
CHECK(content_repo->lockAppend(*claim, content.length() + appended.length()) != nullptr);
}
TEST_CASE("Test Empty Claim", "[TestDBCR3]") {
TestController testController;
auto dir = testController.createTempDirectory();
auto content_repo = std::make_shared<TestDatabaseContentRepository>();
auto configuration = std::make_shared<org::apache::nifi::minifi::ConfigureImpl>();
configuration->setHome(dir);
configuration->set(minifi::Configure::nifi_dbcontent_repository_directory_default, dir.string());
REQUIRE(content_repo->initialize(configuration));
auto claim = std::make_shared<minifi::ResourceClaimImpl>(content_repo);
auto stream = content_repo->write(*claim);
// we're writing nothing to the stream.
stream->close();
content_repo->invalidate();
// reclaim the memory
content_repo = nullptr;
content_repo = std::make_shared<TestDatabaseContentRepository>();
configuration = std::make_shared<org::apache::nifi::minifi::ConfigureImpl>();
configuration->setHome(dir);
configuration->set(minifi::Configure::nifi_dbcontent_repository_directory_default, dir.string());
REQUIRE(content_repo->initialize(configuration));
auto read_stream = content_repo->read(*claim);
std::string readstr;
// error tells us we have an invalid stream
REQUIRE(minifi::io::isError(read_stream->read(readstr)));
}
TEST_CASE("Delete NonExistent Claim", "[TestDBCR4]") {
TestController testController;
auto dir = testController.createTempDirectory();
auto content_repo = std::make_shared<TestDatabaseContentRepository>();
auto configuration = std::make_shared<org::apache::nifi::minifi::ConfigureImpl>();
configuration->setHome(dir);
configuration->set(minifi::Configure::nifi_dbcontent_repository_directory_default, dir.string());
REQUIRE(content_repo->initialize(configuration));
auto claim = std::make_shared<minifi::ResourceClaimImpl>(content_repo);
auto claim2 = std::make_shared<minifi::ResourceClaimImpl>(content_repo);
auto stream = content_repo->write(*claim);
stream->write("well hello there");
stream->close();
content_repo->invalidate();
// reclaim the memory
content_repo = nullptr;
content_repo = std::make_shared<TestDatabaseContentRepository>();
configuration = std::make_shared<org::apache::nifi::minifi::ConfigureImpl>();
configuration->setHome(dir);
configuration->set(minifi::Configure::nifi_dbcontent_repository_directory_default, dir.string());
REQUIRE(content_repo->initialize(configuration));
// we won't complain if it does not exist
REQUIRE(content_repo->remove(*claim2));
auto read_stream = content_repo->read(*claim);
std::string readstr;
read_stream->read(readstr);
REQUIRE(readstr == "well hello there");
}
TEST_CASE("Delete Remove Count Claim", "[TestDBCR5]") {
TestController testController;
auto dir = testController.createTempDirectory();
auto content_repo = std::make_shared<TestDatabaseContentRepository>();
auto configuration = std::make_shared<org::apache::nifi::minifi::ConfigureImpl>();
configuration->setHome(dir);
configuration->set(minifi::Configure::nifi_dbcontent_repository_directory_default, dir.string());
REQUIRE(content_repo->initialize(configuration));
auto claim = std::make_shared<minifi::ResourceClaimImpl>(content_repo);
auto claim2 = std::make_shared<minifi::ResourceClaimImpl>(content_repo);
auto stream = content_repo->write(*claim);
stream->write("well hello there");
stream->close();
content_repo->invalidate();
// reclaim the memory
content_repo = nullptr;
content_repo = std::make_shared<TestDatabaseContentRepository>();
configuration = std::make_shared<org::apache::nifi::minifi::ConfigureImpl>();
configuration->setHome(dir);
configuration->set(minifi::Configure::nifi_dbcontent_repository_directory_default, dir.string());
REQUIRE(content_repo->initialize(configuration));
// increment twice. verify we have 2 for the stream count
// and then test the removal and verify that the claim was removed by virtue of obtaining
// its count.
content_repo->incrementStreamCount(*claim2);
content_repo->incrementStreamCount(*claim2);
REQUIRE(content_repo->getStreamCount(*claim2) == 2);
content_repo->decrementStreamCount(*claim2);
REQUIRE(content_repo->decrementStreamCount(*claim2) == core::StreamManager<minifi::ResourceClaim>::StreamState::Deleted);
REQUIRE(content_repo->getStreamCount(*claim2) == 0);
auto read_stream = content_repo->read(*claim);
std::string readstr;
read_stream->read(readstr);
REQUIRE(readstr == "well hello there");
}
TEST_CASE("ProcessSession::read reads the flowfile from offset to size (RocksDB)", "[readoffsetsize]") {
ContentRepositoryDependentTests::testReadOnSmallerClonedFlowFiles(std::make_shared<core::repository::DatabaseContentRepository>());
}
TEST_CASE("ProcessSession::append should append to the flowfile and set its size correctly (RocksDB)" "[appendsetsize]") {
ContentRepositoryDependentTests::testAppendToUnmanagedFlowFile(std::make_shared<core::repository::DatabaseContentRepository>());
ContentRepositoryDependentTests::testAppendToManagedFlowFile(std::make_shared<core::repository::DatabaseContentRepository>());
}
TEST_CASE("ProcessSession::read can read zero length flowfiles without crash (RocksDB)", "[zerolengthread]") {
ContentRepositoryDependentTests::testReadFromZeroLengthFlowFile(std::make_shared<core::repository::DatabaseContentRepository>());
}
size_t getDbSize(const std::filesystem::path& dir) {
auto db = minifi::internal::RocksDatabase::create({}, {}, dir.string(), {});
auto opendb = db->open();
REQUIRE(opendb);
size_t count = 0;
auto it = opendb->NewIterator({});
for (it->SeekToFirst(); it->Valid(); it->Next()) {
++count;
}
return count;
}
TEST_CASE("DBContentRepository can clear orphan entries") {
TestController testController;
auto dir = testController.createTempDirectory();
auto configuration = std::make_shared<org::apache::nifi::minifi::ConfigureImpl>();
configuration->setHome(dir);
configuration->set(minifi::Configure::nifi_dbcontent_repository_directory_default, dir.string());
{
auto content_repo = std::make_shared<core::repository::DatabaseContentRepository>();
REQUIRE(content_repo->initialize(configuration));
minifi::ResourceClaimImpl claim(content_repo);
content_repo->write(claim)->write("hi");
// ensure that the content is not deleted during resource claim destruction
content_repo->incrementStreamCount(claim);
}
REQUIRE(getDbSize(dir) == 1);
{
auto content_repo = std::make_shared<core::repository::DatabaseContentRepository>();
REQUIRE(content_repo->initialize(configuration));
content_repo->clearOrphans();
}
REQUIRE(getDbSize(dir) == 0);
}