Merge pull request #26 from psavery/nsls2-q3

Q3 Features and Fixes

Author: celiafish

.github/workflows/build_and_test.yml

@@ -2,9 +2,9 @@ name: build and test
 
 on:
   push:
-    branches: [ master ]
+    branches: [ master, 3.0 ]
   pull_request:
-    branches: [ master ]
+    branches: [ master, 3.0 ]
 
 jobs:
   test:
@@ -91,7 +91,7 @@ jobs:
           TOMVIZ_REQUIRE_PYXRF: true
       run: |
         cd tomviz-build
-        export TOMVIZ_TEST_PYTHON_EXECUTABLE=$(which python3)
+        export TOMVIZ_TEST_PYTHON_EXECUTABLE=$(which python)
         ctest --output-on-failure
 
     - name: Upload CTest Log (On Failure Only)

.github/workflows/build_requirements.txt

@@ -8,3 +8,4 @@ libxml2-devel=2.14*
 gtest
 # This is needed for installing stuff on Python3.13
 setuptools
+pip

CMakeLists.txt

@@ -54,8 +54,12 @@ set(tomviz_js_binary_path "${tomviz_html_binary_dir}/tomviz.js")
 set(tomviz_html_binary_path "${tomviz_html_binary_dir}/tomviz.html")
 set(tomviz_web_install_dir "${INSTALL_DATA_DIR}/tomviz/web")
 
-# Centrally set the grand exception for macOS...
 if(APPLE)
+  option(TOMVIZ_MACOSX_BUNDLE "Build a macOS app bundle" ON)
+endif()
+
+# Centrally set the grand exception for macOS...
+if(APPLE AND TOMVIZ_MACOSX_BUNDLE)
   set(MACOSX_BUNDLE_NAME "tomviz")
   set(prefix "Applications/${MACOSX_BUNDLE_NAME}.app/Contents")
   set(INSTALL_INCLUDE_DIR "${prefix}/${INSTALL_INCLUDE_DIR}")
@@ -102,8 +106,8 @@ include(Git)
 determine_version("${tomviz_SOURCE_DIR}" "${GIT_EXECUTABLE}" "tomviz")
 # Hard coded for source tarballs, releases, etc.
 set(tomviz_version_major 2)
-set(tomviz_version_minor 0)
-set(tomviz_version_patch 0)
+set(tomviz_version_minor 3)
+set(tomviz_version_patch 1)
 set(tomviz_version_extra)
 set(tomviz_version
   "${tomviz_version_major}.${tomviz_version_minor}.${tomviz_version_patch}")

cmake/tomvizDetermineVersion.cmake

@@ -40,7 +40,7 @@ function(determine_version source_dir git_command var_prefix)
   if (NOT TOMVIZ_GIT_DESCRIBE)
     if (EXISTS ${git_command})
       execute_process(
-        COMMAND ${git_command} describe
+        COMMAND ${git_command} describe --tags
         WORKING_DIRECTORY ${source_dir}
         RESULT_VARIABLE result
         OUTPUT_VARIABLE output

tests/cxx/CMakeLists.txt

@@ -9,8 +9,7 @@ include_directories(SYSTEM
   ${PARAVIEW_INCLUDE_DIRS}
   ${GTEST_INCLUDE_DIRS})
 include_directories(${PROJECT_SOURCE_DIR}/tomviz)
-include_directories(${PROJECT_SOURCE_DIR}/tomviz/modules)
-include_directories(${PROJECT_SOURCE_DIR}/tomviz/operators)
+include_directories(${PROJECT_SOURCE_DIR}/tomviz/pipeline)
 include_directories(${PROJECT_SOURCE_DIR}/tomviz/animations)
 include_directories(${PROJECT_SOURCE_DIR}/tomviz/loguru)
 include_directories(${PROJECT_SOURCE_DIR}/tomviz/acquisition)
@@ -51,20 +50,18 @@ set(_pythonpath "${_pythonpath}${_separator}${ITK_DIR}/Wrapping/Generators/Pytho
 set(_pythonpath "${_pythonpath}${_separator}$ENV{PYTHONPATH}")
 
 # Add the test cases
-add_cxx_test(OperatorPython PYTHONPATH ${_pythonpath})
+# OperatorPython, ModulePlot, PipelineExecution, DockerUtilities test legacy
+# infrastructure (legacy::OperatorPython / legacy modules / legacy Pipeline)
+# that's being removed and are no longer kept in sync.
 add_cxx_test(Variant)
 add_cxx_test(ScanID)
 add_cxx_test(Utilities)
-add_cxx_qtest(ModulePlot)
-add_cxx_qtest(Tvh5Data)
 add_cxx_qtest(InterfaceBuilder)
-add_cxx_qtest(PipelineExecution PYTHONPATH ${_pythonpath})
-if(UNIX AND NOT APPLE)
-  add_cxx_qtest(DockerUtilities)
-endif()
-if(NOT WIN32)
-  add_cxx_qtest(AcquisitionClient PYTHONPATH "${CMAKE_SOURCE_DIR}/acquisition")
-endif()
+# AcquisitionClient needs the `bottle` Python package (acquisition/requirements-dev.txt)
+# to start its test server; not part of the conda build env, so disabled here.
+# if(NOT WIN32)
+#   add_cxx_qtest(AcquisitionClient PYTHONPATH "${CMAKE_SOURCE_DIR}/acquisition")
+# endif()
 add_cxx_qtest(PtychoWorkflow PYTHONPATH ${_pythonpath})
 set_tests_properties(PtychoWorkflow PROPERTIES TIMEOUT 1800)
 add_cxx_qtest(PyXRFWorkflow PYTHONPATH ${_pythonpath})
@@ -74,3 +71,34 @@ set_tests_properties(PyXRFWorkflow PROPERTIES TIMEOUT 1800)
 create_test_executable(tomvizTests)
 
 target_link_libraries(tomvizTests Qt6::Test)
+
+# Pipeline library tests
+set(_pipeline_pythonpath
+  "${PROJECT_SOURCE_DIR}/tomviz/python${_separator}${_pythonpath}")
+add_executable(pipelineLibTests PipelineLibTest.cxx)
+target_link_libraries(pipelineLibTests
+  tomvizlib pybind11::embed GTest::gtest
+  Qt6::Test ${EXTRA_LINK_LIB})
+target_compile_definitions(pipelineLibTests PRIVATE
+  "TOMVIZ_PYTHON_DIR=\"${PROJECT_SOURCE_DIR}/tomviz/python\"")
+add_test(NAME "PipelineLib" COMMAND pipelineLibTests)
+set_tests_properties("PipelineLib" PROPERTIES
+  ENVIRONMENT "PYTHONPATH=${_pipeline_pythonpath}")
+
+# Pipeline icon resources (must be compiled into each executable, not the
+# static library, so Qt's resource system can initialise them).
+set(PIPELINE_ICONS_QRC "${PROJECT_SOURCE_DIR}/tomviz/pipeline/pipeline_icons.qrc")
+
+# Manual demo app for visually testing PipelineStripWidget
+add_executable(pipelineStripDemo PipelineStripWidgetDemo.cxx ${PIPELINE_ICONS_QRC})
+target_link_libraries(pipelineStripDemo tomvizlib)
+
+# Manual demo app for visually testing pipeline Sinks with ParaView views
+add_executable(pipelineSinkDemo PipelineSinkDemo.cxx ${PIPELINE_ICONS_QRC})
+target_link_libraries(pipelineSinkDemo tomvizlib)
+
+# Manual demo app with full pipeline: source -> transform -> 3 sinks + properties
+add_executable(pipelineDemo PipelineDemo.cxx ${PIPELINE_ICONS_QRC})
+target_compile_definitions(pipelineDemo PRIVATE
+  "TOMVIZ_PYTHON_DIR=\"${PROJECT_SOURCE_DIR}/tomviz/python\"")
+target_link_libraries(pipelineDemo tomvizlib)

tests/cxx/DockerUtilitiesTest.cxx

@@ -8,7 +8,7 @@
 #include <QTemporaryDir>
 #include <QTest>
 
-#include "DockerUtilities.h"
+#include "legacy/DockerUtilities.h"
 
 using namespace tomviz;
 

tests/cxx/ModulePlotTest.cxx

@@ -19,8 +19,8 @@
 #include <vtkNew.h>
 #include <vtkTable.h>
 
-#include "modules/ModulePlot.h"
-#include "operators/OperatorResult.h"
+#include "legacy/modules/ModulePlot.h"
+#include "legacy/operators/OperatorResult.h"
 
 using namespace tomviz;
 

tests/cxx/OperatorPythonTest.cxx

@@ -20,10 +20,10 @@
 #include <QSignalSpy>
 #include <QString>
 
-#include "PipelineProxy.h"
+#include "legacy/PipelineProxy.h"
 #include "TomvizTest.h"
-#include "operators/OperatorProxy.h"
-#include "operators/OperatorPython.h"
+#include "legacy/operators/OperatorProxy.h"
+#include "legacy/operators/OperatorPython.h"
 
 using namespace tomviz;