openlp-core team mailing list archive

[Raoul Snyman <raoul@xxxxxxxxxxx>]

Raoul Snyman has proposed merging lp:~raoul-snyman/openlp/fix-presentations-cleanup-bug into lp:openlp.

Commit message:
Fix a bug when cleaning up thumbnails where all presentation controllers, whether enabled or not, would be cycled through.

Requested reviews:
  OpenLP Core (openlp-core)

For more details, see:
https://code.launchpad.net/~raoul-snyman/openlp/fix-presentations-cleanup-bug/+merge/369624

Fix a bug when cleaning up thumbnails where all presentation controllers, whether enabled or not, would be cycled through.
-- 
Your team OpenLP Core is requested to review the proposed merge of lp:~raoul-snyman/openlp/fix-presentations-cleanup-bug into lp:openlp.

=== modified file 'openlp/plugins/presentations/lib/mediaitem.py'
--- openlp/plugins/presentations/lib/mediaitem.py	2019-05-22 06:47:00 +0000
+++ openlp/plugins/presentations/lib/mediaitem.py	2019-07-03 04:00:28 +0000
@@ -246,6 +246,9 @@
         :rtype: None
         """
         for cidx in self.controllers:
+            if not self.controllers[cidx].enabled():
+                # skip presentation controllers that are not enabled
+                continue
             file_ext = file_path.suffix[1:]
             if file_ext in self.controllers[cidx].supports or file_ext in self.controllers[cidx].also_supports:
                 doc = self.controllers[cidx].add_document(file_path)

=== modified file 'tests/functional/openlp_plugins/presentations/test_mediaitem.py'
--- tests/functional/openlp_plugins/presentations/test_mediaitem.py	2019-05-22 06:47:00 +0000
+++ tests/functional/openlp_plugins/presentations/test_mediaitem.py	2019-07-03 04:00:28 +0000
@@ -24,7 +24,7 @@
 """
 from pathlib import Path
 from unittest import TestCase
-from unittest.mock import MagicMock, call, patch
+from unittest.mock import MagicMock, PropertyMock, call, patch
 
 from openlp.core.common.registry import Registry
 from openlp.plugins.presentations.lib.mediaitem import PresentationMediaItem
@@ -94,17 +94,23 @@
         Test that the clean_up_thumbnails method works as expected when files exists.
         """
         # GIVEN: A mocked controller, and mocked os.path.getmtime
-        mocked_controller = MagicMock()
+        mocked_disabled_controller = MagicMock()
+        mocked_disabled_controller.enabled.return_value = False
+        mocked_disabled_supports = PropertyMock()
+        type(mocked_disabled_controller).supports = mocked_disabled_supports
+        mocked_enabled_controller = MagicMock()
+        mocked_enabled_controller.enabled.return_value = True
         mocked_doc = MagicMock(**{'get_thumbnail_path.return_value': Path()})
-        mocked_controller.add_document.return_value = mocked_doc
-        mocked_controller.supports = ['tmp']
+        mocked_enabled_controller.add_document.return_value = mocked_doc
+        mocked_enabled_controller.supports = ['tmp']
         self.media_item.controllers = {
-            'Mocked': mocked_controller
+            'Enabled': mocked_enabled_controller,
+            'Disabled': mocked_disabled_controller
         }
 
-        thmub_path = MagicMock(st_mtime=100)
+        thumb_path = MagicMock(st_mtime=100)
         file_path = MagicMock(st_mtime=400)
-        with patch.object(Path, 'stat', side_effect=[thmub_path, file_path]), \
+        with patch.object(Path, 'stat', side_effect=[thumb_path, file_path]), \
                 patch.object(Path, 'exists', return_value=True):
             presentation_file = Path('file.tmp')
 
@@ -114,6 +120,7 @@
         # THEN: doc.presentation_deleted should have been called since the thumbnails mtime will be greater than
         #       the presentation_file's mtime.
         mocked_doc.assert_has_calls([call.get_thumbnail_path(1, True), call.presentation_deleted()], True)
+        assert mocked_disabled_supports.call_count == 0
 
     def test_clean_up_thumbnails_missing_file(self):
         """