From 13dcff9aa775d32c3028dc871681accd2a70457c Mon Sep 17 00:00:00 2001 From: Tomas Groth Date: Fri, 1 Nov 2019 20:49:14 +0000 Subject: [PATCH 1/3] Reuse the slidecontroller actions on the display window to enable shortcuts to work for the display window. Fixes bug #286. --- openlp/core/ui/mainwindow.py | 3 ++- openlp/core/ui/slidecontroller.py | 5 ++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/openlp/core/ui/mainwindow.py b/openlp/core/ui/mainwindow.py index 16ca79072..cedd6c836 100644 --- a/openlp/core/ui/mainwindow.py +++ b/openlp/core/ui/mainwindow.py @@ -1003,8 +1003,9 @@ class MainWindow(QtWidgets.QMainWindow, Ui_MainWindow, LogMixin, RegistryPropert """ self.application.set_busy_cursor() self.image_manager.update_display() - # self.renderer.update_display() + self.renderer.resize(self.live_controller.screens.current.display_geometry.size()) self.preview_controller.screen_size_changed() + self.live_controller.setup_displays() self.live_controller.screen_size_changed() self.setFocus() self.activateWindow() diff --git a/openlp/core/ui/slidecontroller.py b/openlp/core/ui/slidecontroller.py index ad89dffd8..5fb4ad7da 100644 --- a/openlp/core/ui/slidecontroller.py +++ b/openlp/core/ui/slidecontroller.py @@ -175,6 +175,8 @@ class SlideController(QtWidgets.QWidget, LogMixin, RegistryProperties): if screen.is_display: display = DisplayWindow(self, screen) self.displays.append(display) + if self.display: + self.__add_actions_to_widget(self.display) @property def display(self): @@ -639,9 +641,6 @@ class SlideController(QtWidgets.QWidget, LogMixin, RegistryProperties): if self.is_live and self.displays: for display in self.displays: display.resize(self.screens.current.display_geometry.size()) - # if self.is_live: - # self.__add_actions_to_widget(self.display) - # The SlidePreview's ratio. def __add_actions_to_widget(self, widget): """ From a94449d8bc623d2fe92be601dcea17d02c6b15bc Mon Sep 17 00:00:00 2001 From: Daniel Date: Sat, 2 Nov 2019 05:21:01 +0000 Subject: [PATCH 2/3] Fix display keypress issues --- openlp/core/display/html/display.js | 2 ++ tests/js/test_display.js | 2 ++ 2 files changed, 4 insertions(+) diff --git a/openlp/core/display/html/display.js b/openlp/core/display/html/display.js index 0eda27cfa..6d9284a2c 100644 --- a/openlp/core/display/html/display.js +++ b/openlp/core/display/html/display.js @@ -357,8 +357,10 @@ var Display = { controls: false, progress: false, history: false, + keyboard: false, overview: false, center: false, + touch: false, help: false, transition: "none", backgroundTransition: "none", diff --git a/tests/js/test_display.js b/tests/js/test_display.js index 857e78507..748ad9b6e 100644 --- a/tests/js/test_display.js +++ b/tests/js/test_display.js @@ -88,8 +88,10 @@ describe("The Display object", function () { controls: false, progress: false, history: false, + keyboard: false, overview: false, center: false, + touch: false, help: false, transition: "none", backgroundTransition: "none", From f606838641341309d241e4939541a4e381ef4a39 Mon Sep 17 00:00:00 2001 From: Raoul Snyman Date: Sat, 2 Nov 2019 06:21:23 +0000 Subject: [PATCH 3/3] Pre-select a screen as the display if there is no screen config - Force the last screen in the list to be the display screen by default - Always select the first screen in the widget - Increase the size of the FTW so that it stops jumping in size - Add some more tests for the widgets - Refactored widgets tests into a single file - Fix #302 properly --- openlp/core/display/screens.py | 17 +- openlp/core/ui/firsttimewizard.py | 3 +- openlp/core/ui/thememanager.py | 1 - openlp/core/widgets/widgets.py | 7 +- .../openlp_core/widgets/test_widgets.py | 198 ------- .../openlp_core/widgets/test_widgets.py | 173 ------- tests/openlp_core/widgets/test_widgets.py | 482 ++++++++++++++++++ 7 files changed, 498 insertions(+), 383 deletions(-) delete mode 100644 tests/functional/openlp_core/widgets/test_widgets.py delete mode 100644 tests/interfaces/openlp_core/widgets/test_widgets.py create mode 100644 tests/openlp_core/widgets/test_widgets.py diff --git a/openlp/core/display/screens.py b/openlp/core/display/screens.py index f4ee08ca6..a0712b6fc 100644 --- a/openlp/core/display/screens.py +++ b/openlp/core/display/screens.py @@ -229,13 +229,16 @@ class ScreenList(metaclass=Singleton): } Settings.extend_default_settings(screen_settings) screen_settings = Settings().value('core/screens') - for number, screen_dict in screen_settings.items(): - # Sometimes this loads as a string instead of an int - number = int(number) - if self.has_screen(number): - self[number].update(screen_dict) - else: - self.screens.append(Screen.from_dict(screen_dict)) + if screen_settings: + for number, screen_dict in screen_settings.items(): + # Sometimes this loads as a string instead of an int + number = int(number) + if self.has_screen(number): + self[number].update(screen_dict) + else: + self.screens.append(Screen.from_dict(screen_dict)) + else: + self[len(self) - 1].is_display = True def save_screen_settings(self): """ diff --git a/openlp/core/ui/firsttimewizard.py b/openlp/core/ui/firsttimewizard.py index 2cb1bb8d2..5d88fda2f 100644 --- a/openlp/core/ui/firsttimewizard.py +++ b/openlp/core/ui/firsttimewizard.py @@ -75,6 +75,7 @@ class ThemeListWidget(QtWidgets.QListWidget): :param QtGui.QResizeEvent event: Not used :return: None """ + super().resizeEvent(event) nominal_width = 141 # Icon width of 133 + 4 each side max_items_per_row = self.viewport().width() // nominal_width or 1 # or 1 to avoid divide by 0 errors col_size = (self.viewport().width() - 1) // max_items_per_row @@ -93,7 +94,7 @@ class UiFirstTimeWizard(object): """ first_time_wizard.setObjectName('first_time_wizard') first_time_wizard.setWindowIcon(UiIcons().main_icon) - first_time_wizard.resize(550, 386) + first_time_wizard.resize(640, 400) first_time_wizard.setModal(True) first_time_wizard.setOptions(QtWidgets.QWizard.IndependentPages | QtWidgets.QWizard.NoBackButtonOnStartPage | QtWidgets.QWizard.NoBackButtonOnLastPage | QtWidgets.QWizard.HaveCustomButton1) diff --git a/openlp/core/ui/thememanager.py b/openlp/core/ui/thememanager.py index 8539f1eab..261bdbbbe 100644 --- a/openlp/core/ui/thememanager.py +++ b/openlp/core/ui/thememanager.py @@ -472,7 +472,6 @@ class ThemeManager(QtWidgets.QWidget, RegistryBase, Ui_ThemeManager, LogMixin, R theme_path = self.theme_path / theme_path new_themes.append(self.unzip_theme(theme_path, self.theme_path)) delete_file(theme_path) - theme_paths = AppLocation.get_files(self.settings_section, '.png') # No themes have been found so create one if not theme_paths: theme = Theme() diff --git a/openlp/core/widgets/widgets.py b/openlp/core/widgets/widgets.py index eeaf9177e..7e3811eec 100644 --- a/openlp/core/widgets/widgets.py +++ b/openlp/core/widgets/widgets.py @@ -163,6 +163,7 @@ class ProxyDialog(QtWidgets.QDialog): self.layout.addWidget(self.button_box) self.button_box.accepted.connect(self.accept) self.button_box.rejected.connect(self.reject) + self.retranslate_ui() def accept(self): """ @@ -351,10 +352,10 @@ class ScreenSelectionWidget(QtWidgets.QWidget): for screen in self.screens: screen_button = ScreenButton(self.screen_frame, screen) screen_button.clicked.connect(self.on_screen_button_clicked) - if not self.current_screen or screen.is_display: - screen_button.click() self.screen_frame_layout.addWidget(screen_button) self.screen_button_group.addButton(screen_button) + if screen.number == 0: + screen_button.click() self.screen_frame_layout.addStretch() def save(self): @@ -394,7 +395,7 @@ class ScreenSelectionWidget(QtWidgets.QWidget): label = QtWidgets.QLabel(None) label.setAlignment(QtCore.Qt.AlignCenter) label.setText(str(screen)) - label.setStyleSheet('font-size: 24pt; font-weight: bold;' + label.setStyleSheet('font-size: 24pt; font-weight: bold; ' 'background-color: #0C0; color: #000; border: 5px solid #000;') label.setGeometry(QtCore.QRect(screen.geometry.x(), screen.geometry.y(), screen.geometry.width(), 100)) label.setWindowFlags(QtCore.Qt.FramelessWindowHint | QtCore.Qt.Tool | QtCore.Qt.WindowStaysOnTopHint | diff --git a/tests/functional/openlp_core/widgets/test_widgets.py b/tests/functional/openlp_core/widgets/test_widgets.py deleted file mode 100644 index bf4f935f5..000000000 --- a/tests/functional/openlp_core/widgets/test_widgets.py +++ /dev/null @@ -1,198 +0,0 @@ -# -*- coding: utf-8 -*- - -########################################################################## -# OpenLP - Open Source Lyrics Projection # -# ---------------------------------------------------------------------- # -# Copyright (c) 2008-2019 OpenLP Developers # -# ---------------------------------------------------------------------- # -# This program is free software: you can redistribute it and/or modify # -# it under the terms of the GNU General Public License as published by # -# the Free Software Foundation, either version 3 of the License, or # -# (at your option) any later version. # -# # -# This program is distributed in the hope that it will be useful, # -# but WITHOUT ANY WARRANTY; without even the implied warranty of # -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # -# GNU General Public License for more details. # -# # -# You should have received a copy of the GNU General Public License # -# along with this program. If not, see . # -########################################################################## -""" -Package to test the openlp.core.widgets.widgets package. -""" -from unittest import TestCase -from unittest.mock import MagicMock, patch - -from PyQt5 import QtCore, QtWidgets - -from openlp.core.display.screens import Screen -from openlp.core.widgets.widgets import ScreenButton, ScreenSelectionWidget - - -class TestSceenButton(TestCase): - def test_screen_button_initialisation(self): - """ - Test the initialisation of the ScreenButton object - """ - # GIVEN: A mocked screen object - screen_mock = MagicMock(spec=Screen) - screen_mock.number = 0 - screen_mock.__str__.return_value = 'Mocked Screen Object' - - # WHEN: initialising the ScreenButton object - instance = ScreenButton(None, screen_mock) - - # THEN: The ScreenButton should have been initalised correctly with the data from the mocked screen object - assert isinstance(instance, QtWidgets.QPushButton) - assert instance.objectName() == 'screen_0_button' - assert instance.isCheckable() is True - assert instance.text() == 'Mocked Screen Object' - - -class TestScreenSelectionWidget(TestCase): - def setUp(self): - patched_qtimer = patch('openlp.core.widgets.widgets.QtCore.QTimer') - self.addCleanup(patched_qtimer.stop) - self.timer_mock = MagicMock(spec=QtCore.QTimer) - qtimer_mock = patched_qtimer.start() - qtimer_mock.return_value = self.timer_mock - - patched_screen_selection_widget_setup_ui = patch.object(ScreenSelectionWidget, 'setup_ui') - self.addCleanup(patched_screen_selection_widget_setup_ui.stop) - patched_screen_selection_widget_setup_ui.start() - - def test_init_default_args(self): - """ - Test the initialisation of ScreenSelectionWidget, when initialised with default arguments - """ - # GIVEN: The ScreenSelectionWidget class - # WHEN: Initialising ScreenSelectionWidget with default arguments - instance = ScreenSelectionWidget() - - # THEN: ScreenSelectionWidget should be an instance of QWidget and the screens attribute should be an empty list - assert isinstance(instance, QtWidgets.QWidget) - assert instance.screens == [] - self.timer_mock.setSingleShot.assert_called_once_with(True) - self.timer_mock.setInterval.assert_called_once_with(3000) - - def test_init_with_args(self): - """ - Test the initialisation of ScreenSelectionWidget, when initialised with the screens keyword arg set - """ - # GIVEN: The ScreenSelectionWidget class - screens_object_mock = MagicMock() - - # WHEN: Initialising ScreenSelectionWidget with the screens keyword arg set - instance = ScreenSelectionWidget(screens=screens_object_mock) - - # THEN: ScreenSelectionWidget should be an instance of QWidget and the screens attribute should the mock used - assert isinstance(instance, QtWidgets.QWidget) - assert instance.screens is screens_object_mock - self.timer_mock.setSingleShot.assert_called_once_with(True) - self.timer_mock.setInterval.assert_called_once_with(3000) - - def test_save_screen_none(self): - """ - Test ScreenSelectionWidget._save_screen when called with the screen arg set as None - """ - # GIVEN: An instance of the ScreenSelectionWidget - instance = ScreenSelectionWidget() - instance.display_group_box = MagicMock(spec=QtWidgets.QGroupBox) - - # WHEN: Calling _save_screen and no screen is selected - instance._save_screen(None) - - # THEN: _save_screen should return without attempting to write to the screen object - instance.display_group_box.isChecked.assert_not_called() - - def test_save_screen_not_display(self): - """ - Test ScreenSelectionWidget._save_screen when the display_group_box is not checked. - """ - # GIVEN: An instance of the ScreenSelectionWidget, and a mocked group_box - instance = ScreenSelectionWidget() - instance.display_group_box = MagicMock(spec=QtWidgets.QGroupBox) - instance.custom_geometry_button = MagicMock(spec=QtWidgets.QRadioButton, **{'isChecked.return_value': False}) - mocked_screen_object = MagicMock(spec=Screen) - mocked_screen_object.is_dislpay = True - - # WHEN: display_group_box isn't checked and _save_screen is called with a mocked Screen object. - instance.display_group_box.isChecked.return_value = False - instance._save_screen(mocked_screen_object) - - # THEN: _save_screen should should be set to False - assert mocked_screen_object.is_display is False - - def test_save_screen_display(self): - """ - Test ScreenSelectionWidget._save_screen when the display_group_box is checked. - """ - # GIVEN: An instance of the ScreenSelectionWidget, and a mocked group_box - instance = ScreenSelectionWidget() - instance.display_group_box = MagicMock(spec=QtWidgets.QGroupBox) - instance.custom_geometry_button = MagicMock(spec=QtWidgets.QRadioButton, **{'isChecked.return_value': False}) - mocked_screen_object = MagicMock(spec=Screen) - - # WHEN: display_group_box is checked and _save_screen is called with a mocked Screen object. - instance.display_group_box.isChecked.return_value = True - instance._save_screen(mocked_screen_object) - - # THEN: _save_screen should should be set to True - assert mocked_screen_object.is_display is True - - @patch('openlp.core.widgets.widgets.QtCore.QRect') - def test_save_screen_full_screen(self, mocked_q_rect): - """ - Test ScreenSelectionWidget._save_screen when the display is set to full screen - """ - # GIVEN: An instance of the ScreenSelectionWidget, and a mocked custom_geometry_button - instance = ScreenSelectionWidget() - instance.display_group_box = MagicMock(spec=QtWidgets.QGroupBox) - instance.custom_geometry_button = MagicMock(spec=QtWidgets.QRadioButton) - mocked_screen_object = MagicMock(spec=Screen) - - # WHEN: custom_geometry_button isn't checked and _save_screen is called with a mocked Screen object. - instance.custom_geometry_button.isChecked.return_value = False - instance._save_screen(mocked_screen_object) - - # THEN: _save_screen should not attempt to save a custom geometry - mocked_q_rect.assert_not_called() - - @patch('openlp.core.widgets.widgets.QtCore.QRect') - def test_save_screen_custom_geometry(self, mocked_q_rect): - """ - Test ScreenSelectionWidget._save_screen when a custom geometry is set - """ - # GIVEN: An instance of the ScreenSelectionWidget, and a mocked custom_geometry_button - instance = ScreenSelectionWidget() - instance.display_group_box = MagicMock(spec=QtWidgets.QGroupBox) - instance.custom_geometry_button = MagicMock(spec=QtWidgets.QRadioButton) - instance.left_spin_box = MagicMock(spec=QtWidgets.QSpinBox, **{'value.return_value': 100}) - instance.top_spin_box = MagicMock(spec=QtWidgets.QSpinBox, **{'value.return_value': 200}) - instance.width_spin_box = MagicMock(spec=QtWidgets.QSpinBox, **{'value.return_value': 300}) - instance.height_spin_box = MagicMock(spec=QtWidgets.QSpinBox, **{'value.return_value': 400}) - mocked_screen_object = MagicMock(spec=Screen) - - # WHEN: custom_geometry_button is checked and _save_screen is called with a mocked Screen object. - instance.custom_geometry_button.isChecked.return_value = True - instance._save_screen(mocked_screen_object) - - # THEN: _save_screen should save the custom geometry - mocked_q_rect.assert_called_once_with(100, 200, 300, 400) - - def test_setup_spin_box(self): - """ - Test that ScreenSelectionWidget._setup_spin_box sets up the given spinbox correctly - """ - # GIVEN: An instance of the ScreenSelectionWidget class and a mocked spin box object - instance = ScreenSelectionWidget() - spin_box_mock = MagicMock(spec=QtWidgets.QSpinBox) - - # WHEN: Calling _setup_spin_box with the mocked spin box object and some sample values - instance._setup_spin_box(spin_box_mock, 0, 100, 50) - - # THEN: The mocked spin box object should have been set up with the specified values - spin_box_mock.setMinimum.assert_called_once_with(0) - spin_box_mock.setMaximum.assert_called_once_with(100) - spin_box_mock.setValue.assert_called_once_with(50) diff --git a/tests/interfaces/openlp_core/widgets/test_widgets.py b/tests/interfaces/openlp_core/widgets/test_widgets.py deleted file mode 100644 index 814c5817e..000000000 --- a/tests/interfaces/openlp_core/widgets/test_widgets.py +++ /dev/null @@ -1,173 +0,0 @@ -# -*- coding: utf-8 -*- - -########################################################################## -# OpenLP - Open Source Lyrics Projection # -# ---------------------------------------------------------------------- # -# Copyright (c) 2008-2019 OpenLP Developers # -# ---------------------------------------------------------------------- # -# This program is free software: you can redistribute it and/or modify # -# it under the terms of the GNU General Public License as published by # -# the Free Software Foundation, either version 3 of the License, or # -# (at your option) any later version. # -# # -# This program is distributed in the hope that it will be useful, # -# but WITHOUT ANY WARRANTY; without even the implied warranty of # -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # -# GNU General Public License for more details. # -# # -# You should have received a copy of the GNU General Public License # -# along with this program. If not, see . # -########################################################################## -""" -Module to test the custom widgets. -""" -from unittest import TestCase -from unittest.mock import MagicMock, call, patch - -from openlp.core.common.registry import Registry -from openlp.core.common.settings import ProxyMode -from openlp.core.widgets.widgets import ProxyWidget -from tests.helpers.testmixin import TestMixin - - -class TestProxyWidget(TestCase, TestMixin): - """ - Test the EditCustomForm. - """ - def setUp(self): - """ - Create the UI - """ - Registry.create() - self.setup_application() - - def test_radio_button_exclusivity_no_proxy(self): - """ - Test that only one radio button can be checked at a time, and that the line edits are only enabled when the - `manual_proxy_radio` is checked - """ - # GIVEN: An instance of the `openlp.core.common.widgets.widgets.ProxyWidget` with a radio already checked - proxy_widget = ProxyWidget() - proxy_widget.manual_proxy_radio.setChecked(True) - - # WHEN: 'Checking' the `no_proxy_radio` button - proxy_widget.no_proxy_radio.setChecked(True) - - # THEN: The other radio buttons should not be checked and the line edits should not be enabled - assert proxy_widget.use_sysem_proxy_radio.isChecked() is False - assert proxy_widget.manual_proxy_radio.isChecked() is False - assert proxy_widget.http_edit.isEnabled() is False - assert proxy_widget.https_edit.isEnabled() is False - assert proxy_widget.username_edit.isEnabled() is False - assert proxy_widget.password_edit.isEnabled() is False - - def test_radio_button_exclusivity_system_proxy(self): - """ - Test that only one radio button can be checked at a time, and that the line edits are only enabled when the - `manual_proxy_radio` is checked - """ - # GIVEN: An instance of the `openlp.core.common.widgets.widgets.ProxyWidget` with a radio already checked - proxy_widget = ProxyWidget() - proxy_widget.manual_proxy_radio.setChecked(True) - - # WHEN: 'Checking' the `use_sysem_proxy_radio` button - proxy_widget.use_sysem_proxy_radio.setChecked(True) - - # THEN: The other radio buttons should not be checked and the line edits should not be enabled - assert proxy_widget.no_proxy_radio.isChecked() is False - assert proxy_widget.manual_proxy_radio.isChecked() is False - assert proxy_widget.http_edit.isEnabled() is False - assert proxy_widget.https_edit.isEnabled() is False - assert proxy_widget.username_edit.isEnabled() is False - assert proxy_widget.password_edit.isEnabled() is False - - def test_radio_button_exclusivity_manual_proxy(self): - """ - Test that only one radio button can be checked at a time, and that the line edits are only enabled when the - `manual_proxy_radio` is checked - """ - # GIVEN: An instance of the `openlp.core.common.widgets.widgets.ProxyWidget` with a radio already checked - proxy_widget = ProxyWidget() - proxy_widget.no_proxy_radio.setChecked(True) - - # WHEN: 'Checking' the `manual_proxy_radio` button - proxy_widget.manual_proxy_radio.setChecked(True) - - # THEN: The other radio buttons should not be checked and the line edits should be enabled - assert proxy_widget.no_proxy_radio.isChecked() is False - assert proxy_widget.use_sysem_proxy_radio.isChecked() is False - assert proxy_widget.http_edit.isEnabled() is True - assert proxy_widget.https_edit.isEnabled() is True - assert proxy_widget.username_edit.isEnabled() is True - assert proxy_widget.password_edit.isEnabled() is True - - def test_proxy_widget_load_default_settings(self): - """ - Test that the default settings are loaded from the config correctly - """ - # GIVEN: And instance of the widget with default settings - proxy_widget = ProxyWidget() - - # WHEN: Calling the `load` method - proxy_widget.load() - - # THEN: The widget should be in its default state - assert proxy_widget.use_sysem_proxy_radio.isChecked() is True - assert proxy_widget.http_edit.text() == '' - assert proxy_widget.https_edit.text() == '' - assert proxy_widget.username_edit.text() == '' - assert proxy_widget.password_edit.text() == '' - - @patch.object(ProxyWidget, 'load') - @patch('openlp.core.widgets.widgets.Settings') - def test_proxy_widget_save_no_proxy_settings(self, settings_patcher, proxy_widget_load_patcher): - """ - Test that the settings are saved correctly - """ - # GIVEN: A Mocked settings instance of the proxy widget with some known values set - settings_instance = MagicMock() - settings_patcher.return_value = settings_instance - proxy_widget = ProxyWidget() - proxy_widget.no_proxy_radio.setChecked(True) - proxy_widget.http_edit.setText('') - proxy_widget.https_edit.setText('') - proxy_widget.username_edit.setText('') - proxy_widget.password_edit.setText('') - - # WHEN: Calling save - proxy_widget.save() - - # THEN: The settings should be set as expected - settings_instance.setValue.assert_has_calls( - [call('advanced/proxy mode', ProxyMode.NO_PROXY), - call('advanced/proxy http', ''), - call('advanced/proxy https', ''), - call('advanced/proxy username', ''), - call('advanced/proxy password', '')]) - - @patch.object(ProxyWidget, 'load') - @patch('openlp.core.widgets.widgets.Settings') - def test_proxy_widget_save_manual_settings(self, settings_patcher, proxy_widget_load_patcher): - """ - Test that the settings are saved correctly - """ - # GIVEN: A Mocked and instance of the proxy widget with some known values set - settings_instance = MagicMock() - settings_patcher.return_value = settings_instance - proxy_widget = ProxyWidget() - proxy_widget.manual_proxy_radio.setChecked(True) - proxy_widget.http_edit.setText('http_proxy_server:port') - proxy_widget.https_edit.setText('https_proxy_server:port') - proxy_widget.username_edit.setText('username') - proxy_widget.password_edit.setText('password') - - # WHEN: Calling save - proxy_widget.save() - - # THEN: The settings should be set as expected - settings_instance.setValue.assert_has_calls( - [call('advanced/proxy mode', ProxyMode.MANUAL_PROXY), - call('advanced/proxy http', 'http_proxy_server:port'), - call('advanced/proxy https', 'https_proxy_server:port'), - call('advanced/proxy username', 'username'), - call('advanced/proxy password', 'password')]) diff --git a/tests/openlp_core/widgets/test_widgets.py b/tests/openlp_core/widgets/test_widgets.py new file mode 100644 index 000000000..bbe52a2ac --- /dev/null +++ b/tests/openlp_core/widgets/test_widgets.py @@ -0,0 +1,482 @@ +# -*- coding: utf-8 -*- + +########################################################################## +# OpenLP - Open Source Lyrics Projection # +# ---------------------------------------------------------------------- # +# Copyright (c) 2008-2019 OpenLP Developers # +# ---------------------------------------------------------------------- # +# This program is free software: you can redistribute it and/or modify # +# it under the terms of the GNU General Public License as published by # +# the Free Software Foundation, either version 3 of the License, or # +# (at your option) any later version. # +# # +# This program is distributed in the hope that it will be useful, # +# but WITHOUT ANY WARRANTY; without even the implied warranty of # +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # +# GNU General Public License for more details. # +# # +# You should have received a copy of the GNU General Public License # +# along with this program. If not, see . # +########################################################################## +""" +Package to test the openlp.core.widgets.widgets package. +""" +from unittest import TestCase +from unittest.mock import MagicMock, call, patch + +from PyQt5 import QtCore, QtWidgets + +from openlp.core.common.settings import ProxyMode +from openlp.core.display.screens import Screen +from openlp.core.widgets.widgets import ProxyWidget, ProxyDialog, ScreenButton, ScreenSelectionWidget +from tests.helpers.testmixin import TestMixin + + +class TestProxyWidget(TestCase, TestMixin): + """ + Test the EditCustomForm. + """ + def setUp(self): + """ + Create the UI + """ + self.setup_application() + + def test_radio_button_exclusivity_no_proxy(self): + """ + Test that only one radio button can be checked at a time, and that the line edits are only enabled when the + `manual_proxy_radio` is checked + """ + # GIVEN: An instance of the `openlp.core.common.widgets.widgets.ProxyWidget` with a radio already checked + proxy_widget = ProxyWidget() + proxy_widget.manual_proxy_radio.setChecked(True) + + # WHEN: 'Checking' the `no_proxy_radio` button + proxy_widget.no_proxy_radio.setChecked(True) + + # THEN: The other radio buttons should not be checked and the line edits should not be enabled + assert proxy_widget.use_sysem_proxy_radio.isChecked() is False + assert proxy_widget.manual_proxy_radio.isChecked() is False + assert proxy_widget.http_edit.isEnabled() is False + assert proxy_widget.https_edit.isEnabled() is False + assert proxy_widget.username_edit.isEnabled() is False + assert proxy_widget.password_edit.isEnabled() is False + + def test_radio_button_exclusivity_system_proxy(self): + """ + Test that only one radio button can be checked at a time, and that the line edits are only enabled when the + `manual_proxy_radio` is checked + """ + # GIVEN: An instance of the `openlp.core.common.widgets.widgets.ProxyWidget` with a radio already checked + proxy_widget = ProxyWidget() + proxy_widget.manual_proxy_radio.setChecked(True) + + # WHEN: 'Checking' the `use_sysem_proxy_radio` button + proxy_widget.use_sysem_proxy_radio.setChecked(True) + + # THEN: The other radio buttons should not be checked and the line edits should not be enabled + assert proxy_widget.no_proxy_radio.isChecked() is False + assert proxy_widget.manual_proxy_radio.isChecked() is False + assert proxy_widget.http_edit.isEnabled() is False + assert proxy_widget.https_edit.isEnabled() is False + assert proxy_widget.username_edit.isEnabled() is False + assert proxy_widget.password_edit.isEnabled() is False + + def test_radio_button_exclusivity_manual_proxy(self): + """ + Test that only one radio button can be checked at a time, and that the line edits are only enabled when the + `manual_proxy_radio` is checked + """ + # GIVEN: An instance of the `openlp.core.common.widgets.widgets.ProxyWidget` with a radio already checked + proxy_widget = ProxyWidget() + proxy_widget.no_proxy_radio.setChecked(True) + + # WHEN: 'Checking' the `manual_proxy_radio` button + proxy_widget.manual_proxy_radio.setChecked(True) + + # THEN: The other radio buttons should not be checked and the line edits should be enabled + assert proxy_widget.no_proxy_radio.isChecked() is False + assert proxy_widget.use_sysem_proxy_radio.isChecked() is False + assert proxy_widget.http_edit.isEnabled() is True + assert proxy_widget.https_edit.isEnabled() is True + assert proxy_widget.username_edit.isEnabled() is True + assert proxy_widget.password_edit.isEnabled() is True + + def test_proxy_widget_load_default_settings(self): + """ + Test that the default settings are loaded from the config correctly + """ + # GIVEN: And instance of the widget with default settings + proxy_widget = ProxyWidget() + + # WHEN: Calling the `load` method + proxy_widget.load() + + # THEN: The widget should be in its default state + assert proxy_widget.use_sysem_proxy_radio.isChecked() is True + assert proxy_widget.http_edit.text() == '' + assert proxy_widget.https_edit.text() == '' + assert proxy_widget.username_edit.text() == '' + assert proxy_widget.password_edit.text() == '' + + @patch.object(ProxyWidget, 'load') + @patch('openlp.core.widgets.widgets.Settings') + def test_proxy_widget_save_no_proxy_settings(self, settings_patcher, proxy_widget_load_patcher): + """ + Test that the settings are saved correctly + """ + # GIVEN: A Mocked settings instance of the proxy widget with some known values set + settings_instance = MagicMock() + settings_patcher.return_value = settings_instance + proxy_widget = ProxyWidget() + proxy_widget.no_proxy_radio.setChecked(True) + proxy_widget.http_edit.setText('') + proxy_widget.https_edit.setText('') + proxy_widget.username_edit.setText('') + proxy_widget.password_edit.setText('') + + # WHEN: Calling save + proxy_widget.save() + + # THEN: The settings should be set as expected + settings_instance.setValue.assert_has_calls( + [call('advanced/proxy mode', ProxyMode.NO_PROXY), + call('advanced/proxy http', ''), + call('advanced/proxy https', ''), + call('advanced/proxy username', ''), + call('advanced/proxy password', '')]) + + @patch.object(ProxyWidget, 'load') + @patch('openlp.core.widgets.widgets.Settings') + def test_proxy_widget_save_manual_settings(self, settings_patcher, proxy_widget_load_patcher): + """ + Test that the settings are saved correctly + """ + # GIVEN: A Mocked and instance of the proxy widget with some known values set + settings_instance = MagicMock() + settings_patcher.return_value = settings_instance + proxy_widget = ProxyWidget() + proxy_widget.manual_proxy_radio.setChecked(True) + proxy_widget.http_edit.setText('http_proxy_server:port') + proxy_widget.https_edit.setText('https_proxy_server:port') + proxy_widget.username_edit.setText('username') + proxy_widget.password_edit.setText('password') + + # WHEN: Calling save + proxy_widget.save() + + # THEN: The settings should be set as expected + settings_instance.setValue.assert_has_calls( + [call('advanced/proxy mode', ProxyMode.MANUAL_PROXY), + call('advanced/proxy http', 'http_proxy_server:port'), + call('advanced/proxy https', 'https_proxy_server:port'), + call('advanced/proxy username', 'username'), + call('advanced/proxy password', 'password')]) + + +class TestProxyDialog(TestCase, TestMixin): + """Test the ProxyDialog""" + + def setUp(self): + """Test setup""" + self.setup_application() + self.build_settings() + + def tearDown(self): + """Teardown tests""" + del self.app + + def test_init(self): + """Test that the ProxyDialog is created successfully""" + # GIVEN: ProxyDialog class + # WHEN: It is instantiated + # THEN: There should be no problems + ProxyDialog() + + def test_accept(self): + """Test that the accept() method of the ProxyDialog works correctly""" + # GIVEN: An instance of a ProxyDialog with a mocked out widget + dlg = ProxyDialog() + dlg.proxy_widget = MagicMock() + + # WHEN: accept() is called + dlg.accept() + + # THEN: The save() method on the widget should have been called + dlg.proxy_widget.save.assert_called_once() + + +class TestSceenButton(TestCase): + def test_screen_button_initialisation(self): + """ + Test the initialisation of the ScreenButton object + """ + # GIVEN: A mocked screen object + screen_mock = MagicMock(spec=Screen) + screen_mock.number = 0 + screen_mock.__str__.return_value = 'Mocked Screen Object' + + # WHEN: initialising the ScreenButton object + instance = ScreenButton(None, screen_mock) + + # THEN: The ScreenButton should have been initalised correctly with the data from the mocked screen object + assert isinstance(instance, QtWidgets.QPushButton) + assert instance.objectName() == 'screen_0_button' + assert instance.isCheckable() is True + assert instance.text() == 'Mocked Screen Object' + + +class TestScreenSelectionWidget(TestCase, TestMixin): + + def setUp(self): + """Test setup""" + self.setup_application() + self.build_settings() + + def tearDown(self): + """Tear down tests""" + del self.app + + def test_init_default_args(self): + """ + Test the initialisation of ScreenSelectionWidget, when initialised with default arguments + """ + # GIVEN: The ScreenSelectionWidget class + # WHEN: Initialising ScreenSelectionWidget with default arguments + with patch('openlp.core.widgets.widgets.QtCore.QTimer') as MockTimer: + mocked_timer = MagicMock() + MockTimer.return_value = mocked_timer + instance = ScreenSelectionWidget() + + # THEN: ScreenSelectionWidget should be an instance of QWidget and the screens attribute should be an empty list + assert isinstance(instance, QtWidgets.QWidget) + assert instance.screens == [] + mocked_timer.setSingleShot.assert_called_once_with(True) + mocked_timer.setInterval.assert_called_once_with(3000) + + def test_init_with_args(self): + """ + Test the initialisation of ScreenSelectionWidget, when initialised with the screens keyword arg set + """ + # GIVEN: The ScreenSelectionWidget class + screens_object_mock = MagicMock() + + # WHEN: Initialising ScreenSelectionWidget with the screens keyword arg set + with patch('openlp.core.widgets.widgets.QtCore.QTimer') as MockTimer: + mocked_timer = MagicMock() + MockTimer.return_value = mocked_timer + instance = ScreenSelectionWidget(screens=screens_object_mock) + + # THEN: ScreenSelectionWidget should be an instance of QWidget and the screens attribute should the mock used + assert isinstance(instance, QtWidgets.QWidget) + assert instance.screens is screens_object_mock + mocked_timer.setSingleShot.assert_called_once_with(True) + mocked_timer.setInterval.assert_called_once_with(3000) + + def test_save_screen_none(self): + """ + Test ScreenSelectionWidget._save_screen when called with the screen arg set as None + """ + # GIVEN: An instance of the ScreenSelectionWidget + instance = ScreenSelectionWidget() + instance.display_group_box = MagicMock(spec=QtWidgets.QGroupBox) + + # WHEN: Calling _save_screen and no screen is selected + instance._save_screen(None) + + # THEN: _save_screen should return without attempting to write to the screen object + instance.display_group_box.isChecked.assert_not_called() + + def test_save_screen_not_display(self): + """ + Test ScreenSelectionWidget._save_screen when the display_group_box is not checked. + """ + # GIVEN: An instance of the ScreenSelectionWidget, and a mocked group_box + instance = ScreenSelectionWidget() + instance.display_group_box = MagicMock(spec=QtWidgets.QGroupBox) + instance.custom_geometry_button = MagicMock(spec=QtWidgets.QRadioButton, **{'isChecked.return_value': False}) + mocked_screen_object = MagicMock(spec=Screen) + mocked_screen_object.is_dislpay = True + + # WHEN: display_group_box isn't checked and _save_screen is called with a mocked Screen object. + instance.display_group_box.isChecked.return_value = False + instance._save_screen(mocked_screen_object) + + # THEN: _save_screen should should be set to False + assert mocked_screen_object.is_display is False + + def test_save_screen_display(self): + """ + Test ScreenSelectionWidget._save_screen when the display_group_box is checked. + """ + # GIVEN: An instance of the ScreenSelectionWidget, and a mocked group_box + instance = ScreenSelectionWidget() + instance.display_group_box = MagicMock(spec=QtWidgets.QGroupBox) + instance.custom_geometry_button = MagicMock(spec=QtWidgets.QRadioButton, **{'isChecked.return_value': False}) + mocked_screen_object = MagicMock(spec=Screen) + + # WHEN: display_group_box is checked and _save_screen is called with a mocked Screen object. + instance.display_group_box.isChecked.return_value = True + instance._save_screen(mocked_screen_object) + + # THEN: _save_screen should should be set to True + assert mocked_screen_object.is_display is True + + @patch('openlp.core.widgets.widgets.QtCore.QRect') + def test_save_screen_full_screen(self, mocked_q_rect): + """ + Test ScreenSelectionWidget._save_screen when the display is set to full screen + """ + # GIVEN: An instance of the ScreenSelectionWidget, and a mocked custom_geometry_button + instance = ScreenSelectionWidget() + instance.display_group_box = MagicMock(spec=QtWidgets.QGroupBox) + instance.custom_geometry_button = MagicMock(spec=QtWidgets.QRadioButton) + mocked_screen_object = MagicMock(spec=Screen) + + # WHEN: custom_geometry_button isn't checked and _save_screen is called with a mocked Screen object. + instance.custom_geometry_button.isChecked.return_value = False + instance._save_screen(mocked_screen_object) + + # THEN: _save_screen should not attempt to save a custom geometry + mocked_q_rect.assert_not_called() + + @patch('openlp.core.widgets.widgets.QtCore.QRect') + def test_save_screen_custom_geometry(self, mocked_q_rect): + """ + Test ScreenSelectionWidget._save_screen when a custom geometry is set + """ + # GIVEN: An instance of the ScreenSelectionWidget, and a mocked custom_geometry_button + instance = ScreenSelectionWidget() + instance.display_group_box = MagicMock(spec=QtWidgets.QGroupBox) + instance.custom_geometry_button = MagicMock(spec=QtWidgets.QRadioButton) + instance.left_spin_box = MagicMock(spec=QtWidgets.QSpinBox, **{'value.return_value': 100}) + instance.top_spin_box = MagicMock(spec=QtWidgets.QSpinBox, **{'value.return_value': 200}) + instance.width_spin_box = MagicMock(spec=QtWidgets.QSpinBox, **{'value.return_value': 300}) + instance.height_spin_box = MagicMock(spec=QtWidgets.QSpinBox, **{'value.return_value': 400}) + mocked_screen_object = MagicMock(spec=Screen) + + # WHEN: custom_geometry_button is checked and _save_screen is called with a mocked Screen object. + instance.custom_geometry_button.isChecked.return_value = True + instance._save_screen(mocked_screen_object) + + # THEN: _save_screen should save the custom geometry + mocked_q_rect.assert_called_once_with(100, 200, 300, 400) + + def test_setup_spin_box(self): + """ + Test that ScreenSelectionWidget._setup_spin_box sets up the given spinbox correctly + """ + # GIVEN: An instance of the ScreenSelectionWidget class and a mocked spin box object + instance = ScreenSelectionWidget() + spin_box_mock = MagicMock(spec=QtWidgets.QSpinBox) + + # WHEN: Calling _setup_spin_box with the mocked spin box object and some sample values + instance._setup_spin_box(spin_box_mock, 0, 100, 50) + + # THEN: The mocked spin box object should have been set up with the specified values + spin_box_mock.setMinimum.assert_called_once_with(0) + spin_box_mock.setMaximum.assert_called_once_with(100) + spin_box_mock.setValue.assert_called_once_with(50) + + def test_load(self): + """ + Test that ScreenSelectionWidget.load() loads the screens correctly + """ + # GIVEN: An instance of the ScreenSelectionWidget and a whole bunch o' mocks + instance = ScreenSelectionWidget() + mocked_widget = MagicMock() + mocked_item = MagicMock() + mocked_item.widget.return_value = mocked_widget + mocked_screen_frame_layout = MagicMock() + mocked_screen_frame_layout.count.side_effect = [1, 0] + mocked_screen_frame_layout.takeAt.return_value = mocked_item + mocked_screen_button_group = MagicMock() + mocked_screen_button_group.buttons.return_value = [mocked_widget] + instance.screen_frame_layout = mocked_screen_frame_layout + instance.screen_button_group = mocked_screen_button_group + instance.screens = [Screen(number=0)] + + # WHEN: load() is called + with patch('openlp.core.widgets.widgets.ScreenButton'): + instance.load() + + # THEN: The mocks should have been called + mocked_widget.setParent.assert_called_once_with(None) + mocked_widget.deleteLater.assert_called_once() + mocked_screen_button_group.removeButton.assert_called_once_with(mocked_widget) + + def test_save(self): + """ + Test that the save() method saves the screens + """ + # GIVEN: A ScreenSelectionWidget and a bunch o' mocks + mocked_screen = MagicMock(**{'number': 0, 'to_dict.return_value': {'number': 0}}) + instance = ScreenSelectionWidget() + instance._save_screen = MagicMock() + instance.screens = [mocked_screen] + instance.current_screen = mocked_screen + + # WHEN: Save is called + with patch('openlp.core.widgets.widgets.Settings') as MockSettings: + mocked_settings = MagicMock() + MockSettings.return_value = mocked_settings + instance.save() + + # THEN: The right things should happen + instance._save_screen.assert_called_once_with(mocked_screen) + MockSettings.assert_called_once() + mocked_screen.to_dict.assert_called_once() + mocked_settings.setValue.assert_called_once_with('core/screens', {0: {'number': 0}}) + + def test_on_identify_timer_shot(self): + """ + Test that the _on_identify_timer_shot() method removes the labels from the screens + """ + # GIVEN: A ScreenSelectionWidget and a bunch o' mocks + instance = ScreenSelectionWidget() + mocked_label = MagicMock() + instance.identify_labels = [mocked_label] + + # WHEN: _on_identify_timer_shot() is called + instance._on_identify_timer_shot() + + # THEN: The labels should be cleared + mocked_label.hide.assert_called_once() + mocked_label.setParent.assert_called_once_with(None) + mocked_label.deleteLater.assert_called_once() + assert instance.identify_labels == [] + + def test_on_identify_button_clicked(self): + """ + Test that the on_identify_button_clicked() method shows a label on each screen + """ + # GIVEN: A ScreenSelectionWidget and a bunch o' mocks + instance = ScreenSelectionWidget() + mocked_screen = MagicMock() + mocked_screen.geometry.x.return_value = 0 + mocked_screen.geometry.y.return_value = 0 + mocked_screen.geometry.width.return_value = 1920 + mocked_screen.__str__.return_value = 'Screen 1' + instance.screens = [mocked_screen] + instance.timer = MagicMock() + + # WHEN: on_identify_button_clicked() is called + with patch('openlp.core.widgets.widgets.QtWidgets.QLabel') as MockLabel: + mocked_label = MagicMock() + MockLabel.return_value = mocked_label + instance.on_identify_button_clicked() + + # THEN: The labels should be cleared + MockLabel.assert_called_once_with(None) + mocked_label.setAlignment.assert_called_once_with(QtCore.Qt.AlignCenter) + mocked_label.setText.assert_called_once_with('Screen 1') + mocked_label.setStyleSheet.assert_called_once_with('font-size: 24pt; font-weight: bold; ' + 'background-color: #0C0; color: #000; ' + 'border: 5px solid #000;') + mocked_label.setGeometry.assert_called_once_with(QtCore.QRect(0, 0, 1920, 100)) + mocked_label.setWindowFlags.assert_called_once_with(QtCore.Qt.FramelessWindowHint | QtCore.Qt.Tool | + QtCore.Qt.WindowStaysOnTopHint | + QtCore.Qt.WindowDoesNotAcceptFocus) + mocked_label.show.assert_called_once() + assert instance.identify_labels == [mocked_label] + instance.timer.start.assert_called_once()