Merge pull request #41 from diffCheckOrg/test_suite

test suite framework 🧪

Author: 9and3

.github/workflows/cpp-build.yml

@@ -20,7 +20,7 @@ jobs:
 
       - name: Cmake Configure
         run: |
-          cmake -S . -B build -A x64 -DBUILD_PYTHON_MODULE=OFF
+          cmake -S . -B build -A x64 -DBUILD_PYTHON_MODULE=OFF -DBUILD_TESTS=OFF -DRUN_TESTS=OFF
 
       - name: CMake Build
-        run: ${{github.workspace}}/cmake/build.bat
+        run: cmake --build build --config Release

.github/workflows/pypi-build.yml

@@ -32,9 +32,11 @@ jobs:
 
       - name: Cmake Configure
         run: |
-          cmake -S . -B build -A x64 -DBUILD_PYTHON_MODULE=ON
+          cmake -S . -B build -A x64 -DBUILD_PYTHON_MODULE=ON -DBUILD_TESTS=OFF -DRUN_TESTS=OFF
       - name: CMake Build
-        run: ${{github.workspace}}/cmake/build.bat
+        run: cmake --build build --config Release
+
+      #FIXME: here we are probably missing to copy the dlls and pyds before building the wheel
 
       - name: Build wheel
         run: |

.github/workflows/test-pass.yml

@@ -0,0 +1,58 @@
+name: "test-pass"
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+
+jobs:
+  windows:
+    runs-on: windows-latest
+
+    env:
+      BUILD_TYPE: Release
+      VCPKG_FILE: c:/vcpkg/scripts/buildsystems/vcpkg.cmake
+      DF_TEST_DATA_DIR: ${{ github.workspace }}/tests/test_data
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          lfs: true  # enable lfs support
+
+      - name: Setup conda environment
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          auto-update-conda: true
+          python-version: 3.9.1
+
+      - name: Create diff_check conda environment
+        run: conda env create -f environment.yml
+      
+      - name: Activate diff_check conda environment
+        run: conda activate diff_check
+
+      - name: Verify Python version
+        run: conda run --name diff_check --no-capture-output python --version
+
+      - name: Cmake Configure
+        run: |
+          conda run --name diff_check --no-capture-output cmake -S . -B build -A x64 -DBUILD_PYTHON_MODULE=ON -DBUILD_TESTS=ON -DRUN_TESTS=OFF
+
+      - name: CMake Build
+        run: conda run --name diff_check --no-capture-output cmake --build build --config Release
+
+      - name: Copying the dlls for python tests and c++ tests
+        run: |
+          copy ${{github.workspace}}/build/bin/Release/diffCheck.dll ${{github.workspace}}/build/df_tests/Release
+          copy ${{github.workspace}}/build/bin/Release/Open3D.dll ${{github.workspace}}/build/df_tests/Release
+
+          copy ${{github.workspace}}/build/bin/Release/diffCheck.dll ${{github.workspace}}/tests/integration_tests/pybinds_tests
+          copy ${{github.workspace}}/build/bin/Release/Open3D.dll ${{github.workspace}}/tests/integration_tests/pybinds_tests
+          copy ${{github.workspace}}/build/Release/*.pyd ${{github.workspace}}/tests/integration_tests/pybinds_tests
+
+      - name: Run tests with cmake
+        run: |
+          conda run --name diff_check ctest --test-dir build --output-on-failure -C Release --verbose

CMakeLists.txt

@@ -7,6 +7,11 @@ list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
 include(external_tools)
 include(options)
 
+# disabling warnings
+if (MSVC)
+    add_compile_options(/wd4003)
+endif()
+
 # check that the -DCMAKE_BUILD_TYPE is set
 if(NOT CMAKE_BUILD_TYPE)
     message(STATUS "Setting build type to 'Release' as none was specified.")
@@ -147,7 +152,7 @@ if (BUILD_PYTHON_MODULE)
 
     pybind11_add_module(${PYBINDMODULE_NAME} src/diffCheckBindings.cc)
 
-    target_link_libraries(${PYBINDMODULE_NAME} PRIVATE ${SHARED_LIB_NAME})
+    target_link_libraries(${PYBINDMODULE_NAME} PUBLIC ${SHARED_LIB_NAME})
     target_include_directories(${PYBINDMODULE_NAME} PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/src)
 
     # copy the pyd file to the pypi directory
@@ -157,29 +162,12 @@ if (BUILD_PYTHON_MODULE)
         ${PYPI_DIR}
         )
     copy_dlls(${TARGET_DLL_PYPI_DIR} ${PYBINDMODULE_NAME})
-
 endif()
 
 #--------------------------------------------------------------------------
 # Tests
 #--------------------------------------------------------------------------
-include(CTest)
-enable_testing()
-add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/deps/googletest)
-set(TESTS_OUT_DIR ${CMAKE_BINARY_DIR}/df_tests/)
-set(TEST_OUT_DIR_BINARY ${TESTS_OUT_DIR}/${CMAKE_BUILD_TYPE})
-
-# add new test suites .cc here
-set(UNIT_TESTS df_test_suites)
-add_executable(${UNIT_TESTS}
-    tests/unit_tests/DFPointCloudTest.cc
-    tests/entryTest.cc
-    )
-set_target_properties(${UNIT_TESTS} PROPERTIES
-    RUNTIME_OUTPUT_DIRECTORY ${TESTS_OUT_DIR}
-    )
-target_link_libraries(${UNIT_TESTS} gtest gtest_main)
-target_link_libraries(${UNIT_TESTS} ${SHARED_LIB_NAME})
+if(BUILD_TESTS)
+    include(tests)
+endif()
 
-add_test(NAME ${UNIT_TESTS} COMMAND ${UNIT_TESTS})
-copy_dlls(${TEST_OUT_DIR_BINARY} ${UNIT_TESTS})

CONTRIBUTING.md

@@ -319,16 +319,48 @@ dfVisualizerPtr->Run();
 ```
 
 
-### CTesting (TO BE UPDATED)
-Tests in df are all `.cc` files added to the `tests` source files, all the data needs to be contained in `tests/test_data`. Finally add your `.cc` files in the cmake:
+### Test suite
+In df we use `CTest` as a test framework managed by Cmake in the  file `cmake/tests.cmake` to run c++ tests with `GoogleTest` and for python in `PyTest`.
 
-https://github.com/diffCheckOrg/diffCheck/blob/efb10e0b5685a1ef1537d0309388f642075d3244/CMakeLists.txt#L170-L173
-
-To run the tests from terminal
-```
-ctest --test-dir .\build\ -C Release -V
+Tests are in the `tests` folder:
+```terminal
+F:\DIFFCHECK\TESTS
+│   allCppTests.cc
+│
+├───integration_tests  <-- mainly python interfaces
+│   ├───ghcomponents_tests   <-- relative to gh components
+│   │       .gitkeep
+│   │
+│   ├───package_tests  <-- relative to the pypi package
+│   │       .gitkeep
+│   │
+│   └───pybinds_tests  <-- strictly pybinding
+│       │   diffCheck.dll
+│       │   diffcheck_bindings.cp39-win_amd64.pyd
+│       │   Open3D.dll
+│       │   test_pybind_pyver.py
+│       │   test_pybind_units.py
+│
+├───test_data  <-- here is where we put some .ply data
+│       roof_quarter.ply
+│
+└───unit_tests  <-- c++ backend, one for each header
+        DFLog.cc
+        DFPointCloudTest.cc
 ```
-or
+
+To run the tests, you can use the following commands:
+```terminal
+cmake -S . -B build -A x64 -DBUILD_PYTHON_MODULE=ON -DBUILD_TESTS=ON -DRUN_TESTS=ON
+cmake --build build --config Release
 ```
-.\build\df_tests\<config>\df_tests.exe
-```
+
+## Write C++ tests
+To write a test, you need to create a new file in the `tests/unit_tests` folder. Next add your file in the executable `${CPP_UNIT_TESTS}` in the `cmake/tests.cmake`.
+e.g.:
+https://github.com/diffCheckOrg/diffCheck/blob/e080a93cdd73d96efb0686f80bf13730e0b8efa3/cmake/tests.cmake#L13-L17
+
+## Write Python tests
+To write a test, you need to create a new file in the `tests/integration_tests` folder. Write a new `.py` test file and add it in the `cmake/tests.cmake` in the `add_test` function.
+e.g.:
+https://github.com/diffCheckOrg/diffCheck/blob/e080a93cdd73d96efb0686f80bf13730e0b8efa3/cmake/tests.cmake#L45-L48

README.md

@@ -3,6 +3,7 @@
 </p>
 <p align="center">
     <img src="https://github.com/diffCheckOrg/diffCheck/actions/workflows/cpp-build.yml/badge.svg">
+    <img src="https://github.com/diffCheckOrg/diffCheck/actions/workflows/test-pass.yml/badge.svg">
     <img src="https://github.com/diffCheckOrg/diffCheck/actions/workflows/gh-build.yml/badge.svg">
     <img src="https://github.com/diffCheckOrg/diffCheck/actions/workflows/pypi-build.yml/badge.svg">
     <img href="https://pypi.org/project/diffCheck/" src="https://img.shields.io/pypi/v/diffCheck">