//////////////////////////////////////////////////////////////////////////////// /// DISCLAIMER /// /// Copyright 2017 ArangoDB GmbH, Cologne, Germany /// /// 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. /// /// Copyright holder is ArangoDB GmbH, Cologne, Germany /// /// @author Andrey Abramov /// @author Vasiliy Nabatchikov //////////////////////////////////////////////////////////////////////////////// #include "common.h" #include "gtest/gtest.h" #include "../Mocks/StorageEngineMock.h" #if USE_ENTERPRISE #include "Enterprise/Ldap/LdapFeature.h" #endif #include "3rdParty/iresearch/tests/tests_config.hpp" #include "Aql/AqlFunctionFeature.h" #include "Aql/Ast.h" #include "Aql/OptimizerRulesFeature.h" #include "Aql/Query.h" #include "Basics/VelocyPackHelper.h" #include "GeneralServer/AuthenticationFeature.h" #include "IResearch/IResearchAnalyzerFeature.h" #include "IResearch/IResearchCommon.h" #include "IResearch/IResearchFeature.h" #include "IResearch/IResearchFilterFactory.h" #include "IResearch/IResearchView.h" #include "Logger/LogTopic.h" #include "Logger/Logger.h" #include "RestServer/AqlFeature.h" #include "RestServer/DatabaseFeature.h" #include "RestServer/DatabasePathFeature.h" #include "RestServer/FlushFeature.h" #include "RestServer/QueryRegistryFeature.h" #include "RestServer/SystemDatabaseFeature.h" #include "RestServer/TraverserEngineRegistryFeature.h" #include "RestServer/ViewTypesFeature.h" #include "Sharding/ShardingFeature.h" #include "StorageEngine/EngineSelectorFeature.h" #include "Transaction/StandaloneContext.h" #include "Utils/OperationOptions.h" #include "Utils/SingleCollectionTransaction.h" #include "V8/v8-globals.h" #include "VocBase/LogicalCollection.h" #include "VocBase/LogicalView.h" #include "IResearch/VelocyPackHelper.h" #include "analysis/analyzers.hpp" #include "analysis/token_attributes.hpp" #include "utils/utf8_path.hpp" #include extern const char* ARGV0; // defined in main.cpp namespace { // ----------------------------------------------------------------------------- // --SECTION-- setup / tear-down // ----------------------------------------------------------------------------- class IResearchQueryTraversalTest : public ::testing::Test { protected: StorageEngineMock engine; arangodb::application_features::ApplicationServer server; std::unique_ptr system; std::vector> features; IResearchQueryTraversalTest() : engine(server), server(nullptr, nullptr) { arangodb::EngineSelectorFeature::ENGINE = &engine; arangodb::tests::init(true); // suppress INFO {authentication} Authentication is turned on (system only), authentication for unix sockets is turned on // suppress WARNING {authentication} --server.jwt-secret is insecure. Use --server.jwt-secret-keyfile instead arangodb::LogTopic::setLogLevel(arangodb::Logger::AUTHENTICATION.name(), arangodb::LogLevel::ERR); // suppress log messages since tests check error conditions arangodb::LogTopic::setLogLevel(arangodb::Logger::AQL.name(), arangodb::LogLevel::ERR); // suppress WARNING {aql} Suboptimal AqlItemMatrix index lookup: arangodb::LogTopic::setLogLevel(arangodb::Logger::FIXME.name(), arangodb::LogLevel::ERR); // suppress WARNING DefaultCustomTypeHandler called arangodb::LogTopic::setLogLevel(arangodb::iresearch::TOPIC.name(), arangodb::LogLevel::FATAL); irs::logger::output_le(iresearch::logger::IRL_FATAL, stderr); // setup required application features features.emplace_back(new arangodb::FlushFeature(server), false); features.emplace_back(new arangodb::ViewTypesFeature(server), true); features.emplace_back(new arangodb::AuthenticationFeature(server), true); features.emplace_back(new arangodb::DatabasePathFeature(server), false); features.emplace_back(new arangodb::DatabaseFeature(server), false); features.emplace_back(new arangodb::ShardingFeature(server), false); features.emplace_back(new arangodb::QueryRegistryFeature(server), false); // must be first arangodb::application_features::ApplicationServer::server->addFeature( features.back().first); // need QueryRegistryFeature feature to be added now in order to create the system database system = irs::memory::make_unique(TRI_vocbase_type_e::TRI_VOCBASE_TYPE_NORMAL, 0, TRI_VOC_SYSTEM_DATABASE); features.emplace_back(new arangodb::SystemDatabaseFeature(server, system.get()), false); // required for IResearchAnalyzerFeature features.emplace_back(new arangodb::TraverserEngineRegistryFeature(server), false); // must be before AqlFeature features.emplace_back(new arangodb::AqlFeature(server), true); features.emplace_back(new arangodb::aql::OptimizerRulesFeature(server), true); features.emplace_back(new arangodb::aql::AqlFunctionFeature(server), true); // required for IResearchAnalyzerFeature features.emplace_back(new arangodb::iresearch::IResearchAnalyzerFeature(server), true); features.emplace_back(new arangodb::iresearch::IResearchFeature(server), true); #if USE_ENTERPRISE features.emplace_back(new arangodb::LdapFeature(server), false); // required for AuthenticationFeature with USE_ENTERPRISE #endif for (auto& f : features) { arangodb::application_features::ApplicationServer::server->addFeature(f.first); } for (auto& f : features) { f.first->prepare(); } for (auto& f : features) { if (f.second) { f.first->start(); } } auto* dbPathFeature = arangodb::application_features::ApplicationServer::getFeature( "DatabasePath"); arangodb::tests::setDatabasePath(*dbPathFeature); // ensure test data is stored in a unique directory } ~IResearchQueryTraversalTest() { system.reset(); // destroy before reseting the 'ENGINE' arangodb::AqlFeature(server).stop(); // unset singleton instance arangodb::LogTopic::setLogLevel(arangodb::iresearch::TOPIC.name(), arangodb::LogLevel::DEFAULT); arangodb::LogTopic::setLogLevel(arangodb::Logger::FIXME.name(), arangodb::LogLevel::DEFAULT); arangodb::LogTopic::setLogLevel(arangodb::Logger::AQL.name(), arangodb::LogLevel::DEFAULT); arangodb::application_features::ApplicationServer::server = nullptr; arangodb::EngineSelectorFeature::ENGINE = nullptr; // destroy application features for (auto& f : features) { if (f.second) { f.first->stop(); } } for (auto& f : features) { f.first->unprepare(); } arangodb::LogTopic::setLogLevel(arangodb::Logger::AUTHENTICATION.name(), arangodb::LogLevel::DEFAULT); } }; // IResearchQuerySetup } // namespace // ----------------------------------------------------------------------------- // --SECTION-- test suite // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @brief setup //////////////////////////////////////////////////////////////////////////////// TEST_F(IResearchQueryTraversalTest, test) { TRI_vocbase_t vocbase(TRI_vocbase_type_e::TRI_VOCBASE_TYPE_NORMAL, 1, "testVocbase"); std::vector insertedDocs; arangodb::LogicalView* view; // create collection0 { auto createJson = arangodb::velocypack::Parser::fromJson( "{ \"name\": \"testCollection0\" }"); auto collection = vocbase.createCollection(createJson->slice()); ASSERT_TRUE((nullptr != collection)); std::vector> docs{ arangodb::velocypack::Parser::fromJson( "{ \"_id\": \"testCollection0/0\", \"_key\": \"0\", \"seq\": -6, " "\"value\": null }"), arangodb::velocypack::Parser::fromJson( "{ \"_id\": \"testCollection0/1\", \"_key\": \"1\", \"seq\": -5, " "\"value\": true }"), arangodb::velocypack::Parser::fromJson( "{ \"_id\": \"testCollection0/2\", \"_key\": \"2\", \"seq\": -4, " "\"value\": \"abc\" }"), arangodb::velocypack::Parser::fromJson( "{ \"_id\": \"testCollection0/3\", \"_key\": \"3\", \"seq\": -3, " "\"value\": 3.14 }"), arangodb::velocypack::Parser::fromJson( "{ \"_id\": \"testCollection0/4\", \"_key\": \"4\", \"seq\": -2, " "\"value\": [ 1, \"abc\" ] }"), arangodb::velocypack::Parser::fromJson( "{ \"_id\": \"testCollection0/5\", \"_key\": \"5\", \"seq\": -1, " "\"value\": { \"a\": 7, \"b\": \"c\" } }"), arangodb::velocypack::Parser::fromJson( "{ \"_id\": \"testCollection0/6\", \"_key\": \"6\", \"seq\": 0, " "\"value\": { \"a\": 7, \"b\": \"c\" } }"), }; arangodb::OperationOptions options; options.returnNew = true; arangodb::SingleCollectionTransaction trx(arangodb::transaction::StandaloneContext::Create(vocbase), *collection, arangodb::AccessMode::Type::WRITE); EXPECT_TRUE((trx.begin().ok())); for (auto& entry : docs) { auto res = trx.insert(collection->name(), entry->slice(), options); EXPECT_TRUE((res.ok())); insertedDocs.emplace_back(res.slice().get("new")); } EXPECT_TRUE((trx.commit().ok())); } // create collection1 { auto createJson = arangodb::velocypack::Parser::fromJson( "{ \"name\": \"testCollection1\" }"); auto collection = vocbase.createCollection(createJson->slice()); ASSERT_TRUE((nullptr != collection)); irs::utf8_path resource; resource /= irs::string_ref(arangodb::tests::testResourceDir); resource /= irs::string_ref("simple_sequential.json"); auto builder = arangodb::basics::VelocyPackHelper::velocyPackFromFile(resource.utf8()); auto slice = builder.slice(); ASSERT_TRUE(slice.isArray()); arangodb::OperationOptions options; options.returnNew = true; arangodb::SingleCollectionTransaction trx(arangodb::transaction::StandaloneContext::Create(vocbase), *collection, arangodb::AccessMode::Type::WRITE); EXPECT_TRUE((trx.begin().ok())); for (arangodb::velocypack::ArrayIterator itr(slice); itr.valid(); ++itr) { auto res = trx.insert(collection->name(), itr.value(), options); EXPECT_TRUE((res.ok())); insertedDocs.emplace_back(res.slice().get("new")); } EXPECT_TRUE((trx.commit().ok())); } // create edge collection { auto createJson = arangodb::velocypack::Parser::fromJson( "{ \"name\": \"edges\", \"type\": 3 }"); auto collection = vocbase.createCollection(createJson->slice()); ASSERT_TRUE((nullptr != collection)); auto createIndexJson = arangodb::velocypack::Parser::fromJson("{ \"type\": \"edge\" }"); bool created = false; auto index = collection->createIndex(createIndexJson->slice(), created); EXPECT_TRUE(index); EXPECT_TRUE(created); arangodb::SingleCollectionTransaction trx(arangodb::transaction::StandaloneContext::Create(vocbase), *collection, arangodb::AccessMode::Type::WRITE); EXPECT_TRUE((trx.begin().ok())); std::vector> docs{ arangodb::velocypack::Parser::fromJson( "{ \"_from\": \"testCollection0/0\", \"_to\": " "\"testCollection0/1\" }"), arangodb::velocypack::Parser::fromJson( "{ \"_from\": \"testCollection0/0\", \"_to\": " "\"testCollection0/2\" }"), arangodb::velocypack::Parser::fromJson( "{ \"_from\": \"testCollection0/0\", \"_to\": " "\"testCollection0/3\" }"), arangodb::velocypack::Parser::fromJson( "{ \"_from\": \"testCollection0/0\", \"_to\": " "\"testCollection0/4\" }"), arangodb::velocypack::Parser::fromJson( "{ \"_from\": \"testCollection0/0\", \"_to\": " "\"testCollection0/5\" }"), arangodb::velocypack::Parser::fromJson( "{ \"_from\": \"testCollection0/6\", \"_to\": " "\"testCollection0/0\" }"), }; arangodb::OperationOptions options; options.returnNew = true; for (auto& entry : docs) { auto res = trx.insert(collection->name(), entry->slice(), options); EXPECT_TRUE((res.ok())); insertedDocs.emplace_back(res.slice().get("new")); } EXPECT_TRUE((trx.commit().ok())); } // create view { auto createJson = arangodb::velocypack::Parser::fromJson( "{ \"name\": \"testView\", \"type\": \"arangosearch\" }"); auto logicalView = vocbase.createView(createJson->slice()); ASSERT_TRUE((false == !logicalView)); view = logicalView.get(); auto* impl = dynamic_cast(view); ASSERT_TRUE((false == !impl)); auto updateJson = arangodb::velocypack::Parser::fromJson( "{ \"links\": {" "\"testCollection0\": { \"includeAllFields\": true, " "\"trackListPositions\": true }," "\"testCollection1\": { \"includeAllFields\": true }" "}}"); EXPECT_TRUE((impl->properties(updateJson->slice(), true).ok())); std::set cids; impl->visitCollections([&cids](TRI_voc_cid_t cid) -> bool { cids.emplace(cid); return true; }); EXPECT_TRUE((2 == cids.size())); EXPECT_TRUE( (arangodb::tests::executeQuery(vocbase, "FOR d IN testView SEARCH 1 ==1 OPTIONS " "{ waitForSync: true } RETURN d") .result.ok())); // commit } // create view on edge collection { auto createJson = arangodb::velocypack::Parser::fromJson( "{ \"name\": \"testViewEdge\", \"type\": \"arangosearch\" }"); auto logicalView = vocbase.createView(createJson->slice()); ASSERT_TRUE((false == !logicalView)); view = logicalView.get(); auto* impl = dynamic_cast(view); ASSERT_TRUE((false == !impl)); auto updateJson = arangodb::velocypack::Parser::fromJson( "{ \"links\": {" "\"edges\": { \"includeAllFields\": true }" "}}"); EXPECT_TRUE((impl->properties(updateJson->slice(), true).ok())); std::set cids; impl->visitCollections([&cids](TRI_voc_cid_t cid) -> bool { cids.emplace(cid); return true; }); EXPECT_TRUE((1 == cids.size())); EXPECT_TRUE( (arangodb::tests::executeQuery(vocbase, "FOR d IN testViewEdge SEARCH 1 ==1 " "OPTIONS { waitForSync: true } RETURN d") .result.ok())); // commit } // check system attribute _from { std::vector expectedDocs{insertedDocs.back().slice()}; auto result = arangodb::tests::executeQuery( vocbase, "FOR d IN testViewEdge SEARCH d._from == 'testCollection0/6' RETURN d"); ASSERT_TRUE(result.result.ok()); auto slice = result.data->slice(); EXPECT_TRUE(slice.isArray()); arangodb::velocypack::ArrayIterator resultIt(slice); ASSERT_TRUE(expectedDocs.size() == resultIt.size()); auto expectedDoc = expectedDocs.begin(); for (; resultIt.valid(); resultIt.next()) { auto const actualDoc = resultIt.value(); auto const resolved = actualDoc.resolveExternals(); EXPECT_TRUE((0 == arangodb::basics::VelocyPackHelper::compare( arangodb::velocypack::Slice(*expectedDoc), resolved, true))); ++expectedDoc; } EXPECT_TRUE(!resultIt.valid()); EXPECT_TRUE(expectedDoc == expectedDocs.end()); } // check system attribute _to { std::vector expectedDocs{insertedDocs.back().slice()}; auto result = arangodb::tests::executeQuery( vocbase, "FOR d IN testViewEdge SEARCH d._to == 'testCollection0/0' RETURN d"); ASSERT_TRUE(result.result.ok()); auto slice = result.data->slice(); EXPECT_TRUE(slice.isArray()); arangodb::velocypack::ArrayIterator resultIt(slice); ASSERT_TRUE(expectedDocs.size() == resultIt.size()); auto expectedDoc = expectedDocs.begin(); for (; resultIt.valid(); resultIt.next()) { auto const actualDoc = resultIt.value(); auto const resolved = actualDoc.resolveExternals(); EXPECT_TRUE((0 == arangodb::basics::VelocyPackHelper::compare( arangodb::velocypack::Slice(*expectedDoc), resolved, true))); ++expectedDoc; } EXPECT_TRUE(!resultIt.valid()); EXPECT_TRUE(expectedDoc == expectedDocs.end()); } // shortest path traversal { std::vector expectedDocs{ insertedDocs[6].slice(), insertedDocs[7].slice(), insertedDocs[5].slice(), insertedDocs[0].slice(), }; auto result = arangodb::tests::executeQuery( vocbase, "FOR v, e IN OUTBOUND SHORTEST_PATH 'testCollection0/6' TO " "'testCollection0/5' edges FOR d IN testView SEARCH d.seq == v.seq " "SORT TFIDF(d) DESC, d.seq DESC, d._id RETURN d"); ASSERT_TRUE(result.result.ok()); auto slice = result.data->slice(); EXPECT_TRUE(slice.isArray()); arangodb::velocypack::ArrayIterator resultIt(slice); ASSERT_TRUE(expectedDocs.size() == resultIt.size()); auto expectedDoc = expectedDocs.begin(); for (; resultIt.valid(); resultIt.next()) { auto const actualDoc = resultIt.value(); auto const resolved = actualDoc.resolveExternals(); EXPECT_TRUE((0 == arangodb::basics::VelocyPackHelper::compare( arangodb::velocypack::Slice(*expectedDoc), resolved, true))); ++expectedDoc; } EXPECT_TRUE(!resultIt.valid()); EXPECT_TRUE(expectedDoc == expectedDocs.end()); } // simple traversal { std::vector expectedDocs{ insertedDocs[5].slice(), insertedDocs[4].slice(), insertedDocs[3].slice(), insertedDocs[2].slice(), insertedDocs[1].slice(), }; auto result = arangodb::tests::executeQuery( vocbase, "FOR v, e, p IN 1..2 OUTBOUND 'testCollection0/0' edges FOR d IN " "testView SEARCH d.seq == v.seq SORT TFIDF(d) DESC, d.seq DESC RETURN " "v"); ASSERT_TRUE(result.result.ok()); auto slice = result.data->slice(); EXPECT_TRUE(slice.isArray()); arangodb::velocypack::ArrayIterator resultIt(slice); ASSERT_TRUE(expectedDocs.size() == resultIt.size()); auto expectedDoc = expectedDocs.begin(); for (; resultIt.valid(); resultIt.next()) { auto const actualDoc = resultIt.value(); auto const resolved = actualDoc.resolveExternals(); EXPECT_TRUE((0 == arangodb::basics::VelocyPackHelper::compare( arangodb::velocypack::Slice(*expectedDoc), resolved, true))); ++expectedDoc; } EXPECT_TRUE(!resultIt.valid()); EXPECT_TRUE(expectedDoc == expectedDocs.end()); } }