Merge lp:~mterry/unity8/skip-spread-tutorial-on-desktop into lp:unity8

[Michael Terry]

Skip parts of the edge tutorial that require a touch device (like spread and bottom edge).

For now, we just use "desktop-mode" to imply "no-touch-device". In the future, presumably Design will provide different tutorial layouts for the various device modes we support. For now, they have only blessed a phone version. So I just skip the problematic parts.

Skip parts of the edge tutorial that require a touch device (like spread and bottom edge).

For now, we just use "desktop-mode" to imply "no-touch-device". In the future, presumably Design will provide different tutorial layouts for the various device modes we support. For now, they have only blessed a phone version. So I just skip the problematic parts.

This was a relatively simple change. But adding a baby test for this (mostly so that when we fix how modes work in Shell.qml, we'll know to update this code due to the newly-broken test) involved a bit of yak shaving.

So... our mock GSettings support is awful. In an ideal world, we'd compile the schemas unity8 provides, point GSettings at them (plus the system ones), and then run GSettings with the memory backend so nothing gets saved to disk. That would avoid the need for a mock entirely.

But for convenience of keeping this tiny branch tiny, I tried to fix the mock we have:

- Fixed a reversed-logic check that prevented id() or path() from being set on any GSettings object (and causing warnings to be printed in test logs all the time about 'GSettings.schema.id may only be set on construction')

- I stopped exposing GSettingsController as an object for Qml. This used to be used by tests to modify all existing GSettings objects, wherever they are. But the test code now directly modifies the Shell's GSettings object. So this class was unused. And I'm not thrilled anyway with exposing a special object that only lives in mocks. If we want to change GSettings, we can make our own object or modify an existing one.

- I moved the property storage from each GSettings to the singleton GSettingsController instance. This way if you change one GSettings object, each other object will notice (and especially, so that if you create a GSettings object after another one was set, they agree in values).

- I validate the schema.id value when setting/getting from GSettings, just for sanity checking.

- I provide a default value of "Staged" for com.canonical.Unity8.usageMode. Without this, we were getting the non-inverted launcher (i.e. the desktop version with the home button at the top) in tests and ./run.sh -f. Fixing this required me to change a test's coordinates that dealt with the home button (which is why you see that odd 0.8/0.2 change in tst_Shell.qml).

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1696
http://jenkins.qa.ubuntu.com/job/unity8-ci/5476/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/1929
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-vivid/640
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-vivid-amd64-ci/641
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-vivid-i386-ci/641
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/1700
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1927
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1927/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/19084

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

review: Needs Fixing (continuous-integration)

[Michael Zanetti (mzanetti)]

two tiny inline comments, and add the checklist please.

review: Needs Fixing

[Michael Terry (mterry)]

 * Are there any related MPs required for this MP to build/function as expected? Please list.
 No

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

 * Did you make sure that your branch does not contain spurious tags?
 Yes

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

 * If you changed the UI, has there been a design review?
 NA

[lp:~mterry/unity8/skip-spread-tutorial-on-desktop]

1697. By Michael Terry on 2015-03-26

Review nits

[Michael Terry (mterry)]

Both comments addressed.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1697
http://jenkins.qa.ubuntu.com/job/unity8-ci/5489/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/1992
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-vivid/653
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-vivid-amd64-ci/654
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-vivid-i386-ci/654
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/1754
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1990
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1990/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/19198

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

review: Approve (continuous-integration)

[Albert Astals Cid (aacid)]

I'd maybe had named that useEdgeDragArea as "useDesktopTutorial", but one can argue about naming forever on these things so not important

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

 * Did CI run pass?
*IT DID* :o

 * Did you make sure that the branch does not contain spurious tags?
Yes

review: Approve

=== modified file 'qml/Shell.qml'
--- qml/Shell.qml	2015-03-10 14:25:12 +0000
+++ qml/Shell.qml	2015-03-26 13:30:45 +0000
@@ -591,6 +591,15 @@
         overlay: overlay
         edgeSize: shell.edgeSize
 
+        // EdgeDragAreas don't work with mice.  So to avoid trapping the user,
+        // we'll tell the tutorial to avoid using them on the Desktop.  The
+        // Desktop doesn't use the same spread design anyway.  The tutorial is
+        // all a bit of a placeholder on non-phone form factors right now.
+        // When the design team gives us more guidance, we can do something
+        // more clever here.
+        // TODO: use DeviceConfiguration instead of checking source
+        useEdgeDragArea: applicationsDisplayLoader.source != Qt.resolvedUrl("Stages/DesktopStage.qml")
+
         onFinished: {
             AccountsService.demoEdges = false;
             active = false; // for immediate response / if AS is having problems

=== modified file 'qml/Tutorial/Tutorial.qml'
--- qml/Tutorial/Tutorial.qml	2015-01-06 19:50:14 +0000
+++ qml/Tutorial/Tutorial.qml	2015-03-26 13:30:45 +0000
@@ -23,6 +23,7 @@
     property alias active: loader.active
     property bool paused
     property real edgeSize
+    property bool useEdgeDragArea
 
     property Item launcher
     property Item panel
@@ -62,6 +63,12 @@
 
         Binding {
             target: loader.item
+            property: "useEdgeDragArea"
+            value: root.useEdgeDragArea
+        }
+
+        Binding {
+            target: loader.item
             property: "launcher"
             value: root.launcher
         }

=== modified file 'qml/Tutorial/TutorialContent.qml'
--- qml/Tutorial/TutorialContent.qml	2015-01-06 19:13:58 +0000
+++ qml/Tutorial/TutorialContent.qml	2015-03-26 13:30:45 +0000
@@ -34,6 +34,7 @@
 
     property bool paused: false
     property real edgeSize
+    property bool useEdgeDragArea
 
     signal finished()
 
@@ -81,10 +82,17 @@
         anchors.fill: parent
         textXOffset: root.launcher.panelWidth
         paused: !shown || root.paused
+        text: root.useEdgeDragArea ? i18n.tr("Tap here to continue.") : i18n.tr("Click here to finish.")
 
         onFinished: {
             root.launcher.hide();
-            tutorialRight.show();
+            if (root.useEdgeDragArea) {
+                tutorialRight.show();
+            } else {
+                // Last two screens use EdgeDragArea (right edge spread and
+                // bottom edge).  So just end tutorial here.
+                root.finish();
+            }
         }
     }
 

=== modified file 'tests/mocks/GSettings.1.0/fake_gsettings.cpp'
--- tests/mocks/GSettings.1.0/fake_gsettings.cpp	2013-08-15 08:11:04 +0000
+++ tests/mocks/GSettings.1.0/fake_gsettings.cpp	2015-03-26 13:30:45 +0000
@@ -20,7 +20,9 @@
 
 GSettingsControllerQml* GSettingsControllerQml::s_controllerInstance = 0;
 
-GSettingsControllerQml::GSettingsControllerQml() {
+GSettingsControllerQml::GSettingsControllerQml()
+    : m_usageMode("Staged")
+{
 }
 
 GSettingsControllerQml::~GSettingsControllerQml() {
@@ -34,17 +36,29 @@
     return s_controllerInstance;
 }
 
-void GSettingsControllerQml::registerSettingsObject(GSettingsQml *obj) {
-    m_registeredGSettings.append(obj);
-}
-
-void GSettingsControllerQml::unRegisterSettingsObject(GSettingsQml *obj) {
-    m_registeredGSettings.removeOne(obj);
-}
-
-void GSettingsControllerQml::setPictureUri(const QString &str) {
-    Q_FOREACH (GSettingsQml *obj, m_registeredGSettings) {
-        obj->setPictureUri(str);
+QString GSettingsControllerQml::pictureUri() const
+{
+    return m_pictureUri;
+}
+
+void GSettingsControllerQml::setPictureUri(const QString &str)
+{
+    if (str != m_pictureUri) {
+        m_pictureUri = str;
+        Q_EMIT pictureUriChanged(m_pictureUri);
+    }
+}
+
+QString GSettingsControllerQml::usageMode() const
+{
+    return m_usageMode;
+}
+
+void GSettingsControllerQml::setUsageMode(const QString &usageMode)
+{
+    if (usageMode != m_usageMode) {
+        m_usageMode = usageMode;
+        Q_EMIT usageModeChanged(m_usageMode);
     }
 }
 
@@ -56,7 +70,7 @@
 }
 
 void GSettingsSchemaQml::setId(const QByteArray &id) {
-    if (m_id.isEmpty()) {
+    if (!m_id.isEmpty()) {
         qWarning("GSettings.schema.id may only be set on construction");
         return;
     }
@@ -69,7 +83,7 @@
 }
 
 void GSettingsSchemaQml::setPath(const QByteArray &path) {
-    if (m_path.isEmpty()) {
+    if (!m_path.isEmpty()) {
         qWarning("GSettings.schema.path may only be set on construction");
         return;
     }
@@ -77,26 +91,48 @@
     m_path = path;
 }
 
-GSettingsQml::GSettingsQml(QObject *parent): QObject(parent) {
+GSettingsQml::GSettingsQml(QObject *parent)
+    : QObject(parent)
+{
     m_schema = new GSettingsSchemaQml(this);
-    GSettingsControllerQml::instance()->registerSettingsObject(this);
-}
-
-GSettingsQml::~GSettingsQml() {
-    GSettingsControllerQml::instance()->unRegisterSettingsObject(this);
+    connect(GSettingsControllerQml::instance(), SIGNAL(pictureUriChanged(const QString &)),
+            this, SIGNAL(pictureUriChanged(const QString &)));
+    connect(GSettingsControllerQml::instance(), SIGNAL(usageModeChanged(const QString &)),
+            this, SIGNAL(usageModeChanged(const QString &)));
 }
 
 GSettingsSchemaQml * GSettingsQml::schema() const {
     return m_schema;
 }
 
-QString GSettingsQml::pictureUri() const {
-    return m_pictureUri;
-}
-
-void GSettingsQml::setPictureUri(const QString &str) {
-    if (str != m_pictureUri) {
-        m_pictureUri = str;
-        Q_EMIT pictureUriChanged(m_pictureUri);
+QString GSettingsQml::pictureUri() const
+{
+    if (m_schema->id() == "org.gnome.desktop.background") {
+        return GSettingsControllerQml::instance()->pictureUri();
+    } else {
+        return "";
+    }
+}
+
+void GSettingsQml::setPictureUri(const QString &str)
+{
+    if (m_schema->id() == "org.gnome.desktop.background") {
+        GSettingsControllerQml::instance()->setPictureUri(str);
+    }
+}
+
+QString GSettingsQml::usageMode() const
+{
+    if (m_schema->id() == "com.canonical.Unity8") {
+        return GSettingsControllerQml::instance()->usageMode();
+    } else {
+        return "";
+    }
+}
+
+void GSettingsQml::setUsageMode(const QString &usageMode)
+{
+    if (m_schema->id() == "com.canonical.Unity8") {
+        GSettingsControllerQml::instance()->setUsageMode(usageMode);
     }
 }

=== modified file 'tests/mocks/GSettings.1.0/fake_gsettings.h'
--- tests/mocks/GSettings.1.0/fake_gsettings.h	2014-08-26 08:14:44 +0000
+++ tests/mocks/GSettings.1.0/fake_gsettings.h	2015-03-26 13:30:45 +0000
@@ -46,25 +46,26 @@
 
     Q_PROPERTY(GSettingsSchemaQml* schema READ schema NOTIFY schemaChanged)
     Q_PROPERTY(QString pictureUri READ pictureUri WRITE setPictureUri NOTIFY pictureUriChanged)
+    Q_PROPERTY(QString usageMode READ usageMode WRITE setUsageMode NOTIFY usageModeChanged)
 
 public:
     GSettingsQml(QObject *parent = nullptr);
-    ~GSettingsQml();
 
     GSettingsSchemaQml * schema() const;
     QString pictureUri() const;
+    QString usageMode() const;
 
     void setPictureUri(const QString &str);
+    void setUsageMode(const QString &usageMode);
 
 Q_SIGNALS:
     void schemaChanged();
     void pictureUriChanged(const QString&);
+    void usageModeChanged(const QString&);
 
 private:
     GSettingsSchemaQml* m_schema;
 
-    QString m_pictureUri;
-
     friend class GSettingsSchemaQml;
 };
 
@@ -76,13 +77,22 @@
     static GSettingsControllerQml* instance();
     ~GSettingsControllerQml();
 
-    void registerSettingsObject(GSettingsQml *obj);
-    void unRegisterSettingsObject(GSettingsQml *obj);
-    Q_INVOKABLE void setPictureUri(const QString &str);
+    QString pictureUri() const;
+    void setPictureUri(const QString &str);
+
+    QString usageMode() const;
+    void setUsageMode(const QString &usageMode);
+
+Q_SIGNALS:
+    void pictureUriChanged(const QString&);
+    void usageModeChanged(const QString&);
 
 private:
     GSettingsControllerQml();
 
+    QString m_pictureUri;
+    QString m_usageMode;
+
     static GSettingsControllerQml* s_controllerInstance;
     QList<GSettingsQml *> m_registeredGSettings;
 };

=== modified file 'tests/mocks/GSettings.1.0/plugin.cpp'
--- tests/mocks/GSettings.1.0/plugin.cpp	2013-08-23 11:56:44 +0000
+++ tests/mocks/GSettings.1.0/plugin.cpp	2015-03-26 13:30:45 +0000
@@ -19,14 +19,8 @@
 
 #include <QtQml/qqml.h>
 
-static QObject* controllerProvider(QQmlEngine* /* engine */, QJSEngine* /* scriptEngine */)
-{
-    return GSettingsControllerQml::instance();
-}
-
 void FakeGSettingsQmlPlugin::registerTypes(const char *uri)
 {
-    qmlRegisterSingletonType<GSettingsControllerQml>(uri, 1, 0, "GSettingsController", controllerProvider);
     qmlRegisterType<GSettingsQml>(uri, 1, 0, "GSettings");
     qmlRegisterUncreatableType<GSettingsSchemaQml>(uri, 1, 0, "GSettingsSchema",
                                                    "GSettingsSchema can only be used inside of a GSettings component");

=== modified file 'tests/qmltests/Tutorial/tst_Tutorial.qml'
--- tests/qmltests/Tutorial/tst_Tutorial.qml	2015-02-05 21:13:16 +0000
+++ tests/qmltests/Tutorial/tst_Tutorial.qml	2015-03-26 13:30:45 +0000
@@ -17,6 +17,7 @@
 import QtQuick 2.0
 import QtTest 1.0
 import AccountsService 0.1
+import GSettings 1.0
 import LightDM 0.1 as LightDM
 import Ubuntu.Components 1.1
 import Unity.Application 0.1
@@ -45,6 +46,11 @@
         }
     }
 
+    GSettings {
+        id: unity8Settings
+        schema.id: "com.canonical.Unity8"
+    }
+
     Component.onCompleted: {
         // must set the mock mode before loading the Shell
         LightDM.Greeter.mockMode = "single-pin";
@@ -112,6 +118,7 @@
 
         function init() {
             tryCompare(shell, "enabled", true); // enabled by greeter when ready
+            unity8Settings.usageMode = "Staged";
             AccountsService.demoEdges = false;
             AccountsService.demoEdges = true;
             swipeAwayGreeter();
@@ -185,17 +192,19 @@
         }
 
         function checkRightEdge() {
-            touchFlick(shell, shell.width, halfHeight, halfWidth, halfHeight);
+            if (unity8Settings.usageMode === "Staged") {
+                touchFlick(shell, shell.width, halfHeight, halfWidth, halfHeight);
 
-            var stage = findChild(shell, "stage");
-            var spreadView = findChild(stage, "spreadView");
-            tryCompare(spreadView, "phase", 0);
+                var stage = findChild(shell, "stage");
+                var spreadView = findChild(stage, "spreadView");
+                tryCompare(spreadView, "phase", 0);
+            }
         }
 
         function checkBottomEdge() {
             // Can't actually check effect of swipe, since dash isn't really loaded
             var applicationsDisplayLoader = findChild(shell, "applicationsDisplayLoader");
-            tryCompare(applicationsDisplayLoader.item, "interactive", false);
+            tryCompare(applicationsDisplayLoader, "interactive", false);
         }
 
         function checkFinished() {
@@ -256,6 +265,14 @@
             goToPage(null);
         }
 
+        function test_walkthroughOnDesktop() {
+            unity8Settings.usageMode = "Windowed";
+            var page = goToPage("tutorialLeftFinish");
+            var tick = findChild(page, "tick");
+            tap(tick);
+            checkFinished();
+        }
+
         function test_launcherShortDrag() {
             // goToPage does a normal launcher pull.  But here we want to test
             // just barely pulling the launcher out and letting go (i.e. not

=== modified file 'tests/qmltests/tst_Shell.qml'
--- tests/qmltests/tst_Shell.qml	2015-03-18 10:16:42 +0000
+++ tests/qmltests/tst_Shell.qml	2015-03-26 13:30:45 +0000
@@ -1084,11 +1084,11 @@
             {
                 var buttonShowDashHome = findChild(launcher, "buttonShowDashHome");
                 var startPos = buttonShowDashHome.mapToItem(shell,
+                        buttonShowDashHome.width * 0.2,
+                        buttonShowDashHome.height * 0.8);
+                var endPos = buttonShowDashHome.mapToItem(shell,
                         buttonShowDashHome.width * 0.8,
                         buttonShowDashHome.height * 0.2);
-                var endPos = buttonShowDashHome.mapToItem(shell,
-                        buttonShowDashHome.width * 0.2,
-                        buttonShowDashHome.height * 0.8);
                 touchFlick(shell, startPos.x, startPos.y, endPos.x, endPos.y);
             }