From 2b9d2a994b7d0f226adec8932422c81d2e7b8e43 Mon Sep 17 00:00:00 2001 From: Ken Roberts Date: Fri, 24 Nov 2017 00:30:37 -0800 Subject: [PATCH 1/2] Bugfix 1734275 Nonstandard LAMP reply --- openlp/core/projectors/manager.py | 12 +- openlp/core/projectors/pjlink.py | 23 +-- .../projectors/test_projector_bugfixes_01.py | 134 ++++++++++++++++++ .../projectors/test_projector_pjlink_base.py | 54 +------ .../test_projector_pjlink_commands.py | 29 ---- 5 files changed, 155 insertions(+), 97 deletions(-) create mode 100644 tests/functional/openlp_core/projectors/test_projector_bugfixes_01.py diff --git a/openlp/core/projectors/manager.py b/openlp/core/projectors/manager.py index 0e00d602d..f9e3b191e 100644 --- a/openlp/core/projectors/manager.py +++ b/openlp/core/projectors/manager.py @@ -672,14 +672,16 @@ class ProjectorManager(QtWidgets.QWidget, RegistryBase, UiProjectorManager, LogM data=projector.model_filter) count = 1 for item in projector.link.lamp: + if item['On'] is None: + onoff = translate('OpenLP.ProjectorManager', 'Unavailable') + elif item['On']: + onoff = translate('OpenLP.ProjectorManager', 'ON') + else: + onoff = translate('OpenLP.ProjectorManager', 'OFF') message += '{title} {count} {status} '.format(title=translate('OpenLP.ProjectorManager', 'Lamp'), count=count, - status=translate('OpenLP.ProjectorManager', - 'ON') - if item['On'] - else translate('OpenLP.ProjectorManager', - 'OFF')) + status=onoff) message += '{title}: {hours}
'.format(title=translate('OpenLP.ProjectorManager', 'Hours'), hours=item['Hours']) diff --git a/openlp/core/projectors/pjlink.py b/openlp/core/projectors/pjlink.py index 38013097f..6ebc462f2 100644 --- a/openlp/core/projectors/pjlink.py +++ b/openlp/core/projectors/pjlink.py @@ -403,16 +403,19 @@ class PJLinkCommands(object): """ lamps = [] data_dict = data.split() - while data_dict: - try: - fill = {'Hours': int(data_dict[0]), 'On': False if data_dict[1] == '0' else True} - except ValueError: - # In case of invalid entry - log.warning('({ip}) process_lamp(): Invalid data "{data}"'.format(ip=self.ip, data=data)) - return - lamps.append(fill) - data_dict.pop(0) # Remove lamp hours - data_dict.pop(0) # Remove lamp on/off + if len(data_dict) < 2: + lamps.append({'Hours': int(data_dict[0]), 'On': None}) + else: + while data_dict: + try: + fill = {'Hours': int(data_dict[0]), 'On': False if data_dict[1] == '0' else True} + except ValueError: + # In case of invalid entry + log.warning('({ip}) process_lamp(): Invalid data "{data}"'.format(ip=self.ip, data=data)) + return + lamps.append(fill) + data_dict.pop(0) # Remove lamp hours + data_dict.pop(0) # Remove lamp on/off self.lamp = lamps return diff --git a/tests/functional/openlp_core/projectors/test_projector_bugfixes_01.py b/tests/functional/openlp_core/projectors/test_projector_bugfixes_01.py new file mode 100644 index 000000000..6b5b4c54e --- /dev/null +++ b/tests/functional/openlp_core/projectors/test_projector_bugfixes_01.py @@ -0,0 +1,134 @@ +# -*- coding: utf-8 -*- +# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4 + +############################################################################### +# OpenLP - Open Source Lyrics Projection # +# --------------------------------------------------------------------------- # +# Copyright (c) 2008-2015 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; version 2 of the License. # +# # +# 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, write to the Free Software Foundation, Inc., 59 # +# Temple Place, Suite 330, Boston, MA 02111-1307 USA # +############################################################################### +""" +Package to test the openlp.core.projectors.pjlink base package. +""" +from unittest import TestCase +from unittest.mock import patch + +from openlp.core.projectors.db import Projector +from openlp.core.projectors.pjlink import PJLink + +from tests.resources.projector.data import TEST_PIN, TEST_CONNECT_AUTHENTICATE, TEST_HASH, TEST1_DATA + +pjlink_test = PJLink(Projector(**TEST1_DATA), no_poll=True) + + +class TestPJLinkBugs(TestCase): + """ + Tests for the PJLink module bugfixes + """ + def test_bug_1550891_process_clss_nonstandard_reply_1(self): + """ + Bugfix 1550891: CLSS request returns non-standard reply with Optoma/Viewsonic projector + """ + # GIVEN: Test object + pjlink = pjlink_test + + # WHEN: Process non-standard reply + pjlink.process_clss('Class 1') + + # THEN: Projector class should be set with proper value + self.assertEqual(pjlink.pjlink_class, '1', + 'Non-standard class reply should have set class=1') + + def test_bug_1550891_process_clss_nonstandard_reply_2(self): + """ + Bugfix 1550891: CLSS request returns non-standard reply with BenQ projector + """ + # GIVEN: Test object + pjlink = pjlink_test + + # WHEN: Process non-standard reply + pjlink.process_clss('Version2') + + # THEN: Projector class should be set with proper value + # NOTE: At this time BenQ is Class 1, but we're trying a different value to verify + self.assertEqual(pjlink.pjlink_class, '2', + 'Non-standard class reply should have set class=2') + + @patch.object(pjlink_test, 'send_command') + @patch.object(pjlink_test, 'waitForReadyRead') + @patch.object(pjlink_test, 'projectorAuthentication') + @patch.object(pjlink_test, 'timer') + @patch.object(pjlink_test, 'socket_timer') + def test_bug_1593882_no_pin_authenticated_connection(self, + mock_socket_timer, + mock_timer, + mock_authentication, + mock_ready_read, + mock_send_command): + """ + Test bug 1593882 no pin and authenticated request exception + """ + # GIVEN: Test object and mocks + pjlink = pjlink_test + pjlink.pin = None + mock_ready_read.return_value = True + + # WHEN: call with authentication request and pin not set + pjlink.check_login(data=TEST_CONNECT_AUTHENTICATE) + + # THEN: 'No Authentication' signal should have been sent + mock_authentication.emit.assert_called_with(pjlink.ip) + + @patch.object(pjlink_test, 'waitForReadyRead') + @patch.object(pjlink_test, 'state') + @patch.object(pjlink_test, '_send_command') + @patch.object(pjlink_test, 'timer') + @patch.object(pjlink_test, 'socket_timer') + def test_bug_1593883_pjlink_authentication(self, + mock_socket_timer, + mock_timer, + mock_send_command, + mock_state, + mock_waitForReadyRead): + """ + Test bugfix 1593883 pjlink authentication + """ + # GIVEN: Test object and data + pjlink = pjlink_test + pjlink.pin = TEST_PIN + mock_state.return_value = pjlink.ConnectedState + mock_waitForReadyRead.return_value = True + + # WHEN: Athenticated connection is called + pjlink.check_login(data=TEST_CONNECT_AUTHENTICATE) + + # THEN: send_command should have the proper authentication + self.assertEqual("{test}".format(test=mock_send_command.call_args), + "call(data='{hash}%1CLSS ?\\r')".format(hash=TEST_HASH)) + + def test_bug_1734275_pjlink_nonstandard_lamp(self): + """ + Test bugfix 17342785 non-standard LAMP response + """ + # GIVEN: Test object + pjlink = pjlink_test + + # WHEN: Process lamp command called with only hours and no lamp power state + pjlink.process_lamp("45") + + # THEN: Lamp should show hours as 45 and lamp power as Unavailable + self.assertEqual(len(pjlink.lamp), 1, 'There should only be 1 lamp available') + self.assertEqual(pjlink.lamp[0]['Hours'], 45, 'Lamp hours should have equalled 45') + self.assertIsNone(pjlink.lamp[0]['On'], 'Lamp power should be "Unavailable"') diff --git a/tests/functional/openlp_core/projectors/test_projector_pjlink_base.py b/tests/functional/openlp_core/projectors/test_projector_pjlink_base.py index 75b32d8c1..7253df032 100644 --- a/tests/functional/openlp_core/projectors/test_projector_pjlink_base.py +++ b/tests/functional/openlp_core/projectors/test_projector_pjlink_base.py @@ -29,7 +29,7 @@ from openlp.core.projectors.constants import E_PARAMETER, ERROR_STRING, S_ON, S_ from openlp.core.projectors.db import Projector from openlp.core.projectors.pjlink import PJLink -from tests.resources.projector.data import TEST_PIN, TEST_SALT, TEST_CONNECT_AUTHENTICATE, TEST_HASH, TEST1_DATA +from tests.resources.projector.data import TEST_PIN, TEST_SALT, TEST_CONNECT_AUTHENTICATE, TEST1_DATA pjlink_test = PJLink(Projector(**TEST1_DATA), no_poll=True) @@ -79,58 +79,6 @@ class TestPJLinkBase(TestCase): 'change_status should have been called with "{}"'.format( ERROR_STRING[E_PARAMETER])) - @patch.object(pjlink_test, 'send_command') - @patch.object(pjlink_test, 'waitForReadyRead') - @patch.object(pjlink_test, 'projectorAuthentication') - @patch.object(pjlink_test, 'timer') - @patch.object(pjlink_test, 'socket_timer') - def test_bug_1593882_no_pin_authenticated_connection(self, - mock_socket_timer, - mock_timer, - mock_authentication, - mock_ready_read, - mock_send_command): - """ - Test bug 1593882 no pin and authenticated request exception - """ - # GIVEN: Test object and mocks - pjlink = pjlink_test - pjlink.pin = None - mock_ready_read.return_value = True - - # WHEN: call with authentication request and pin not set - pjlink.check_login(data=TEST_CONNECT_AUTHENTICATE) - - # THEN: 'No Authentication' signal should have been sent - mock_authentication.emit.assert_called_with(pjlink.ip) - - @patch.object(pjlink_test, 'waitForReadyRead') - @patch.object(pjlink_test, 'state') - @patch.object(pjlink_test, '_send_command') - @patch.object(pjlink_test, 'timer') - @patch.object(pjlink_test, 'socket_timer') - def test_bug_1593883_pjlink_authentication(self, - mock_socket_timer, - mock_timer, - mock_send_command, - mock_state, - mock_waitForReadyRead): - """ - Test bugfix 1593883 pjlink authentication - """ - # GIVEN: Test object and data - pjlink = pjlink_test - pjlink.pin = TEST_PIN - mock_state.return_value = pjlink.ConnectedState - mock_waitForReadyRead.return_value = True - - # WHEN: Athenticated connection is called - pjlink.check_login(data=TEST_CONNECT_AUTHENTICATE) - - # THEN: send_command should have the proper authentication - self.assertEqual("{test}".format(test=mock_send_command.call_args), - "call(data='{hash}%1CLSS ?\\r')".format(hash=TEST_HASH)) - @patch.object(pjlink_test, 'disconnect_from_host') def test_socket_abort(self, mock_disconnect): """ diff --git a/tests/functional/openlp_core/projectors/test_projector_pjlink_commands.py b/tests/functional/openlp_core/projectors/test_projector_pjlink_commands.py index 584b63cf9..32544dd09 100644 --- a/tests/functional/openlp_core/projectors/test_projector_pjlink_commands.py +++ b/tests/functional/openlp_core/projectors/test_projector_pjlink_commands.py @@ -570,35 +570,6 @@ class TestPJLinkCommands(TestCase): self.assertEqual(pjlink.pjlink_class, '2', 'Projector should have set class=2') - def test_projector_process_clss_nonstandard_reply_optoma(self): - """ - Bugfix 1550891: CLSS request returns non-standard reply with Optoma projector - """ - # GIVEN: Test object - pjlink = pjlink_test - - # WHEN: Process non-standard reply - pjlink.process_clss('Class 1') - - # THEN: Projector class should be set with proper value - self.assertEqual(pjlink.pjlink_class, '1', - 'Non-standard class reply should have set class=1') - - def test_projector_process_clss_nonstandard_reply_benq(self): - """ - Bugfix 1550891: CLSS request returns non-standard reply with BenQ projector - """ - # GIVEN: Test object - pjlink = pjlink_test - - # WHEN: Process non-standard reply - pjlink.process_clss('Version2') - - # THEN: Projector class should be set with proper value - # NOTE: At this time BenQ is Class 1, but we're trying a different value to verify - self.assertEqual(pjlink.pjlink_class, '2', - 'Non-standard class reply should have set class=2') - @patch.object(openlp.core.projectors.pjlink, 'log') def test_projector_process_clss_invalid_nan(self, mock_log): """ From b650ef5730f231821ec58ee9d565365b8cf6464f Mon Sep 17 00:00:00 2001 From: Ken Roberts Date: Fri, 24 Nov 2017 11:08:23 -0800 Subject: [PATCH 2/2] Refactor mocks --- openlp/core/projectors/manager.py | 8 +-- openlp/core/projectors/pjlink.py | 14 ++-- .../projectors/test_projector_bugfixes_01.py | 64 +++++++++---------- 3 files changed, 43 insertions(+), 43 deletions(-) diff --git a/openlp/core/projectors/manager.py b/openlp/core/projectors/manager.py index f9e3b191e..b352858b1 100644 --- a/openlp/core/projectors/manager.py +++ b/openlp/core/projectors/manager.py @@ -673,15 +673,15 @@ class ProjectorManager(QtWidgets.QWidget, RegistryBase, UiProjectorManager, LogM count = 1 for item in projector.link.lamp: if item['On'] is None: - onoff = translate('OpenLP.ProjectorManager', 'Unavailable') + status = translate('OpenLP.ProjectorManager', 'Unavailable') elif item['On']: - onoff = translate('OpenLP.ProjectorManager', 'ON') + status = translate('OpenLP.ProjectorManager', 'ON') else: - onoff = translate('OpenLP.ProjectorManager', 'OFF') + status = translate('OpenLP.ProjectorManager', 'OFF') message += '{title} {count} {status} '.format(title=translate('OpenLP.ProjectorManager', 'Lamp'), count=count, - status=onoff) + status=status) message += '{title}: {hours}
'.format(title=translate('OpenLP.ProjectorManager', 'Hours'), hours=item['Hours']) diff --git a/openlp/core/projectors/pjlink.py b/openlp/core/projectors/pjlink.py index 6ebc462f2..16a65bd11 100644 --- a/openlp/core/projectors/pjlink.py +++ b/openlp/core/projectors/pjlink.py @@ -402,20 +402,20 @@ class PJLinkCommands(object): :param data: Lamp(s) status. """ lamps = [] - data_dict = data.split() - if len(data_dict) < 2: - lamps.append({'Hours': int(data_dict[0]), 'On': None}) + lamp_list = data.split() + if len(lamp_list) < 2: + lamps.append({'Hours': int(lamp_list[0]), 'On': None}) else: - while data_dict: + while lamp_list: try: - fill = {'Hours': int(data_dict[0]), 'On': False if data_dict[1] == '0' else True} + fill = {'Hours': int(lamp_list[0]), 'On': False if lamp_list[1] == '0' else True} except ValueError: # In case of invalid entry log.warning('({ip}) process_lamp(): Invalid data "{data}"'.format(ip=self.ip, data=data)) return lamps.append(fill) - data_dict.pop(0) # Remove lamp hours - data_dict.pop(0) # Remove lamp on/off + lamp_list.pop(0) # Remove lamp hours + lamp_list.pop(0) # Remove lamp on/off self.lamp = lamps return diff --git a/tests/functional/openlp_core/projectors/test_projector_bugfixes_01.py b/tests/functional/openlp_core/projectors/test_projector_bugfixes_01.py index 6b5b4c54e..c33220d4a 100644 --- a/tests/functional/openlp_core/projectors/test_projector_bugfixes_01.py +++ b/tests/functional/openlp_core/projectors/test_projector_bugfixes_01.py @@ -30,19 +30,29 @@ from openlp.core.projectors.pjlink import PJLink from tests.resources.projector.data import TEST_PIN, TEST_CONNECT_AUTHENTICATE, TEST_HASH, TEST1_DATA -pjlink_test = PJLink(Projector(**TEST1_DATA), no_poll=True) - class TestPJLinkBugs(TestCase): """ Tests for the PJLink module bugfixes """ + def setUp(self): + ''' + Initialization + ''' + self.pjlink_test = PJLink(Projector(**TEST1_DATA), no_poll=True) + + def tearDown(self): + ''' + Cleanups + ''' + self.pjlink_test = None + def test_bug_1550891_process_clss_nonstandard_reply_1(self): """ Bugfix 1550891: CLSS request returns non-standard reply with Optoma/Viewsonic projector """ # GIVEN: Test object - pjlink = pjlink_test + pjlink = self.pjlink_test # WHEN: Process non-standard reply pjlink.process_clss('Class 1') @@ -56,7 +66,7 @@ class TestPJLinkBugs(TestCase): Bugfix 1550891: CLSS request returns non-standard reply with BenQ projector """ # GIVEN: Test object - pjlink = pjlink_test + pjlink = self.pjlink_test # WHEN: Process non-standard reply pjlink.process_clss('Version2') @@ -66,22 +76,17 @@ class TestPJLinkBugs(TestCase): self.assertEqual(pjlink.pjlink_class, '2', 'Non-standard class reply should have set class=2') - @patch.object(pjlink_test, 'send_command') - @patch.object(pjlink_test, 'waitForReadyRead') - @patch.object(pjlink_test, 'projectorAuthentication') - @patch.object(pjlink_test, 'timer') - @patch.object(pjlink_test, 'socket_timer') - def test_bug_1593882_no_pin_authenticated_connection(self, - mock_socket_timer, - mock_timer, - mock_authentication, - mock_ready_read, - mock_send_command): + def test_bug_1593882_no_pin_authenticated_connection(self): """ Test bug 1593882 no pin and authenticated request exception """ # GIVEN: Test object and mocks - pjlink = pjlink_test + mock_socket_timer = patch.object(self.pjlink_test, 'socket_timer').start() + mock_timer = patch.object(self.pjlink_test, 'timer').start() + mock_authentication = patch.object(self.pjlink_test, 'projectorAuthentication').start() + mock_ready_read = patch.object(self.pjlink_test, 'waitForReadyRead').start() + mock_send_command = patch.object(self.pjlink_test, 'send_command').start() + pjlink = self.pjlink_test pjlink.pin = None mock_ready_read.return_value = True @@ -91,22 +96,17 @@ class TestPJLinkBugs(TestCase): # THEN: 'No Authentication' signal should have been sent mock_authentication.emit.assert_called_with(pjlink.ip) - @patch.object(pjlink_test, 'waitForReadyRead') - @patch.object(pjlink_test, 'state') - @patch.object(pjlink_test, '_send_command') - @patch.object(pjlink_test, 'timer') - @patch.object(pjlink_test, 'socket_timer') - def test_bug_1593883_pjlink_authentication(self, - mock_socket_timer, - mock_timer, - mock_send_command, - mock_state, - mock_waitForReadyRead): + def test_bug_1593883_pjlink_authentication(self): """ Test bugfix 1593883 pjlink authentication """ # GIVEN: Test object and data - pjlink = pjlink_test + mock_socket_timer = patch.object(self.pjlink_test, 'socket_timer').start() + mock_timer = patch.object(self.pjlink_test, 'timer').start() + mock_send_command = patch.object(self.pjlink_test, 'write').start() + mock_state = patch.object(self.pjlink_test, 'state').start() + mock_waitForReadyRead = patch.object(self.pjlink_test, 'waitForReadyRead').start() + pjlink = self.pjlink_test pjlink.pin = TEST_PIN mock_state.return_value = pjlink.ConnectedState mock_waitForReadyRead.return_value = True @@ -116,14 +116,14 @@ class TestPJLinkBugs(TestCase): # THEN: send_command should have the proper authentication self.assertEqual("{test}".format(test=mock_send_command.call_args), - "call(data='{hash}%1CLSS ?\\r')".format(hash=TEST_HASH)) + "call(b'{hash}%1CLSS ?\\r')".format(hash=TEST_HASH)) - def test_bug_1734275_pjlink_nonstandard_lamp(self): + def test_bug_1734275_process_lamp_nonstandard_reply(self): """ Test bugfix 17342785 non-standard LAMP response """ # GIVEN: Test object - pjlink = pjlink_test + pjlink = self.pjlink_test # WHEN: Process lamp command called with only hours and no lamp power state pjlink.process_lamp("45") @@ -131,4 +131,4 @@ class TestPJLinkBugs(TestCase): # THEN: Lamp should show hours as 45 and lamp power as Unavailable self.assertEqual(len(pjlink.lamp), 1, 'There should only be 1 lamp available') self.assertEqual(pjlink.lamp[0]['Hours'], 45, 'Lamp hours should have equalled 45') - self.assertIsNone(pjlink.lamp[0]['On'], 'Lamp power should be "Unavailable"') + self.assertIsNone(pjlink.lamp[0]['On'], 'Lamp power should be "None"')