Add Google tests for unit testing jni

.gitignore

@@ -19,3 +19,11 @@ jni/CPack*
 jni/_CPack*
 jni/release
 jni/packages
+jni/CTestTestfile.cmake
+jni/KNNPlugin_JNI.cbp
+jni/Testing/
+jni/_deps/
+jni/bin/
+jni/lib/
+jni/jni_test*
+jni/googletest*

jni/CMakeLists.txt

@@ -74,6 +74,9 @@ add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/external/nmslib/similarity_search)
 # ---------------------------------------------------------------------------
 
 # ---------------------------------- FAISS ----------------------------------
+# Avoid building faiss tests
+set(BUILD_TESTING OFF)
+
 if (${CMAKE_SYSTEM_NAME} STREQUAL Darwin)
     if(CMAKE_C_COMPILER_ID MATCHES "Clang\$")
         set(OpenMP_C_FLAGS "-Xpreprocessor -fopenmp")
@@ -117,6 +120,53 @@ set_target_properties(${TARGET_LIB} PROPERTIES POSITION_INDEPENDENT_CODE ON)
 set_target_properties(${TARGET_LIB} PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/release)
 # ---------------------------------------------------------------------------
 
+# --------------------------------- TESTS -----------------------------------
+# Reference - https://crascit.com/2015/07/25/cmake-gtest/
+configure_file(CMakeLists.txt.in googletest-download/CMakeLists.txt)
+execute_process(COMMAND "${CMAKE_COMMAND}" -G "${CMAKE_GENERATOR}" .
+        WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/googletest-download"
+)
+execute_process(COMMAND "${CMAKE_COMMAND}" --build .
+        WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/googletest-download"
+)
+set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+
+add_subdirectory("${CMAKE_BINARY_DIR}/googletest-src"
+        "${CMAKE_BINARY_DIR}/googletest-build"
+)
+add_executable(
+        jni_test
+        tests/faiss_wrapper_test.cpp
+        tests/nmslib_wrapper_test.cpp
+        tests/test_util.cpp)
+
+target_link_libraries(
+        jni_test
+        gtest_main
+        gmock_main
+        faiss
+        NonMetricSpaceLib
+        ${BLAS_LIBRARIES}
+        ${LAPACK_LIBRARIES}
+        OpenMP::OpenMP_CXX
+        ${TARGET_LIB}
+)
+
+target_include_directories(jni_test PRIVATE
+        ${CMAKE_CURRENT_SOURCE_DIR}/tests
+        ${CMAKE_CURRENT_SOURCE_DIR}/include
+        $ENV{JAVA_HOME}/include
+        $ENV{JAVA_HOME}/include/${JVM_OS_TYPE}
+        ${CMAKE_CURRENT_SOURCE_DIR}/external/faiss
+        ${CMAKE_CURRENT_SOURCE_DIR}/external/nmslib/similarity_search/include
+        ${gtest_SOURCE_DIR}/include
+        ${gmock_SOURCE_DIR}/include)
+
+
+set_target_properties(jni_test PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/bin)
+
+# ---------------------------------------------------------------------------
+
 # -------------------------------- INSTALL ----------------------------------
 # Installation rules for shared library
 install(TARGETS ${TARGET_LIB}

jni/CMakeLists.txt.in

@@ -0,0 +1,14 @@
+cmake_minimum_required(VERSION 2.8.2)
+project(googletest-download NONE)
+
+include(ExternalProject)
+ExternalProject_Add(googletest
+        GIT_REPOSITORY https://github.com/google/googletest.git
+        GIT_TAG master
+        SOURCE_DIR "${CMAKE_BINARY_DIR}/googletest-src"
+        BINARY_DIR "${CMAKE_BINARY_DIR}/googletest-build"
+        CONFIGURE_COMMAND ""
+        BUILD_COMMAND ""
+        INSTALL_COMMAND ""
+        TEST_COMMAND ""
+        )

jni/include/faiss_wrapper.h

@@ -12,6 +12,8 @@
 #ifndef OPENSEARCH_KNN_FAISS_WRAPPER_H
 #define OPENSEARCH_KNN_FAISS_WRAPPER_H
 
+#include "jni_util.h"
+
 #include <jni.h>
 
 namespace knn_jni {

jni/include/jni_util.h

@@ -174,7 +174,10 @@ namespace knn_jni {
 
     extern const std::string NPROBES;
     extern const std::string COARSE_QUANTIZER;
+    extern const std::string M;
+    extern const std::string M_NMSLIB;
     extern const std::string EF_CONSTRUCTION;
+    extern const std::string EF_CONSTRUCTION_NMSLIB;
     extern const std::string EF_SEARCH;
 
     // --------------------------------------------------------------------------

jni/include/nmslib_wrapper.h

@@ -12,9 +12,15 @@
 #ifndef OPENSEARCH_KNN_NMSLIB_WRAPPER_H
 #define OPENSEARCH_KNN_NMSLIB_WRAPPER_H
 
-#include <jni.h>
 #include "jni_util.h"
 
+#include "methodfactory.h"
+#include "space.h"
+#include "spacefactory.h"
+
+#include <jni.h>
+#include <string>
+
 namespace knn_jni {
     namespace nmslib_wrapper {
         // Create an index with ids and vectors. The configuration is defined by values in the Java map, parametersJ.
@@ -38,6 +44,17 @@ namespace knn_jni {
 
         // Perform required initialization operations for the library
         void InitLibrary();
+
+        struct IndexWrapper {
+            explicit IndexWrapper(const std::string& spaceType) {
+                // Index gets constructed with a reference to data (see above) but is otherwise unused
+                similarity::ObjectVector data;
+                space.reset(similarity::SpaceFactoryRegistry<float>::Instance().CreateSpace(spaceType, similarity::AnyParams()));
+                index.reset(similarity::MethodFactoryRegistry<float>::Instance().CreateMethod(false, "hnsw", spaceType, *space, data));
+            }
+            std::unique_ptr<similarity::Space<float>> space;
+            std::unique_ptr<similarity::Index<float>> index;
+        };
     }
 }
 

jni/src/faiss_wrapper.cpp

@@ -12,17 +12,17 @@
 #include "jni_util.h"
 #include "faiss_wrapper.h"
 
+#include "faiss/impl/io.h"
 #include "faiss/index_factory.h"
-#include "faiss/MetaIndexes.h"
 #include "faiss/index_io.h"
 #include "faiss/IndexHNSW.h"
 #include "faiss/IndexIVFFlat.h"
+#include "faiss/MetaIndexes.h"
 
 #include <algorithm>
 #include <jni.h>
-#include <vector>
 #include <string>
-#include <faiss/impl/io.h>
+#include <vector>
 
 
 // Translate space type to faiss metric

jni/src/jni_util.cpp

@@ -413,5 +413,9 @@ const std::string knn_jni::NEG_DOT_PRODUCT = "negdotprod";
 
 const std::string knn_jni::NPROBES = "nprobes";
 const std::string knn_jni::COARSE_QUANTIZER = "coarse_quantizer";
+const std::string knn_jni::M = "m";
+const std::string knn_jni::M_NMSLIB = "M";
 const std::string knn_jni::EF_CONSTRUCTION = "ef_construction";
+const std::string knn_jni::EF_CONSTRUCTION_NMSLIB = "efConstruction";
 const std::string knn_jni::EF_SEARCH = "ef_search";
+

jni/src/nmslib_wrapper.cpp

@@ -12,9 +12,6 @@
 #include "jni_util.h"
 #include "nmslib_wrapper.h"
 
-#include <jni.h>
-#include <string>
-
 #include "init.h"
 #include "index.h"
 #include "params.h"
@@ -24,17 +21,9 @@
 #include "spacefactory.h"
 #include "space.h"
 
+#include <jni.h>
+#include <string>
 
-struct IndexWrapper {
-    explicit IndexWrapper(const string& spaceType) {
-        // Index gets constructed with a reference to data (see above) but is otherwise unused
-        similarity::ObjectVector data;
-        space.reset(similarity::SpaceFactoryRegistry<float>::Instance().CreateSpace(spaceType, similarity::AnyParams()));
-        index.reset(similarity::MethodFactoryRegistry<float>::Instance().CreateMethod(false, "hnsw", spaceType, *space, data));
-    }
-    std::unique_ptr<similarity::Space<float>> space;
-    std::unique_ptr<similarity::Index<float>> index;
-};
 
 std::string TranslateSpaceType(const std::string& spaceType);
 
@@ -60,14 +49,14 @@ void knn_jni::nmslib_wrapper::CreateIndex(knn_jni::JNIUtilInterface * jniUtil, J
     // Handle parameters
     auto parametersCpp = jniUtil->ConvertJavaMapToCppMap(env, parametersJ);
     std::vector<std::string> indexParameters;
-    if(parametersCpp.find("ef_construction") != parametersCpp.end()) {
-        auto efConstruction = jniUtil->ConvertJavaObjectToCppInteger(env, parametersCpp["ef_construction"]);
-        indexParameters.push_back("efConstruction=" + std::to_string(efConstruction));
+    if(parametersCpp.find(knn_jni::EF_CONSTRUCTION) != parametersCpp.end()) {
+        auto efConstruction = jniUtil->ConvertJavaObjectToCppInteger(env, parametersCpp[knn_jni::EF_CONSTRUCTION]);
+        indexParameters.push_back(knn_jni::EF_CONSTRUCTION_NMSLIB + "=" + std::to_string(efConstruction));
     }
 
-    if(parametersCpp.find("m") != parametersCpp.end()) {
-        auto m = jniUtil->ConvertJavaObjectToCppInteger(env, parametersCpp["m"]);
-        indexParameters.push_back("M=" + std::to_string(m));
+    if(parametersCpp.find(knn_jni::M) != parametersCpp.end()) {
+        auto m = jniUtil->ConvertJavaObjectToCppInteger(env, parametersCpp[knn_jni::M]);
+        indexParameters.push_back(knn_jni::M_NMSLIB + "=" + std::to_string(m));
     }
     jniUtil->DeleteLocalRef(env, parametersJ);
 
@@ -160,9 +149,9 @@ jlong knn_jni::nmslib_wrapper::LoadIndex(knn_jni::JNIUtilInterface * jniUtil, JN
     }
 
     // Load index
-    IndexWrapper * indexWrapper;
+    knn_jni::nmslib_wrapper::IndexWrapper * indexWrapper;
     try {
-        indexWrapper = new IndexWrapper(spaceTypeCpp);
+        indexWrapper = new knn_jni::nmslib_wrapper::IndexWrapper(spaceTypeCpp);
         indexWrapper->index->LoadIndex(indexPathCpp);
         indexWrapper->index->SetQueryTimeParams(similarity::AnyParams(queryParams));
     } catch (...) {
@@ -184,7 +173,7 @@ jobjectArray knn_jni::nmslib_wrapper::QueryIndex(knn_jni::JNIUtilInterface * jni
         throw std::runtime_error("Invalid pointer to index");
     }
 
-    auto *indexWrapper = reinterpret_cast<IndexWrapper*>(indexPointerJ);
+    auto *indexWrapper = reinterpret_cast<knn_jni::nmslib_wrapper::IndexWrapper*>(indexPointerJ);
 
     int dim	= jniUtil->GetJavaFloatArrayLength(env, queryVectorJ);
 
@@ -223,7 +212,7 @@ jobjectArray knn_jni::nmslib_wrapper::QueryIndex(knn_jni::JNIUtilInterface * jni
 }
 
 void knn_jni::nmslib_wrapper::Free(jlong indexPointerJ) {
-    auto *indexWrapper = reinterpret_cast<IndexWrapper*>(indexPointerJ);
+    auto *indexWrapper = reinterpret_cast<knn_jni::nmslib_wrapper::IndexWrapper*>(indexPointerJ);
     delete indexWrapper;
 }