Standalone 1/N: Move driver source and test files to separate directo…

…ries (#293) Splitting up #291. Moves files and updates CMakeLists.txt files accordingly.
acquire-project · Sep 18, 2024 · 8084499 · 8084499
1 parent e5a27d1
commit 8084499
Show file tree

Hide file tree

Showing 67 changed files with 150 additions and 142 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -19,6 +19,9 @@ set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
+option(NOTEST "Disable all tests" OFF)
+option(BUILD_ACQUIRE_DRIVER_ZARR "Build the Acquire Zarr driver" ON)
+
 add_subdirectory(src)
 add_subdirectory(tests)
 add_subdirectory(examples)

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -1,57 +1,3 @@
-if (NOT TARGET acquire-core-logger)
-    add_subdirectory(../acquire-common/acquire-core-libs ${CMAKE_CURRENT_BINARY_DIR}/acquire-core-libs)
+if (BUILD_ACQUIRE_DRIVER_ZARR)
+    add_subdirectory(driver)
 endif ()
-
-set(tgt acquire-driver-zarr)
-add_library(${tgt} MODULE
-        common/dimension.hh
-        common/dimension.cpp
-        common/thread.pool.hh
-        common/thread.pool.cpp
-        common/s3.connection.hh
-        common/s3.connection.cpp
-        common/utilities.hh
-        common/utilities.cpp
-        writers/sink.hh
-        writers/sink.creator.hh
-        writers/sink.creator.cpp
-        writers/file.sink.hh
-        writers/file.sink.cpp
-        writers/s3.sink.hh
-        writers/s3.sink.cpp
-        writers/array.writer.hh
-        writers/array.writer.cpp
-        writers/zarrv2.array.writer.hh
-        writers/zarrv2.array.writer.cpp
-        writers/zarrv3.array.writer.hh
-        writers/zarrv3.array.writer.cpp
-        writers/blosc.compressor.hh
-        writers/blosc.compressor.cpp
-        zarr.hh
-        zarr.cpp
-        zarr.v2.hh
-        zarr.v2.cpp
-        zarr.v3.hh
-        zarr.v3.cpp
-        zarr.driver.c
-)
-
-target_include_directories(${tgt} PRIVATE
-  $<BUILD_INTERFACE:${CMAKE_SOURCE_DIR}/src>
-)
-
-target_enable_simd(${tgt})
-target_link_libraries(${tgt} PRIVATE
-        acquire-core-logger
-        acquire-core-platform
-        acquire-device-kit
-        acquire-device-properties
-        blosc_static
-        nlohmann_json::nlohmann_json
-        miniocpp::miniocpp
-)
-set_target_properties(${tgt} PROPERTIES
-        MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>"
-)
-
-install(TARGETS ${tgt} LIBRARY DESTINATION lib)
diff --git a/src/driver/CMakeLists.txt b/src/driver/CMakeLists.txt
@@ -0,0 +1,57 @@
+if (NOT TARGET acquire-core-logger)
+    add_subdirectory(${CMAKE_SOURCE_DIR}/acquire-common/acquire-core-libs ${CMAKE_CURRENT_BINARY_DIR}/acquire-core-libs)
+endif ()
+
+set(tgt acquire-driver-zarr)
+add_library(${tgt} MODULE
+        common/dimension.hh
+        common/dimension.cpp
+        common/thread.pool.hh
+        common/thread.pool.cpp
+        common/s3.connection.hh
+        common/s3.connection.cpp
+        common/utilities.hh
+        common/utilities.cpp
+        writers/sink.hh
+        writers/sink.creator.hh
+        writers/sink.creator.cpp
+        writers/file.sink.hh
+        writers/file.sink.cpp
+        writers/s3.sink.hh
+        writers/s3.sink.cpp
+        writers/array.writer.hh
+        writers/array.writer.cpp
+        writers/zarrv2.array.writer.hh
+        writers/zarrv2.array.writer.cpp
+        writers/zarrv3.array.writer.hh
+        writers/zarrv3.array.writer.cpp
+        writers/blosc.compressor.hh
+        writers/blosc.compressor.cpp
+        zarr.hh
+        zarr.cpp
+        zarr.v2.hh
+        zarr.v2.cpp
+        zarr.v3.hh
+        zarr.v3.cpp
+        zarr.driver.c
+)
+
+target_include_directories(${tgt} PRIVATE
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
+)
+
+target_enable_simd(${tgt})
+target_link_libraries(${tgt} PRIVATE
+        acquire-core-logger
+        acquire-core-platform
+        acquire-device-kit
+        acquire-device-properties
+        blosc_static
+        nlohmann_json::nlohmann_json
+        miniocpp::miniocpp
+)
+set_target_properties(${tgt} PROPERTIES
+        MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>"
+)
+
+install(TARGETS ${tgt} LIBRARY DESTINATION lib)
diff --git a/src/README.md → src/driver/README.md b/src/README.md → src/driver/README.md
diff --git a/src/common/dimension.cpp → src/driver/common/dimension.cpp b/src/common/dimension.cpp → src/driver/common/dimension.cpp
diff --git a/src/common/dimension.hh → src/driver/common/dimension.hh b/src/common/dimension.hh → src/driver/common/dimension.hh
diff --git a/src/common/macros.hh → src/driver/common/macros.hh b/src/common/macros.hh → src/driver/common/macros.hh
diff --git a/src/common/s3.connection.cpp → src/driver/common/s3.connection.cpp b/src/common/s3.connection.cpp → src/driver/common/s3.connection.cpp
diff --git a/src/common/s3.connection.hh → src/driver/common/s3.connection.hh b/src/common/s3.connection.hh → src/driver/common/s3.connection.hh
diff --git a/src/common/thread.pool.cpp → src/driver/common/thread.pool.cpp b/src/common/thread.pool.cpp → src/driver/common/thread.pool.cpp
diff --git a/src/common/thread.pool.hh → src/driver/common/thread.pool.hh b/src/common/thread.pool.hh → src/driver/common/thread.pool.hh
diff --git a/src/common/utilities.cpp → src/driver/common/utilities.cpp b/src/common/utilities.cpp → src/driver/common/utilities.cpp
diff --git a/src/common/utilities.hh → src/driver/common/utilities.hh b/src/common/utilities.hh → src/driver/common/utilities.hh
diff --git a/src/writers/array.writer.cpp → src/driver/writers/array.writer.cpp b/src/writers/array.writer.cpp → src/driver/writers/array.writer.cpp
diff --git a/src/writers/array.writer.hh → src/driver/writers/array.writer.hh b/src/writers/array.writer.hh → src/driver/writers/array.writer.hh
diff --git a/src/writers/blosc.compressor.cpp → src/driver/writers/blosc.compressor.cpp b/src/writers/blosc.compressor.cpp → src/driver/writers/blosc.compressor.cpp
diff --git a/src/writers/blosc.compressor.hh → src/driver/writers/blosc.compressor.hh b/src/writers/blosc.compressor.hh → src/driver/writers/blosc.compressor.hh
diff --git a/src/writers/file.sink.cpp → src/driver/writers/file.sink.cpp b/src/writers/file.sink.cpp → src/driver/writers/file.sink.cpp
diff --git a/src/writers/file.sink.hh → src/driver/writers/file.sink.hh b/src/writers/file.sink.hh → src/driver/writers/file.sink.hh
diff --git a/src/writers/s3.sink.cpp → src/driver/writers/s3.sink.cpp b/src/writers/s3.sink.cpp → src/driver/writers/s3.sink.cpp
diff --git a/src/writers/s3.sink.hh → src/driver/writers/s3.sink.hh b/src/writers/s3.sink.hh → src/driver/writers/s3.sink.hh
diff --git a/src/writers/sink.creator.cpp → src/driver/writers/sink.creator.cpp b/src/writers/sink.creator.cpp → src/driver/writers/sink.creator.cpp
diff --git a/src/writers/sink.creator.hh → src/driver/writers/sink.creator.hh b/src/writers/sink.creator.hh → src/driver/writers/sink.creator.hh
diff --git a/src/writers/sink.hh → src/driver/writers/sink.hh b/src/writers/sink.hh → src/driver/writers/sink.hh
diff --git a/src/writers/zarrv2.array.writer.cpp → src/driver/writers/zarrv2.array.writer.cpp b/src/writers/zarrv2.array.writer.cpp → src/driver/writers/zarrv2.array.writer.cpp
diff --git a/src/writers/zarrv2.array.writer.hh → src/driver/writers/zarrv2.array.writer.hh b/src/writers/zarrv2.array.writer.hh → src/driver/writers/zarrv2.array.writer.hh
diff --git a/src/writers/zarrv3.array.writer.cpp → src/driver/writers/zarrv3.array.writer.cpp b/src/writers/zarrv3.array.writer.cpp → src/driver/writers/zarrv3.array.writer.cpp
diff --git a/src/writers/zarrv3.array.writer.hh → src/driver/writers/zarrv3.array.writer.hh b/src/writers/zarrv3.array.writer.hh → src/driver/writers/zarrv3.array.writer.hh
diff --git a/src/zarr.cpp → src/driver/zarr.cpp b/src/zarr.cpp → src/driver/zarr.cpp
diff --git a/src/zarr.driver.c → src/driver/zarr.driver.c b/src/zarr.driver.c → src/driver/zarr.driver.c
diff --git a/src/zarr.hh → src/driver/zarr.hh b/src/zarr.hh → src/driver/zarr.hh
diff --git a/src/zarr.v2.cpp → src/driver/zarr.v2.cpp b/src/zarr.v2.cpp → src/driver/zarr.v2.cpp
diff --git a/src/zarr.v2.hh → src/driver/zarr.v2.hh b/src/zarr.v2.hh → src/driver/zarr.v2.hh
diff --git a/src/zarr.v3.cpp → src/driver/zarr.v3.cpp b/src/zarr.v3.cpp → src/driver/zarr.v3.cpp
diff --git a/src/zarr.v3.hh → src/driver/zarr.v3.hh b/src/zarr.v3.hh → src/driver/zarr.v3.hh
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
@@ -1,90 +1,7 @@
 if (${NOTEST})
     message(STATUS "Skipping test targets")
 else ()
-    set(NOTEST "TRUE")
-    add_subdirectory(../acquire-common/acquire-driver-common ${CMAKE_CURRENT_BINARY_DIR}/acquire-driver-common)
-    add_subdirectory(../acquire-common/acquire-video-runtime ${CMAKE_CURRENT_BINARY_DIR}/acquire-video-runtime)
-    set(NOTEST "FALSE")
-
-    #
-    # PARAMETERS
-    #
-    set(project acquire-driver-zarr) # CMAKE_PROJECT_NAME gets overridden if this is a subtree of another project
-
-    #
-    # Tests
-    #
-    set(tests
-            list-devices
-            unit-tests
-            get
-            get-meta
-            get-set-get
-            external-metadata-with-whitespace-ok
-            restart-stopped-zarr-resets-threadpool
-            repeat-start
-            metadata-dimension-sizes
-            write-zarr-v2-raw
-            write-zarr-v2-raw-chunk-size-larger-than-frame-size
-            write-zarr-v2-raw-with-even-chunking
-            write-zarr-v2-raw-with-even-chunking-and-rollover
-            write-zarr-v2-raw-with-ragged-chunking
-            write-zarr-v2-with-lz4-compression
-            write-zarr-v2-with-zstd-compression
-            write-zarr-v2-compressed-with-chunking
-            write-zarr-v2-compressed-with-chunking-and-rollover
-            write-zarr-v2-raw-multiscale
-            write-zarr-v2-raw-multiscale-with-trivial-tile-size
-            write-zarr-v2-compressed-multiscale
-            write-zarr-v2-to-s3
-            multiscales-metadata
-            write-zarr-v3-raw
-            write-zarr-v3-raw-with-ragged-sharding
-            write-zarr-v3-raw-chunk-exceeds-array
-            write-zarr-v3-compressed
-            write-zarr-v3-raw-multiscale
-            write-zarr-v3-to-s3
-    )
-
-    foreach (name ${tests})
-        set(tgt "${project}-${name}")
-        add_executable(${tgt} ${name}.cpp)
-        target_compile_definitions(${tgt} PUBLIC "TEST=\"${tgt}\"")
-        set_target_properties(${tgt} PROPERTIES
-                MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>"
-        )
-        target_include_directories(${tgt} PRIVATE "${CMAKE_CURRENT_LIST_DIR}/../")
-        target_link_libraries(${tgt}
-                acquire-core-logger
-                acquire-core-platform
-                acquire-video-runtime
-                nlohmann_json::nlohmann_json
-                miniocpp::miniocpp
-        )
-
-        add_test(NAME test-${tgt} COMMAND ${tgt})
-        set_tests_properties(test-${tgt} PROPERTIES LABELS "anyplatform;acquire-driver-zarr")
-    endforeach ()
-
-    #
-    # Copy driver to tests
-    #
-    list(POP_FRONT tests onename)
-
-    foreach (driver
-            acquire-driver-common
-            acquire-driver-zarr
-    )
-        add_custom_target(${project}-copy-${driver}-for-tests
-                COMMAND ${CMAKE_COMMAND} -E copy
-                $<TARGET_FILE:${driver}>
-                $<TARGET_FILE_DIR:${project}-${onename}>
-                DEPENDS ${driver}
-                COMMENT "Copying ${driver} to $<TARGET_FILE_DIR:${project}-${onename}>"
-        )
-
-        foreach (name ${tests})
-            add_dependencies(${tgt} ${project}-copy-${driver}-for-tests)
-        endforeach ()
-    endforeach ()
+    if (BUILD_ACQUIRE_DRIVER_ZARR)
+        add_subdirectory(driver)
+    endif ()
 endif ()
diff --git a/tests/driver/CMakeLists.txt b/tests/driver/CMakeLists.txt
@@ -0,0 +1,85 @@
+set(NOTEST "TRUE")
+add_subdirectory(${CMAKE_SOURCE_DIR}/acquire-common ${CMAKE_CURRENT_BINARY_DIR}/acquire-common)
+set(NOTEST "FALSE")
+
+#
+# PARAMETERS
+#
+set(project acquire-driver-zarr) # CMAKE_PROJECT_NAME gets overridden if this is a subtree of another project
+
+#
+# Tests
+#
+set(tests
+        list-devices
+        unit-tests
+        get
+        get-meta
+        get-set-get
+        external-metadata-with-whitespace-ok
+        restart-stopped-zarr-resets-threadpool
+        repeat-start
+        metadata-dimension-sizes
+        write-zarr-v2-raw
+        write-zarr-v2-raw-chunk-size-larger-than-frame-size
+        write-zarr-v2-raw-with-even-chunking
+        write-zarr-v2-raw-with-even-chunking-and-rollover
+        write-zarr-v2-raw-with-ragged-chunking
+        write-zarr-v2-with-lz4-compression
+        write-zarr-v2-with-zstd-compression
+        write-zarr-v2-compressed-with-chunking
+        write-zarr-v2-compressed-with-chunking-and-rollover
+        write-zarr-v2-raw-multiscale
+        write-zarr-v2-raw-multiscale-with-trivial-tile-size
+        write-zarr-v2-compressed-multiscale
+        write-zarr-v2-to-s3
+        multiscales-metadata
+        write-zarr-v3-raw
+        write-zarr-v3-raw-with-ragged-sharding
+        write-zarr-v3-raw-chunk-exceeds-array
+        write-zarr-v3-compressed
+        write-zarr-v3-raw-multiscale
+        write-zarr-v3-to-s3
+)
+
+foreach (name ${tests})
+    set(tgt "${project}-${name}")
+    add_executable(${tgt} ${name}.cpp)
+    target_compile_definitions(${tgt} PUBLIC "TEST=\"${tgt}\"")
+    set_target_properties(${tgt} PROPERTIES
+            MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>"
+    )
+    target_include_directories(${tgt} PRIVATE "${CMAKE_CURRENT_LIST_DIR}/../")
+    target_link_libraries(${tgt}
+            acquire-core-logger
+            acquire-core-platform
+            acquire-video-runtime
+            nlohmann_json::nlohmann_json
+            miniocpp::miniocpp
+    )
+
+    add_test(NAME test-${tgt} COMMAND ${tgt})
+    set_tests_properties(test-${tgt} PROPERTIES LABELS "anyplatform;acquire-driver-zarr")
+endforeach ()
+
+#
+# Copy driver to tests
+#
+list(POP_FRONT tests onename)
+
+foreach (driver
+        acquire-driver-common
+        acquire-driver-zarr
+)
+    add_custom_target(${project}-copy-${driver}-for-tests
+            COMMAND ${CMAKE_COMMAND} -E copy
+            $<TARGET_FILE:${driver}>
+            $<TARGET_FILE_DIR:${project}-${onename}>
+            DEPENDS ${driver}
+            COMMENT "Copying ${driver} to $<TARGET_FILE_DIR:${project}-${onename}>"
+    )
+
+    foreach (name ${tests})
+        add_dependencies(${tgt} ${project}-copy-${driver}-for-tests)
+    endforeach ()
+endforeach ()
diff --git a/tests/README.md → tests/driver/README.md b/tests/README.md → tests/driver/README.md
diff --git a/.../external-metadata-with-whitespace-ok.cpp → .../external-metadata-with-whitespace-ok.cpp b/.../external-metadata-with-whitespace-ok.cpp → .../external-metadata-with-whitespace-ok.cpp
diff --git a/tests/get-meta.cpp → tests/driver/get-meta.cpp b/tests/get-meta.cpp → tests/driver/get-meta.cpp
diff --git a/tests/get-set-get.cpp → tests/driver/get-set-get.cpp b/tests/get-set-get.cpp → tests/driver/get-set-get.cpp
diff --git a/tests/get.cpp → tests/driver/get.cpp b/tests/get.cpp → tests/driver/get.cpp
diff --git a/tests/list-devices.cpp → tests/driver/list-devices.cpp b/tests/list-devices.cpp → tests/driver/list-devices.cpp
diff --git a/tests/metadata-dimension-sizes.cpp → tests/driver/metadata-dimension-sizes.cpp b/tests/metadata-dimension-sizes.cpp → tests/driver/metadata-dimension-sizes.cpp
diff --git a/tests/multiscales-metadata.cpp → tests/driver/multiscales-metadata.cpp b/tests/multiscales-metadata.cpp → tests/driver/multiscales-metadata.cpp
diff --git a/tests/repeat-start.cpp → tests/driver/repeat-start.cpp b/tests/repeat-start.cpp → tests/driver/repeat-start.cpp
diff --git a/...estart-stopped-zarr-resets-threadpool.cpp → ...estart-stopped-zarr-resets-threadpool.cpp b/...estart-stopped-zarr-resets-threadpool.cpp → ...estart-stopped-zarr-resets-threadpool.cpp
diff --git a/tests/unit-tests.cpp → tests/driver/unit-tests.cpp b/tests/unit-tests.cpp → tests/driver/unit-tests.cpp
diff --git a/...s/write-zarr-v2-compressed-multiscale.cpp → ...r/write-zarr-v2-compressed-multiscale.cpp b/...s/write-zarr-v2-compressed-multiscale.cpp → ...r/write-zarr-v2-compressed-multiscale.cpp
diff --git a/...compressed-with-chunking-and-rollover.cpp → ...compressed-with-chunking-and-rollover.cpp b/...compressed-with-chunking-and-rollover.cpp → ...compressed-with-chunking-and-rollover.cpp
diff --git a/...rite-zarr-v2-compressed-with-chunking.cpp → ...rite-zarr-v2-compressed-with-chunking.cpp b/...rite-zarr-v2-compressed-with-chunking.cpp → ...rite-zarr-v2-compressed-with-chunking.cpp
diff --git a/...raw-chunk-size-larger-than-frame-size.cpp → ...raw-chunk-size-larger-than-frame-size.cpp b/...raw-chunk-size-larger-than-frame-size.cpp → ...raw-chunk-size-larger-than-frame-size.cpp
diff --git a/...raw-multiscale-with-trivial-tile-size.cpp → ...raw-multiscale-with-trivial-tile-size.cpp b/...raw-multiscale-with-trivial-tile-size.cpp → ...raw-multiscale-with-trivial-tile-size.cpp
diff --git a/tests/write-zarr-v2-raw-multiscale.cpp → ...s/driver/write-zarr-v2-raw-multiscale.cpp b/tests/write-zarr-v2-raw-multiscale.cpp → ...s/driver/write-zarr-v2-raw-multiscale.cpp
diff --git a/...2-raw-with-even-chunking-and-rollover.cpp → ...2-raw-with-even-chunking-and-rollover.cpp b/...2-raw-with-even-chunking-and-rollover.cpp → ...2-raw-with-even-chunking-and-rollover.cpp
diff --git a/.../write-zarr-v2-raw-with-even-chunking.cpp → .../write-zarr-v2-raw-with-even-chunking.cpp b/.../write-zarr-v2-raw-with-even-chunking.cpp → .../write-zarr-v2-raw-with-even-chunking.cpp
diff --git a/...rite-zarr-v2-raw-with-ragged-chunking.cpp → ...rite-zarr-v2-raw-with-ragged-chunking.cpp b/...rite-zarr-v2-raw-with-ragged-chunking.cpp → ...rite-zarr-v2-raw-with-ragged-chunking.cpp
diff --git a/tests/write-zarr-v2-raw.cpp → tests/driver/write-zarr-v2-raw.cpp b/tests/write-zarr-v2-raw.cpp → tests/driver/write-zarr-v2-raw.cpp
diff --git a/tests/write-zarr-v2-to-s3.cpp → tests/driver/write-zarr-v2-to-s3.cpp b/tests/write-zarr-v2-to-s3.cpp → tests/driver/write-zarr-v2-to-s3.cpp
diff --git a/tests/write-zarr-v2-with-lz4-compression.cpp → ...er/write-zarr-v2-with-lz4-compression.cpp b/tests/write-zarr-v2-with-lz4-compression.cpp → ...er/write-zarr-v2-with-lz4-compression.cpp
diff --git a/...s/write-zarr-v2-with-zstd-compression.cpp → ...r/write-zarr-v2-with-zstd-compression.cpp b/...s/write-zarr-v2-with-zstd-compression.cpp → ...r/write-zarr-v2-with-zstd-compression.cpp
diff --git a/tests/write-zarr-v3-compressed.cpp → tests/driver/write-zarr-v3-compressed.cpp b/tests/write-zarr-v3-compressed.cpp → tests/driver/write-zarr-v3-compressed.cpp
diff --git a/...write-zarr-v3-raw-chunk-exceeds-array.cpp → ...write-zarr-v3-raw-chunk-exceeds-array.cpp b/...write-zarr-v3-raw-chunk-exceeds-array.cpp → ...write-zarr-v3-raw-chunk-exceeds-array.cpp
diff --git a/tests/write-zarr-v3-raw-multiscale.cpp → ...s/driver/write-zarr-v3-raw-multiscale.cpp b/tests/write-zarr-v3-raw-multiscale.cpp → ...s/driver/write-zarr-v3-raw-multiscale.cpp
diff --git a/...rite-zarr-v3-raw-with-ragged-sharding.cpp → ...rite-zarr-v3-raw-with-ragged-sharding.cpp b/...rite-zarr-v3-raw-with-ragged-sharding.cpp → ...rite-zarr-v3-raw-with-ragged-sharding.cpp
diff --git a/tests/write-zarr-v3-raw.cpp → tests/driver/write-zarr-v3-raw.cpp b/tests/write-zarr-v3-raw.cpp → tests/driver/write-zarr-v3-raw.cpp
diff --git a/tests/write-zarr-v3-to-s3.cpp → tests/driver/write-zarr-v3-to-s3.cpp b/tests/write-zarr-v3-to-s3.cpp → tests/driver/write-zarr-v3-to-s3.cpp