Merge lp:~stolowski/unity-2d/fix-912777 into lp:unity-2d

[Paweł Stołowski]

[launcher] Prevent progress bar from "overflowing".
Application::updateOverlaysStateEnforce - enforce launcher item progress values reported by applications to be within 0.0 - 1.0 range.

[launcher] Fixes https://bugs.launchpad.net/bugs/912777 + adds testability test cases.

[Michał Sawicz (saviq)]

Hey, in the case of this tests there's no need to kill / launch panel as it's unrelated.

review: Needs Fixing

[lp:~stolowski/unity-2d/fix-912777]

956. By Paweł Stołowski on 2012-03-06

Launcher item progress testability tests - don't start/kill panels as
panel is unrelated. Removed 'sleep' from the last test case.

[Paweł Stołowski (stolowski)]

> Hey, in the case of this tests there's no need to kill / launch panel as it's
> unrelated.

Agreed. Fixed.

[Gerry Boland (gerboland)]

Can you please list what python modules are needed for this to run, which are not part of a default install? They'll need to be added to the list of test requirements.

That will require updating the README file at the least, with perhaps a check to only run the test if all dependencies are installed, else skip with a warning.

[lp:~stolowski/unity-2d/fix-912777]

957. By Paweł Stołowski on 2012-03-09

Tests README file - added fake_progress.py to the list of dependencies.

[Paweł Stołowski (stolowski)]

> Can you please list what python modules are needed for this to run, which are
> not part of a default install? They'll need to be added to the list of test
> requirements.
>
> That will require updating the README file at the least, with perhaps a check
> to only run the test if all dependencies are installed, else skip with a
> warning.

Python modules needed by this test (python-gi, git1.2-unity-5.0) are in the default installation. Added them to the README - apt-get install ... step just in case.

[Gerry Boland (gerboland)]

Excellent, works perfect, test great too. Nice work

review: Approve

=== modified file 'libunity-2d-private/src/application.cpp'
--- libunity-2d-private/src/application.cpp	2012-03-05 11:28:54 +0000
+++ libunity-2d-private/src/application.cpp	2012-03-09 10:17:20 +0000
@@ -1137,6 +1137,13 @@
 Application::updateOverlaysState(const QString& sender, const QMap<QString, QVariant>& properties)
 {
     if (updateOverlayState(properties, "progress", &m_progress)) {
+        if (m_progress < 0.0f) {
+            m_progress = 0.0f;
+        } else {
+            if (m_progress > 1.0f) {
+                m_progress = 1.0f;
+            }
+        }
         Q_EMIT progressChanged(m_progress);
     }
     if (updateOverlayState(properties, "progress-visible", &m_progressBarVisible)) {
 
=== modified file 'tests/README'
--- tests/README	2012-01-24 11:47:05 +0000
+++ tests/README	2012-03-09 10:17:20 +0000
@@ -61,7 +61,9 @@
 
 $ sudo apt-get install rubygems testability-qttas \
   ruby-testability-driver-qt-sut-plugin testability-visualizer \
-  librmagick-ruby1.8 xdotool xsel x11-utils
+  librmagick-ruby1.8 xdotool xsel x11-utils gir1.2-unity-5.0 python-gi
+
+Note: gir1.2-unity-5.0 and python-gi are required by fake_progress.py.
 
 You need to configure Testability for your usage. Assuming you’ll be testing on 
 your host machine, this involves editing /etc/tdriver/tdriver_parameters.xml to 
 
=== added file 'tests/launcher/launcher_item_progress.rb'
--- tests/launcher/launcher_item_progress.rb	1970-01-01 00:00:00 +0000
+++ tests/launcher/launcher_item_progress.rb	2012-03-09 10:17:20 +0000
@@ -0,0 +1,144 @@
+#!/usr/bin/env ruby1.8
+=begin
+/*
+ * This file is part of unity-2d
+ *
+ * Copyright 2012 Canonical Ltd.
+ *
+ * Authors:
+ * - Pawel Stolowski <[e-mail]>
+ *
+ * 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 3.
+ *
+ * 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, see <http://www.gnu.org/licenses/>.
+ */
+=end
+
+require '../run-tests.rb' unless $INIT_COMPLETED
+require 'xdo/xwindow'
+require 'tmpwindow'
+require 'launchercli'
+
+############################# Test Suite #############################
+context "Sizing tests" do
+  # Run once at the beginning of this test suite
+  startup do
+    $SUT.execute_shell_command 'killall unity-2d-shell'
+    $SUT.execute_shell_command 'killall unity-2d-shell'
+
+    # Minimize all windows
+    XDo::XWindow.toggle_minimize_all
+  end
+
+  # Run once at the end of this test suite
+  shutdown do
+  end
+
+  # Run before each test case begins
+  setup do
+    # Execute the application 
+    @app = $SUT.run( :name => UNITY_2D_SHELL,
+                     :arguments => "-testability",
+                     :sleeptime => 2 )
+
+    # Make certain application is ready for testing
+    verify{ @app.Launcher() }
+  end
+
+  # Run after each test case completes
+  teardown do
+    #Need to kill Launcher as it does not shutdown when politely asked
+    $SUT.execute_shell_command 'pkill -nf unity-2d-shell'
+  end
+
+  #####################################################################################
+  # Test cases
+
+  # Test case objectives:
+  #   * Check that progress bar in Launcher item is correctly updated for progress values 0-100%.
+  # Pre-conditions
+  #   * 'Home Folder' item (nautilus) is present in the launcher.
+  # Test steps
+  #   * Report progress = 0% from nautilus, verify progress bar width is 0.
+  #   * Report progress = 50% from nautilus, verify progress bar width is 1/2 of normal width
+  #   * Report progress = 100% from nautilus, verify progress bar width is at full.
+  #   * Hide progress bar of nautilus.
+  # Post-conditions
+  #   * None
+  # References
+  #   * None
+  test "Valid progress bar values" do
+    lcli = LauncherItemClient.new('nautilus-home.desktop')
+    lcli.set_progress(0.0)
+   
+    progressTopImg = @app.Launcher().QDeclarativeFocusScope().LauncherList(:name=>"main").QDeclarativeItem(:name=>"Home Folder").QDeclarativeImage(:name=>"progressBar")
+    progressImg = progressTopImg.QDeclarativeImage()
+
+    verify_equal( '', TIMEOUT, "Progress bar is visible" ) {
+        progressTopImg['state']
+    }
+
+    verify_equal( 0, TIMEOUT, "Progress bar at 0%" ) {
+        progressImg['width'].to_i
+    }
+
+    lcli.set_progress(0.5)
+    verify_equal( progressImg['implicitWidth'].to_i / 2, TIMEOUT, "Progress bar at 50%" ) {
+        progressImg['width'].to_i
+    }
+
+    lcli.set_progress(1.0)
+    verify_equal( progressImg['implicitWidth'].to_i, TIMEOUT, "Progress bar at 100%" ) {
+        progressImg['width'].to_i
+    }
+
+    lcli.hide_progress()
+    verify_equal( 'hidden', TIMEOUT, "Progress bar is not visible" ) {
+        progressTopImg['state']
+    }
+  end
+ 
+  # Test case objectives:
+  #   * Check that progress bar in Launcher item is correctly updated for invalid values (outside of 0-100% range).
+  # Pre-conditions
+  #   * 'Home Folder' item (nautilus) is present in the launcher.
+  # Test steps
+  #   * Report progress = -1 from nautilus, verify progress bar width is 0.
+  #   * Report progress = 200% from nautilus, verify progress bar width is at full.
+  #   * Hide progress bar of nautilus.
+  # Post-conditions
+  #   * None
+  # References
+  #   * None
+
+  test "Invalid progress bar values" do
+    lcli = LauncherItemClient.new('nautilus-home.desktop')
+    lcli.set_progress(-1.0)
+
+    progressTopImg = @app.Launcher().QDeclarativeFocusScope().LauncherList(:name=>"main").QDeclarativeItem(:name=>"Home Folder").QDeclarativeImage(:name=>"progressBar")
+    progressImg = progressTopImg.QDeclarativeImage()
+   
+    verify_equal( 0, TIMEOUT, "Attempt to set negative progress value; progress set to 0%" ) {
+        progressImg['width'].to_i
+    }
+
+    lcli.set_progress(2.0)
+    verify_equal( progressImg['implicitWidth'].to_i, TIMEOUT, "Attempt to set big progress value; progress set to 100%" ) {
+        progressImg['width'].to_i
+    }
+
+    lcli.hide_progress()
+    verify_equal( 'hidden', TIMEOUT, "Progress bar is not visible" ) {
+        progressTopImg['state']
+    }
+  end
+
+end
 
=== added file 'tests/misc/fake_progress.py'
--- tests/misc/fake_progress.py	1970-01-01 00:00:00 +0000
+++ tests/misc/fake_progress.py	2012-03-09 10:17:20 +0000
@@ -0,0 +1,61 @@
+#!/usr/bin/python
+
+#
+# Simple script to fake progress updates on Unity Launcher items.
+# Run without arguments for usage.
+#
+# Author: Pawel Stolowski <[e-mail]>
+#
+
+from gi.repository import Unity, GObject
+import sys
+
+usage = """Usage:
+fake_progress.py [-t|-f] <app> [value]
+
+  -t    Show progress_visible = true property
+  -f    Send progress_visible = false property
+  app   Name of application .desktop file on the Launcher (e.g. "nautilus-home.desktop")
+  value Progress bar value (normally 0.0 - 1.0, but invalid values may be used for testing)
+"""
+
+loop = GObject.MainLoop()
+    
+def force_quit():
+    loop.quit()
+ 
+send_show = False
+send_hide = False
+
+i  = 1
+if len(sys.argv) > i:
+    if sys.argv[i] == '-f':
+        send_hide = True
+        i = i+1
+    if sys.argv[i] == '-t':
+        send_show = True
+        i = i+1
+
+ctx = GObject.MainContext()
+if len(sys.argv) > i:
+    appname = sys.argv[i]
+    i = i+1
+    launcher = Unity.LauncherEntry.get_for_desktop_id(appname)
+    
+    if len(sys.argv) > i:
+        progress = float(sys.argv[i])
+        print 'send: progress = ' + sys.argv[i]
+        launcher.set_property("progress", progress)
+
+    if send_show:
+        print 'send: progress_visible = true'
+        launcher.set_property("progress_visible", True)
+
+    if send_hide:
+        print 'send: progress_visible = false'
+        launcher.set_property("progress_visible", False)
+else:
+    sys.exit(usage)
+
+GObject.timeout_add(100, force_quit)
+loop.run()
 
=== added file 'tests/misc/lib/launchercli.rb'
--- tests/misc/lib/launchercli.rb	1970-01-01 00:00:00 +0000
+++ tests/misc/lib/launchercli.rb	2012-03-09 10:17:20 +0000
@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby1.8
+=begin
+/*
+ * This file is part of unity-2d
+ *
+ * Copyright 2012 Canonical Ltd.
+ *
+ * Authors:
+ * - Pawel Stolowski <[e-mail]>
+ *
+ * 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 3.
+ *
+ * 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, see <http://www.gnu.org/licenses/>.
+ */
+=end
+
+# Helper class to interact with Launcher items.
+class LauncherItemClient
+
+    # fake_progress.py location relative to the directory of current script
+    @@FAKE_PROGRESS_SCRIPT = File.dirname(__FILE__) + '/../fake_progress.py'
+
+    def initialize(desktop_file)
+        @desktop_file = desktop_file
+    end
+
+    def set_progress(value)
+        `#{@@FAKE_PROGRESS_SCRIPT} -t #{@desktop_file} #{value}`
+    end
+
+    def hide_progress()
+        `#{@@FAKE_PROGRESS_SCRIPT} -f #{@desktop_file}`
+    end
+end