System Tests: run tests "offscreen" on Windows OS to prevent popups (#2804)

Author: MikeSullivan7

Makefile

@@ -51,6 +51,9 @@ test-verbose:
 test-system:
 	${XVFBRUN} python -m pytest -vs -rs -p no:xdist -p no:randomly -p no:repeat -p no:cov -o log_cli=true --run-system-tests mantidimaging/gui/test/
 
+test-system-show:
+	python -m pytest -vs -rs -p no:xdist -p no:randomly -p no:repeat -p no:cov -o log_cli=true --run-system-tests-show mantidimaging/gui/test/
+
 test-screenshots:
 	-mkdir ${TEST_RESULT_DIR}
 	APPLITOOLS_API_KEY=local APPLITOOLS_IMAGE_DIR=${TEST_RESULT_DIR} ${XVFBRUN} pytest -p no:xdist -p no:randomly -p no:cov mantidimaging/eyes_tests/ -vs --run-eyes-tests

conftest.py

@@ -2,6 +2,7 @@
 # SPDX - License - Identifier: GPL-3.0-or-later
 from __future__ import annotations
 
+import os
 from collections import Counter
 
 import pytest
@@ -12,7 +13,8 @@
 
 
 def pytest_addoption(parser):
-    parser.addoption("--run-system-tests", action="store_true", default=False, help="Run GUI system tests")
+    parser.addoption("--run-system-tests", action="store_true", default=False, help="Run GUI system tests offscreen")
+    parser.addoption("--run-system-tests-show", action="store_true", default=False, help="Run GUI system tests")
     parser.addoption("--run-unit-tests", action="store_true", default=False, help="Run unit tests")
     parser.addoption("--run-eyes-tests", action="store_true", default=False, help="Run eyes tests")
 
@@ -30,6 +32,10 @@ def pytest_configure(config):
 def pytest_collection_modifyitems(config, items):
     if config.getoption("--run-system-tests"):
         allowed_markers.append(pytest.mark.system.mark)
+        os.environ["QT_QPA_PLATFORM"] = "minimal"
+    if config.getoption("--run-system-tests-show"):
+        allowed_markers.append(pytest.mark.system.mark)
+        os.environ["QT_QPA_PLATFORM"] = ""
     if config.getoption("--run-eyes-tests"):
         allowed_markers.append(pytest.mark.eyes.mark)
     if config.getoption("--run-unit-tests") or len(allowed_markers) == 0:

mantidimaging/gui/test/gui_system_base.py

@@ -6,10 +6,12 @@
 import unittest
 from unittest import mock
 
+from PyQt5 import QtCore
 from PyQt5.QtCore import Qt, QTimer
 from PyQt5.QtTest import QTest
 from PyQt5.QtWidgets import QApplication, QMessageBox, QInputDialog, QDialog
 import pytest
+from mantidimaging.test_helpers.qt_test_message_handler import qt_message_handler
 
 from mantidimaging.core.utility.leak_tracker import leak_tracker
 from mantidimaging.gui.windows.main import MainWindowView
@@ -24,6 +26,8 @@
 SHOW_DELAY = 10  # Can be increased to watch tests
 SHORT_DELAY = 100
 
+QtCore.qInstallMessageHandler(qt_message_handler)
+
 
 @mock_versions
 @pytest.mark.system

mantidimaging/test_helpers/qt_test_message_handler.py

@@ -0,0 +1,19 @@
+# Copyright (C) 2021 ISIS Rutherford Appleton Laboratory UKRI
+# SPDX - License - Identifier: GPL-3.0-or-later
+from PyQt5 import QtCore
+
+
+def qt_message_handler(mode, context, message):
+    mode_map = {
+        QtCore.QtInfoMsg: 'INFO',
+        QtCore.QtWarningMsg: 'WARNING',
+        QtCore.QtCriticalMsg: 'CRITICAL',
+        QtCore.QtFatalMsg: 'FATAL'
+    }
+
+    # Get the string label for mode, otherwise default to 'DEBUG'
+    mode_str = mode_map.get(mode, 'DEBUG')
+    if mode == QtCore.QtWarningMsg and 'propagateSizeHints' in message:
+        return
+    print(f"qt_message_handler: line: {context.line}, func: {context.function}, file: {context.file}")
+    print(f"{mode_str}: {message}\n")