Merge lp:~aacid/unity8/preview_progress into lp:unity8

[Albert Astals Cid]

Progress Preview Widget

* Are there any related MPs required for this MP to build/function as expected?
Listed as prerequisite

 * Did you perform an exploratory manual test run of your code change and any related functionality?
Yes

 * If you changed the packaging (debian), did you subscribe the ubuntu-unity team to this MP?
N/A

 * If you changed the UI, has there been a design review?
N/A

[lp:~aacid/unity8/preview_progress]

713. By Albert Astals Cid on 2014-02-12

Actually commit the test file ^_^

714. By Albert Astals Cid on 2014-02-12

Some explanation of what are we doing in the test

715. By Albert Astals Cid on 2014-02-12

whitespacing

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:715
http://jenkins.qa.ubuntu.com/job/unity8-ci/2303/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/3159
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-touch/2844/console
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-trusty/1173
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-amd64-ci/824
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-armhf-ci/828
        deb: http://jenkins.qa.ubuntu.com/job/unity8-trusty-armhf-ci/828/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-i386-ci/824
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/2777
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3161
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3161/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2846
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2846/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/5254/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/3870

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/2303/rebuild

review: Needs Fixing (continuous-integration)

[Albert Astals Cid (aacid)]

The autopilot error gets fixed by https://code.launchpad.net/~elopio/unity8/fix1277591-open_scope_scrolling_waiting_for_wrong_property/+merge/205423

[Andrea Cimitan (cimi)]

I think the documentation needs a \brief headline (then a new line with the rest of the description, to be consistent)

Question, is total of Ubuntu.DownloadDaemonListener 0.1 always > 0?

163 + spy.target = previewProgress
semicolon

Also, considering all the issues we had with signalSpy, I'd rather clear it after
compare(args[2], progressjsonFinish);, and compare with 1 then.

review: Needs Fixing

[lp:~aacid/unity8/preview_progress]

716. By Albert Astals Cid on 2014-02-12

fixlets

717. By Albert Astals Cid on 2014-02-12

Cimi is scared total may be <= 0

718. By Albert Astals Cid on 2014-02-12

fix test name

[Andrea Cimitan (cimi)]

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:718
http://jenkins.qa.ubuntu.com/job/unity8-ci/2305/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/3168
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-touch/2852
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-trusty/1175
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-amd64-ci/826
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-armhf-ci/830
        deb: http://jenkins.qa.ubuntu.com/job/unity8-trusty-armhf-ci/830/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-i386-ci/826
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/2785
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3170
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3170/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2854
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2854/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/5262
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/3879

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/2305/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:718
http://jenkins.qa.ubuntu.com/job/unity8-ci/2312/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/3202
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-touch/2883
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-trusty/1182
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-amd64-ci/833
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-armhf-ci/837
        deb: http://jenkins.qa.ubuntu.com/job/unity8-trusty-armhf-ci/837/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-i386-ci/833
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/2816
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3204
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3204/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2885
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2885/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/5291
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/3917

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/2312/rebuild

review: Approve (continuous-integration)

[Andrea Cimitan (cimi)]

 * Did you perform an exploratory manual test run of the code change and any related functionality?
Yes

 * Did CI run pass? If not, please explain why.
Yes

=== added file 'qml/Dash/Previews/PreviewProgress.qml'
--- qml/Dash/Previews/PreviewProgress.qml	1970-01-01 00:00:00 +0000
+++ qml/Dash/Previews/PreviewProgress.qml	2014-02-12 16:28:25 +0000
@@ -0,0 +1,70 @@
+/*
+ * Copyright (C) 2014 Canonical, Ltd.
+ *
+ * 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/>.
+ */
+
+import QtQuick 2.1
+import Ubuntu.Components 0.1
+import Ubuntu.DownloadDaemonListener 0.1
+
+/*! \brief Preview widget for a progress bar.
+ *
+ *  It feeds itself from the source determined in widgetData["source"]
+ *  At the moment we only support the dbus source defined
+ *  by source["dbus-name"] and source["dbus-object"]
+ */
+
+PreviewWidget {
+    id: root
+
+    implicitHeight: progressBar.implicitHeight
+    implicitWidth: progressBar.implicitWidth
+
+    ProgressBar {
+        id: progressBar
+        objectName: "progressBar"
+        value: 0
+        maximumValue: 100
+        implicitHeight: units.gu(5)
+        height: parent.height
+        width: parent.width
+
+        property var source: widgetData["source"]
+        // TODO Eventually we will need to support more sources other
+        // than DownloadTracker via dbus so we'll need a Loader based on source contents
+
+        DownloadTracker {
+            service: progressBar.source["dbus-name"] || ""
+            dbusPath: progressBar.source["dbus-object"] || ""
+
+            onProgress: {
+                if (total <= 0) {
+                    progressBar.indeterminate = true;
+                } else {
+                    progressBar.indeterminate = false;
+                    var percentage = parseInt(received * 100 / total);
+                    progressBar.value = percentage;
+                }
+            }
+
+            onFinished: {
+                root.triggered(widgetId, "finished", widgetData)
+            }
+
+            onError: {
+                root.triggered(widgetId, "failed", widgetData)
+            }
+        }
+    }
+}
 
=== modified file 'qml/Dash/Previews/PreviewWidgetFactory.qml'
--- qml/Dash/Previews/PreviewWidgetFactory.qml	2014-02-12 16:28:25 +0000
+++ qml/Dash/Previews/PreviewWidgetFactory.qml	2014-02-12 16:28:25 +0000
@@ -47,6 +47,7 @@
             case "gallery": return "PreviewImageGallery.qml";
             case "header": return "PreviewHeader.qml";
             case "image": return "PreviewZoomableImage.qml"
+            case "progress": return "PreviewProgress.qml";
             case "text": return "PreviewTextSummary.qml";
             case "video": return "PreviewVideoPlayback.qml";
             default: return "";
 
=== modified file 'tests/qmltests/CMakeLists.txt'
--- tests/qmltests/CMakeLists.txt	2014-02-12 16:28:25 +0000
+++ tests/qmltests/CMakeLists.txt	2014-02-12 16:28:25 +0000
@@ -61,6 +61,7 @@
 add_qml_test(Dash/Previews PreviewAudioPlayback IMPORT_PATHS ${qmltest_DEFAULT_IMPORT_PATHS} ${CMAKE_BINARY_DIR}/tests/mocks)
 add_qml_test(Dash/Previews PreviewImageGallery IMPORT_PATHS ${qmltest_DEFAULT_IMPORT_PATHS} ${CMAKE_BINARY_DIR}/tests/mocks)
 add_qml_test(Dash/Previews PreviewHeader IMPORT_PATHS ${qmltest_DEFAULT_IMPORT_PATHS} ${CMAKE_BINARY_DIR}/tests/mocks)
+add_qml_test(Dash/Previews PreviewProgress IMPORT_PATHS ${qmltest_DEFAULT_IMPORT_PATHS} ${CMAKE_BINARY_DIR}/tests/mocks)
 add_qml_test(Dash/Previews PreviewTextSummary IMPORT_PATHS ${qmltest_DEFAULT_IMPORT_PATHS} ${CMAKE_BINARY_DIR}/tests/mocks)
 add_qml_test(Dash/Previews PreviewVideoPlayback IMPORT_PATHS ${qmltest_DEFAULT_IMPORT_PATHS} ${CMAKE_BINARY_DIR}/tests/mocks)
 add_qml_test(Dash/Previews PreviewZoomableImage IMPORT_PATHS ${qmltest_DEFAULT_IMPORT_PATHS} ${CMAKE_BINARY_DIR}/tests/mocks)
 
=== added file 'tests/qmltests/Dash/Previews/tst_PreviewProgress.qml'
--- tests/qmltests/Dash/Previews/tst_PreviewProgress.qml	1970-01-01 00:00:00 +0000
+++ tests/qmltests/Dash/Previews/tst_PreviewProgress.qml	2014-02-12 16:28:25 +0000
@@ -0,0 +1,87 @@
+/*
+ * Copyright 2014 Canonical Ltd.
+ *
+ * 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/>.
+ */
+
+import QtQuick 2.0
+import QtTest 1.0
+import "../../../../qml/Dash/Previews"
+import Unity.Test 0.1 as UT
+import Ubuntu.Components 0.1
+
+Rectangle {
+    id: root
+    width: units.gu(60)
+    height: units.gu(80)
+
+    property var progressjson: {
+        "type": "progress",
+        "source": { "dbus-name" : "somename", "dbus-object": "somestring" }
+    }
+
+    property var progressjsonFinish: {
+        "type": "progress",
+        "source": { "dbus-name" : "somename", "dbus-object": "finish" }
+    }
+
+    property var progressjsonError: {
+        "type": "progress",
+        "source": { "dbus-name" : "somename", "dbus-object": "error" }
+    }
+
+    SignalSpy {
+        id: spy
+        signalName: "triggered"
+    }
+
+    PreviewProgress {
+        id: previewProgress
+        widgetId: "previewProgress"
+        widgetData: progressjson
+        width: units.gu(30)
+
+        Rectangle {
+            anchors.fill: parent
+            color: "red"
+            opacity: 0.1
+        }
+    }
+
+    UT.UnityTestCase {
+        name: "PreviewProgressTest"
+        when: windowShown
+
+        function test_json() {
+            spy.target = previewProgress;
+
+            // The mock DownloadTracker triggers its signals when you pass
+            // finish/error as dbus-object to it. Exercise it here
+            previewProgress.widgetData = progressjsonFinish;
+            compare(spy.count, 1);
+            var args = spy.signalArguments[0];
+            compare(args[0], "previewProgress");
+            compare(args[1], "finished");
+            compare(args[2], progressjsonFinish);
+
+            spy.clear();
+
+            previewProgress.widgetData = progressjsonError;
+            compare(spy.count, 1);
+            var args = spy.signalArguments[0];
+            compare(args[0], "previewProgress");
+            compare(args[1], "failed");
+            compare(args[2], progressjsonError);
+        }
+    }
+}
 
=== modified file 'tests/qmltests/Dash/Previews/tst_PreviewWidgetFactory.qml'
--- tests/qmltests/Dash/Previews/tst_PreviewWidgetFactory.qml	2014-02-12 16:28:25 +0000
+++ tests/qmltests/Dash/Previews/tst_PreviewWidgetFactory.qml	2014-02-12 16:28:25 +0000
@@ -80,6 +80,7 @@
                 { tag: "Gallery", type: "gallery", source: "PreviewImageGallery.qml" },
                 { tag: "Header", type: "header", source: "PreviewHeader.qml" },
                 { tag: "Image", type: "image", source: "PreviewZoomableImage.qml" },
+                { tag: "Progress", type: "progress", source: "PreviewProgress.qml" },
                 { tag: "Text", type: "text", source: "PreviewTextSummary.qml" },
                 { tag: "Video", type: "video", source: "PreviewVideoPlayback.qml" },
             ];