Separate compilation of source and tests

.github/workflows/ci-workflow.yml

@@ -58,7 +58,7 @@ jobs:
       - run: pip3 install --user -r tools/python_api/requirements_dev.txt
 
       - name: build
-        run: make release NUM_THREADS=30
+        run: make benchmark NUM_THREADS=30
 
       - name: benchmark
         run: python3 benchmark/benchmark_runner.py --dataset ldbc-sf100 --thread 1

CMakeLists.txt

@@ -43,6 +43,8 @@ endif()
 if(${ENABLE_UBSAN})
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=undefined -fno-common -fpermissive")
 endif()
+option(BUILD_TESTS "Build C++ and Python tests." FALSE)
+option(BUILD_BENCHMARK "Build benchmarks." FALSE)
 
 function(link_threads LIBRARY)
     if (CMAKE_VERSION VERSION_LESS "3.1")
@@ -55,7 +57,7 @@ endfunction()
 function(add_kuzu_test TEST_NAME)
     set(SRCS ${ARGN})
     add_executable(${TEST_NAME} ${SRCS})
-    target_link_libraries(${TEST_NAME} PRIVATE test_helper)
+    target_link_libraries(${TEST_NAME} PRIVATE test_helper graph_test)
     target_include_directories(${TEST_NAME} PRIVATE ${PROJECT_SOURCE_DIR}/test/include)
     include(GoogleTest)
     gtest_discover_tests(${TEST_NAME})
@@ -82,5 +84,9 @@ include_directories(third_party/pybind11/include)
 
 add_subdirectory(third_party)
 add_subdirectory(src)
-add_subdirectory(test)
+if (${BUILD_TESTS})
+    add_subdirectory(test)
+elseif (${BUILD_BENCHMARK})
+    add_subdirectory(test/test_helper)
+endif()
 add_subdirectory(tools)

Makefile

@@ -1,6 +1,4 @@
-.PHONY: all release debug test clean arrow clean-external clean-all
-
-all: release
+.PHONY: release debug test benchmark all debug-all arrow clean clean-external clean-all
 
 GENERATOR=
 FORCE_COLOR=
@@ -46,8 +44,29 @@ debug: arrow
 	cmake $(GENERATOR) $(FORCE_COLOR) $(SANITIZER_FLAG) -DCMAKE_BUILD_TYPE=Debug ../.. && \
 	cmake --build . --config Debug -- -j $(NUM_THREADS)
 
+all: arrow
+	mkdir -p build/release && \
+	cd build/release && \
+	cmake $(GENERATOR) $(FORCE_COLOR) $(SANITIZER_FLAG) -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=TRUE -DBUILD_BENCHMARK=TRUE ../.. && \
+	cmake --build . --config Release -- -j $(NUM_THREADS)
+
+alldebug: arrow
+	mkdir -p build/debug && \
+	cd build/debug && \
+	cmake $(GENERATOR) $(FORCE_COLOR) $(SANITIZER_FLAG) -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTS=TRUE -DBUILD_BENCHMARK=TRUE ../.. && \
+	cmake --build . --config Debug -- -j $(NUM_THREADS)
 
-test: release
+benchmark: arrow
+	mkdir -p build/release && \
+	cd build/release && \
+	cmake $(GENERATOR) $(FORCE_COLOR) $(SANITIZER_FLAG) -DCMAKE_BUILD_TYPE=Release -DBUILD_BENCHMARK=TRUE ../.. && \
+	cmake --build . --config Release -- -j $(NUM_THREADS)
+
+test: arrow
+	mkdir -p build/release && \
+	cd build/release && \
+	cmake $(GENERATOR) $(FORCE_COLOR) $(SANITIZER_FLAG) -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=TRUE ../.. && \
+	cmake --build . --config Release -- -j $(NUM_THREADS)
 	cd $(ROOT_DIR)/build/release/test && \
 	ctest
 

README.md

@@ -18,11 +18,16 @@ Kùzu is being actively developed at University of Waterloo as a feature-rich an
 
 ## Build
 To build from source code, Kùzu requires Cmake(>=3.11), Python 3, and a compiler that supports `C++20`.
-- Perform a full clean build
+- Perform a full clean build without tests and benchmark:
   - `make clean && make`
-- Run tests (optional)
+- Perform a full clean build with tests and benchmark (optional):
+  - `make clean && make all`
+- Run tests (optional):
   - `make test`
 
+For development, use `make debug` to build a non-optimized debug version.
+To build in parallel, pass `NUM_THREADS` as parameter, e.g., `make NUM_THREADS=8`.
+
 After build, our CLI binary `kuzu_shell` is available under the directory `build/release/tools/shell/`.
 
 ## Installation

test/CMakeLists.txt

@@ -12,6 +12,7 @@ target_link_libraries(GTest::GTest INTERFACE gmock_main)
 
 enable_testing()
 add_subdirectory(test_helper)
+add_subdirectory(graph_test)
 add_subdirectory(binder)
 add_subdirectory(catalog)
 add_subdirectory(common)

test/binder/binder_error_test.cpp

@@ -1,6 +1,5 @@
-#include "test_helper/test_helper.h"
+#include "graph_test/graph_test.h"
 
-using ::testing::Test;
 using namespace kuzu::testing;
 
 class BinderErrorTest : public DBTest {

test/binder/binder_test.cpp

@@ -1,6 +1,5 @@
-#include "test_helper/test_helper.h"
+#include "graph_test/graph_test.h"
 
-using ::testing::Test;
 using namespace kuzu::testing;
 
 class BinderTest : public DBTest {

test/catalog/CMakeLists.txt

@@ -1,5 +1,5 @@
 add_executable(catalog_test catalog_test.cpp)
 
-target_link_libraries(catalog_test PUBLIC test_helper)
+target_link_libraries(catalog_test PUBLIC graph_test)
 
 add_test(kuzu_catalog_test catalog_test)

test/catalog/catalog_test.cpp

@@ -1,8 +1,6 @@
 #include "catalog/catalog.h"
-#include "gtest/gtest.h"
-#include "test_helper/test_helper.h"
+#include "graph_test/graph_test.h"
 
-using namespace std;
 using namespace kuzu::catalog;
 
 class CatalogTest : public testing::Test {

test/common/date_test.cpp

@@ -4,7 +4,6 @@
 #include "gtest/gtest.h"
 
 using namespace kuzu::common;
-using namespace std;
 
 TEST(DateTests, IsLeapYearTest) {
     EXPECT_TRUE(Date::IsLeapYear(2000));

test/common/interval_test.cpp

@@ -1,10 +1,9 @@
 #include <string>
 
 #include "common/types/types_include.h"
-#include "include/gtest/gtest.h"
+#include "gtest/gtest.h"
 
 using namespace kuzu::common;
-using namespace std;
 
 TEST(IntervalTests, FromCString) {
     interval_t result;

test/common/time_test.cpp

@@ -2,10 +2,9 @@
 
 #include "common/exception.h"
 #include "common/types/types_include.h"
-#include "include/gtest/gtest.h"
+#include "gtest/gtest.h"
 
 using namespace kuzu::common;
-using namespace std;
 
 TEST(TimeTests, FromTime) {
     // Hour out of range

test/common/timestamp_test.cpp

@@ -2,10 +2,9 @@
 
 #include "common/exception.h"
 #include "common/types/types_include.h"
-#include "include/gtest/gtest.h"
+#include "gtest/gtest.h"
 
 using namespace kuzu::common;
-using namespace std;
 
 TEST(TimestampTests, FromDatetime) {
     // day is out of range

test/common/types_test.cpp

@@ -5,7 +5,6 @@
 #include "gtest/gtest.h"
 
 using namespace kuzu::common;
-using namespace std;
 
 TEST(TypesTests, StringToINT64Conversion) {
     EXPECT_EQ(2147483648, TypeUtils::TypeUtils::convertToInt64("2147483648"));

test/copy/arrow_node_copy_test.cpp

@@ -1,8 +1,5 @@
-#include <iostream>
+#include "graph_test/graph_test.h"
 
-#include "test_helper/test_helper.h"
-
-using namespace std;
 using namespace kuzu::common;
 using namespace kuzu::storage;
 using namespace kuzu::testing;

test/copy/copy_dates_test.cpp

@@ -1,6 +1,5 @@
-#include "test_helper/test_helper.h"
+#include "graph_test/graph_test.h"
 
-using namespace std;
 using namespace kuzu::common;
 using namespace kuzu::storage;
 using namespace kuzu::testing;

test/copy/copy_dos_style_newline_test.cpp

@@ -1,6 +1,5 @@
-#include "test_helper/test_helper.h"
+#include "graph_test/graph_test.h"
 
-using namespace std;
 using namespace kuzu::common;
 using namespace kuzu::storage;
 using namespace kuzu::testing;

test/copy/copy_fault_test.cpp

@@ -1,8 +1,7 @@
 #include "common/exception.h"
-#include "test_helper/test_helper.h"
+#include "graph_test/graph_test.h"
 
 using namespace kuzu::testing;
-using namespace std;
 
 class CopyFaultTest : public EmptyDBTest {
 public:

test/copy/copy_interval_test.cpp

@@ -1,8 +1,7 @@
 #include <string>
 
-#include "test_helper/test_helper.h"
+#include "graph_test/graph_test.h"
 
-using namespace std;
 using namespace kuzu::common;
 using namespace kuzu::storage;
 using namespace kuzu::testing;

test/copy/copy_lists_test.cpp

@@ -1,7 +1,6 @@
 #include "common/type_utils.h"
-#include "test_helper/test_helper.h"
+#include "graph_test/graph_test.h"
 
-using namespace std;
 using namespace kuzu::common;
 using namespace kuzu::storage;
 using namespace kuzu::testing;

test/copy/copy_test.cpp

@@ -1,7 +1,6 @@
 #include "common/csv_reader/csv_reader.h"
-#include "test_helper/test_helper.h"
+#include "graph_test/graph_test.h"
 
-using namespace std;
 using namespace kuzu::common;
 using namespace kuzu::catalog;
 using namespace kuzu::storage;

test/copy/copy_timestamp_test.cpp

@@ -1,6 +1,5 @@
-#include "test_helper/test_helper.h"
+#include "graph_test/graph_test.h"
 
-using namespace std;
 using namespace kuzu::common;
 using namespace kuzu::storage;
 using namespace kuzu::testing;

test/demo_db/demo_db_test.cpp

@@ -1,4 +1,4 @@
-#include "test_helper/test_helper.h"
+#include "graph_test/graph_test.h"
 
 using ::testing::Test;
 using namespace kuzu::testing;

test/graph_test/CMakeLists.txt

@@ -0,0 +1,13 @@
+add_library(
+        graph_test
+        OBJECT
+        graph_test.cpp)
+
+target_include_directories(
+        graph_test
+        PUBLIC
+        ../include/
+        ../../src/include
+)
+
+target_link_libraries(graph_test PUBLIC GTest::GTest kuzu)