incorporate comments on tests

Author: arthurpassos

src/Storages/Cache/ObjectStorageListObjectsCache.h

@@ -10,6 +10,7 @@ namespace DB
 
 class ObjectStorageListObjectsCache
 {
+    friend class ObjectStorageListObjectsCacheTest;
 public:
     ObjectStorageListObjectsCache(const ObjectStorageListObjectsCache &) = delete;
     ObjectStorageListObjectsCache(ObjectStorageListObjectsCache &&) noexcept = delete;

src/Storages/Cache/tests/gtest_object_storage_list_objects_cache.cpp

@@ -6,70 +6,73 @@
 namespace DB
 {
 
-auto & initializeAndGetCacheInstance()
+class ObjectStorageListObjectsCacheTest : public ::testing::Test
 {
-    static auto & cache = ObjectStorageListObjectsCache::instance();
-    cache.setTTL(3);
-    cache.setMaxCount(100);
-    cache.setMaxSizeInBytes(1000000);
-    return cache;
-}
-
-static auto & cache = initializeAndGetCacheInstance();
+protected:
+    void SetUp() override
+    {
+        cache = std::unique_ptr<ObjectStorageListObjectsCache>(new ObjectStorageListObjectsCache());
+        cache->setTTL(3);
+        cache->setMaxCount(100);
+        cache->setMaxSizeInBytes(1000000);
+    }
 
-ObjectStorageListObjectsCache::Key default_key {"default", "test-bucket", "test-prefix/"};
+    std::unique_ptr<ObjectStorageListObjectsCache> cache;
+    static ObjectStorageListObjectsCache::Key default_key;
 
-std::shared_ptr<ObjectStorageListObjectsCache::Value> createTestValue(const std::vector<std::string>& paths)
-{
-    auto value = std::make_shared<ObjectStorageListObjectsCache::Value>();
-    for (const auto & path : paths)
+    static std::shared_ptr<ObjectStorageListObjectsCache::Value> createTestValue(const std::vector<std::string>& paths)
     {
-        value->push_back(std::make_shared<ObjectInfo>(path));
+        auto value = std::make_shared<ObjectStorageListObjectsCache::Value>();
+        for (const auto & path : paths)
+        {
+            value->push_back(std::make_shared<ObjectInfo>(path));
+        }
+        return value;
     }
-    return value;
-}
+};
 
+ObjectStorageListObjectsCache::Key ObjectStorageListObjectsCacheTest::default_key {"default", "test-bucket", "test-prefix/"};
 
-TEST(ObjectStorageListObjectsCacheTest, BasicSetAndGet)
+TEST_F(ObjectStorageListObjectsCacheTest, BasicSetAndGet)
 {
-    cache.clear();
+    cache->clear();
     const std::string bucket = "test-bucket";
     const std::string prefix = "test-prefix/";
     auto value = createTestValue({"test-prefix/file1.txt", "test-prefix/file2.txt"});
 
-    cache.set(default_key, value);
+    cache->set(default_key, value);
 
-    auto result = cache.get(default_key).value();
+    auto result = cache->get(default_key).value();
     ASSERT_EQ(result.size(), 2);
     EXPECT_EQ(result[0]->getPath(), "test-prefix/file1.txt");
     EXPECT_EQ(result[1]->getPath(), "test-prefix/file2.txt");
 }
 
-TEST(ObjectStorageListObjectsCacheTest, CacheMiss)
+TEST_F(ObjectStorageListObjectsCacheTest, CacheMiss)
 {
-    cache.clear();
+    cache->clear();
     const std::string bucket = "test-bucket";
     const std::string prefix = "test-prefix/";
 
-    EXPECT_FALSE(cache.get(default_key));
+    EXPECT_FALSE(cache->get(default_key));
 }
 
-TEST(ObjectStorageListObjectsCacheTest, ClearCache)
+TEST_F(ObjectStorageListObjectsCacheTest, ClearCache)
 {
-    cache.clear();
+    cache->clear();
     const std::string bucket = "test-bucket";
     const std::string prefix = "test-prefix/";
     auto value = createTestValue({"test-prefix/file1.txt", "test-prefix/file2.txt"});
 
-    cache.set(default_key, value);
-    cache.clear();
+    cache->set(default_key, value);
+    cache->clear();
 
-    EXPECT_FALSE(cache.get(default_key));
+    EXPECT_FALSE(cache->get(default_key));
 }
 
-TEST(ObjectStorageListObjectsCacheTest, PrefixMatching)
+TEST_F(ObjectStorageListObjectsCacheTest, PrefixMatching)
 {
-    cache.clear();
+    cache->clear();
 
     auto short_prefix_key = default_key;
     short_prefix_key.prefix = "parent/";
@@ -85,20 +88,20 @@ TEST(ObjectStorageListObjectsCacheTest, PrefixMatching)
         "parent/child/grandchild/file1.txt",
         "parent/child/grandchild/file2.txt"});
 
-    cache.set(mid_prefix_key, value);
+    cache->set(mid_prefix_key, value);
 
-    auto result1 = cache.get(mid_prefix_key).value();
+    auto result1 = cache->get(mid_prefix_key).value();
     EXPECT_EQ(result1.size(), 2);
 
-    auto result2 = cache.get(long_prefix_key).value();
+    auto result2 = cache->get(long_prefix_key).value();
     EXPECT_EQ(result2.size(), 2);
 
-    EXPECT_FALSE(cache.get(short_prefix_key));
+    EXPECT_FALSE(cache->get(short_prefix_key));
 }
 
-TEST(ObjectStorageListObjectsCacheTest, PrefixFiltering)
+TEST_F(ObjectStorageListObjectsCacheTest, PrefixFiltering)
 {
-    cache.clear();
+    cache->clear();
 
     auto key_with_short_prefix = default_key;
     key_with_short_prefix.prefix = "parent/";
@@ -112,34 +115,34 @@ TEST(ObjectStorageListObjectsCacheTest, PrefixFiltering)
         "parent/child2/file3.txt"
     });
 
-    cache.set(key_with_short_prefix, value);
+    cache->set(key_with_short_prefix, value);
 
-    auto result = cache.get(key_with_mid_prefix, true).value();
+    auto result = cache->get(key_with_mid_prefix, true).value();
     EXPECT_EQ(result.size(), 1);
     EXPECT_EQ(result[0]->getPath(), "parent/child1/file2.txt");
 }
 
-TEST(ObjectStorageListObjectsCacheTest, TTLExpiration)
+TEST_F(ObjectStorageListObjectsCacheTest, TTLExpiration)
 {
-    cache.clear();
+    cache->clear();
     const std::string bucket = "test-bucket";
     const std::string prefix = "test-prefix/";
     auto value = createTestValue({"test-prefix/file1.txt"});
 
-    cache.set(default_key, value);
+    cache->set(default_key, value);
 
     // Verify we can get it immediately
-    auto result1 = cache.get(default_key).value();
+    auto result1 = cache->get(default_key).value();
     EXPECT_EQ(result1.size(), 1);
 
     std::this_thread::sleep_for(std::chrono::seconds(4));
 
-    EXPECT_FALSE(cache.get(default_key));
+    EXPECT_FALSE(cache->get(default_key));
 }
 
-TEST(ObjectStorageListObjectsCacheTest, BestPrefixMatch)
+TEST_F(ObjectStorageListObjectsCacheTest, BestPrefixMatch)
 {
-    cache.clear();
+    cache->clear();
 
     auto short_prefix_key = default_key;
     short_prefix_key.prefix = "a/b/";
@@ -153,11 +156,11 @@ TEST(ObjectStorageListObjectsCacheTest, BestPrefixMatch)
     auto short_prefix = createTestValue({"a/b/c/d/file1.txt", "a/b/c/file1.txt", "a/b/file2.txt"});
     auto mid_prefix = createTestValue({"a/b/c/d/file1.txt", "a/b/c/file1.txt"});
 
-    cache.set(short_prefix_key, short_prefix);
-    cache.set(mid_prefix_key, mid_prefix);
+    cache->set(short_prefix_key, short_prefix);
+    cache->set(mid_prefix_key, mid_prefix);
 
     // should pick mid_prefix, which has size 2. filter_by_prefix=false so we can assert by size
-    auto result = cache.get(long_prefix_key, false).value();
+    auto result = cache->get(long_prefix_key, false).value();
     EXPECT_EQ(result.size(), 2u);
 }