openlp/tests/functional/openlp_plugins/presentations/test_powerpointcontroller.py

# -*- coding: utf-8 -*-
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4

###############################################################################
# OpenLP - Open Source Lyrics Projection                                      #
# --------------------------------------------------------------------------- #
# Copyright (c) 2008-2013 Raoul Snyman                                        #
# Portions copyright (c) 2008-2013 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                          #
###############################################################################
"""
Functional tests to test the PowerPointController class and related methods.
"""
from unittest import TestCase
import os
from mock import MagicMock
from openlp.plugins.presentations.lib.powerpointcontroller import \
    PowerpointController, PowerpointDocument, _get_text_from_shapes

TEST_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..',
    '..', 'resources'))

class TestLibModule(TestCase):

    def setUp(self):
        mocked_plugin = MagicMock()
        mocked_plugin.settings_section = 'presentations'
        self.ppc = PowerpointController(mocked_plugin)
        self.file_name = os.path.join(TEST_PATH, "test.pptx")
        self.doc = PowerpointDocument(self.ppc, self.file_name)

    # add _test    to the name to enable
    def verify_installation(self):
        """
        Test the installation of Powerpoint
        """
        # GIVEN: A boolean value set to true
        # WHEN: We "convert" it to a bool
        is_installed = self.ppc.check_available()
        # THEN: We should get back a True bool
        self.assertEqual(is_installed, True, 'The result should be True')

    # add _test to the following if necessary
    def verify_loading_document(self):
        """
        Test loading a document in PowerPoint
        """             
        # GIVEN: the filename
        print(self.file_name)
        # WHEN: loading the filename
        self.doc = PowerpointDocument(self.ppc, self.file_name)
        self.doc.load_presentation()
        result = self.doc.is_loaded()
        # THEN: result should be true
        self.assertEqual(result, True, 'The result should be True')

    def create_titles_and_notes_test(self):
        """
        Test creating the titles from PowerPoint
        """
        # GIVEN: mocked save_titles_and_notes, _get_text_from_shapes and two mocked slides
        self.doc = PowerpointDocument(self.ppc, self.file_name)
        self.doc.save_titles_and_notes = MagicMock()
        self.doc._PowerpointDocument__get_text_from_shapes = MagicMock()
        slide = MagicMock()
        slide.Shapes.Title.TextFrame.TextRange.Text = 'SlideText'
        pres = MagicMock()
        pres.Slides = [slide, slide]
        self.doc.presentation = pres
        # WHEN reading the titles and notes
        self.doc.create_titles_and_notes()
        # THEN the save should have been called exactly once with 2 titles and 2 notes
        self.doc.save_titles_and_notes.assert_called_once_with(
            ['SlideText\n', 'SlideText\n'], [' ', ' '])

    def create_titles_and_notes_with_no_slides_test(self):
        """
        Test creating the titles from PowerPoint when it returns no slides
        """
        # GIVEN: mocked save_titles_and_notes, _get_text_from_shapes and two mocked slides
        self.doc = PowerpointDocument(self.ppc, self.file_name)
        self.doc.save_titles_and_notes = MagicMock()
        self.doc._PowerpointDocument__get_text_from_shapes = MagicMock()
        pres = MagicMock()
        pres.Slides = []
        self.doc.presentation = pres
        # WHEN reading the titles and notes
        self.doc.create_titles_and_notes()
        # THEN the save should have been called exactly once with empty titles and notes
        self.doc.save_titles_and_notes.assert_called_once_with([], [])

    def get_text_from_shapes_test(self):
        """
        Test getting text from powerpoint shapes 
        """
        # GIVEN: mocked 
        shape = MagicMock()
        shape.PlaceholderFormat.Type = 2
        shape.HasTextFrame = shape.TextFrame.HasText = True
        shape.TextFrame.TextRange.Text = 'slideText'
        shapes = [shape, shape]
        result = _get_text_from_shapes(shapes)
        self.assertEqual(result, 'slideText\nslideText\n',
            'result should match \'slideText\nslideText\n\'')

    def get_text_from_shapes_with_no_shapes_test(self):
        """
        Test getting text from powerpoint shapes with no shapes
        """
        # GIVEN: mocked 
        shapes = []
        result = _get_text_from_shapes(shapes)
        self.assertEqual(result, '', 'result should be empty')