arangodb/tests/IResearch/Containers-test.cpp

//////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2017 EMC Corporation
///
/// 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 EMC Corporation
///
/// @author Andrey Abramov
/// @author Vasiliy Nabatchikov
////////////////////////////////////////////////////////////////////////////////

#include <set>
#include <tuple>
#include "gtest/gtest.h"
#include "utils/thread_utils.hpp"

#include "IResearch/Containers.h"

TEST(ContainersTest, testResourceMutex) {
  struct Value : public arangodb::iresearch::ResourceMutex {
   public:
    Value(int* value) : ResourceMutex(value) {}
    int* get() const {
      return static_cast<int*>(arangodb::iresearch::ResourceMutex::get());
    }
  };

  // test value
  {
    int i = 5;
    Value value(&i);
    EXPECT_EQ(&i, value.get());
    value.reset();
    EXPECT_EQ(nullptr, value.get());
  }

  // test read lock
  {
    int i = 5;
    Value value(&i);
    std::condition_variable cond;
    std::mutex cond_mutex;
    SCOPED_LOCK_NAMED(cond_mutex, cond_lock);
    auto mutex = value.mutex();
    SCOPED_LOCK(mutex);  // read lock

    std::thread thread([&value, &cond, &cond_mutex]() -> void {
      SCOPED_LOCK(cond_mutex);
      auto mutex = value.mutex();
      SCOPED_LOCK(mutex);
      cond.notify_all();
    });
    auto result = cond.wait_for(cond_lock, std::chrono::milliseconds(1000));  // assume thread finishes in 1000ms

    thread.join();
    EXPECT_EQ(std::cv_status::no_timeout, result);  // check only after joining with thread to avoid early exit
  }

  // test write lock
  {
    int i = 5;
    Value value(&i);
    std::condition_variable cond;
    std::mutex cond_mutex;
    SCOPED_LOCK_NAMED(value.mutex(), lock);
    SCOPED_LOCK_NAMED(cond_mutex, cond_lock);
    std::atomic<bool> reset(false);
    std::thread thread([&cond, &cond_mutex, &value, &reset]() -> void {
      value.reset();
      reset = true;
      SCOPED_LOCK(cond_mutex);
      cond.notify_all();
    });

    auto result0 = cond.wait_for(cond_lock, std::chrono::milliseconds(50));

    // MSVC 2015/2017 seems to sporadically notify condition variables without explicit request
    MSVC2015_ONLY(while (!reset && result0 == std::cv_status::no_timeout) result0 =
                      cond.wait_for(cond_lock, std::chrono::milliseconds(50)));
    MSVC2017_ONLY(while (!reset && result0 == std::cv_status::no_timeout) result0 =
                      cond.wait_for(cond_lock, std::chrono::milliseconds(50)));

    lock.unlock();
    auto result1 = cond.wait_for(cond_lock, std::chrono::milliseconds(50));
    cond_lock.unlock();
    thread.join();
    EXPECT_EQ(std::cv_status::timeout, result0);  // check only after joining with thread to avoid early exit
    EXPECT_NE(std::cv_status::timeout, result1);  // check only after joining with thread to avoid early exit
  }
}

TEST(ContainersTest, test_Hasher) {
  // ensure hashing of irs::bytes_ref is possible
  {
    typedef arangodb::iresearch::UnorderedRefKeyMapBase<irs::byte_type, int>::KeyHasher Hasher;
    Hasher hasher;
    irs::string_ref strRef("abcdefg");
    irs::bytes_ref ref = irs::ref_cast<irs::byte_type>(strRef);
    EXPECT_FALSE((0 == hasher(ref)));
  }

  // ensure hashing of irs::string_ref is possible
  {
    typedef arangodb::iresearch::UnorderedRefKeyMapBase<char, int>::KeyHasher Hasher;
    Hasher hasher;
    irs::string_ref ref("abcdefg");
    EXPECT_FALSE((0 == hasher(ref)));
  }
}

TEST(ContainersTest, test_UniqueHeapInstance) {
  {
    struct TestStruct {};

    // ensure copy works (different instance)
    {
      arangodb::iresearch::UniqueHeapInstance<TestStruct> instance;
      auto* ptr = instance.get();

      arangodb::iresearch::UniqueHeapInstance<TestStruct> instance1;
      auto* ptr1 = instance1.get();
      EXPECT_FALSE((ptr == instance1.get()));
      instance1 = instance;
      EXPECT_FALSE((ptr1 == instance1.get()));
      EXPECT_FALSE((ptr == instance1.get()));

      arangodb::iresearch::UniqueHeapInstance<TestStruct> instance2(instance);
      EXPECT_FALSE((ptr == instance2.get()));
    }

    // ensure element copy works (different instance)
    {
      arangodb::iresearch::UniqueHeapInstance<TestStruct> instance;
      auto* ptr = instance.get();

      arangodb::iresearch::UniqueHeapInstance<TestStruct> instance1;
      auto* ptr1 = instance1.get();
      EXPECT_FALSE((ptr == instance1.get()));
      instance1 = *instance;
      EXPECT_TRUE((ptr1 == instance1.get()));
      EXPECT_FALSE((ptr == instance1.get()));

      arangodb::iresearch::UniqueHeapInstance<TestStruct> instance2(*instance);
      EXPECT_FALSE((ptr == instance2.get()));
    }
  }

  {
    static size_t counter = 0;
    struct TestStruct {
      size_t id;
      TestStruct() : id(++counter) {}
      TestStruct(TestStruct&& other) : id(other.id){};
      TestStruct(TestStruct const&) = delete;
      TestStruct& operator=(TestStruct const&) = delete;
      TestStruct& operator=(TestStruct&& other) {
        id = other.id;
        return *this;
      }
    };

    // ensure move works (same instance)
    {
      arangodb::iresearch::UniqueHeapInstance<TestStruct> instance;
      auto* ptr = instance.get();

      arangodb::iresearch::UniqueHeapInstance<TestStruct> instance1;
      EXPECT_FALSE((ptr == instance1.get()));
      instance1 = std::move(instance);
      EXPECT_TRUE((ptr == instance1.get()));

      arangodb::iresearch::UniqueHeapInstance<TestStruct> instance2(std::move(instance1));
      EXPECT_TRUE((ptr == instance2.get()));
    }

    // ensure value move works (same instance)
    {
      arangodb::iresearch::UniqueHeapInstance<TestStruct> instance;
      auto* ptr = instance.get();
      auto id = ptr->id;

      arangodb::iresearch::UniqueHeapInstance<TestStruct> instance1;
      EXPECT_FALSE((ptr == instance1.get()));
      EXPECT_FALSE((id == instance1->id));
      instance1 = std::move(*instance);
      EXPECT_TRUE((id == instance1->id));

      arangodb::iresearch::UniqueHeapInstance<TestStruct> instance2(std::move(*instance1));
      EXPECT_TRUE((id == instance2->id));
    }
  }
}

TEST(ContainersTest, test_UnorderedRefKeyMap) {
  static size_t counter = 0;
  struct TestStruct {
    size_t id;
    int value;
    TestStruct() : id(++counter), value(-1) {}
    TestStruct(int v) : id(++counter), value(v) {}
  };

  arangodb::iresearch::UnorderedRefKeyMap<char, TestStruct> map;
  EXPECT_TRUE((0 == counter));
  EXPECT_TRUE((map.empty()));
  EXPECT_TRUE((0 == map.size()));

  // new element via operator
  {
    auto& value = map["abc"];
    EXPECT_TRUE((1 == counter));
    EXPECT_FALSE((map.empty()));
    EXPECT_TRUE((1 == map.size()));
    EXPECT_TRUE((1 == value.id));
    EXPECT_TRUE((-1 == value.value));
  }

  // new element via emplace no args
  {
    auto itr = map.emplace("def");
    EXPECT_TRUE((2 == counter));
    EXPECT_FALSE((map.empty()));
    EXPECT_TRUE((2 == map.size()));
    EXPECT_TRUE((itr.second));
    EXPECT_TRUE((irs::string_ref("def") == itr.first.key()));
    EXPECT_TRUE((2 == itr.first.value().id));
    EXPECT_TRUE((-1 == itr.first.value().value));
  }

  // new element via emplace with args
  {
    auto itr = map.emplace("ghi", 42);
    EXPECT_TRUE((3 == counter));
    EXPECT_FALSE((map.empty()));
    EXPECT_TRUE((3 == map.size()));
    EXPECT_TRUE((itr.second));
    EXPECT_TRUE((irs::string_ref("ghi") == itr.first.key()));
    EXPECT_TRUE((3 == itr.first.value().id));
    EXPECT_TRUE((42 == itr.first.value().value));
  }

  // duplicate element via operator
  {
    auto& value = map["ghi"];
    EXPECT_TRUE((3 == counter));
    EXPECT_FALSE((map.empty()));
    EXPECT_TRUE((3 == map.size()));
    EXPECT_TRUE((3 == value.id));
    EXPECT_TRUE((42 == value.value));
  }

  // duplicate element via emplace no args
  {
    auto itr = map.emplace("ghi");
    EXPECT_TRUE((3 == counter));
    EXPECT_FALSE((map.empty()));
    EXPECT_TRUE((3 == map.size()));
    EXPECT_FALSE((itr.second));
    EXPECT_TRUE((irs::string_ref("ghi") == itr.first.key()));
    EXPECT_TRUE((3 == itr.first.value().id));
    EXPECT_TRUE((42 == itr.first.value().value));
  }

  // duplicate element via emplace with args
  {
    auto itr = map.emplace("def", 1234);
    EXPECT_TRUE((3 == counter));
    EXPECT_FALSE((map.empty()));
    EXPECT_TRUE((3 == map.size()));
    EXPECT_FALSE((itr.second));
    EXPECT_TRUE((irs::string_ref("def") == itr.first.key()));
    EXPECT_TRUE((2 == itr.first.value().id));
    EXPECT_TRUE((-1 == itr.first.value().value));
  }

  // search via iterator
  {
    auto itr = map.find("ghi");
    EXPECT_FALSE((map.end() == itr));
    EXPECT_TRUE((irs::string_ref("ghi") == itr.key()));
    EXPECT_TRUE((3 == itr.value().id));
    EXPECT_TRUE((42 == itr.value().value));

    itr = map.find("xyz");
    EXPECT_TRUE((map.end() == itr));
  }

  // search via pointer
  {
    auto ptr = map.findPtr("ghi");
    EXPECT_FALSE((nullptr == ptr));
    EXPECT_TRUE((3 == ptr->id));
    EXPECT_TRUE((42 == ptr->value));

    ptr = map.findPtr("xyz");
    EXPECT_TRUE((nullptr == ptr));
  }

  // validate iteration
  {
    std::set<std::string> expected({"abc", "def", "ghi"});

    for (auto& entry : map) {
      EXPECT_TRUE((1 == expected.erase(entry.key())));
    }

    EXPECT_TRUE((expected.empty()));
  }

  map.clear();
  EXPECT_TRUE((0 == map.size()));
  EXPECT_TRUE((map.begin() == map.end()));
}