← Back to team overview

openlp-core team mailing list archive

[Merge] lp:~sam92/openlp/bug-1332990 into lp:openlp

 

Samuel Mehrbrodt has proposed merging lp:~sam92/openlp/bug-1332990 into lp:openlp.

Requested reviews:
  Tim Bentley (trb143)
Related bugs:
  Bug #1332990 in OpenLP: "Theme export broken"
  https://bugs.launchpad.net/openlp/+bug/1332990

For more details, see:
https://code.launchpad.net/~sam92/openlp/bug-1332990/+merge/224991

Fix theme export and add unit test.

The Windows unit test fails because somehow the 2.2.2 tag got in here.

[SUCCESS] http://ci.openlp.org/job/Branch-01-Pull/485/
[SUCCESS] http://ci.openlp.org/job/Branch-02-Functional-Tests/441/
[SUCCESS] http://ci.openlp.org/job/Branch-03-Interface-Tests/386/
[FAILURE] http://ci.openlp.org/job/Branch-04-Windows_Tests/346/
[SUCCESS] http://ci.openlp.org/job/Branch-05a-Code_Analysis/235/
[SUCCESS] http://ci.openlp.org/job/Branch-05b-Test_Coverage/109/
-- 
https://code.launchpad.net/~sam92/openlp/bug-1332990/+merge/224991
Your team OpenLP Core is subscribed to branch lp:openlp.
=== modified file 'openlp/core/ui/thememanager.py'
--- openlp/core/ui/thememanager.py	2014-03-20 19:10:31 +0000
+++ openlp/core/ui/thememanager.py	2014-06-30 12:40:04 +0000
@@ -384,16 +384,8 @@
         self.application.set_busy_cursor()
         if path:
             Settings().setValue(self.settings_section + '/last directory export', path)
-            theme_path = os.path.join(path, theme + '.otz')
-            theme_zip = None
             try:
-                theme_zip = zipfile.ZipFile(theme_path, 'w')
-                source = os.path.join(self.path, theme)
-                for files in os.walk(source):
-                    for name in files[2]:
-                        theme_zip.write(
-                            os.path.join(source, name).encode('utf-8'), os.path.join(theme, name).encode('utf-8')
-                        )
+                self._export_theme(path, theme)
                 QtGui.QMessageBox.information(self,
                                               translate('OpenLP.ThemeManager', 'Theme Exported'),
                                               translate('OpenLP.ThemeManager',
@@ -403,11 +395,29 @@
                 critical_error_message_box(translate('OpenLP.ThemeManager', 'Theme Export Failed'),
                                            translate('OpenLP.ThemeManager',
                                                      'Your theme could not be exported due to an error.'))
-            finally:
-                if theme_zip:
-                    theme_zip.close()
         self.application.set_normal_cursor()
 
+    def _export_theme(self, path, theme):
+        """
+        Create the zipfile with the theme contents.
+        :param path: Location where the zip file will be placed
+        :param theme: The name of the theme to be exported
+        """
+        theme_path = os.path.join(path, theme + '.otz')
+        try:
+            theme_zip = zipfile.ZipFile(theme_path, 'w')
+            source = os.path.join(self.path, theme)
+            for files in os.walk(source):
+                for name in files[2]:
+                    theme_zip.write(os.path.join(source, name), os.path.join(theme, name))
+        except (IOError, OSError):
+            if theme_zip:
+                theme_zip.close()
+                shutil.rmtree(theme_path, True)
+            raise
+        else:
+            theme_zip.close()
+
     def on_import_theme(self, field=None):
         """
         Opens a file dialog to select the theme file(s) to import before attempting to extract OpenLP themes from

=== added file 'tests/functional/openlp_core_ui/test_thememanager.py'
--- tests/functional/openlp_core_ui/test_thememanager.py	1970-01-01 00:00:00 +0000
+++ tests/functional/openlp_core_ui/test_thememanager.py	2014-06-30 12:40:04 +0000
@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection                                      #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2014 Raoul Snyman                                        #
+# Portions copyright (c) 2008-2014 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                          #
+###############################################################################
+"""
+Package to test the openlp.core.ui.thememanager package.
+"""
+import zipfile
+import os
+
+from unittest import TestCase
+from tests.interfaces import MagicMock
+
+from openlp.core.ui import ThemeManager
+
+RESOURCES_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..', 'resources', 'themes'))
+
+
+class TestThemeManager(TestCase):
+
+    def export_theme_test(self):
+        """
+        Test exporting a theme .
+        """
+        # GIVEN: A new ThemeManager instance.
+        theme_manager = ThemeManager()
+        theme_manager.path = RESOURCES_PATH
+        zipfile.ZipFile.__init__ = MagicMock()
+        zipfile.ZipFile.__init__.return_value = None
+        zipfile.ZipFile.write = MagicMock()
+
+        # WHEN: The theme is exported
+        theme_manager._export_theme('/some/path', 'Default')
+
+        # THEN: The zipfile should be created at the given path
+        zipfile.ZipFile.__init__.assert_called_with('/some/path/Default.otz', 'w')
+        zipfile.ZipFile.write.assert_called_with(os.path.join(RESOURCES_PATH, 'Default', 'Default.xml'),
+                                                 'Default/Default.xml')

=== added directory 'tests/resources/themes'
=== added directory 'tests/resources/themes/Default'
=== added file 'tests/resources/themes/Default/Default.xml'
--- tests/resources/themes/Default/Default.xml	1970-01-01 00:00:00 +0000
+++ tests/resources/themes/Default/Default.xml	2014-06-30 12:40:04 +0000
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="utf-8"?>
+<theme version="2.0">
+    <name>Default</name>
+    <background type="solid">
+        <color>#000000</color>
+    </background>
+    <font type="main">
+        <name>Arial</name>
+        <color>#FFFFFF</color>
+        <size>40</size>
+        <bold>False</bold>
+        <italics>False</italics>
+        <line_adjustment>0</line_adjustment>
+        <location height="690" override="False" width="1004" x="10" y="10"/>
+        <shadow shadowColor="#000000" shadowSize="5">True</shadow>
+        <outline outlineColor="#000000" outlineSize="2">False</outline>
+    </font>
+    <font type="footer">
+        <name>Arial</name>
+        <color>#FFFFFF</color>
+        <size>12</size>
+        <bold>False</bold>
+        <italics>False</italics>
+        <line_adjustment>0</line_adjustment>
+        <location height="78" override="False" width="1004" x="10" y="690"/>
+        <shadow shadowColor="#000000" shadowSize="5">True</shadow>
+        <outline outlineColor="#000000" outlineSize="2">False</outline>
+    </font>
+    <display>
+        <horizontalAlign>0</horizontalAlign>
+        <verticalAlign>0</verticalAlign>
+        <slideTransition>False</slideTransition>
+    </display>
+</theme>


Follow ups