Fix structure viewer rendering on macOS and add basic GUI tests based on screenshot comparison #29
Conversation
Screenshots slightly differs between platforms
Fix pyside6 version to be 6.5.3 because of the issues with QtQuick3D rendering on macOS: - Particles not supported due to missing RGBA32F and RGBA16F texture format support - No GLSL shader code found (versions tried: QList(120) ) in baked shader
There was a problem hiding this comment.
Looks good.
I would prefer to have all dependencies in the pyproject.toml file.
I did not do any testing of the behavior on OSX.
I tried to do the GUI tests on my windows setup. However, I had problems when the screendump for the model page should be generated since the data to be loaded where not at the right place or something. I also noticed that my black theme seemed would cause problems. So I assume the tests are exclusive for usage on pipelines.
.github/workflows/installer.yml
Outdated
| @@ -223,6 +236,7 @@ jobs: | |||
| - name: Install Python dependences | |||
| run: | | |||
| python -m pip install requests | |||
| python -m pip install pytest pytest-image-diff | |||
There was a problem hiding this comment.
Why are these not defined in the project.toml file.
There was a problem hiding this comment.
Moved to pyproject.toml. Although another flit package installation step is added to be able to install EasyDiffractionApp dependencies, but not the EasyDiffractionApp package itself. This feature does not seem to be implemented in pip.
.github/workflows/installer.yml
Outdated
| @@ -66,15 +66,13 @@ jobs: | |||
| python -m pip install numpy lmfit numdifftools | |||
There was a problem hiding this comment.
Why are these here rather than an optional dependency in the project.toml file?
There was a problem hiding this comment.
Moved to pyproject.toml. Although another flit package installation step is added to be able to install EasyDiffractionApp dependencies, but not the EasyDiffractionApp package itself. This feature does not seem to be implemented in pip.
easyDiffractionApp/main.py
Outdated
| @@ -20,13 +20,13 @@ | |||
| EnvironmentVariables.set() | |||
| console.debug('Environment variables defined') | |||
|
|
|||
| # Magically fixes the following issues in QtQuick3D on macOS for local run | |||
| # Magically fixes the following issues in QtQuick3D on macOS when using pyside6==6.5.3 | |||
There was a problem hiding this comment.
Suggest to delete this if it is no longer needed
There was a problem hiding this comment.
Old irrelevant comments have been removed. Although the QtWebEngine initialisation step is commented out, it is temporarily preserved.
This PR fixes an issue with
QtQuick3Dfailing to render on macOS. We usedos.environ['QSG_RHI_BACKEND'] = 'opengl'to force OpenGL to be the RHI backend on all platforms to be able to use theuseOpenGLproperty forQtChartsXYSeries. This leads to errors like:Particles not supported due to missing RGBA32F and RGBA16F texture format support...andNo GLSL shader code found (versions tried: QList(120) ) in the baked shader....RHI is now automatically selected depending on the platform. OpenGL acceleration has been temporarily disabled.
Another addition to this PR is the GUI basic tests, which are based on comparing screenshots for each page of the application to the desired ones. Although we do not use platform-specific GUI elements, screenshots vary slightly from platform to platform. Therefore, comparisons are always made with images created for the same platform. These tests are called twice during the CI process - before creating the application installer and after installing the application on a fresh machine.