Add a new option OLP_SDK_ENABLE_DEFAULT_CACHE (#1181)

The new options is enabled by default. In case it is disabled
explicitly by the user, it's users responsibility to provide cache
implementation that implements the olp::cache::KayValueCache interface.

Relates-To: OLPEDGE-2373

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

Author: mykhailo-kuchma

.github/workflows/ci.yml

@@ -34,3 +34,16 @@ jobs:
       run: ./scripts/linux/psv/test_psv.sh
       shell: bash
 
+  linux-gcc-psv-build-no-cache:
+    name: Linux Build using gcc & tests & code coverage
+    runs-on: ubuntu-18.04
+    steps:
+
+    - name: Check out repository
+      uses: actions/checkout@v2
+    - name: Install Ubuntu dependencies
+      run: sudo apt-get install -y libboost-all-dev ccache libssl-dev libcurl4-openssl-dev --no-install-recommends
+      shell: bash
+    - name: Compile project without cache
+      run: ./scripts/linux/psv/build_psv_no_cache.sh
+      shell: bash

CMakeLists.txt

@@ -42,6 +42,7 @@ option(OLP_SDK_BUILD_EXTERNAL_DEPS "Download and build external dependencies" ON
 option(OLP_SDK_BUILD_EXAMPLES "Enable examples targets" OFF)
 option(OLP_SDK_MSVC_PARALLEL_BUILD_ENABLE "Enable parallel build on MSVC" ON)
 option(OLP_SDK_DISABLE_DEBUG_LOGGING "Disable debug and trace level logging" OFF)
+option(OLP_SDK_ENABLE_DEFAULT_CACHE "Enable default cache implementation" ON)
 
 # C++ standard version. Minimum supported version is 11.
 set(CMAKE_CXX_STANDARD 11)

README.md

@@ -185,6 +185,7 @@ cmake --build . --target docs
 | `OLP_SDK_BOOST_THROW_EXCEPTION_EXTERNAL` | Defaults to `OFF`. When `OLP_SDK_NO_EXCEPTION` is `ON`, `boost` requires `boost::throw_exception()` to be defined. If enabled, the external definition of `boost::throw_exception()` is used. Otherwise, the library uses own definition. |
 | `OLP_SDK_MSVC_PARALLEL_BUILD_ENABLE` (Windows Only) | Defaults to `ON`. If enabled, the `/MP` compilation flag is added to build the Data SDK using multiple cores. |
 | `OLP_SDK_DISABLE_DEBUG_LOGGING`| Defaults to `OFF`. If enabled, The debug and trace level log messages will not be printed. |
+| `OLP_SDK_ENABLE_DEFAULT_CACHE `| Defaults to `ON`. If enabled, The default cache implementation based on leveldb backend is enabled. |
 
 ## Use the SDK
 

external/CMakeLists.txt

@@ -65,12 +65,14 @@ if(NOT TARGET RapidJSON AND NOT RapidJSON_FOUND)
     add_subdirectory(rapidjson)
 endif()
 
-find_package(leveldb QUIET)
-if(NOT TARGET leveldb AND NOT leveldb_FOUND)
-    add_subdirectory(leveldb)
-    set(leveldb_DIR ${EXTERNAL_leveldb_DIR} PARENT_SCOPE)
-    set(leveldb_INCLUDE_DIR ${EXTERNAL_leveldb_INCLUDE_DIR} PARENT_SCOPE)
-    set(Snappy_DIR ${EXTERNAL_Snappy_DIR} PARENT_SCOPE)
+if(OLP_SDK_ENABLE_DEFAULT_CACHE)
+    find_package(leveldb QUIET)
+    if(NOT TARGET leveldb AND NOT leveldb_FOUND)
+        add_subdirectory(leveldb)
+        set(leveldb_DIR ${EXTERNAL_leveldb_DIR} PARENT_SCOPE)
+        set(leveldb_INCLUDE_DIR ${EXTERNAL_leveldb_INCLUDE_DIR} PARENT_SCOPE)
+        set(Snappy_DIR ${EXTERNAL_Snappy_DIR} PARENT_SCOPE)
+    endif()
 endif()
 
 find_package(Boost QUIET)

olp-cpp-sdk-core/CMakeLists.txt

@@ -21,10 +21,15 @@ set(DESCRIPTION "Core network and utility library for the HERE OLP SDK C++")
 
 find_package(RapidJSON 1.1.0 REQUIRED CMAKE_FIND_ROOT_PATH_BOTH)
 find_package(Boost REQUIRED)
-find_package(leveldb REQUIRED)
-find_package(Snappy REQUIRED)
 find_package(Threads REQUIRED)
 
+if(OLP_SDK_ENABLE_DEFAULT_CACHE)
+    find_package(Snappy REQUIRED)
+    find_package(leveldb REQUIRED)
+endif()
+
+configure_file(./include/olp/core/Config.h.in ${CMAKE_CURRENT_BINARY_DIR}/include/olp/core/Config.h)
+
 include(configs/ConfigNetwork.cmake)
 include(cmake/CompileChecks.cmake)
 
@@ -180,6 +185,10 @@ set(OLP_SDK_GEOTYPE_HEADER
     ./include/olp/core/geo/Types.h
 )
 
+set(OLP_SDK_CONFIG_HEADER
+    ${CMAKE_CURRENT_BINARY_DIR}/include/olp/core/Config.h
+)
+
 set(OLP_SDK_MATH_HEADERS
     ./include/olp/core/math/AlignedBox.h
     ./include/olp/core/math/Math.h
@@ -343,10 +352,10 @@ set(OLP_SDK_CORE_HEADERS
     ${OLP_SDK_GEOTILING_HEADERS}
     ${OLP_SDK_COREAPI_HEADERS}
     ${OLP_SDK_GEOTYPE_HEADER}
+    ${OLP_SDK_CONFIG_HEADER}
 )
 
 set(OLP_SDK_CORE_SOURCES
-    ${OLP_SDK_CACHE_SOURCES}
     ${OLP_SDK_CLIENT_SOURCES}
     ${OLP_SDK_HTTP_SOURCES}
     ${OLP_SDK_PLATFORM_SOURCES}
@@ -356,12 +365,12 @@ set(OLP_SDK_CORE_SOURCES
     ${OLP_SDK_GEO_SOURCES}
 )
 
-include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include)
-include_directories(${CMAKE_CURRENT_BINARY_DIR}/include)
+if(OLP_SDK_ENABLE_DEFAULT_CACHE)
+    set(OLP_SDK_CORE_SOURCES ${OLP_SDK_CORE_SOURCES} ${OLP_SDK_CACHE_SOURCES})
+endif()
 
 add_library(${PROJECT_NAME} ${OLP_SDK_CORE_SOURCES} ${OLP_SDK_CORE_HEADERS})
 
-
 if (OLP_SDK_DISABLE_DEBUG_LOGGING)
     target_compile_definitions(${PROJECT_NAME}
         PUBLIC LOGGING_DISABLE_DEBUG_LEVEL)
@@ -385,7 +394,6 @@ target_include_directories(${PROJECT_NAME} PUBLIC
     $<BUILD_INTERFACE:${RapidJSON_INCLUDE_DIRS}>
     $<BUILD_INTERFACE:${RAPIDJSON_INCLUDE_DIRS}>
 
-    $<BUILD_INTERFACE:${leveldb_INCLUDE_DIR}>
     $<INSTALL_INTERFACE:include>)
 
 if (ANDROID)
@@ -404,10 +412,19 @@ target_link_libraries(${PROJECT_NAME}
         ${OLP_SDK_NETWORK_CURL_LIBRARIES}
         ${NETWORK_WINHTTP_LIBRARIES}
         ${CMAKE_THREAD_LIBS_INIT}
-    PRIVATE
-        leveldb::leveldb
 )
 
+if(OLP_SDK_ENABLE_DEFAULT_CACHE)
+    target_include_directories(${PROJECT_NAME}
+        PUBLIC
+            $<BUILD_INTERFACE:${leveldb_INCLUDE_DIR}>
+    )
+    target_link_libraries(${PROJECT_NAME}
+        PRIVATE
+            leveldb::leveldb
+    )
+endif()
+
 if(IOS)
     if (CMAKE_GENERATOR MATCHES "Xcode")
         set_target_properties (
@@ -475,8 +492,9 @@ install (FILES ${OLP_SDK_GEOCOORDINATES_HEADERS} DESTINATION ${INCLUDE_DIRECTORY
 install (FILES ${OLP_SDP_GEOPROJECTION_HEADERS} DESTINATION ${INCLUDE_DIRECTORY}/olp/core/geo/projection)
 install (FILES ${OLP_SDK_GEOTILING_HEADERS} DESTINATION ${INCLUDE_DIRECTORY}/olp/core/geo/tiling)
 install (FILES ${OLP_SDK_LOGGING_HEADERS} DESTINATION ${INCLUDE_DIRECTORY}/olp/core/logging)
-install (FILES ${OLP_SDK_COREAPI_HEADERS} DESTINATION ${INCLUDE_DIRECTORY}/olp/core/)
+install (FILES ${OLP_SDK_COREAPI_HEADERS} DESTINATION ${INCLUDE_DIRECTORY}/olp/core)
 install (FILES ${OLP_SDK_GEOTYPE_HEADER} DESTINATION ${INCLUDE_DIRECTORY}/olp/core/geo)
+install (FILES ${OLP_SDK_CONFIG_HEADER} DESTINATION ${INCLUDE_DIRECTORY}/olp/core)
 
 export_config()
 

olp-cpp-sdk-core/include/olp/core/Config.h.in

@@ -0,0 +1,20 @@
+/*
+ * Copyright (C) 2021 HERE Europe B.V.
+ *
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * License-Filename: LICENSE
+ */
+
+#cmakedefine OLP_SDK_ENABLE_DEFAULT_CACHE

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

@@ -21,13 +21,18 @@
 
 #include <string>
 
+#include <olp/core/Config.h>
+
 #include <olp/core/CoreApi.h>
+
 #include <olp/core/porting/deprecated.h>
 #include <boost/optional.hpp>
 
 namespace olp {
 namespace cache {
 
+#ifdef OLP_SDK_ENABLE_DEFAULT_CACHE
+
 /**
  * @brief Options for opening a disk cache.
  */
@@ -152,5 +157,14 @@ struct CORE_API CacheSettings {
   boost::optional<std::string> disk_path_protected = boost::none;
 };
 
+#else
+
+/**
+ * @brief Dummy settings for default cache factory.
+ */
+struct CORE_API CacheSettings {};
+
+#endif  // OLP_SDK_ENABLE_DEFAULT_CACHE
+
 }  // namespace cache
 }  // namespace olp

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

@@ -23,9 +23,12 @@
 #include <mutex>
 #include <string>
 
+#include <olp/core/Config.h>
 #include "CacheSettings.h"
 #include "KeyValueCache.h"
 
+#ifdef OLP_SDK_ENABLE_DEFAULT_CACHE
+
 namespace olp {
 namespace cache {
 
@@ -273,3 +276,5 @@ class CORE_API DefaultCache : public KeyValueCache {
 
 }  // namespace cache
 }  // namespace olp
+
+#endif // OLP_SDK_ENABLE_DEFAULT_CACHE

olp-cpp-sdk-core/src/client/OlpClientSettingsFactory.cpp

@@ -19,6 +19,7 @@
 
 #include "olp/core/client/OlpClientSettingsFactory.h"
 
+#include "olp/core/Config.h"
 #include "olp/core/cache/CacheSettings.h"
 #include "olp/core/cache/DefaultCache.h"
 #include "olp/core/client/OlpClientSettings.h"
@@ -47,6 +48,7 @@ OlpClientSettingsFactory::CreateDefaultNetworkRequestHandler(
 
 std::unique_ptr<cache::KeyValueCache>
 OlpClientSettingsFactory::CreateDefaultCache(cache::CacheSettings settings) {
+#ifdef OLP_SDK_ENABLE_DEFAULT_CACHE
   auto cache = std::make_unique<cache::DefaultCache>(std::move(settings));
   auto error = cache->Open();
   if (error == cache::DefaultCache::StorageOpenResult::OpenDiskPathFailure) {
@@ -59,6 +61,11 @@ OlpClientSettingsFactory::CreateDefaultCache(cache::CacheSettings settings) {
     return nullptr;
   }
   return cache;
+#else
+  OLP_SDK_CORE_UNUSED(settings);
+  OLP_SDK_LOG_FATAL(kLogTag, "Default cache implementation is disabled.");
+  return nullptr;
+#endif // OLP_SDK_ENABLE_DEFAULT_CACHE
 }
 
 void OlpClientSettingsFactory::PrewarmConnection(

scripts/linux/psv/build_psv_no_cache.sh

@@ -0,0 +1,29 @@
+#!/bin/bash -ex
+#
+# Copyright (C) 2021 HERE Europe B.V.
+#
+# 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.
+#
+# SPDX-License-Identifier: Apache-2.0
+# License-Filename: LICENSE
+
+mkdir -p build
+cd build
+
+cmake \
+    -DOLP_SDK_ENABLE_TESTING=OFF \
+    -DOLP_SDK_ENABLE_DEFAULT_CACHE=OFF \
+    -DBUILD_SHARED_LIBS=ON \
+    ..
+
+cmake --build . -- -j$(nproc)