Add method to list keys (#1638)

Adds interface for the method to list keys available in the cache.

Relates-To: HERESDK-8383

Signed-off-by: Mykhailo Diachenko <[email protected]>

Author: diachenko-mischa

olp-cpp-sdk-core/include/olp/core/cache/KeyValueCache.h

@@ -244,6 +244,20 @@ class CORE_API KeyValueCache {
     OLP_SDK_CORE_UNUSED(prefix);
     return client::ApiError(client::ErrorCode::Unknown, "Not implemented");
   }
+
+  /**
+   * @brief Lists the keys that match the given prefix.
+   *
+   * @param prefix The prefix that matches the keys.
+   *
+   * @return The collection of matched keys or an error. Empty collection if not
+   * keys match the prefix.
+   */
+  virtual OperationOutcome<KeyListType> ListKeysWithPrefix(
+      const std::string& prefix) {
+    OLP_SDK_CORE_UNUSED(prefix);
+    return client::ApiError(client::ErrorCode::Unknown, "Not implemented");
+  }
 };
 
 }  // namespace cache

olp-cpp-sdk-core/tests/cache/DefaultCacheTest.cpp

@@ -749,6 +749,16 @@ TEST(DefaultCacheTest, OpenTypeCache) {
   }
 }
 
+TEST(DefaultCacheTest, ListKeysWithPrefixNotImplemented) {
+  olp::cache::DefaultCache cache;
+
+  const auto result = cache.ListKeysWithPrefix("prefix");
+
+  EXPECT_FALSE(result.IsSuccessful());
+  EXPECT_EQ(olp::client::ErrorCode::Unknown, result.GetError().GetErrorCode());
+  EXPECT_EQ("Not implemented", result.GetError().GetMessage());
+}
+
 struct TestParameters {
   OptionalString disk_path_mutable = kTempDirMutable;
   OptionalString disk_path_protected = olp::porting::none;