Add minimalistic smoke flow and consumption reference

Author: AnastaZIuk

docs/consume/README.md

@@ -182,3 +182,18 @@ Note:
 - this is a known issue on Nabla side and will be refactored
 - do not propagate that pattern to package consumers
 - consumer-facing package helpers are designed to avoid exposing absolute paths in consumer compile definitions
+
+## 9. Smoke reference
+
+`smoke/` is a reference consumer for Nabla package consumption.
+
+It contains multiple usage flows:
+
+- `MINIMALISTIC` link-only consumption without helper calls
+- `CONFIGURE_ONLY` helper-based configure-time runtime sync
+- `BUILD_ONLY` helper-based build-time runtime sync
+
+Flow selection is done with `NBL_SMOKE_FLOW` in `smoke/CMakeLists.txt` and `FLOW` in `smoke/RunSmokeFlow.cmake`.
+
+Smoke is also used as CI coverage for package consumption flows.  
+The `smoke-tests` job in `.github/workflows/build-nabla.yml` runs those flows as end-to-end checks.

smoke/CMakeLists.txt

@@ -32,13 +32,15 @@ target_link_libraries(smoke PRIVATE Nabla::Nabla)
 target_compile_definitions(smoke PRIVATE _AFXDLL)
 target_precompile_headers(smoke PRIVATE pch.hpp)
 
-set(NBL_SMOKE_FLOW "CONFIGURE_ONLY" CACHE STRING "Smoke runtime flow: CONFIGURE_ONLY or BUILD_ONLY")
-set_property(CACHE NBL_SMOKE_FLOW PROPERTY STRINGS CONFIGURE_ONLY BUILD_ONLY)
+set(NBL_SMOKE_FLOW "CONFIGURE_ONLY" CACHE STRING "Smoke runtime flow: MINIMALISTIC, CONFIGURE_ONLY or BUILD_ONLY")
+set_property(CACHE NBL_SMOKE_FLOW PROPERTY STRINGS MINIMALISTIC CONFIGURE_ONLY BUILD_ONLY)
 string(TOUPPER "${NBL_SMOKE_FLOW}" NBL_SMOKE_FLOW)
 message(STATUS "Smoke runtime flow: ${NBL_SMOKE_FLOW}")
 option(NBL_SMOKE_INSTALL_SELFTEST "Install smoke with CTest metadata and run tests from install tree" ON)
 
-if(NBL_SMOKE_FLOW STREQUAL "CONFIGURE_ONLY")
+if(NBL_SMOKE_FLOW STREQUAL "MINIMALISTIC")
+    message(STATUS "Smoke minimalistic flow uses only package default runtime lookup")
+elseif(NBL_SMOKE_FLOW STREQUAL "CONFIGURE_ONLY")
     nabla_setup_runtime_modules(
         TARGETS smoke
         RUNTIME_MODULES_SUBDIR "Libraries"

smoke/RunSmokeFlow.cmake

@@ -1,10 +1,10 @@
 if(NOT DEFINED FLOW)
-    message(FATAL_ERROR "FLOW is required. Allowed values: CONFIGURE_ONLY, BUILD_ONLY")
+    message(FATAL_ERROR "FLOW is required. Allowed values: MINIMALISTIC, CONFIGURE_ONLY, BUILD_ONLY")
 endif()
 
 string(TOUPPER "${FLOW}" FLOW)
-if(NOT FLOW MATCHES "^(CONFIGURE_ONLY|BUILD_ONLY)$")
-    message(FATAL_ERROR "Invalid FLOW='${FLOW}'. Allowed values: CONFIGURE_ONLY, BUILD_ONLY")
+if(NOT FLOW MATCHES "^(MINIMALISTIC|CONFIGURE_ONLY|BUILD_ONLY)$")
+    message(FATAL_ERROR "Invalid FLOW='${FLOW}'. Allowed values: MINIMALISTIC, CONFIGURE_ONLY, BUILD_ONLY")
 endif()
 
 if(NOT DEFINED CONFIG)
@@ -44,12 +44,17 @@ endfunction()
 
 file(REMOVE_RECURSE "${BUILD_DIR}")
 
+set(_run_install_selftest ON)
+if(FLOW STREQUAL "MINIMALISTIC")
+    set(_run_install_selftest OFF)
+endif()
+
 run_cmd(
     "${CMAKE_COMMAND}"
     -S "${SMOKE_SOURCE_DIR}"
     -B "${BUILD_DIR}"
     -D "NBL_SMOKE_FLOW=${FLOW}"
-    -D "NBL_SMOKE_INSTALL_SELFTEST=ON"
+    -D "NBL_SMOKE_INSTALL_SELFTEST=${_run_install_selftest}"
 )
 
 run_cmd(
@@ -68,21 +73,23 @@ run_cmd(
     -C "${CONFIG}"
 )
 
-file(REMOVE_RECURSE "${INSTALL_DIR}")
+if(_run_install_selftest)
+    file(REMOVE_RECURSE "${INSTALL_DIR}")
 
-run_cmd(
-    "${CMAKE_COMMAND}"
-    --install "${BUILD_DIR}"
-    --config "${CONFIG}"
-    --prefix "${INSTALL_DIR}"
-)
+    run_cmd(
+        "${CMAKE_COMMAND}"
+        --install "${BUILD_DIR}"
+        --config "${CONFIG}"
+        --prefix "${INSTALL_DIR}"
+    )
 
-run_cmd(
-    "${CTEST_BIN}"
-    --verbose
-    --test-dir "${INSTALL_DIR}"
-    --force-new-ctest-process
-    --output-on-failure
-    --no-tests=error
-    -C "${CONFIG}"
-)
+    run_cmd(
+        "${CTEST_BIN}"
+        --verbose
+        --test-dir "${INSTALL_DIR}"
+        --force-new-ctest-process
+        --output-on-failure
+        --no-tests=error
+        -C "${CONFIG}"
+    )
+endif()