Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates for SketchUp 2024 #714

Merged
merged 33 commits into from
May 30, 2024
Merged

Updates for SketchUp 2024 #714

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
bfcf310
Updates for SketchUp 2024
macumber May 17, 2024
377c9d3
One more File.exists
jmarrec May 17, 2024
48d1f9d
Fixup looking for system ruby for running tests
jmarrec May 17, 2024
50f155a
Use same major and minor version of Qt as SketchUp
macumber May 18, 2024
2751769
Don't run workflow if PR is draft
macumber May 18, 2024
f0b8a25
Trigger CI when PR is marked ready for review
macumber May 19, 2024
598c17d
Update to official 3.8.0 packages
macumber May 19, 2024
fff53cf
Update resources
macumber May 20, 2024
55cfab6
Update .github/workflows/app_build.yml
jmarrec May 21, 2024
6473833
Unrelated update AboutBox and model_editor fallbacks for Qt6
jmarrec May 23, 2024
d4f56e7
Allow passing QT_VERSION (default 6.5.3) - Update Qt version in about…
jmarrec May 23, 2024
ae7730b
Make Ruby3 compatible
macumber May 25, 2024
b70a120
Try calling automationmodetool
macumber May 25, 2024
d86d19f
Fix some bugs
macumber May 26, 2024
4ef58a9
Merge branch 'sketchup_2024' of github.com:openstudiocoalition/OpenSt…
macumber May 26, 2024
7d30090
clang format
macumber May 26, 2024
addfaf0
Try the gtest/QApplication workaround
macumber May 26, 2024
4e1dee8
Missed this file
macumber May 26, 2024
f35dda7
Apply fix to benchmark as well, remove PathWatcher support for direct…
macumber May 26, 2024
5dea4d3
Clean up documentation
macumber May 26, 2024
427d60d
Clang format
macumber May 26, 2024
03018ef
Move to Qt 6.5.2
macumber May 26, 2024
1157124
Fix ruby test
macumber May 26, 2024
fbe0d12
Merge branch 'sketchup_2024' of github.com:openstudiocoalition/OpenSt…
macumber May 26, 2024
dbaa0c4
Try to fix tests on Ubuntu
macumber May 26, 2024
6e95292
libxcb -> libxcb-icccm4
macumber May 27, 2024
67dac8d
More libxcb
macumber May 27, 2024
4ac00c2
Remove missing packages
macumber May 27, 2024
1d8597a
Use versions that exist
macumber May 27, 2024
ff6c20e
Temp disable other platforms to get remaining libxcb issues
macumber May 27, 2024
051b028
Add libxcb-shape
macumber May 27, 2024
4cd5ac0
Finally got tests working on Ubuntu
macumber May 27, 2024
808ff08
Merge branch 'develop' into sketchup_2024
macumber May 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/app_build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ env:
BUILD_TESTING: ON
BUILD_BENCHMARK: ON
BUILD_PACKAGE: ON
QT_VERSION: 6.6.3
QT_VERSION: 6.5.3
Copy link
Collaborator

@jmarrec jmarrec May 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yikes. That's for sketchup using a different Qt then. How was it working before though? Is Qt a new sketchup dependency?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok I follow now. Sketchup was using Qt 5 until 2023.1 where it switched to Qt 6.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I don't really like having our Qt version tied to SketchUp's. That is the idea of eventually removing all the Qt stuff from the SketchUp Plug-in, the biggest thing to replace is the Inspector Dialog which is not that hard but it isn't trivial.


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 }}
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jmarrec what do you think about this? I can't remember when we would want to use 'skip' or 'ci' instead?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm the way I have it now marking as "Ready to Review" doesn't trigger the build, I'll work on that.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok now it runs when marked ready for review

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So you can push a commit with "[skip ci]" in the commit message and the run won't be triggered.

But this is now baked into github actions anyways; https://docs.github.com/en/actions/managing-workflow-runs/skipping-workflow-runs


runs-on: ${{ matrix.os }}
continue-on-error: true
strategy:
Expand Down Expand Up @@ -405,7 +405,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/6.5.3/macos/"
fi

echo "$QT_INSTALL_DIR/bin" >> $GITHUB_PATH
Expand Down
10 changes: 6 additions & 4 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -508,9 +510,9 @@ 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.3/msvc2019_64
set(QT_INSTALL_DIR "" CACHE PATH "Path to Qt Install")
set(QT_VERSION "6.6.3")
set(QT_VERSION "6.5.3")

# TODO: how to set OPENSSL_ROOT_DIR to a generator expression?
set(OPENSSL_ROOT_DIR ${CONAN_OPENSSL_ROOT_RELEASE})
Expand All @@ -534,7 +536,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)
Expand Down Expand Up @@ -608,7 +610,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.5.3 (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()
Expand Down
2 changes: 1 addition & 1 deletion developer/ruby/GitHubIssueStats.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
106 changes: 72 additions & 34 deletions ruby/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
6 changes: 3 additions & 3 deletions ruby/openstudio_modeleditor.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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, 'Qt5Core.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, 'Qt5Core.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, 'Qt5Core.dll'))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we looking for Qt5? I suppose "if install path fails" is always false then.

qt_dll_path = debug_dll_path
end
end
Expand Down
4 changes: 2 additions & 2 deletions src/openstudio_app/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ elseif( UNIX )
COMMAND ${CMAKE_COMMAND} -E copy_if_different ${qweb_resources_devtools} $<TARGET_FILE_DIR:${target_name}>/resources/
COMMAND ${CMAKE_COMMAND} -E copy_if_different ${qweb_resources_100} $<TARGET_FILE_DIR:${target_name}>/resources/
COMMAND ${CMAKE_COMMAND} -E copy_if_different ${qweb_resources_200} $<TARGET_FILE_DIR:${target_name}>/resources/
COMMAND ${CMAKE_COMMAND} -E copy_if_different ${qweb_resources_v8_context_snapshot} $<TARGET_FILE_DIR:${target_name}>/resources/
#COMMAND ${CMAKE_COMMAND} -E copy_if_different ${qweb_resources_v8_context_snapshot} $<TARGET_FILE_DIR:${target_name}>/resources/
)

# Note: JM: Qt 6.3.0, I can no longer access $<TARGET_FILE:Qt6::QXcbIntegrationPlugin>
Expand Down Expand Up @@ -272,7 +272,7 @@ elseif( WIN32 )
COMMAND ${CMAKE_COMMAND} -E copy_if_different ${qweb_resources_devtools} $<TARGET_FILE_DIR:${target_name}>/resources/
COMMAND ${CMAKE_COMMAND} -E copy_if_different ${qweb_resources_100} $<TARGET_FILE_DIR:${target_name}>/resources/
COMMAND ${CMAKE_COMMAND} -E copy_if_different ${qweb_resources_200} $<TARGET_FILE_DIR:${target_name}>/resources/
COMMAND ${CMAKE_COMMAND} -E copy_if_different ${qweb_resources_v8_context_snapshot} $<TARGET_FILE_DIR:${target_name}>/resources/
#COMMAND ${CMAKE_COMMAND} -E copy_if_different ${qweb_resources_v8_context_snapshot} $<TARGET_FILE_DIR:${target_name}>/resources/
)

# On Windows, we must copy the DLLs inside the build folder or it won't find them
Expand Down
Loading