Merge lp:~marmyshev/openlp/bug_1117098 into lp:openlp

[Dmitriy Marmyshev]

Fixed transparent display on OS X

[Raoul Snyman (raoul-snyman)]

review: Approve

[Raoul Snyman (raoul-snyman)]

sorry, you need to write a test

review: Needs Fixing

[Jonathan Corwin (j-corwin)]

This causes a 1 pixel white border to appear around the transparent display screen on Windows.

review: Needs Fixing

[Dmitriy Marmyshev (marmyshev)]

Raoul, can you help me wiht writing test for this? Because I dont know how to test it.

[lp:~marmyshev/openlp/bug_1117098]

2300. By Dmitriy Marmyshev on 2013-09-18

Removes border, but not affects to OSX border and shadow

[Phill (phill-ridout)]

Dmitriy,

http://wiki.openlp.org/Development:Unit_Tests should be of some help.

A good example to follow would be http://bazaar.launchpad.net/~openlp-core/openlp/trunk/view/head:/tests/functional/openlp_plugins/songs/test_foilpresenterimport.py

The encoding_declaration_removal_test method is probably similar to what you want to achieve (if a little more basic)

This is probably a nice easy one to start on. We're going to test the function you modified. (set_transparency )There is not any tests written for this module yet, so you will need to create a new file /tests/functional/openlp_core_ui/test_maindisplay.py

In a #TODO: Make a list of all the classes and methods so that we know what needs doing still

Create a class call it "TestMainDisplay" and sub class from TestCase

Because this function has two paths (one if enabled is true and one if enabled is false) you will need to write two tests.

You might as well write a setUp and tearDown functions as these will be helpful when more tests are added. In the setUp you will need to patch and mock __init__ .setAutoFillBackground, .setStyleSheet, .setAttribute, .repaint

Create two test functions, I'd call it "test_set_transparency_enable" & "test_set_transparency_disable"

First thing you will need to do in each test function is write you #GIVEN so something like:
"#GIVEN: Reset mocks: MainDisplay.__init__, MainDisplay.setAutoFillBackground, etc. And an instance of MainDisplay
Now reset the mocks that we are going to check the calls on later and create an instance of MainDisplay

Now you need to write you #WHEN: so one will be like:
"#WHEN: MainDispaly.set_transparency is called with a true value"
So call result = instance.set_transparency(True)

Now write you #THEN:
"#THEN: MainDisplay.setAutoFillBackground, MainDisplay.setStyleSheet, MainDisplay.setAttribute, MainDisplay.repaint should have been called with known values"
Now you will need to assert that your mocks have been called with the expected values so the mock for MainDisplay.setStyleSheet should be called with "QGraphicsView {background: transparent; border: 0px;}"

Hope this gives you a start.

[Jonathan Corwin (j-corwin)]

This now works fine on Windows

[lp:~marmyshev/openlp/bug_1117098]

2301. By Dmitriy Marmyshev on 2013-10-11

some start

2302. By Dmitriy Marmyshev on 2013-10-24

Tests for transparency

2303. By Dmitriy Marmyshev on 2013-10-24

fixes

2304. By Dmitriy Marmyshev on 2013-10-26

Trunk & fixes

Unmerged revisions

=== modified file 'openlp/core/ui/maindisplay.py'
--- openlp/core/ui/maindisplay.py	2013-10-23 18:49:39 +0000
+++ openlp/core/ui/maindisplay.py	2013-10-24 18:41:39 +0000
@@ -167,8 +167,10 @@
         """
         if enabled:
             self.setAutoFillBackground(False)
+            self.setStyleSheet("QGraphicsView {background: transparent; border: 0px;}")
         else:
             self.setAttribute(QtCore.Qt.WA_NoSystemBackground, False)
+            self.setStyleSheet("QGraphicsView {}")
         self.setAttribute(QtCore.Qt.WA_TranslucentBackground, enabled)
         self.repaint()
 

=== added file 'tests/functional/openlp_core_ui/test_maindisplay.py'
--- tests/functional/openlp_core_ui/test_maindisplay.py	1970-01-01 00:00:00 +0000
+++ tests/functional/openlp_core_ui/test_maindisplay.py	2013-10-24 18:41:39 +0000
@@ -0,0 +1,84 @@
+# -*- 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, Dmitriy Marmyshev      #
+# --------------------------------------------------------------------------- #
+# 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.lib.maindisplay package.
+"""
+from unittest import TestCase
+
+from mock import MagicMock
+
+from openlp.core.ui.maindisplay import MainDisplay
+
+
+class TestMainDisplay(TestCase):
+    """
+    Test the functions in the :mod:`MainDisplay` module.
+    """
+    #TODO: The following classes still need tests written for
+    #   - Display
+    #   - MainDisplay
+    #   - AudioPlayer
+
+
+    def set_transparency_enable_test(self):
+        """
+        Test creating an instance of the MainDisplay class
+        """
+        # GIVEN: get an instance of MainDisplay
+        display = MagicMock()
+        main_dispaly = MainDisplay(display)
+
+        # WHEN: MainDispaly.set_transparency is called with a true value"
+        main_dispaly.set_transparency(True)
+
+        # THEN: check MainDisplay.setAutoFillBackground, MainDisplay.setStyleSheet, MainDisplay.setAttribute,
+        assert main_dispaly.StyleSheet == "QGraphicsView {background: transparent; border: 0px;}", \
+            'MainDisplay instance should be transparent'
+        assert main_dispaly.getAutoFillBackground == False, \
+            'MainDisplay instance should be without background auto fill'
+        assert main_dispaly.getAttribute(QtCore.Qt.WA_TranslucentBackground) == True, \
+            'MainDisplay hasnt translusent background'
+
+    def set_transparency_disable_test(self):
+        """
+        Test creating an instance of the MainDisplay class
+        """
+        # GIVEN: get an instance of MainDisplay
+        display = MagicMock()
+        main_dispaly = MainDisplay(display)
+
+        # WHEN: MainDispaly.set_transparency is called with a False value"
+        main_dispaly.set_transparency(False)
+
+        # THEN: check MainDisplay.setAutoFillBackground, MainDisplay.setStyleSheet, MainDisplay.setAttribute,
+        assert main_dispaly.StyleSheet == "QGraphicsView {}", \
+            'MainDisplay instance should not be transparent'
+        assert main_dispaly.getAutoFillBackground == True, 'MainDisplay instance should be with background auto fill'
+        assert main_dispaly.getAttribute(QtCore.Qt.WA_TranslucentBackground) == True, \
+            'MainDisplay hasnt translusent background'