Merge pull request #714 from openstudiocoalition/sketchup_2024

Updates for SketchUp 2024

Author: jmarrec

.github/workflows/app_build.yml

@@ -8,19 +8,21 @@ on:
       - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
   pull_request:
     branches: [ master, develop ]
+    types: [ opened, reopened, synchronize, ready_for_review ]
 
 env:
   BUILD_TYPE: Release
   BUILD_DOCUMENTATION: OFF
   BUILD_TESTING: ON
   BUILD_BENCHMARK: ON
   BUILD_PACKAGE: ON
-  QT_VERSION: 6.6.3
+  QT_VERSION: 6.5.2
+  QT_DEBUG_PLUGINS: 1
 
 jobs:
   build:
-    # Note: as of 2021-01-29, this only works for push, not for pull request
-    # if: "!(contains(github.event.head_commit.message, 'skip') && contains(github.event.head_commit.message, 'ci'))"
+    if: ${{ github.event_name == 'push' || !github.event.pull_request.draft }}
+
     runs-on: ${{ matrix.os }}
     continue-on-error: true
     strategy:
@@ -130,7 +132,7 @@ jobs:
         if [ "$RUNNER_OS" == "Linux" ]; then
           echo "Install needed system dependencies for OPENGL (due to Qt) for Linux"
           sudo apt update -qq
-          sudo apt install -y mesa-common-dev libglu1-mesa-dev patchelf ninja-build ccache libxkbcommon-x11-dev libgl1-mesa-dev chrpath libxcb-cursor0
+          sudo apt install -y mesa-common-dev libglu1-mesa-dev patchelf ninja-build ccache libxkbcommon-x11-dev libgl1-mesa-dev chrpath libxcb-icccm4 libxcb-keysyms1 libxcb-xkb1 libxcb-randr0 libxcb-shape0 libxkbcommon-x11-0 libxcb-cursor0
           gcc --version
 
           ccache --set-config=cache_dir=$CCACHE_DIR
@@ -405,7 +407,7 @@ jobs:
         cmake -E make_directory ./build
 
         if [ "$RUNNER_OS" == "macOS" ]; then
-          QT_INSTALL_DIR="/Users/irvinemac/Qt/6.6.3/macos/"
+          QT_INSTALL_DIR="/Users/irvinemac/Qt/$QT_VERSION/macos/"
         fi
 
         echo "$QT_INSTALL_DIR/bin" >> $GITHUB_PATH
@@ -552,9 +554,15 @@ jobs:
       # Execute tests defined by the CMake configuration.
       # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
       run: |
-        Xvfb :99 &
-        export DISPLAY=:99
-        ctest -j -T test --output-on-failure --no-compress-output -C $BUILD_TYPE || true
+        if [ "$RUNNER_OS" == "macOS" ]; then
+          automationmodetool
+          export XVFBCMD=""
+        elif [ "$RUNNER_OS" == "Windows" ]; then
+          export XVFBCMD=""
+        else
+          export XVFBCMD="xvfb-run"
+        fi
+        $XVFBCMD ctest -j -T test --output-on-failure --no-compress-output -C $BUILD_TYPE || true
 
     - name: Archive test results?
       uses: actions/upload-artifact@v4
@@ -568,9 +576,15 @@ jobs:
       # Execute tests defined by the CMake configuration.
       # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
       run: |
-        Xvfb :99 &
-        export DISPLAY=:99
-        Products/SpacesSurfaces_Benchmark --benchmark_out_format=csv --benchmark_out='bench_results_SpacesSurfaces.csv' || true
+        if [ "$RUNNER_OS" == "macOS" ]; then
+          automationmodetool
+          export XVFBCMD=""
+        elif [ "$RUNNER_OS" == "Windows" ]; then
+          export XVFBCMD=""
+        else
+          export XVFBCMD="xvfb-run"
+        fi
+        $XVFBCMD Products/SpacesSurfaces_Benchmark --benchmark_out_format=csv --benchmark_out='bench_results_SpacesSurfaces.csv' || true
 
     - name: Archive benchmark results?
       uses: actions/upload-artifact@v4

CMakeLists.txt

@@ -477,6 +477,8 @@ if(WIN32)
   # add_compile_definitions(BOOST_USE_WINDOWS_H) # Getting a confict with `typedef GUID UUID` from windows.h
   add_compile_definitions(BOOST_WINAPI_DEFINE_VERSION_MACROS)
   add_compile_definitions(WIN32_LEAN_AND_MEAN) # That excludes stuff that's not used too often, including the GUID stuff
+  # TODO: remove when possible, see https://github.com/microsoft/cpprestsdk/issues/1768
+  add_compile_definitions(_SILENCE_STDEXT_ARR_ITERS_DEPRECATION_WARNING)
 endif()
 
 # Check version of gcc
@@ -508,9 +510,18 @@ if(UNIX)
 endif()
 
 # Qt
-# e.g. QT_INSTALL_DIR = C:/Qt/6.6.3/msvc2019_64
+# e.g. QT_INSTALL_DIR = C:/Qt/6.5.2/msvc2019_64
 set(QT_INSTALL_DIR "" CACHE PATH "Path to Qt Install")
-set(QT_VERSION "6.6.3")
+set(QT_VERSION "6.5.2" CACHE STRING "Qt target version, defaults to 6.5.2")
+
+# For AboutBox, but also validates that the version is valid
+string(REGEX MATCH "^([0-9]+\\.[0-9]+)"
+  QT_VERSION_MAJOR_MINOR ${QT_VERSION})
+if(NOT QT_VERSION_MAJOR_MINOR)
+  message(FATAL_ERROR "Failed to match QT_VERSION=${QT_VERSION}")
+endif()
+set(QT_DOC_LINK "https://doc.qt.io/qt-${QT_VERSION_MAJOR_MINOR}/qtmodules.html")
+
 
 # TODO: how to set OPENSSL_ROOT_DIR to a generator expression?
 set(OPENSSL_ROOT_DIR ${CONAN_OPENSSL_ROOT_RELEASE})
@@ -534,7 +545,7 @@ find_file(qweb_resources NAMES qtwebengine_resources.pak PATHS "${QT_INSTALL_DIR
 find_file(qweb_resources_devtools NAMES qtwebengine_devtools_resources.pak PATHS "${QT_INSTALL_DIR}/resources/" "${QT_INSTALL_DIR}/lib/QtWebEngineCore.framework/Resources" NO_DEFAULT_PATH)
 find_file(qweb_resources_100 NAMES qtwebengine_resources_100p.pak PATHS "${QT_INSTALL_DIR}/resources/" "${QT_INSTALL_DIR}/lib/QtWebEngineCore.framework/Resources" NO_DEFAULT_PATH)
 find_file(qweb_resources_200 NAMES qtwebengine_resources_200p.pak PATHS "${QT_INSTALL_DIR}/resources/" "${QT_INSTALL_DIR}/lib/QtWebEngineCore.framework/Resources" NO_DEFAULT_PATH)
-find_file(qweb_resources_v8_context_snapshot NAMES v8_context_snapshot.bin PATHS "${QT_INSTALL_DIR}/resources/" "${QT_INSTALL_DIR}/lib/QtWebEngineCore.framework/Resources" NO_DEFAULT_PATH)
+#find_file(qweb_resources_v8_context_snapshot NAMES v8_context_snapshot.bin PATHS "${QT_INSTALL_DIR}/resources/" "${QT_INSTALL_DIR}/lib/QtWebEngineCore.framework/Resources" NO_DEFAULT_PATH)
 
 # QT_WEB_LIBS are linked by OS App and openstudio_lib but not by openstudio_modeleditor.so or openstudio_modeleditor
 list(APPEND QT_WEB_LIBS Qt6::WebEngineCore)
@@ -608,7 +619,7 @@ if(WIN32)
 endif()
 
 if(UNIX AND NOT APPLE)
-  # Apparently libqxcb.so depends on libQt6OpenGL.so in Qt 6.6.3 (it depended on libGL on 5.15.0 but not OpenGL)
+  # Apparently libqxcb.so depends on libQt6OpenGL.so in Qt 6 (it depended on libGL on 5.15.0 but not OpenGL)
   find_package(Qt6OpenGL ${QT_VERSION} REQUIRED PATHS ${QT_INSTALL_DIR} NO_DEFAULT_PATH)
   list(APPEND QT_LIBS Qt6::OpenGL)
 endif()

FindOpenStudioSDK.cmake

@@ -4,9 +4,9 @@ set(OPENSTUDIO_VERSION_PATCH 0)
 set(OPENSTUDIO_VERSION "${OPENSTUDIO_VERSION_MAJOR}.${OPENSTUDIO_VERSION_MINOR}.${OPENSTUDIO_VERSION_PATCH}")
 
 #If this is an official release, leave this "", otherwise put for eg '-rc1'
-set(OPENSTUDIO_VERSION_PRERELEASE "-rc2")
+set(OPENSTUDIO_VERSION_PRERELEASE "")
 # Enter SHA, always, eg "+79857912c4"
-set(OPENSTUDIO_VERSION_SHA "+af997f4fef")
+set(OPENSTUDIO_VERSION_SHA "+f953b6fcaf")
 
 # Paths where the cmake-downloaded archives will be put
 set(OPENSTUDIO_ARCHIVE_DIR "${PROJECT_BINARY_DIR}/OpenStudio-${OPENSTUDIO_VERSION}")
@@ -17,27 +17,27 @@ set(OPENSTUDIO_EXT "tar.gz")
 if(APPLE)
   set(OPENSTUDIO_PLATFORM "Darwin-${ARCH}")
   if(ARCH MATCHES "arm64")
-    set(OPENSTUDIO_EXPECTED_HASH 6a68bd93010d3fd5e7236913af956a76)
+    set(OPENSTUDIO_EXPECTED_HASH 0e983b1a7bd2eed2b27c866125e0716b)
   else()
-    set(OPENSTUDIO_EXPECTED_HASH bb5e18b91537125689590038177c85a4)
+    set(OPENSTUDIO_EXPECTED_HASH 8be3effb0599888511958999774df569)
   endif()
 
 elseif(UNIX)
   set(OPENSTUDIO_PLATFORM "${LSB_RELEASE_ID_SHORT}-${LSB_RELEASE_VERSION_SHORT}-${ARCH}")
   if(LSB_RELEASE_VERSION_SHORT MATCHES "22.04")
     if (ARCH MATCHES "arm64")
-      set(OPENSTUDIO_EXPECTED_HASH 57b2a8e706999a6eb1acbfbacf13241a)
+      set(OPENSTUDIO_EXPECTED_HASH ff544a9dfa4846de6af959a0c1ec926d)
     else()
-      set(OPENSTUDIO_EXPECTED_HASH 6b81e79fe69d0860d94922967b881855)
+      set(OPENSTUDIO_EXPECTED_HASH b14c71b37a01040f3216abc68488ed62)
     endif()
   elseif(LSB_RELEASE_VERSION_SHORT MATCHES "20.04")
-    set(OPENSTUDIO_EXPECTED_HASH 171510ee1a23d0542d0f71a9388d3bc3)
+    set(OPENSTUDIO_EXPECTED_HASH 98539ab193b15a140146add5e089900c)
   else()
     message(FATAL_ERROR "OpenStudio SDK no longer provides packages for Ubuntu 18.04")
   endif()
 
 elseif(WIN32)
-  set(OPENSTUDIO_EXPECTED_HASH 9230fddeb444a2792e575278c97c4335)
+  set(OPENSTUDIO_EXPECTED_HASH 26395d446a91a0042d3976cabd0fb5ab)
   set(OPENSTUDIO_PLATFORM "Windows")
 endif()
 

ProjectMacros.cmake

@@ -140,7 +140,7 @@ macro(CREATE_TEST_TARGETS BASE_NAME SRC DEPENDENCIES)
     endif()
 
     target_link_libraries(${BASE_NAME}_tests
-      gtest::gtest
+      GTest::gtest
       ${ALL_DEPENDENCIES}
     )
 

ci/clang-format.sh

@@ -33,14 +33,14 @@ then
 fi
 
 # first find if any files changed
-num=$(git diff $PR_BRANCH_NAME $TARGET_BRANCH_NAME --name-only | /bin/grep '.*\.\(cpp\|c\|cxx\|cxx.in\|hpp\|h\|hxx\|hxx.in\)$' | wc -l | tr -d '[:space:]')
+num=$(git diff $PR_BRANCH_NAME $TARGET_BRANCH_NAME --name-only | grep '.*\.\(cpp\|c\|cxx\|cxx.in\|hpp\|h\|hxx\|hxx.in\)$' | wc -l | tr -d '[:space:]')
 if [ $num -eq 0 ]
 then
   echo "No files of type (cpp, c, cxx, cxx.in, hpp, h, hxx, hxx.in) changed. Skipping clang-formatting"
   exit 0
 fi
 
-git diff $PR_BRANCH_NAME $TARGET_BRANCH_NAME --name-only | /bin/grep '.*\.\(cpp\|c\|cxx\|cxx.in\|hpp\|h\|hxx\|hxx.in\)$' | xargs clang-format -style=file -i -fallback-style=none
+git diff $PR_BRANCH_NAME $TARGET_BRANCH_NAME --name-only | grep '.*\.\(cpp\|c\|cxx\|cxx.in\|hpp\|h\|hxx\|hxx.in\)$' | xargs clang-format -style=file -i -fallback-style=none
 
 # clang-format will auto correct files so prepare the diff and use this as artifact
 git diff > clang_format.patch

developer/ruby/GitHubIssueStats.rb

@@ -61,7 +61,7 @@ def print_issue(issue)
 if !ENV['GITHUB_TOKEN'].nil?
   token = ENV['GITHUB_TOKEN']
   @github = Github.new oauth_token: token
-elsif File.exists?(Dir.home + '/github_config.yml')
+elsif File.exist?(Dir.home + '/github_config.yml')
   github_options = YAML.load_file(Dir.home + '/github_config.yml')
   token = github_options['oauth_token']
   @github = Github.new oauth_token: token

ruby/CMakeLists.txt

@@ -112,53 +112,91 @@ if(BUILD_TESTING)
   # find all tests
   file(GLOB RUBY_TEST_SRC "test/*.rb")
 
-  # TODO: It doesn't work with this executable that's in build/Ruby-install/bin
-  # message("RUBY_EXECUTABLE=${RUBY_EXECUTABLE}")
 
-  # I added FindRuby.cmake from cmake 3.18.2 (after patching cmake to support versions greater than 2 and adding RVM support) in the CMake folder which is part of the CMAKE_MODULE_PATH
-  set(Ruby_FIND_VIRTUALENV FIRST)
-  find_package(Ruby 2.7)
+  # **NOTE**: we do not want to grab the conan one, which is statically built on all platforms, and is a msvc build on windows
+  # Instead, we want to grab the regularly installed one on your system
 
-  if(NOT Ruby_EXECUTABLE)
-    message(WARNING "Your system ruby wasn't found, you won't be able to run the `ctest -R RubyTest` command and the tests won't be created at all.")
-  else()
-    message(STATUS "Found Ruby_EXECUTABLE=${Ruby_EXECUTABLE}")
-  endif()
+  set(_RUBY_POSSIBLE_EXECUTABLE_NAMES
+    ruby
+    ruby3.2
+    ruby3.2.2
+    ruby32
+    ruby322
+  )
 
-  # add a test for each unit test
-  set(RUBY_TEST_REQUIRES "#include test files")
-  foreach(f ${RUBY_TEST_SRC})
+  # TODO: this isn't great but I haven't found a better way to locate the system ruby (and avoid the conan one)
+  find_program(SYSTEM_RUBY_EXECUTABLE NAMES ${_RUBY_POSSIBLE_EXECUTABLE_NAMES}
+    HINTS
+      "/usr/local/rvm/rubies/ruby-3.2.2/bin/"
+      "/usr/local/rvm/rubies/ruby-3.2.2/bin/ruby"
+      "/usr/share/rvm/rubies/ruby-3.2.2/bin/"
+      "$ENV{HOME}/.rvm/rubies/ruby-3.2.2/bin/"
+      "$ENV{HOME}/.rbenv/versions/3.2.2/bin/"
+
+      "C:/Ruby32-x64/bin/"
+
+       "/usr/local/ruby322/bin/"
+       "/usr/local/ruby32/bin/"
+       "/usr/bin/"
+       "/usr/local/bin/"
+
+    NO_DEFAULT_PATH)
+
+  if(SYSTEM_RUBY_EXECUTABLE)
+    # Validate the version
+    execute_process (COMMAND "${SYSTEM_RUBY_EXECUTABLE}" -e "puts RUBY_VERSION"
+      RESULT_VARIABLE _result
+      OUTPUT_VARIABLE _system_ruby_version
+      ERROR_QUIET
+      OUTPUT_STRIP_TRAILING_WHITESPACE)
+    if(_result OR (_system_ruby_version VERSION_LESS 3.2) OR (_system_ruby_version VERSION_GREATER_EQUAL 3.3))
+      if(_result)
+        message(WARNING "Cannot use the interpreter \"${SYSTEM_RUBY_EXECUTABLE}\"")
+      else()
+        message(WARNING "Wrong version \"${_system_ruby_version}\" for the interpreter \"${SYSTEM_RUBY_EXECUTABLE}\", not >= 3.2 < 3.3")
+      endif()
+      set_property (CACHE SYSTEM_RUBY_EXECUTABLE PROPERTY VALUE "SYSTEM_RUBY_EXECUTABLE-NOTFOUND")
+    else()
+      message(STATUS "Found SYSTEM_RUBY_EXECUTABLE=${SYSTEM_RUBY_EXECUTABLE} with version ${_system_ruby_version}")
+    endif()
+   endif()
+
+  if(NOT SYSTEM_RUBY_EXECUTABLE)
+    message(WARNING "A valid system ruby (3.2.2 or near) wasn't found, you won't be able to run the `ctest -R RubyTest` command and the tests won't be created at all.")
+  else()
+    # add a test for each unit test
+    set(RUBY_TEST_REQUIRES "#include test files")
+    foreach(f ${RUBY_TEST_SRC})
 
-    file(READ "${f}" CONTENTS)
-    string(REGEX MATCHALL "def +test_([A-Za-z_0-9 ]+)" FOUND_TESTS ${CONTENTS})
+      file(READ "${f}" CONTENTS)
+      string(REGEX MATCHALL "def +test_([A-Za-z_0-9 ]+)" FOUND_TESTS ${CONTENTS})
 
-    foreach(HIT ${FOUND_TESTS})
-      string(REGEX REPLACE "def +test_([A-Za-z_0-9]+)" "\\1" TEST_NAME ${HIT})
-      string(REGEX MATCH "/?([A-Za-z_0-9 ]+)\\.rb" FILE_NAME ${f})
-      string(REGEX REPLACE "/?([A-Za-z_0-9 ]+)\\.rb" "\\1" FILE_NAME ${FILE_NAME})
+      foreach(HIT ${FOUND_TESTS})
+        string(REGEX REPLACE "def +test_([A-Za-z_0-9]+)" "\\1" TEST_NAME ${HIT})
+        string(REGEX MATCH "/?([A-Za-z_0-9 ]+)\\.rb" FILE_NAME ${f})
+        string(REGEX REPLACE "/?([A-Za-z_0-9 ]+)\\.rb" "\\1" FILE_NAME ${FILE_NAME})
 
-      # DLM: Cannot load openstudio_modeleditor.so into CLI because linked with different version of Ruby
-      # CLI Test
-      #add_test(NAME "OSApp-CLITest-${FILE_NAME}-${TEST_NAME}"
-      #  COMMAND "${CMAKE_COMMAND}" -E chdir "${CMAKE_CURRENT_BINARY_DIR}"
-      #    "${openstudio_EXECUTABLE}" "-I" "$<TARGET_FILE_DIR:openstudio_modeleditor_rb>"
-      #    "${f}" "--name=test_${TEST_NAME}"
-      #)
+        set(CTEST_NAME "OSApp-RubyTest-${FILE_NAME}-${TEST_NAME}")
 
-      #set_tests_properties("OSApp-CLITest-${FILE_NAME}-${TEST_NAME}" PROPERTIES TIMEOUT 660 )
+        # DLM: Cannot load openstudio_modeleditor.so into CLI because linked with different version of Ruby
+        # CLI Test
+        #add_test(NAME "OSApp-CLITest-${FILE_NAME}-${TEST_NAME}"
+        #  COMMAND "${CMAKE_COMMAND}" -E chdir "${CMAKE_CURRENT_BINARY_DIR}"
+        #    "${openstudio_EXECUTABLE}" "-I" "$<TARGET_FILE_DIR:openstudio_modeleditor_rb>"
+        #    "${f}" "--name=test_${TEST_NAME}"
+        #)
 
-      if (Ruby_EXECUTABLE)
         # Call with Ruby itself
-        add_test(NAME "OSApp-RubyTest-${FILE_NAME}-${TEST_NAME}"
+        add_test(NAME "${CTEST_NAME}"
           COMMAND "${CMAKE_COMMAND}" -E chdir "${CMAKE_CURRENT_BINARY_DIR}"
-            "${Ruby_EXECUTABLE}" "-I" "$<TARGET_FILE_DIR:openstudio::openstudio_rb>" # Or just ${openstudio_ROOT_DIR}/Ruby
+          "${SYSTEM_RUBY_EXECUTABLE}" "-I" "$<TARGET_FILE_DIR:openstudio::openstudio_rb>" # Or just ${openstudio_ROOT_DIR}/Ruby
             "-I" "$<TARGET_FILE_DIR:openstudio_modeleditor_rb>"
             "${f}" "--name=test_${TEST_NAME}"
         )
-
-        set_tests_properties("OSApp-RubyTest-${FILE_NAME}-${TEST_NAME}" PROPERTIES TIMEOUT 660 )
-      endif()
+        set_tests_properties("${CTEST_NAME}" PROPERTIES TIMEOUT 660 )
+      endforeach()
 
     endforeach()
-  endforeach()
+
+  endif()
 endif()

ruby/openstudio_modeleditor.rb

@@ -51,12 +51,12 @@ module WinAPI
   qt_dll_path = File.expand_path(File.join(File.dirname(__FILE__), '../bin/'))
 
   # if install path fails, try developer paths
-  if !File.exists?(File.join(qt_dll_path, 'Qt5Core.dll'))
+  if !File.exist?(File.join(qt_dll_path, 'Qt6Core.dll'))
     release_dll_path = File.expand_path(File.join(File.dirname(__FILE__), '../../Release/'))
     debug_dll_path = File.expand_path(File.join(File.dirname(__FILE__), '../../Debug/'))
-    if File.exists?(File.join(release_dll_path, 'Qt5Core.dll'))
+    if File.exist?(File.join(release_dll_path, 'Qt6Core.dll'))
       qt_dll_path = release_dll_path
-    elsif File.exists?(File.join(debug_dll_path, 'Qt5Core.dll'))
+    elsif File.exist?(File.join(debug_dll_path, 'Qt6Core.dll'))
       qt_dll_path = debug_dll_path
     end
   end

ruby/test/PathWatcher_Test.rb

@@ -116,42 +116,8 @@ def test_watchDir
     p = OpenStudio::Path.new("./")
     assert(OpenStudio::exists(p))
 
-    filePath = OpenStudio::Path.new("./path_watcher_dir")
-    if OpenStudio::exists(filePath)
-      OpenStudio::remove(filePath)
-    end
-    assert((not OpenStudio::exists(filePath)))
-
-    watcher = TestPathWatcher.new(p)
-    assert((not watcher.changed))
-
-    filePath = OpenStudio::Path.new("./path_watcher_dir")
-    File.open(filePath.to_s, 'w') do |f|
-      f << "test 1"
-	  begin
-		f.fsync
-	  rescue
-	    f.flush
-	  end
-    end
-    assert(OpenStudio::exists(filePath))
-
-    # calls processEvents
-    OpenStudio::System::msleep(10000)
-    OpenStudio::Modeleditor::Application::instance().processEvents(10000)
-
-    assert(watcher.changed)
-    watcher.changed = false
-    assert((not watcher.changed))
-
-    OpenStudio::remove(filePath)
-    assert((not OpenStudio::exists(filePath)))
-
-    # calls processEvents
-    OpenStudio::System::msleep(10000)
-    OpenStudio::Modeleditor::Application::instance().processEvents(10000)
-
-    assert(watcher.changed)
+    # try existent dir
+    assert_raises(RuntimeError){TestPathWatcher.new(OpenStudio::Path.new(p))}
 
     # try non-existent dir
     assert_raises(RuntimeError){TestPathWatcher.new(OpenStudio::Path.new("./I do not exist/"))}