//////////////////////////////////////////////////////////////////////////////// /// @brief test case for AddFollower job /// /// @file /// /// 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 Kaveh Vahedipour /// @author Copyright 2017, ArangoDB GmbH, Cologne, Germany //////////////////////////////////////////////////////////////////////////////// #include "gtest/gtest.h" #include "fakeit.hpp" #include #include #include #include #include "Agency/AddFollower.h" #include "Agency/AgentInterface.h" #include "Agency/Node.h" #include "lib/Basics/StringUtils.h" #include "lib/Random/RandomGenerator.h" using namespace arangodb; using namespace arangodb::basics; using namespace arangodb::consensus; using namespace fakeit; namespace arangodb { namespace tests { namespace add_follower_test { const std::string PREFIX = "arango"; const std::string DATABASE = "database"; const std::string COLLECTION = "collection"; const std::string SHARD = "s99"; const std::string SHARD_LEADER = "leader"; const std::string SHARD_FOLLOWER1 = "follower1"; const std::string SHARD_FOLLOWER2 = "follower2"; const std::string FREE_SERVER = "free"; const std::string FREE_SERVER2 = "free2"; bool aborts = false; const char* agency = #include "AddFollowerTest.json" ; const char* todo = #include "AddFollowerTestToDo.json" ; Node createNodeFromBuilder(Builder const& builder) { Builder opBuilder; { VPackObjectBuilder a(&opBuilder); opBuilder.add("new", builder.slice()); } Node node(""); node.handle(opBuilder.slice()); return node; } Builder createBuilder(char const* c) { Options options; options.checkAttributeUniqueness = true; VPackParser parser(&options); parser.parse(c); Builder builder; builder.add(parser.steal()->slice()); return builder; } Node createNode(char const* c) { return createNodeFromBuilder(createBuilder(c)); } Node createRootNode() { return createNode(agency); } typedef std::function(Slice const&, std::string const&)> TestStructType; inline static std::string typeName(Slice const& slice) { return std::string(slice.typeName()); } class AddFollowerTest : public ::testing::Test { protected: Node baseStructure; Builder builder; std::string jobId; write_ret_t fakeWriteResult; trans_ret_t fakeTransResult; AddFollowerTest() : baseStructure(createRootNode()), jobId("1"), fakeWriteResult(true, "", std::vector{APPLIED}, std::vector{1}), fakeTransResult(true, "", 1, 0, std::make_shared()) { arangodb::RandomGenerator::initialize(arangodb::RandomGenerator::RandomType::MERSENNE); baseStructure.toBuilder(builder); } }; TEST_F(AddFollowerTest, creating_a_job_should_create_a_job_in_todo) { Mock mockAgent; When(Method(mockAgent, write)).AlwaysDo([&](query_t const& q, consensus::AgentInterface::WriteMode w) -> write_ret_t { auto expectedJobKey = "/arango/Target/ToDo/" + jobId; EXPECT_TRUE(typeName(q->slice()) == "array"); EXPECT_TRUE(q->slice().length() == 1); EXPECT_TRUE(typeName(q->slice()[0]) == "array"); EXPECT_TRUE(q->slice()[0].length() == 1); // we always simply override! no preconditions... EXPECT_TRUE(typeName(q->slice()[0][0]) == "object"); EXPECT_TRUE(q->slice()[0][0].length() == 1); // should ONLY do an entry in todo EXPECT_TRUE(typeName(q->slice()[0][0].get(expectedJobKey)) == "object"); auto job = q->slice()[0][0].get(expectedJobKey); EXPECT_TRUE(typeName(job.get("creator")) == "string"); EXPECT_TRUE(typeName(job.get("type")) == "string"); EXPECT_TRUE(job.get("type").copyString() == "addFollower"); EXPECT_TRUE(typeName(job.get("database")) == "string"); EXPECT_TRUE(job.get("database").copyString() == DATABASE); EXPECT_TRUE(typeName(job.get("collection")) == "string"); EXPECT_TRUE(job.get("collection").copyString() == COLLECTION); EXPECT_TRUE(typeName(job.get("shard")) == "string"); EXPECT_TRUE(job.get("shard").copyString() == SHARD); EXPECT_TRUE(typeName(job.get("jobId")) == "string"); EXPECT_TRUE(typeName(job.get("timeCreated")) == "string"); return fakeWriteResult; }); When(Method(mockAgent, waitFor)).AlwaysReturn(AgentInterface::raft_commit_t::OK); auto& agent = mockAgent.get(); auto addFollower = AddFollower(baseStructure(PREFIX), &agent, jobId, "unittest", DATABASE, COLLECTION, SHARD); addFollower.create(); } TEST_F(AddFollowerTest, collection_still_exists) { TestStructType createTestStructure = [&](Slice const& s, std::string const& path) { std::unique_ptr builder; if (path == "/arango/Plan/Collections/" + DATABASE + "/" + COLLECTION) { return builder; } builder = std::make_unique(); if (s.isObject()) { VPackObjectBuilder b(builder.get()); for (auto const& it : VPackObjectIterator(s)) { auto childBuilder = createTestStructure(it.value, path + "/" + it.key.copyString()); if (childBuilder) { builder->add(it.key.copyString(), childBuilder->slice()); } } if (path == "/arango/Target/ToDo") { builder->add(jobId, createBuilder(todo).slice()); } } else { builder->add(s); } return builder; }; auto builder = createTestStructure(baseStructure.toBuilder().slice(), ""); ASSERT_TRUE(builder); Node agency = createNodeFromBuilder(*builder); Mock mockAgent; When(Method(mockAgent, write)).AlwaysDo([&](query_t const& q, consensus::AgentInterface::WriteMode w) -> write_ret_t { EXPECT_TRUE(typeName(q->slice()) == "array"); EXPECT_TRUE(q->slice().length() == 1); EXPECT_TRUE(typeName(q->slice()[0]) == "array"); // we always simply override! no preconditions... EXPECT_TRUE(q->slice()[0].length() == 1); EXPECT_TRUE(typeName(q->slice()[0][0]) == "object"); auto writes = q->slice()[0][0]; EXPECT_TRUE(typeName(writes.get("/arango/Target/ToDo/1")) == "object"); EXPECT_TRUE(typeName(writes.get("/arango/Target/ToDo/1").get("op")) == "string"); EXPECT_TRUE(writes.get("/arango/Target/ToDo/1").get("op").copyString() == "delete"); EXPECT_TRUE(typeName(writes.get("/arango/Target/Finished/1")) == "object"); return fakeWriteResult; }); When(Method(mockAgent, waitFor)).AlwaysReturn(AgentInterface::raft_commit_t::OK); auto& agent = mockAgent.get(); AddFollower(agency("arango"), &agent, JOB_STATUS::TODO, jobId).start(aborts); } TEST_F(AddFollowerTest, collection_has_nonempty_distributeshardslike) { TestStructType createTestStructure = [&](Slice const& s, std::string const& path) { std::unique_ptr builder = std::make_unique(); if (s.isObject()) { VPackObjectBuilder b(builder.get()); for (auto const& it : VPackObjectIterator(s)) { auto childBuilder = createTestStructure(it.value, path + "/" + it.key.copyString()); if (childBuilder) { builder->add(it.key.copyString(), childBuilder->slice()); } } if (path == "/arango/Plan/Collections/" + DATABASE + "/" + COLLECTION) { builder->add("distributeShardsLike", VPackValue("PENG")); } if (path == "/arango/Target/ToDo") { builder->add(jobId, createBuilder(todo).slice()); } } else { builder->add(s); } return builder; }; auto builder = createTestStructure(baseStructure.toBuilder().slice(), ""); ASSERT_TRUE(builder); auto agency = createNodeFromBuilder(*builder); Mock mockAgent; When(Method(mockAgent, write)).AlwaysDo([&](query_t const& q, consensus::AgentInterface::WriteMode w) -> write_ret_t { EXPECT_TRUE(typeName(q->slice()) == "array"); EXPECT_TRUE(q->slice().length() == 1); EXPECT_TRUE(typeName(q->slice()[0]) == "array"); EXPECT_TRUE(q->slice()[0].length() == 1); // we always simply override! no preconditions... EXPECT_TRUE(typeName(q->slice()[0][0]) == "object"); auto writes = q->slice()[0][0]; EXPECT_TRUE(typeName(writes.get("/arango/Target/ToDo/1")) == "object"); EXPECT_TRUE(typeName(writes.get("/arango/Target/ToDo/1").get("op")) == "string"); EXPECT_TRUE(writes.get("/arango/Target/ToDo/1").get("op").copyString() == "delete"); EXPECT_TRUE(typeName(writes.get("/arango/Target/Failed/1")) == "object"); return fakeWriteResult; }); When(Method(mockAgent, waitFor)).AlwaysReturn(AgentInterface::raft_commit_t::OK); auto& agent = mockAgent.get(); AddFollower(agency("arango"), &agent, JOB_STATUS::TODO, jobId).start(aborts); } TEST_F(AddFollowerTest, condition_still_holds) { TestStructType createTestStructure = [&](Slice const& s, std::string const& path) { std::unique_ptr builder = std::make_unique(); if (s.isObject()) { VPackObjectBuilder b(builder.get()); for (auto const& it : VPackObjectIterator(s)) { auto childBuilder = createTestStructure(it.value, path + "/" + it.key.copyString()); if (childBuilder) { builder->add(it.key.copyString(), childBuilder->slice()); } } if (path == "/arango/Target/ToDo") { builder->add(jobId, createBuilder(todo).slice()); } } else { if (path == "/arango/Plan/Collections/" + DATABASE + "/" + COLLECTION + "/shards/" + SHARD) { VPackArrayBuilder a(builder.get()); for (auto const& serv : VPackArrayIterator(s)) { builder->add(serv); } builder->add(VPackValue(SHARD_FOLLOWER2)); } else { builder->add(s); } } return builder; }; auto builder = createTestStructure(baseStructure.toBuilder().slice(), ""); ASSERT_TRUE(builder); Node agency = createNodeFromBuilder(*builder); Mock mockAgent; When(Method(mockAgent, write)).AlwaysDo([&](query_t const& q, consensus::AgentInterface::WriteMode w) -> write_ret_t { EXPECT_TRUE(typeName(q->slice()) == "array"); EXPECT_TRUE(q->slice().length() == 1); EXPECT_TRUE(typeName(q->slice()[0]) == "array"); EXPECT_TRUE(q->slice()[0].length() == 1); // we always simply override! no preconditions... EXPECT_TRUE(typeName(q->slice()[0][0]) == "object"); auto writes = q->slice()[0][0]; EXPECT_TRUE(typeName(writes.get("/arango/Target/ToDo/1")) == "object"); EXPECT_TRUE(typeName(writes.get("/arango/Target/ToDo/1").get("op")) == "string"); EXPECT_TRUE(writes.get("/arango/Target/ToDo/1").get("op").copyString() == "delete"); EXPECT_TRUE(writes.get("/arango/Target/Finished/1").get("collection").copyString() == COLLECTION); EXPECT_TRUE(writes.get("/arango/Target/Pending/1").get("op").copyString() == "delete"); EXPECT_TRUE(typeName(writes.get("/arango/Target/Failed/1")) == "none"); return fakeWriteResult; }); When(Method(mockAgent, waitFor)).AlwaysReturn(AgentInterface::raft_commit_t::OK); AgentInterface& agent = mockAgent.get(); AddFollower(agency("arango"), &agent, JOB_STATUS::TODO, jobId).start(aborts); } TEST_F(AddFollowerTest, if_no_job_under_shard_leave_job_in_todo) { TestStructType createTestStructure = [&](Slice const& s, std::string const& path) { std::unique_ptr builder = std::make_unique(); if (s.isObject()) { VPackObjectBuilder b(builder.get()); for (auto const& it : VPackObjectIterator(s)) { auto childBuilder = createTestStructure(it.value, path + "/" + it.key.copyString()); if (childBuilder) { builder->add(it.key.copyString(), childBuilder->slice()); } } if (path == "/arango/Target/ToDo") { builder->add(jobId, createBuilder(todo).slice()); } if (path == "/arango/Supervision/Shards") { builder->add(SHARD, VPackValue("2")); } } else { builder->add(s); } return builder; }; auto builder = createTestStructure(baseStructure.toBuilder().slice(), ""); ASSERT_TRUE(builder); auto agency = createNodeFromBuilder(*builder); Mock mockAgent; When(Method(mockAgent, write)).AlwaysDo([&](query_t const& q, consensus::AgentInterface::WriteMode w) -> write_ret_t { EXPECT_TRUE(typeName(q->slice()) == "array"); EXPECT_TRUE(q->slice().length() == 1); EXPECT_TRUE(typeName(q->slice()[0]) == "array"); EXPECT_TRUE(q->slice()[0].length() == 1); // we always simply override! no preconditions... EXPECT_TRUE(typeName(q->slice()[0][0]) == "object"); auto writes = q->slice()[0][0]; EXPECT_TRUE(typeName(writes.get("/arango/Target/ToDo/1")) == "object"); EXPECT_TRUE(writes.get("/arango/Target/Finished/1").get("collection").copyString() == COLLECTION); return fakeWriteResult; }); When(Method(mockAgent, waitFor)).AlwaysReturn(AgentInterface::raft_commit_t::OK); auto& agent = mockAgent.get(); AddFollower(agency("arango"), &agent, JOB_STATUS::TODO, jobId).start(aborts); } TEST_F(AddFollowerTest, we_can_find_one_with_status_good) { TestStructType createTestStructure = [&](Slice const& s, std::string const& path) { std::unique_ptr builder = std::make_unique(); if (s.isObject()) { VPackObjectBuilder b(builder.get()); for (auto const& it : VPackObjectIterator(s)) { auto childBuilder = createTestStructure(it.value, path + "/" + it.key.copyString()); if (childBuilder) { builder->add(it.key.copyString(), childBuilder->slice()); } } if (path == "/arango/Target/ToDo") { builder->add(jobId, createBuilder(todo).slice()); } if (path == "/arango/Supervision/Health/follower2") { builder->add("Status", VPackValue("FAILED")); } if (path == "/arango/Supervision/Health/free") { builder->add("Status", VPackValue("FAILED")); } } else { builder->add(s); } return builder; }; auto builder = createTestStructure(baseStructure.toBuilder().slice(), ""); ASSERT_TRUE(builder); Node agency = createNodeFromBuilder(*builder); Mock mockAgent; When(Method(mockAgent, write)).AlwaysDo([&](query_t const& q, consensus::AgentInterface::WriteMode w) -> write_ret_t { EXPECT_TRUE(typeName(q->slice()) == "array"); EXPECT_TRUE(q->slice().length() == 1); EXPECT_TRUE(typeName(q->slice()[0]) == "array"); EXPECT_TRUE(q->slice()[0].length() == 1); // we always simply override! no preconditions... EXPECT_TRUE(typeName(q->slice()[0][0]) == "object"); auto writes = q->slice()[0][0]; EXPECT_TRUE(typeName(writes.get("/arango/Target/ToDo/1")) == "object"); EXPECT_TRUE(writes.get("/arango/Target/Finished/1").get("collection").copyString() == COLLECTION); return fakeWriteResult; }); When(Method(mockAgent, waitFor)).AlwaysReturn(AgentInterface::raft_commit_t::OK); AgentInterface& agent = mockAgent.get(); AddFollower(agency("arango"), &agent, JOB_STATUS::TODO, jobId).start(aborts); } TEST_F(AddFollowerTest, job_performed_immediately_in_a_single_transaction) { TestStructType createTestStructure = [&](Slice const& s, std::string const& path) { std::unique_ptr builder = std::make_unique(); if (s.isObject()) { VPackObjectBuilder b(builder.get()); for (auto const& it : VPackObjectIterator(s)) { auto childBuilder = createTestStructure(it.value, path + "/" + it.key.copyString()); if (childBuilder) { builder->add(it.key.copyString(), childBuilder->slice()); } } if (path == "/arango/Target/ToDo") { builder->add(jobId, createBuilder(todo).slice()); } } else { builder->add(s); } return builder; }; auto builder = createTestStructure(baseStructure.toBuilder().slice(), ""); ASSERT_TRUE(builder); Node agency = createNodeFromBuilder(*builder); Mock mockAgent; When(Method(mockAgent, write)).AlwaysDo([&](query_t const& q, consensus::AgentInterface::WriteMode w) -> write_ret_t { EXPECT_TRUE(typeName(q->slice()) == "array"); EXPECT_TRUE(q->slice().length() == 1); EXPECT_TRUE(typeName(q->slice()[0]) == "array"); EXPECT_TRUE(q->slice()[0].length() == 2); // we always simply override! no preconditions... EXPECT_TRUE(typeName(q->slice()[0][0]) == "object"); auto writes = q->slice()[0][0]; EXPECT_TRUE(typeName(writes.get("/arango/Target/ToDo/1")) == "object"); EXPECT_TRUE(typeName(writes.get("/arango/Target/ToDo/1").get("op")) == "string"); EXPECT_TRUE(writes.get("/arango/Target/ToDo/1").get("op").copyString() == "delete"); EXPECT_TRUE(writes.get("/arango/Target/Finished/1").get("collection").copyString() == COLLECTION); EXPECT_TRUE(typeName(writes.get("/arango/Target/Pending/1")) == "none"); EXPECT_TRUE(typeName(writes.get("/arango/Target/Failed/1")) == "none"); return fakeWriteResult; }); When(Method(mockAgent, waitFor)).AlwaysReturn(AgentInterface::raft_commit_t::OK); AgentInterface& agent = mockAgent.get(); AddFollower(agency("arango"), &agent, JOB_STATUS::TODO, jobId).start(aborts); } TEST_F(AddFollowerTest, job_can_still_be_safely_aborted) { TestStructType createTestStructure = [&](Slice const& s, std::string const& path) { std::unique_ptr builder = std::make_unique(); if (s.isObject()) { VPackObjectBuilder b(builder.get()); for (auto const& it : VPackObjectIterator(s)) { auto childBuilder = createTestStructure(it.value, path + "/" + it.key.copyString()); if (childBuilder) { builder->add(it.key.copyString(), childBuilder->slice()); } } if (path == "/arango/Target/ToDo") { builder->add(jobId, createBuilder(todo).slice()); } } else { builder->add(s); } return builder; }; auto builder = createTestStructure(baseStructure.toBuilder().slice(), ""); ASSERT_TRUE(builder); Node agency = createNodeFromBuilder(*builder); Mock mockAgent; When(Method(mockAgent, write)).AlwaysDo([&](query_t const& q, consensus::AgentInterface::WriteMode w) -> write_ret_t { EXPECT_TRUE(typeName(q->slice()) == "array"); EXPECT_TRUE(q->slice().length() == 1); EXPECT_TRUE(typeName(q->slice()[0]) == "array"); EXPECT_TRUE(q->slice()[0].length() == 1); // we always simply override! no preconditions... EXPECT_TRUE(typeName(q->slice()[0][0]) == "object"); auto writes = q->slice()[0][0]; EXPECT_TRUE(typeName(writes.get("/arango/Target/Failed/1")) == "object"); EXPECT_TRUE(writes.get("/arango/Target/Failed/1").get("collection").copyString() == COLLECTION); EXPECT_TRUE(typeName(writes.get("/arango/Target/ToDo/1").get("op")) == "string"); EXPECT_TRUE(writes.get("/arango/Target/ToDo/1").get("op").copyString() == "delete"); EXPECT_TRUE(typeName(writes.get("/arango/Target/Pending/1").get("op")) == "string"); EXPECT_TRUE(writes.get("/arango/Target/Pending/1").get("op").copyString() == "delete"); return fakeWriteResult; }); When(Method(mockAgent, waitFor)).AlwaysReturn(AgentInterface::raft_commit_t::OK); AgentInterface& agent = mockAgent.get(); AddFollower(agency("arango"), &agent, JOB_STATUS::PENDING, jobId).abort("test abort"); } TEST_F(AddFollowerTest, job_cannot_be_aborted) { TestStructType createTestStructure = [&](Slice const& s, std::string const& path) { std::unique_ptr builder = std::make_unique(); if (s.isObject()) { VPackObjectBuilder b(builder.get()); for (auto const& it : VPackObjectIterator(s)) { auto childBuilder = createTestStructure(it.value, path + "/" + it.key.copyString()); if (childBuilder) { builder->add(it.key.copyString(), childBuilder->slice()); } } if (path == "/arango/Target/Pending") { builder->add(jobId, createBuilder(todo).slice()); } } else { builder->add(s); } return builder; }; auto builder = createTestStructure(baseStructure.toBuilder().slice(), ""); ASSERT_TRUE(builder); Node agency = createNodeFromBuilder(*builder); Mock mockAgent; When(Method(mockAgent, write)).AlwaysDo([&](query_t const& q, consensus::AgentInterface::WriteMode w) -> write_ret_t { EXPECT_TRUE(typeName(q->slice()) == "array"); EXPECT_TRUE(q->slice().length() == 1); EXPECT_TRUE(typeName(q->slice()[0]) == "array"); EXPECT_TRUE(q->slice()[0].length() == 1); // we always simply override! no preconditions... EXPECT_TRUE(typeName(q->slice()[0][0]) == "object"); auto writes = q->slice()[0][0]; EXPECT_TRUE(typeName(writes.get("/arango/Target/Failed/1")) == "object"); EXPECT_TRUE(writes.get("/arango/Target/Failed/1").get("collection").copyString() == COLLECTION); EXPECT_TRUE(typeName(writes.get("/arango/Target/ToDo/1").get("op")) == "string"); EXPECT_TRUE(writes.get("/arango/Target/ToDo/1").get("op").copyString() == "delete"); EXPECT_TRUE(typeName(writes.get("/arango/Target/Pending/1").get("op")) == "string"); EXPECT_TRUE(writes.get("/arango/Target/Pending/1").get("op").copyString() == "delete"); return fakeWriteResult; }); When(Method(mockAgent, waitFor)).AlwaysReturn(AgentInterface::raft_commit_t::OK); AgentInterface& agent = mockAgent.get(); AddFollower(agency("arango"), &agent, JOB_STATUS::TODO, jobId).abort("test abort"); } } // namespace add_follower_test } // namespace tests } // namespace arangodb