Merge lp:~thelinuxguy/openlp/backport-fix into lp:openlp/2.4

[Simon Hanna]

Backport songbeamer fix

[Tim Bentley (trb143)]

Add this to your merge proposal:
--------------------------------
lp:~thelinuxguy/openlp/backport-fix (revision 2681)
[SUCCESS] https://ci.openlp.io/job/Branch-01-Pull/1951/
[FAILURE] https://ci.openlp.io/job/Branch-02-Functional-Tests/1862/
Stopping after failure

Test that when the logout method is called, it logs the user out of SongSelect ... ok
Test that when the logout method is called, it logs the user out of SongSelect ... ok
Test that saving a song with an existing author performs the correct actions ... ok
Test that saving a song with a new author performs the correct actions ... ok
Test that saving a song with topics performs the correct actions ... ok
Test that saving a song with an author name of only one word performs the correct actions ... ok
Test that when the search finds MAX (2) results, it simply returns a list with those (2) ... ok
Test that when the search finds no results, it simply returns an empty list ... ok
Test that when the search finds no results, it simply returns an empty list ... ok
Test that when the search finds 2 results, it simply returns a list with 2 results ... ok
Test that the search is stopped with stop() is called ... ok
Test that loading a SongShow Plus file works correctly on various files ... ok
Test creating an instance of the SongShow Plus file importer ... ok
Test SongShowPlusImport.do_import handles different invalid import_source values ... ok
Test to_openlp_verse_tag method by simulating adding a verse ... ok
Test to_openlp_verse_tag method by simulating adding a verse to the verse order ... ok
Test SongShowPlusImport.do_import handles different invalid import_source values ... ok
Test that loading an SundayPlus file works correctly on various files ... ok
Test that loading an VideoPsalm file works correctly on various files ... ok
Test that loading a Words of Worship file works correctly ... ok
Test that loading an Worship Assistant file works correctly ... ok
Failure: SkipTest (Not Windows, skipping test) ... SKIP: Not Windows, skipping test
Test that loading an ZionWorx file works correctly on various files ... ok
Test creating an instance of the ZionWorx file importer ... ok
Test the about text of the song usage plugin ... ok
Test that check_pre_condition returns true for valid manager session ... ok
Test the initialisation of the SongUsagePlugin class ... ok
Test that all the default settings are correct ... ok
Test that clicking on the dock icon on Mac OS X restores the main window if it is minimized ... ok
Test that we don't try to backup on a new install ... ok
Test that we try to backup on a new install ... ok
Test the reimplemented event method ... ok

======================================================================
ERROR: Test that a CP1252 encoded file get's decoded properly.
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/var/lib/jenkins/shared-repo/branch/tests/functional/openlp_plugins/songs/test_songbeamerimport.py", line 57, in test_cp1252_encoded_file
    self.load_external_result_data(os.path.join(TEST_PATH, 'cp1252song.json')))
  File "/var/lib/jenkins/shared-repo/branch/tests/helpers/songfileimport....

review: Needs Fixing

[lp:~thelinuxguy/openlp/backport-fix]

2682. By Simon Hanna on 2017-03-29

Restore previously deleted import

Unmerged revisions

=== modified file 'openlp/plugins/songs/lib/importers/songbeamer.py'
--- openlp/plugins/songs/lib/importers/songbeamer.py	2017-01-22 17:04:32 +0000
+++ openlp/plugins/songs/lib/importers/songbeamer.py	2017-03-29 22:05:27 +0000
@@ -22,11 +22,10 @@
 """
 The :mod:`songbeamer` module provides the functionality for importing SongBeamer songs into the OpenLP database.
 """
-import chardet
-import codecs
 import logging
 import os
 import re
+import chardet
 
 from openlp.plugins.songs.lib import VerseType
 from openlp.plugins.songs.lib.importers.songimport import SongImport
@@ -120,7 +119,7 @@
                 # The encoding should only be ANSI (cp1252), UTF-8, Unicode, Big-Endian-Unicode.
                 # So if it doesn't start with 'u' we default to cp1252. See:
                 # https://forum.songbeamer.com/viewtopic.php?p=419&sid=ca4814924e37c11e4438b7272a98b6f2
-                if self.input_file_encoding.lower().startswith('u'):
+                if not self.input_file_encoding.lower().startswith('u'):
                     self.input_file_encoding = 'cp1252'
                 infile = open(import_file, 'rt', encoding=self.input_file_encoding)
                 song_data = infile.readlines()

=== modified file 'tests/functional/openlp_plugins/songs/test_songbeamerimport.py'
--- tests/functional/openlp_plugins/songs/test_songbeamerimport.py	2016-12-31 11:05:48 +0000
+++ tests/functional/openlp_plugins/songs/test_songbeamerimport.py	2017-03-29 22:05:27 +0000
@@ -49,6 +49,13 @@
         self.file_import([os.path.join(TEST_PATH, 'Lobsinget dem Herrn.sng')],
                          self.load_external_result_data(os.path.join(TEST_PATH, 'Lobsinget dem Herrn.json')))
 
+    def test_cp1252_encoded_file(self):
+        """
+        Test that a CP1252 encoded file get's decoded properly.
+        """
+        self.file_import([os.path.join(TEST_PATH, 'cp1252song.sng')],
+                         self.load_external_result_data(os.path.join(TEST_PATH, 'cp1252song.json')))
+
 
 class TestSongBeamerImport(TestCase):
     """

=== added file 'tests/resources/songbeamersongs/cp1252song.json'
--- tests/resources/songbeamersongs/cp1252song.json	1970-01-01 00:00:00 +0000
+++ tests/resources/songbeamersongs/cp1252song.json	2017-03-29 22:05:27 +0000
@@ -0,0 +1,8 @@
+{
+"title": "Some Song",
+ "authors": ["Author"],
+ "verses" : [
+   ["Here are a couple of \"weird\" chars’’’.\n", "v"],
+   ["Here is another one….\n\n", "v"]
+ ]
+}

=== added file 'tests/resources/songbeamersongs/cp1252song.sng'
--- tests/resources/songbeamersongs/cp1252song.sng	1970-01-01 00:00:00 +0000
+++ tests/resources/songbeamersongs/cp1252song.sng	2017-03-29 22:05:27 +0000
@@ -0,0 +1,15 @@
+#LangCount=1
+#Editor=SongBeamer 4.28a
+#Version=3
+#Format=F/K//
+#TitleFormat=U
+#Title=Some Song
+#Author=Author
+#Melody=Author
+#(c)=No copyright
+#CCLI=0000000000
+---
+Here are a couple of "weird" chars’’’.
+---
+Here is another one….
+