Merge lp:~kissiel/checkbox/confined-qml-jobs into lp:checkbox

[Maciej Kisielewski]

This MR brings support for the confined tests!

3e61d6f checkbox-touch: make test quasi-object forward flags
442be29 checkbox-touch: make test quasi-object forward partial_id
abc3808 checkbox-touch: change version to 1.2 to match what plainbox reports
18700ec checkbox-touch: add shell for running confined tests
ecc05b6 checkbox-touch: add QML confined page component
91e2524 checkbox-touch: add function that runs confined qml jobs
33e2a62 checkbox-touch: check for 'confined' flag and act appropriately
3ced2e1 checkbox-touch: add confinement generator

[Zygmunt Krynicki (zyga)]

I had a review session with Maciek earlier today. Let's merge it.

review: Approve

=== modified file 'checkbox-touch/checkbox-touch.qml'
--- checkbox-touch/checkbox-touch.qml	2015-07-23 08:25:48 +0000
+++ checkbox-touch/checkbox-touch.qml	2015-07-23 11:16:26 +0000
@@ -456,7 +456,10 @@
                 performUserInteractTest(test);
                 break;
             case 'qml':
-                performQmlTest(test);
+                if (test.flags.indexOf("confined") > -1)
+                    performConfinedQmlTest(test);
+                else
+                    performQmlTest(test);
                 break;
             default:
                 test.outcome = "skip";
@@ -590,6 +593,17 @@
         progressHeader.update(test);
         pageStack.push(qmlNativePage);
     }
+    function performConfinedQmlTest(test) {
+        var comp = Qt.createComponent(Qt.resolvedUrl("components/QmlConfinedPage.qml"))
+        console.log(comp.errorString());
+        var qmlNativePage = comp.createObject();
+        qmlNativePage.test = test
+        qmlNativePage.applicationVersion = app.applicationVersion;
+        qmlNativePage.testDone.connect(completeTest);
+        qmlNativePage.__customHeaderContents = progressHeader;
+        progressHeader.update(test);
+        pageStack.push(qmlNativePage);
+    }
 
     function showVerificationScreen(test) {
         var verificationPage = Qt.createComponent(Qt.resolvedUrl("components/TestVerificationPage.qml")).createObject();

=== added file 'checkbox-touch/components/QmlConfinedPage.qml'
--- checkbox-touch/components/QmlConfinedPage.qml	1970-01-01 00:00:00 +0000
+++ checkbox-touch/components/QmlConfinedPage.qml	2015-07-23 11:16:26 +0000
@@ -0,0 +1,160 @@
+/*
+ * This file is part of Checkbox
+ *
+ * Copyright 2015 Canonical Ltd.
+ *
+ * Authors:
+ * - Maciej Kisielewski <[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/>.
+ */
+
+/*! \brief Page for Qml native test
+*/
+
+import QtQuick 2.0
+import Ubuntu.Components 1.1
+import QtQuick.Layouts 1.1
+import "ConfirmationLogic.js" as ConfirmationLogic
+import Ubuntu.Content 1.1
+
+Page {
+    id: qmlNativePage
+    property var test: { "name": "", "description": "", "test_number": 0, "tests_count": 0}
+    property var applicationVersion: ""
+
+    signal testDone(var test);
+
+    objectName: "qmlNativePage"
+    title: i18n.tr("Test Description")
+
+    /* testingShell serves as the interface to the external world from the
+     * qml-test. */
+    Object {
+        id: testingShell
+        property string name: "Checkbox-touch qml confined shell"
+        property alias pageStack: qmlNativePage.pageStack
+        property string sessionDir: app.sessionDir
+        function getTest() {
+            return test;
+        }
+    }
+
+    Connections {
+        target: ContentHub
+        onImportRequested: {
+            var resultFile = String(transfer.items[0].url).replace(
+                'file://', '');
+            var xhr = new XMLHttpRequest;
+            xhr.open("GET", resultFile);
+            xhr.onreadystatechange = function() {
+                if (xhr.readyState === XMLHttpRequest.DONE) {
+                    try {
+                        var result = JSON.parse(xhr.responseText);
+                        test["outcome"] = result["outcome"];
+                        testDone(test);
+                    } catch (x) {
+                        console.error("ERROR when parsing result json obj.")
+                    }
+                }
+            }
+            xhr.send();
+            transfer.finalize();
+        }
+    }
+
+    head {
+        actions: [
+            Action {
+                id: skipAction
+                iconName: "media-seek-forward"
+                text: i18n.tr("Skip")
+                onTriggered: {
+                    var confirmationOptions = {
+                        question : i18n.tr("Do you really want to skip this test?"),
+                        remember : true,
+                    }
+                    ConfirmationLogic.confirmRequest(qmlNativePage,
+                        confirmationOptions, function(res) {
+                            if (res) {
+                                test["outcome"] = "skip";
+                                testDone(test);
+                            }
+                    });
+                }
+            }
+        ]
+    }
+
+    ColumnLayout {
+        id: body
+        spacing: units.gu(3)
+        anchors {
+            fill: parent
+            topMargin: units.gu(3)
+            bottomMargin: units.gu(3)
+            leftMargin: units.gu(1)
+            rightMargin: units.gu(1)
+        }
+
+        Label {
+            fontSize: "large"
+            Layout.fillWidth: true
+            wrapMode: Text.WrapAtWordBoundaryOrAnywhere
+            text: test["name"]
+            font.bold: true
+        }
+
+        Flickable {
+            Layout.fillWidth: true
+            Layout.fillHeight: true
+            contentHeight: childrenRect.height
+            flickableDirection: Flickable.VerticalFlick
+            clip: true
+            Label {
+                fontSize: "medium"
+                anchors.fill: parent
+                wrapMode: Text.WrapAtWordBoundaryOrAnywhere
+                text: test["description"]
+            }
+        }
+
+        ColumnLayout {
+            id: busyIndicatorGroup
+            visible: false
+            Layout.fillWidth: true
+            Layout.fillHeight: true
+
+            Label {
+                fontSize: "large"
+                Layout.fillWidth: true
+                wrapMode: Text.WrapAtWordBoundaryOrAnywhere
+                text: i18n.tr("Waiting for the test to finish")
+                font.bold: true
+            }
+        }
+
+        LatchButton {
+            objectName: "continueButton"
+            color: UbuntuColors.green
+            Layout.fillWidth: true
+            text: i18n.tr("Continue")
+            onClicked: {
+                busyIndicatorGroup.visible = true;
+                var appName = "com.ubuntu.checkbox_" + test["partial_id"] + "_" + applicationVersion + ".desktop";
+                console.log("Launching " + appName);
+                Qt.openUrlExternally("application:///" + appName);
+            }
+        }
+    }
+}

=== added directory 'checkbox-touch/confinement'
=== added file 'checkbox-touch/confinement/generate-confinement.py'
--- checkbox-touch/confinement/generate-confinement.py	1970-01-01 00:00:00 +0000
+++ checkbox-touch/confinement/generate-confinement.py	2015-07-23 11:16:26 +0000
@@ -0,0 +1,111 @@
+#!/usr/bin/env python3
+# This file is part of Checkbox.
+#
+# Copyright 2015 Canonical Ltd.
+# Written by:
+#   Maciej Kisielewski <[e-mail]>
+#
+# Checkbox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3,
+# as published by the Free Software Foundation.
+#
+# Checkbox 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 Checkbox.  If not, see <http://www.gnu.org/licenses/>.
+import argparse
+import os
+import string
+import sys
+
+
+CONTENT_HUB = """{
+    "destination": [ "documents"],
+    "source": [ "documents"],
+    "share": [ "documents"]
+}"""
+
+APPARMOR = """{
+    "policy_groups": [
+        "networking",
+        "webview",
+        "content_exchange",
+        "content_exchange_source"
+    ],
+    "policy_version": 1.2
+}"""
+
+
+DESKTOP = """[Desktop Entry]
+Name=Checkbox-${partial_id}
+Comment=${partial_id} - confined test from Checkbox
+Exec=qmlscene -I lib/py/plainbox/data/plainbox-qml-modules/ -I providers/${provider_name}/data/ --checkbox-name=${full_checkbox_name} --job ../providers/${provider_name}/data/${qml_file} $$@ confinement/plainbox-confined-shell.qml
+Icon=checkbox-touch.svg
+Terminal=false
+Type=Application
+X-Ubuntu-Touch=true
+"""
+
+HOOK = """
+"${partial_id}": {
+      "apparmor": "providers/${provider_name}/data/confined/${partial_id}.apparmor",
+      "desktop": "providers/${provider_name}/data/confined/${partial_id}.desktop",
+      "content-hub": "providers/${provider_name}/data/confined/${partial_id}-ch.json"
+}
+"""
+
+def generate_confinement(provider_name, partial_id, full_checkbox_name, qml_file):
+    # generate content-hub file
+    target_dir = os.path.join('data', 'confined')
+    if not os.path.exists(target_dir):
+        os.makedirs(target_dir)
+
+    content_hub_path = os.path.join(target_dir, partial_id + '-ch.json')
+    with open(content_hub_path, "wt") as f:
+        f.write(CONTENT_HUB)
+
+    # generate apparmor file
+    apparmor_path = os.path.join(target_dir, partial_id + '.apparmor')
+    with open(apparmor_path, "wt") as f:
+        f.write(APPARMOR)
+
+ 
+    # generate desktop file
+    desktop_path = os.path.join(target_dir, partial_id + '.desktop')
+    template = string.Template(DESKTOP)
+    with open(desktop_path, "wt") as f:
+        f.write(template.substitute(partial_id=partial_id, provider_name=provider_name, full_checkbox_name=full_checkbox_name, qml_file=qml_file))
+
+def generate_hook(provider_name, partial_id):
+    return string.Template(HOOK).substitute(
+        provider_name=provider_name, partial_id=partial_id)
+
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Generate confinement files for Checkbox")
+    parser.add_argument('--checkbox_version', action='store', type=str)
+    parser.add_argument('job_ids', nargs='+')
+    args = parser.parse_args()
+    checkbox_name = "com.ubuntu.checkbox_checkbox-touch_" + args.checkbox_version
+
+    # check if current dir looks like a provider - very dumb heuristic
+    if not os.path.exists('manage.py'):
+        sys.exit("Current directory doesn't look like a plainbox provider")
+    provider_name = os.path.split(os.getcwd())[-1]
+
+    hooks = ''
+    for job in args.job_ids:
+        generate_confinement(provider_name, job, checkbox_name, job + '.qml')
+        hooks += generate_hook(provider_name, job)
+
+    print("Add following hooks to your checkbox-touch.manifest:")
+    print(hooks)
+
+
+if __name__ == '__main__':
+    main()

=== added file 'checkbox-touch/confinement/plainbox-confined-shell.qml'
--- checkbox-touch/confinement/plainbox-confined-shell.qml	1970-01-01 00:00:00 +0000
+++ checkbox-touch/confinement/plainbox-confined-shell.qml	2015-07-23 11:16:26 +0000
@@ -0,0 +1,130 @@
+/*
+ * This file is part of Checkbox
+ *
+ * Copyright 2015 Canonical Ltd.
+ *
+ * Authors:
+ * - Maciej Kisielewski <[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/>.
+ */
+/*! \brief QML standalone shell for confined tests
+*/
+import QtQuick 2.0
+import Ubuntu.Components 0.1
+import Ubuntu.Content 1.1
+import io.thp.pyotherside 1.2
+
+MainView {
+    id: mainView
+    width: units.gu(100)
+    height: units.gu(75)
+
+    // information and functionality passed to qml job component
+    property var testingShell: {
+        "name": "Checkbox-touch qml confined shell",
+        "pageStack": pageStack
+    }
+    property var activeTransfer;
+
+    Arguments {
+        id: args
+        Argument {
+            name: "job"
+            help: "QML-native job to run"
+            required: true
+            valueNames: ["PATH"]
+        }
+        Argument {
+            name: "checkbox-name"
+            help: "Qualified name of Checkbox app to send results to"
+            required: true
+            valueNames: ["checkbox-touch-x.x.x"]
+        }
+    }
+
+    Loader {
+        id: loader
+        anchors.fill: parent
+        onStatusChanged: {
+            if (loader.status === Loader.Error) {
+                testDone({'outcome': 'crash'});
+            }
+        }
+        onLoaded: loader.item.testDone.connect(testDone)
+    }
+    Python {
+        id: py
+        Component.onCompleted: {
+            addImportPath('./confinement/');
+            importModule('os', function() {});
+            importModule('plainbox_confined_shell', function() {
+                loader.setSource(args.values['job'],
+                                 {'testingShell': testingShell});
+            });
+        }
+    }
+
+    function testDone(res) {
+        loader.active = false;
+        endPage.visible = true;
+        var transfer = checkboxPeer.request()
+        py.call("plainbox_confined_shell.obj_to_file", [res, 'com.ubuntu.checkbox', 'res.json'], function(resJson) {
+            console.log('Result file availble @ ' + resJson);
+            mainView.activeTransfer = checkboxPeer.request()
+            mainView.activeTransfer.items = [ contentItemComponent.createObject(
+                mainView, {url: resJson})]
+            mainView.activeTransfer.state = ContentTransfer.Charged;
+        });
+
+    }
+    Page {
+        id: endPage
+        visible: false
+        anchors.fill: parent
+        Label {
+            anchors.fill: parent
+            text: i18n.tr("sending results - you should not see this page :-)")
+        }
+    }
+    ContentPeer {
+        id: checkboxPeer
+        appId: args.values['checkbox-name']
+        contentType: ContentType.Documents
+        handler: ContentHandler.Destination
+    }
+    Connections {
+        target: mainView.activeTransfer
+        onStateChanged: {
+            if (mainView.activeTransfer.state === ContentTransfer.Finalized) {
+                var resultFile = String(mainView.activeTransfer.items[0].url).replace(
+                'file://', '');
+                console.log("Transfer completed; removing result file");
+                py.call('os.unlink', [resultFile], function() {
+                    Qt.quit();
+                });
+            }
+        }
+    }
+
+    Component {
+        id: contentItemComponent
+        ContentItem {
+        }
+    }
+
+    PageStack {
+        id: pageStack
+    }
+
+}

=== added file 'checkbox-touch/confinement/plainbox_confined_shell.py'
--- checkbox-touch/confinement/plainbox_confined_shell.py	1970-01-01 00:00:00 +0000
+++ checkbox-touch/confinement/plainbox_confined_shell.py	2015-07-23 11:16:26 +0000
@@ -0,0 +1,43 @@
+# This file is part of Checkbox.
+#
+# Copyright 2015 Canonical Ltd.
+# Written by:
+#   Maciej Kisielewski <[e-mail]>
+#
+# Checkbox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3,
+# as published by the Free Software Foundation.
+#
+# Checkbox 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 Checkbox.  If not, see <http://www.gnu.org/licenses/>.
+
+import json
+import os
+
+
+def obj_to_file(obj, consumer_name, filename):
+    """
+    Stringify object, write it to file and return path to the file.
+
+    :param object:
+        Object to be stringified
+    :param consumer_name:
+        Name of the app that will consume the generated file
+    :param filename:
+        Name of the file to write to (just the basename)
+    :returns:
+        Path to the written file
+    """
+    s = json.dumps(obj)
+    dir_path = os.path.join(os.environ['XDG_RUNTIME_DIR'], consumer_name)
+    if not os.path.exists(dir_path):
+        os.makedirs(dir_path)
+    out_path = os.path.join(dir_path, filename)
+    with open(out_path, "wt") as f:
+        f.write(s)
+    return out_path

=== modified file 'checkbox-touch/manifest.json'
--- checkbox-touch/manifest.json	2015-06-24 13:44:55 +0000
+++ checkbox-touch/manifest.json	2015-07-23 11:16:26 +0000
@@ -11,7 +11,7 @@
     "maintainer": "Zygmunt Krynicki <[e-mail]>",
     "name": "com.ubuntu.checkbox",
     "title": "Checkbox",
-    "version": "1.2.0",
+    "version": "1.2",
     "x-source": {
         "vcs-bzr": "lp:checkbox",
         "vcs-bzr-revno": "checkbox-touch-v1.2.0"

=== modified file 'checkbox-touch/py/checkbox_touch.py'
--- checkbox-touch/py/checkbox_touch.py	2015-07-23 08:25:48 +0000
+++ checkbox-touch/py/checkbox_touch.py	2015-07-23 11:16:26 +0000
@@ -468,12 +468,14 @@
                 job.tr_verification() is not None else description,
                 "plugin": job.plugin,
                 "id": job.id,
+                "partial_id": job.partial_id,
                 "user": job.user,
                 "qml_file": job.qml_file,
                 "start_time": time.time(),
                 "test_number": self.index,
                 "tests_count": len(self.context.state.run_list),
-                "command": job.command
+                "command": job.command,
+                "flags": job.get_flag_set()
             }
             if not job_state.can_start():
                 test["outcome"] = "skip"