Merge lp:~jonas-drange/ubuntu-settings-components/apl into lp:ubuntu-settings-components

[Jonas G. Drange]

* Fix issues discovered when migrating USS to APL.
* Bump version so as to allow USS to complete the migration.

[lp:~jonas-drange/ubuntu-settings-components/apl]

178. By Jonas G. Drange on 2016-12-19

syncs with trunk

179. By Jonas G. Drange on 2016-12-19

drops parentpage, unused variable

180. By Jonas G. Drange on 2016-12-19

clarifies changes

181. By Jonas G. Drange on 2016-12-19

fixes typos in Fingerprint

[Nick Dedekind (nick-dedekind)]

Looks ok

review: Approve

=== modified file 'debian/changelog'
--- debian/changelog	2016-12-01 00:34:17 +0000
+++ debian/changelog	2016-12-19 15:01:27 +0000
@@ -1,3 +1,10 @@
+ubuntu-settings-components (0.12+17.04.20161123-0ubuntu2) UNRELEASED; urgency=medium
+
+  * Allows Fingerprint and VPN modules to work well with APL and pagestacks.
+  * Bumps version to 0.12 so that consumers can migrate to APL safely.
+
+ -- Jonas G. Drange <[e-mail]>  Fri, 16 Dec 2016 14:16:24 +0100
+
 ubuntu-settings-components (0.11+17.04.20161201-0ubuntu1) zesty; urgency=medium
 
   * dateExt: take care of the numbers of days in month when adding
 
=== modified file 'plugins/Ubuntu/Settings/Fingerprint/Fingerprint.qml'
--- plugins/Ubuntu/Settings/Fingerprint/Fingerprint.qml	2016-06-15 10:45:27 +0000
+++ plugins/Ubuntu/Settings/Fingerprint/Fingerprint.qml	2016-12-19 15:01:27 +0000
@@ -23,11 +23,13 @@
 
 Page {
     id: root
+    objectName: "fingerprintItemPage"
     property string name
     property string templateId
 
     signal requestDeletion(string templateId)
     signal requestRename(string templateId, string name)
+    signal done()
 
     function deletionFailed() {
         PopupUtils.open(deletionFailed);
@@ -96,7 +98,7 @@
                 onAccepted: {
                     if (text) {
                         requestRename(templateId, text);
-                        pageStack.pop();
+                        done();
                     }
                 }
             }
 
=== modified file 'plugins/Ubuntu/Settings/Fingerprint/Fingerprints.qml'
--- plugins/Ubuntu/Settings/Fingerprint/Fingerprints.qml	2016-06-16 20:31:12 +0000
+++ plugins/Ubuntu/Settings/Fingerprint/Fingerprints.qml	2016-12-19 15:01:27 +0000
@@ -107,6 +107,31 @@
         }
     }
 
+    // Pushes onto a pageStack or an APL.
+    function pushShim(page, opts) {
+        var incubator;
+        if (typeof opts === 'undefined')
+            opts = {};
+        if (pageStack.push) {
+            return pageStack.push(page, opts);
+        } else {
+            page = Qt.createComponent(page);
+            incubator = pageStack.addPageToNextColumn(root, page, opts);
+            incubator.forceCompletion();
+            return incubator.object;
+        }
+    }
+
+    /* Pops a pageStack or APL. The page argument is only effective if the
+    pageStack is an APL, in which case all child pages of page are removed. */
+    function popShim(page) {
+        if (pageStack.pop) {
+            pageStack.pop();
+        } else {
+            pageStack.removePages(page);
+        }
+    }
+
     signal requestPasscode()
 
     Component.onCompleted: {
@@ -231,7 +256,7 @@
 
                     ListItem {
                         height: fpLayout.height + (divider.visible ? divider.height : 0)
-                        onClicked: _fpInstancePage = pageStack.push(
+                        onClicked: _fpInstancePage = pushShim(
                                 Qt.resolvedUrl("Fingerprint.qml"), {
                                 name: modelData.name,
                                 templateId: modelData.templateId
@@ -261,7 +286,7 @@
                 ListItem {
                     height: addFpLayout.height + (divider.visible ? divider.height : 0)
                     onClicked: {
-                        _setupPage = pageStack.push(Qt.resolvedUrl("Setup.qml"));
+                        _setupPage = pushShim(Qt.resolvedUrl("Setup.qml"));
                         root.enroll();
                     }
                     enabled: parent.enabled
@@ -342,7 +367,11 @@
     Connections {
         target: _setupPage
         onEnroll: root.enroll()
-        onCancel: root.cancel()
+        onCancel: {
+            root.cancel();
+            popShim(root);
+        }
+        onDone: popShim(root)
     }
 
     Connections {
@@ -353,6 +382,7 @@
             _removalOperation.start(removalObserver);
         }
         onRequestRename: renameTemplate(templateId, name)
+        onDone: popShim(root)
     }
 
     Observer {
@@ -404,8 +434,15 @@
         onCanceled: _removalOperation = null
         onSucceeded: {
             _removalOperation = null;
-            if (pageStack.currentPage === _fpInstancePage)
-                pageStack.pop();
+            /* If we have a currentPage, pop one page. If not, pop every child
+            of root. */
+            if (pageStack.currentPage) {
+                if (pageStack.currentPage === _fpInstancePage) {
+                    popShim();
+                }
+            } else {
+                popShim(root);
+            }
             root.removeTemplate(result);
         }
     }
 
=== modified file 'plugins/Ubuntu/Settings/Fingerprint/Setup.qml'
--- plugins/Ubuntu/Settings/Fingerprint/Setup.qml	2016-07-12 12:32:18 +0000
+++ plugins/Ubuntu/Settings/Fingerprint/Setup.qml	2016-12-19 15:01:27 +0000
@@ -29,6 +29,7 @@
 
     signal enroll()
     signal cancel()
+    signal done()
 
     function enrollmentFailed(error) {
         root.state = "failed";
@@ -346,10 +347,7 @@
                 }
                 height: parent.height
                 width: units.gu(10)
-                onClicked: {
-                    root.cancel();
-                    pageStack.pop();
-                }
+                onClicked: root.cancel()
 
                 Label {
                     id: cancelButtonText
@@ -370,7 +368,7 @@
                 enabled: false
                 height: parent.height
                 width: units.gu(10)
-                onClicked: pageStack.pop()
+                onClicked: root.done()
 
                 Label {
                     id: doneButtonText
 
=== modified file 'plugins/Ubuntu/Settings/Vpn/VpnEditor.qml'
--- plugins/Ubuntu/Settings/Vpn/VpnEditor.qml	2016-04-27 12:30:12 +0000
+++ plugins/Ubuntu/Settings/Vpn/VpnEditor.qml	2016-12-19 15:01:27 +0000
@@ -31,6 +31,7 @@
 
     signal typeChanged(var connection, int type)
     signal reconnectionPrompt()
+    signal done()
 
     function commit () {
         editorLoader.item.state = 'committing';
@@ -137,7 +138,7 @@
                     if (editor.isNew) {
                         connection.remove();
                     }
-                    pageStack.pop();
+                    done();
                 }
                 Layout.fillWidth: true
             }
@@ -187,7 +188,7 @@
             if (connection.active) {
                 editor.reconnectionPrompt();
             }
-            pageStack.pop();
+            done();
         }
     }
 }
 
=== modified file 'tests/qmltests/Fingerprint/tst_FingerprintNames.qml'
--- tests/qmltests/Fingerprint/tst_FingerprintNames.qml	2016-08-17 11:11:24 +0000
+++ tests/qmltests/Fingerprint/tst_FingerprintNames.qml	2016-12-19 15:01:27 +0000
@@ -279,6 +279,11 @@
         signalName: "requestRename"
     }
 
+    SignalSpy {
+        id: doneSpy
+        signalName: "done"
+    }
+
     UbuntuTestCase {
         name: "TestTemplate"
         when: windowShown
@@ -310,11 +315,13 @@
             pageStack.push(templateInstance);
             requestRenameSpy.target = templateInstance;
             requestDeletionSpy.target = templateInstance;
+            doneSpy.target = templateInstance;
         }
 
         function cleanup() {
             requestRenameSpy.clear();
             requestDeletionSpy.clear();
+            doneSpy.clear();
             pageStack.pop();
             templateInstance.destroy();
             templateInstance = null;
@@ -347,6 +354,17 @@
             compare(requestRenameSpy.signalArguments[0][1], "Your finger");
         }
 
+        function test_requestDone() {
+            templateInstance.templateId = "tmplId";
+            templateInstance.name = "My finger";
+
+            getNameInput().text = "Your finger";
+            getNameInput().accepted();
+            doneSpy.wait();
+
+            compare(doneSpy.count, 1);
+        }
+
         function test_deletionFailed() {
             templateInstance.deletionFailed();
             tryCompareFunction(function () {
 
=== modified file 'tests/qmltests/Fingerprint/tst_Fingerprints.qml'
--- tests/qmltests/Fingerprint/tst_Fingerprints.qml	2016-08-17 11:56:24 +0000
+++ tests/qmltests/Fingerprint/tst_Fingerprints.qml	2016-12-19 15:01:27 +0000
@@ -18,6 +18,7 @@
 
 import QtQuick 2.4
 import QtTest 1.0
+import Ubuntu.Components 1.3
 import Ubuntu.Test 0.1
 import Ubuntu.Settings.Fingerprint 0.1
 import Biometryd 0.0
@@ -29,6 +30,16 @@
     height: units.gu(90)
 
     Component {
+        id: testPageStackComponent
+        PageStack {}
+    }
+
+    Component {
+        id: testAplComponent
+        AdaptivePageLayout {}
+    }
+
+    Component {
         id: fingerprintsComponent
 
         Fingerprints {
@@ -44,18 +55,21 @@
         name: "Fingerprints"
         when: windowShown
 
+        property var testPageStack: null
         property var fingerprintsInstance: null
 
         function init() {
             Biometryd.setAvailable(true);
-            fingerprintsInstance = fingerprintsComponent.createObject(testRoot);
+            testPageStack = testPageStackComponent.createObject(testRoot);
+            fingerprintsInstance = testPageStack.push(fingerprintsComponent);
         }
 
         function cleanup() {
             spy.clear();
             spy.target = null;
             spy.signalName = "";
-            fingerprintsInstance.destroy();
+            testPageStack.pop();
+            testPageStack.destroy();
             GSettingsController.setFingerprintNames({});
         }
 
@@ -226,5 +240,119 @@
                 return GSettingsController.fingerprintNames()["tmplId"];
             }, targetFingerprintName);
         }
+
+        function test_goToSetup() {
+            var btn = getSetupEntry();
+            fingerprintsInstance.passcodeSet = true;
+            mouseClick(btn, btn.width / 2, btn.height / 2);
+            compare(testPageStack.currentPage.objectName, "fingerprintSetupPage");
+
+            // Go back
+            testPageStack.currentPage.done();
+            compare(testPageStack.currentPage, fingerprintsInstance);
+        }
+
+        function test_goToFingerprint() {
+            var obs = getEnrollmentObserver();
+            var btn;
+
+            // Prerequisites for test:
+            fingerprintsInstance.passcodeSet = true;
+            obs.mockEnroll("tmplId", "");
+
+            btn = findChild(fingerprintsInstance, "fingerprintInstance-0");
+            waitForRendering(btn);
+            mouseClick(btn, btn.width / 2, btn.height / 2);
+            tryCompareFunction(function () {
+                return !!findChild(testRoot, "fingerprintItemPage");
+            }, true);
+
+            // Go back
+            testPageStack.currentPage.done();
+            compare(testPageStack.currentPage, fingerprintsInstance);
+        }
+    }
+
+
+    UbuntuTestCase {
+        name: "FingerprintsAdaptivePageLayout"
+        when: windowShown
+
+        Component {
+            id: pageComponent
+            Page {
+                header: PageHeader {}
+            }
+        }
+
+        property var testApl: null
+        property var fingerprintsInstance: null
+
+        function waitFor(objectName) {
+            tryCompareFunction(function () {
+                return !!findChild(testRoot, objectName);
+            }, true);
+        }
+
+        function waitForDestruction(objectName) {
+            tryCompareFunction(function () {
+                return !!findChild(testRoot, objectName);
+            }, false);
+        }
+
+        function init() {
+            var incubator;
+            Biometryd.setAvailable(true);
+            testApl = testAplComponent.createObject(testRoot, {
+                primaryPageSource: pageComponent
+            });
+
+            // Wait until the primaryPage has been created.
+            tryCompareFunction(function () {
+                return !!testApl.primaryPage
+            }, true);
+
+            // Synchronously create the fingerprint instance on the APL.
+            incubator = testApl.addPageToNextColumn(
+                testApl.primaryPage, fingerprintsComponent
+            );
+            incubator.forceCompletion();
+            fingerprintsInstance = incubator.object;
+            waitForRendering(fingerprintsInstance)
+        }
+
+        function cleanup() {
+            testApl.removePages(testApl.primaryPage);
+            testApl.destroy();
+        }
+
+        function test_goToSetup() {
+            var btn = findChild(fingerprintsInstance, "fingerprintSetupEntry");;
+            fingerprintsInstance.passcodeSet = true;
+            mouseClick(btn, btn.width / 2, btn.height / 2);
+            waitFor("fingerprintSetupPage");
+
+            // Go back out
+            findChild(testRoot, "fingerprintSetupPage").done();
+            waitForDestruction("fingerprintSetupPage");
+        }
+
+        function test_goToFingerprint() {
+            var obs = findInvisibleChild(fingerprintsInstance, "enrollmentObserver");
+            var btn;
+
+            // Prerequisites for test:
+            fingerprintsInstance.passcodeSet = true;
+            obs.mockEnroll("tmplId", "");
+
+            btn = findChild(fingerprintsInstance, "fingerprintInstance-0");
+            waitForRendering(btn);
+            mouseClick(btn, btn.width / 2, btn.height / 2);
+            waitFor("fingerprintItemPage");
+
+            // Go back out.
+            findChild(testRoot, "fingerprintItemPage").done();
+            waitForDestruction("fingerprintItemPage");
+        }
     }
 }