forked from openlp/openlp
271 lines
12 KiB
Python
271 lines
12 KiB
Python
# -*- coding: utf-8 -*-
|
|
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
|
|
|
|
###############################################################################
|
|
# OpenLP - Open Source Lyrics Projection #
|
|
# --------------------------------------------------------------------------- #
|
|
# Copyright (c) 2008-2015 Raoul Snyman #
|
|
# Portions copyright (c) 2008-2015 Tim Bentley, Gerald Britton, Jonathan #
|
|
# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
|
|
# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
|
|
# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
|
|
# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
|
|
# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
|
|
# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
|
|
# --------------------------------------------------------------------------- #
|
|
# 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 #
|
|
###############################################################################
|
|
"""
|
|
This module contains tests for the pptviewcontroller module of the Presentations plugin.
|
|
"""
|
|
import os
|
|
import shutil
|
|
|
|
from tempfile import mkdtemp
|
|
from unittest import TestCase
|
|
|
|
from tests.functional import MagicMock, patch
|
|
from tests.helpers.testmixin import TestMixin
|
|
from tests.utils.constants import TEST_RESOURCES_PATH
|
|
|
|
from openlp.plugins.presentations.lib.pptviewcontroller import PptviewDocument, PptviewController
|
|
from openlp.core.common import is_win
|
|
|
|
if is_win():
|
|
from ctypes import cdll
|
|
|
|
|
|
class TestPptviewController(TestCase, TestMixin):
|
|
"""
|
|
Test the PptviewController Class
|
|
"""
|
|
# TODO: Items left to test
|
|
# PptviewController
|
|
# start_process(self)
|
|
# kill
|
|
|
|
def setUp(self):
|
|
"""
|
|
Set up the patches and mocks need for all tests.
|
|
"""
|
|
self.setup_application()
|
|
self.build_settings()
|
|
self.mock_plugin = MagicMock()
|
|
self.temp_folder = mkdtemp()
|
|
self.mock_plugin.settings_section = self.temp_folder
|
|
|
|
def tearDown(self):
|
|
"""
|
|
Stop the patches
|
|
"""
|
|
self.destroy_settings()
|
|
shutil.rmtree(self.temp_folder)
|
|
|
|
def constructor_test(self):
|
|
"""
|
|
Test the Constructor from the PptViewController
|
|
"""
|
|
# GIVEN: No presentation controller
|
|
controller = None
|
|
|
|
# WHEN: The presentation controller object is created
|
|
controller = PptviewController(plugin=self.mock_plugin)
|
|
|
|
# THEN: The name of the presentation controller should be correct
|
|
self.assertEqual('Powerpoint Viewer', controller.name,
|
|
'The name of the presentation controller should be correct')
|
|
|
|
def check_available_test(self):
|
|
"""
|
|
Test check_available / check_installed
|
|
"""
|
|
# GIVEN: A mocked dll loader and a controller
|
|
with patch('ctypes.cdll.LoadLibrary') as mocked_load_library:
|
|
mocked_process = MagicMock()
|
|
mocked_process.CheckInstalled.return_value = True
|
|
mocked_load_library.return_value = mocked_process
|
|
controller = PptviewController(plugin=self.mock_plugin)
|
|
|
|
# WHEN: check_available is called
|
|
available = controller.check_available()
|
|
|
|
# THEN: On windows it should return True, on other platforms False
|
|
if is_win():
|
|
self.assertTrue(available, 'check_available should return True on windows.')
|
|
else:
|
|
self.assertFalse(available, 'check_available should return False when not on windows.')
|
|
|
|
|
|
class TestPptviewDocument(TestCase):
|
|
"""
|
|
Test the PptviewDocument Class
|
|
"""
|
|
# TODO: Items left to test
|
|
# PptviewDocument
|
|
# __init__
|
|
# create_thumbnails
|
|
# close_presentation
|
|
# is_loaded
|
|
# is_active
|
|
# blank_screen
|
|
# unblank_screen
|
|
# is_blank
|
|
# stop_presentation
|
|
# start_presentation
|
|
# get_slide_number
|
|
# get_slide_count
|
|
# goto_slide
|
|
# next_step
|
|
# previous_step
|
|
|
|
def setUp(self):
|
|
"""
|
|
Set up the patches and mocks need for all tests.
|
|
"""
|
|
self.os_isdir_patcher = patch('openlp.plugins.presentations.lib.pptviewcontroller.os.path.isdir')
|
|
self.pptview_document_create_thumbnails_patcher = patch(
|
|
'openlp.plugins.presentations.lib.pptviewcontroller.PptviewDocument.create_thumbnails')
|
|
self.pptview_document_stop_presentation_patcher = patch(
|
|
'openlp.plugins.presentations.lib.pptviewcontroller.PptviewDocument.stop_presentation')
|
|
self.presentation_document_get_temp_folder_patcher = patch(
|
|
'openlp.plugins.presentations.lib.pptviewcontroller.PresentationDocument.get_temp_folder')
|
|
self.presentation_document_setup_patcher = patch(
|
|
'openlp.plugins.presentations.lib.pptviewcontroller.PresentationDocument._setup')
|
|
self.screen_list_patcher = patch('openlp.plugins.presentations.lib.pptviewcontroller.ScreenList')
|
|
self.rect_patcher = MagicMock()
|
|
self.mock_os_isdir = self.os_isdir_patcher.start()
|
|
self.mock_pptview_document_create_thumbnails = self.pptview_document_create_thumbnails_patcher.start()
|
|
self.mock_pptview_document_stop_presentation = self.pptview_document_stop_presentation_patcher.start()
|
|
self.mock_presentation_document_get_temp_folder = self.presentation_document_get_temp_folder_patcher.start()
|
|
self.mock_presentation_document_setup = self.presentation_document_setup_patcher.start()
|
|
self.mock_rect = self.rect_patcher.start()
|
|
self.mock_screen_list = self.screen_list_patcher.start()
|
|
self.mock_controller = MagicMock()
|
|
self.mock_presentation = MagicMock()
|
|
self.temp_folder = mkdtemp()
|
|
self.mock_presentation_document_get_temp_folder.return_value = self.temp_folder
|
|
|
|
def tearDown(self):
|
|
"""
|
|
Stop the patches
|
|
"""
|
|
self.os_isdir_patcher.stop()
|
|
self.pptview_document_create_thumbnails_patcher.stop()
|
|
self.pptview_document_stop_presentation_patcher.stop()
|
|
self.presentation_document_get_temp_folder_patcher.stop()
|
|
self.presentation_document_setup_patcher.stop()
|
|
self.rect_patcher.stop()
|
|
self.screen_list_patcher.stop()
|
|
shutil.rmtree(self.temp_folder)
|
|
|
|
def load_presentation_succesfull_test(self):
|
|
"""
|
|
Test the PptviewDocument.load_presentation() method when the PPT is successfully opened
|
|
"""
|
|
# GIVEN: A reset mocked_os
|
|
self.mock_os_isdir.reset()
|
|
|
|
# WHEN: The temporary directory exists and OpenPPT returns successfully (not -1)
|
|
self.mock_os_isdir.return_value = True
|
|
self.mock_controller.process.OpenPPT.return_value = 0
|
|
instance = PptviewDocument(self.mock_controller, self.mock_presentation)
|
|
instance.file_path = 'test\path.ppt'
|
|
|
|
if is_win():
|
|
result = instance.load_presentation()
|
|
|
|
# THEN: PptviewDocument.load_presentation should return True
|
|
self.assertTrue(result)
|
|
|
|
def load_presentation_un_succesfull_test(self):
|
|
"""
|
|
Test the PptviewDocument.load_presentation() method when the temporary directory does not exist and the PPT is
|
|
not successfully opened
|
|
"""
|
|
# GIVEN: A reset mock_os_isdir
|
|
self.mock_os_isdir.reset()
|
|
|
|
# WHEN: The temporary directory does not exist and OpenPPT returns unsuccessfully (-1)
|
|
with patch('openlp.plugins.presentations.lib.pptviewcontroller.os.makedirs') as mock_makedirs:
|
|
self.mock_os_isdir.return_value = False
|
|
self.mock_controller.process.OpenPPT.return_value = -1
|
|
instance = PptviewDocument(self.mock_controller, self.mock_presentation)
|
|
instance.file_path = 'test\path.ppt'
|
|
if is_win():
|
|
result = instance.load_presentation()
|
|
|
|
# THEN: The temp folder should be created and PptviewDocument.load_presentation should return False
|
|
mock_makedirs.assert_called_once_with(self.temp_folder)
|
|
self.assertFalse(result)
|
|
|
|
def create_titles_and_notes_test(self):
|
|
"""
|
|
Test PowerpointController.create_titles_and_notes
|
|
"""
|
|
# GIVEN: mocked PresentationController.save_titles_and_notes and a pptx file
|
|
doc = PptviewDocument(self.mock_controller, self.mock_presentation)
|
|
doc.file_path = os.path.join(TEST_RESOURCES_PATH, 'presentations', 'test.pptx')
|
|
doc.save_titles_and_notes = MagicMock()
|
|
|
|
# WHEN reading the titles and notes
|
|
doc.create_titles_and_notes()
|
|
|
|
# THEN save_titles_and_notes should have been called once with empty arrays
|
|
doc.save_titles_and_notes.assert_called_once_with(['Test 1\n', '\n', 'Test 2\n', 'Test 4\n', 'Test 3\n'],
|
|
['Notes for slide 1', 'Inserted', 'Notes for slide 2',
|
|
'Notes \nfor slide 4', 'Notes for slide 3'])
|
|
|
|
def create_titles_and_notes_nonexistent_file_test(self):
|
|
"""
|
|
Test PowerpointController.create_titles_and_notes with nonexistent file
|
|
"""
|
|
# GIVEN: mocked PresentationController.save_titles_and_notes and an nonexistent file
|
|
with patch('builtins.open') as mocked_open, \
|
|
patch('openlp.plugins.presentations.lib.pptviewcontroller.os.path.exists') as mocked_exists, \
|
|
patch('openlp.plugins.presentations.lib.presentationcontroller.check_directory_exists') as \
|
|
mocked_dir_exists:
|
|
mocked_exists.return_value = False
|
|
mocked_dir_exists.return_value = False
|
|
doc = PptviewDocument(self.mock_controller, self.mock_presentation)
|
|
doc.file_path = 'Idontexist.pptx'
|
|
doc.save_titles_and_notes = MagicMock()
|
|
|
|
# WHEN: Reading the titles and notes
|
|
doc.create_titles_and_notes()
|
|
|
|
# THEN: File existens should have been checked, and not have been opened.
|
|
doc.save_titles_and_notes.assert_called_once_with(None, None)
|
|
mocked_exists.assert_any_call('Idontexist.pptx')
|
|
self.assertEqual(mocked_open.call_count, 0, 'There should be no calls to open a file.')
|
|
|
|
def create_titles_and_notes_invalid_file_test(self):
|
|
"""
|
|
Test PowerpointController.create_titles_and_notes with invalid file
|
|
"""
|
|
# GIVEN: mocked PresentationController.save_titles_and_notes and an invalid file
|
|
with patch('builtins.open') as mocked_open, \
|
|
patch('openlp.plugins.presentations.lib.pptviewcontroller.zipfile.is_zipfile') as mocked_is_zf:
|
|
mocked_is_zf.return_value = False
|
|
mocked_open.filesize = 10
|
|
doc = PptviewDocument(self.mock_controller, self.mock_presentation)
|
|
doc.file_path = os.path.join(TEST_RESOURCES_PATH, 'presentations', 'test.ppt')
|
|
doc.save_titles_and_notes = MagicMock()
|
|
|
|
# WHEN: reading the titles and notes
|
|
doc.create_titles_and_notes()
|
|
|
|
# THEN:
|
|
doc.save_titles_and_notes.assert_called_once_with(None, None)
|
|
self.assertEqual(mocked_is_zf.call_count, 1, 'is_zipfile should have been called once')
|