raoul
/
openlp
forked from openlp/openlp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
openlp/tests/functional/openlp_core_ui/test_firsttimeform.py

272 lines
13 KiB
Python
Raw Normal View History

Add tests for First Time Wizards web config file
2014-04-15 18:44:33 +00:00
# -*- coding: utf-8 -*-
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
###############################################################################
# OpenLP - Open Source Lyrics Projection #
# --------------------------------------------------------------------------- #
Yet another year goes by
2016-12-31 11:05:48 +00:00
# Copyright (c) 2008-2017 OpenLP Developers #
Add tests for First Time Wizards web config file
2014-04-15 18:44:33 +00:00
# --------------------------------------------------------------------------- #
# 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.ui.firsttimeform package.
"""
[refactor] Renamed "was_download_cancelled" to "was_cancelled" [refactor] Put some more stuff back into initalise() where it belongs [refactor] Rewrote old tests, wrote new tests
2014-11-08 21:15:25 +00:00
import os
Fix ftw socket.timeout bug 1422683
2015-02-17 21:27:51 +00:00
import socket
import tempfile
Catch network error in FTW
2015-01-13 19:03:05 +00:00
import urllib
Add tests for First Time Wizards web config file
2014-04-15 18:44:33 +00:00
from unittest import TestCase
from openlp.core.common import Registry
from openlp.core.ui.firsttimeform import FirstTimeForm
Added and updated tests: - Refactored FirstTimeForm to use an initalise() method, in order to be more testable - Rewrote FTW tests to test initialise() - Refactored TestMixin get_application() to setup_application() since it doesn't actually return an application object - Refactored ListPreviewWidget to make it more testable - Wrote tests for ListPreviewWidget - Refactored FormattingTagsForm somewhat - Updated FormattingTagsForm tests Updated setup.py with some Python3 changes.
2014-10-22 20:43:05 +00:00
from tests.functional import MagicMock, patch
Reorder imports
2014-04-15 20:51:55 +00:00
from tests.helpers.testmixin import TestMixin
Added and updated tests: - Refactored FirstTimeForm to use an initalise() method, in order to be more testable - Rewrote FTW tests to test initialise() - Refactored TestMixin get_application() to setup_application() since it doesn't actually return an application object - Refactored ListPreviewWidget to make it more testable - Wrote tests for ListPreviewWidget - Refactored FormattingTagsForm somewhat - Updated FormattingTagsForm tests Updated setup.py with some Python3 changes.
2014-10-22 20:43:05 +00:00
FAKE_CONFIG = b"""
[general]
base url = http://example.com/frw/
[songs]
directory = songs
[bibles]
directory = bibles
[themes]
directory = themes
"""
Made the FTW able to handle if the downloaded config file is invalid. Fixes: https://launchpad.net/bugs/1222944
2014-11-07 09:32:45 +00:00
FAKE_BROKEN_CONFIG = b"""
[general]
base url = http://example.com/frw/
[songs]
directory = songs
[bibles]
directory = bibles
"""
FAKE_INVALID_CONFIG = b"""
<html>
<head><title>This is not a config file</title></head>
<body>Some text</body>
</html>
"""
Add tests for First Time Wizards web config file
2014-04-15 18:44:33 +00:00
class TestFirstTimeForm(TestCase, TestMixin):
def setUp(self):
Added and updated tests: - Refactored FirstTimeForm to use an initalise() method, in order to be more testable - Rewrote FTW tests to test initialise() - Refactored TestMixin get_application() to setup_application() since it doesn't actually return an application object - Refactored ListPreviewWidget to make it more testable - Wrote tests for ListPreviewWidget - Refactored FormattingTagsForm somewhat - Updated FormattingTagsForm tests Updated setup.py with some Python3 changes.
2014-10-22 20:43:05 +00:00
self.setup_application()
self.app.setApplicationVersion('0.0')
[refactor] Renamed "was_download_cancelled" to "was_cancelled" [refactor] Put some more stuff back into initalise() where it belongs [refactor] Rewrote old tests, wrote new tests
2014-11-08 21:15:25 +00:00
# Set up a fake "set_normal_cursor" method since we're not dealing with an actual OpenLP application object
self.app.set_normal_cursor = lambda: None
Fixed up merge conflicts.
2014-12-12 20:57:42 +00:00
self.app.process_events = lambda: None
Add tests for First Time Wizards web config file
2014-04-15 18:44:33 +00:00
Registry.create()
Registry().register('application', self.app)
Fix ftw socket.timeout bug 1422683
2015-02-17 21:27:51 +00:00
self.tempfile = os.path.join(tempfile.gettempdir(), 'testfile')
def tearDown(self):
if os.path.isfile(self.tempfile):
os.remove(self.tempfile)
Add tests for First Time Wizards web config file
2014-04-15 18:44:33 +00:00
Add a test
2016-04-29 20:52:37 +00:00
@patch('openlp.core.ui.firsttimewizard.is_macosx')
def constructor_macosx_test(self, mocked_is_macosx):
"""
Test that the form is resized correctly on OS X
"""
# GIVEN: The platform is OS X
mocked_is_macosx.return_value = True
# WHEN: The wizard is created
frw = FirstTimeForm(None)
# THEN: The form should have been resized
size = frw.size()
self.assertEqual(634, size.width())
self.assertEqual(386, size.height())
[refactor] Renamed "was_download_cancelled" to "was_cancelled" [refactor] Put some more stuff back into initalise() where it belongs [refactor] Rewrote old tests, wrote new tests
2014-11-08 21:15:25 +00:00
def initialise_test(self):
Add tests for First Time Wizards web config file
2014-04-15 18:44:33 +00:00
"""
[refactor] Renamed "was_download_cancelled" to "was_cancelled" [refactor] Put some more stuff back into initalise() where it belongs [refactor] Rewrote old tests, wrote new tests
2014-11-08 21:15:25 +00:00
Test if we can intialise the FirstTimeForm
Add tests for First Time Wizards web config file
2014-04-15 18:44:33 +00:00
"""
[refactor] Renamed "was_download_cancelled" to "was_cancelled" [refactor] Put some more stuff back into initalise() where it belongs [refactor] Rewrote old tests, wrote new tests
2014-11-08 21:15:25 +00:00
# GIVEN: A First Time Wizard and an expected screen object
frw = FirstTimeForm(None)
expected_screens = MagicMock()
# WHEN: The First Time Wizard is initialised
frw.initialize(expected_screens)
# THEN: The screens should be set up, and the default values initialised
self.assertEqual(expected_screens, frw.screens, 'The screens should be correct')
self.assertTrue(frw.web_access, 'The default value of self.web_access should be True')
self.assertFalse(frw.was_cancelled, 'The default value of self.was_cancelled should be False')
self.assertListEqual([], frw.theme_screenshot_threads, 'The list of threads should be empty')
self.assertListEqual([], frw.theme_screenshot_workers, 'The list of workers should be empty')
self.assertFalse(frw.has_run_wizard, 'has_run_wizard should be False')
def set_defaults_test(self):
"""
Test that the default values are set when set_defaults() is run
"""
# GIVEN: An initialised FRW and a whole lot of stuff mocked out
frw = FirstTimeForm(None)
frw.initialize(MagicMock())
with patch.object(frw, 'restart') as mocked_restart, \
patch.object(frw, 'cancel_button') as mocked_cancel_button, \
patch.object(frw, 'no_internet_finish_button') as mocked_no_internet_finish_btn, \
patch.object(frw, 'currentIdChanged') as mocked_currentIdChanged, \
patch.object(Registry, 'register_function') as mocked_register_function, \
patch('openlp.core.ui.firsttimeform.Settings') as MockedSettings, \
patch('openlp.core.ui.firsttimeform.gettempdir') as mocked_gettempdir, \
patch('openlp.core.ui.firsttimeform.check_directory_exists') as mocked_check_directory_exists, \
patch.object(frw.application, 'set_normal_cursor') as mocked_set_normal_cursor:
mocked_settings = MagicMock()
mocked_settings.value.return_value = True
MockedSettings.return_value = mocked_settings
mocked_gettempdir.return_value = 'temp'
expected_temp_path = os.path.join('temp', 'openlp')
# WHEN: The set_defaults() method is run
frw.set_defaults()
# THEN: The default values should have been set
mocked_restart.assert_called_with()
self.assertEqual('http://openlp.org/files/frw/', frw.web, 'The default URL should be set')
mocked_cancel_button.clicked.connect.assert_called_with(frw.on_cancel_button_clicked)
mocked_no_internet_finish_btn.clicked.connect.assert_called_with(frw.on_no_internet_finish_button_clicked)
mocked_currentIdChanged.connect.assert_called_with(frw.on_current_id_changed)
mocked_register_function.assert_called_with('config_screen_changed', frw.update_screen_list_combo)
mocked_no_internet_finish_btn.setVisible.assert_called_with(False)
mocked_settings.value.assert_called_with('core/has run wizard')
mocked_gettempdir.assert_called_with()
mocked_check_directory_exists.assert_called_with(expected_temp_path)
def update_screen_list_combo_test(self):
Add tests for First Time Wizards web config file
2014-04-15 18:44:33 +00:00
"""
[refactor] Renamed "was_download_cancelled" to "was_cancelled" [refactor] Put some more stuff back into initalise() where it belongs [refactor] Rewrote old tests, wrote new tests
2014-11-08 21:15:25 +00:00
Test that the update_screen_list_combo() method works correctly
Add tests for First Time Wizards web config file
2014-04-15 18:44:33 +00:00
"""
[refactor] Renamed "was_download_cancelled" to "was_cancelled" [refactor] Put some more stuff back into initalise() where it belongs [refactor] Rewrote old tests, wrote new tests
2014-11-08 21:15:25 +00:00
# GIVEN: A mocked Screen() object and an initialised First Run Wizard and a mocked display_combo_box
expected_screen_list = ['Screen 1', 'Screen 2']
mocked_screens = MagicMock()
mocked_screens.get_screen_list.return_value = expected_screen_list
frw = FirstTimeForm(None)
frw.initialize(mocked_screens)
with patch.object(frw, 'display_combo_box') as mocked_display_combo_box:
mocked_display_combo_box.count.return_value = 2
# WHEN: update_screen_list_combo() is called
frw.update_screen_list_combo()
# THEN: The combobox should have been updated
mocked_display_combo_box.clear.assert_called_with()
mocked_screens.get_screen_list.assert_called_with()
mocked_display_combo_box.addItems.assert_called_with(expected_screen_list)
mocked_display_combo_box.count.assert_called_with()
mocked_display_combo_box.setCurrentIndex.assert_called_with(1)
def on_cancel_button_clicked_test(self):
"""
Test that the cancel button click slot shuts down the threads correctly
"""
# GIVEN: A FRW, some mocked threads and workers (that isn't quite done) and other mocked stuff
frw = FirstTimeForm(None)
frw.initialize(MagicMock())
mocked_worker = MagicMock()
mocked_thread = MagicMock()
mocked_thread.isRunning.side_effect = [True, False]
frw.theme_screenshot_workers.append(mocked_worker)
frw.theme_screenshot_threads.append(mocked_thread)
with patch('openlp.core.ui.firsttimeform.time') as mocked_time, \
patch.object(frw.application, 'set_normal_cursor') as mocked_set_normal_cursor:
# WHEN: on_cancel_button_clicked() is called
frw.on_cancel_button_clicked()
# THEN: The right things should be called in the right order
self.assertTrue(frw.was_cancelled, 'The was_cancelled property should have been set to True')
mocked_worker.set_download_canceled.assert_called_with(True)
mocked_thread.isRunning.assert_called_with()
self.assertEqual(2, mocked_thread.isRunning.call_count, 'isRunning() should have been called twice')
mocked_time.sleep.assert_called_with(0.1)
self.assertEqual(1, mocked_time.sleep.call_count, 'sleep() should have only been called once')
mocked_set_normal_cursor.assert_called_with()
Made the FTW able to handle if the downloaded config file is invalid. Fixes: https://launchpad.net/bugs/1222944
2014-11-07 09:32:45 +00:00
def broken_config_test(self):
"""
Test if we can handle an config file with missing data
"""
# GIVEN: A mocked get_web_page, a First Time Wizard, an expected screen object, and a mocked broken config file
with patch('openlp.core.ui.firsttimeform.get_web_page') as mocked_get_web_page:
first_time_form = FirstTimeForm(None)
Fixed up merge conflicts.
2014-12-12 20:57:42 +00:00
first_time_form.initialize(MagicMock())
Made the FTW able to handle if the downloaded config file is invalid. Fixes: https://launchpad.net/bugs/1222944
2014-11-07 09:32:45 +00:00
mocked_get_web_page.return_value.read.return_value = FAKE_BROKEN_CONFIG
Fixed up merge conflicts.
2014-12-12 20:57:42 +00:00
# WHEN: The First Time Wizard is downloads the config file
first_time_form._download_index()
Made the FTW able to handle if the downloaded config file is invalid. Fixes: https://launchpad.net/bugs/1222944
2014-11-07 09:32:45 +00:00
# THEN: The First Time Form should not have web access
self.assertFalse(first_time_form.web_access, 'There should not be web access with a broken config file')
def invalid_config_test(self):
"""
Test if we can handle an config file in invalid format
"""
# GIVEN: A mocked get_web_page, a First Time Wizard, an expected screen object, and a mocked invalid config file
with patch('openlp.core.ui.firsttimeform.get_web_page') as mocked_get_web_page:
first_time_form = FirstTimeForm(None)
Fixed up merge conflicts.
2014-12-12 20:57:42 +00:00
first_time_form.initialize(MagicMock())
Made the FTW able to handle if the downloaded config file is invalid. Fixes: https://launchpad.net/bugs/1222944
2014-11-07 09:32:45 +00:00
mocked_get_web_page.return_value.read.return_value = FAKE_INVALID_CONFIG
Fixed up merge conflicts.
2014-12-12 20:57:42 +00:00
# WHEN: The First Time Wizard is downloads the config file
first_time_form._download_index()
Made the FTW able to handle if the downloaded config file is invalid. Fixes: https://launchpad.net/bugs/1222944
2014-11-07 09:32:45 +00:00
# THEN: The First Time Form should not have web access
self.assertFalse(first_time_form.web_access, 'There should not be web access with an invalid config file')
Catch network error in FTW
2015-01-13 19:03:05 +00:00
@patch('openlp.core.ui.firsttimeform.get_web_page')
Migrate to PyQt5
2015-11-07 00:49:40 +00:00
@patch('openlp.core.ui.firsttimeform.QtWidgets.QMessageBox')
Catch network error in FTW
2015-01-13 19:03:05 +00:00
def network_error_test(self, mocked_message_box, mocked_get_web_page):
"""
Test we catch a network error in First Time Wizard - bug 1409627
"""
# GIVEN: Initial setup and mocks
first_time_form = FirstTimeForm(None)
first_time_form.initialize(MagicMock())
mocked_get_web_page.side_effect = urllib.error.HTTPError(url='http//localhost',
code=407,
msg='Network proxy error',
hdrs=None,
fp=None)
# WHEN: the First Time Wizard calls to get the initial configuration
first_time_form._download_index()
# THEN: the critical_error_message_box should have been called
self.assertEquals(mocked_message_box.mock_calls[1][1][0], 'Network Error 407',
'first_time_form should have caught Network Error')
Fix ftw socket.timeout bug 1422683
2015-02-17 21:27:51 +00:00
@patch('openlp.core.ui.firsttimeform.urllib.request.urlopen')
def socket_timeout_test(self, mocked_urlopen):
"""
Test socket timeout gets caught
"""
# GIVEN: Mocked urlopen to fake a network disconnect in the middle of a download
first_time_form = FirstTimeForm(None)
first_time_form.initialize(MagicMock())
mocked_urlopen.side_effect = socket.timeout()
# WHEN: Attempt to retrieve a file
first_time_form.url_get_file(url='http://localhost/test', f_path=self.tempfile)
# THEN: socket.timeout should have been caught
# NOTE: Test is if $tmpdir/tempfile is still there, then test fails since ftw deletes bad downloaded files
self.assertFalse(os.path.exists(self.tempfile), 'FTW url_get_file should have caught socket.timeout')