Merge lp:~kissiel/checkbox/package-checkbox-touch into lp:checkbox

[Maciej Kisielewski]

This MR brings packaging of checkbox-touch, together with default settings forwarding to app and documentation.
fca0846 checkbox-touch: documentation update
30ff9e9 checkbox-touch: add click packaging stuff

[Zygmunt Krynicki (zyga)]

Nice, I made a few comments down below

[Zygmunt Krynicki (zyga)]

I've added two ideas below, I'll make sure you can use those today

[lp:~kissiel/checkbox/package-checkbox-touch]

3383. By Zygmunt Krynicki on 2014-11-04

"automatic merge of lp:~zkrynicki/checkbox/travis/ by tarmac [r=sylvain-pineau][bug=][author=zkrynicki]"

3384. By Zygmunt Krynicki on 2014-11-04

"automatic merge of lp:~zkrynicki/checkbox/decorators/ by tarmac [r=sylvain-pineau][bug=][author=zkrynicki]"

3385. By Zygmunt Krynicki on 2014-11-04

"automatic merge of lp:~zkrynicki/checkbox/decorators/ by tarmac [r=kissiel][bug=][author=zkrynicki]"

3386. By Zygmunt Krynicki on 2014-11-04

"automatic merge of lp:~zkrynicki/checkbox/travis-more/ by tarmac [r=sylvain-pineau][bug=][author=zkrynicki]"

3387. By Sylvain Pineau on 2014-11-06

"automatic merge of lp:~sylvain-pineau/checkbox/export-touch-results/ by tarmac [r=sylvain-pineau,zkrynicki][bug=1375591][author=sylvain-pineau]"

3388. By Sylvain Pineau on 2014-11-06

"automatic merge of lp:~sylvain-pineau/checkbox/fix-1389253/ by tarmac [r=apulido,zkrynicki][bug=1389253][author=sylvain-pineau]"

3389. By Sylvain Pineau on 2014-11-06

"automatic merge of lp:~sylvain-pineau/checkbox/fix-1387843/ by tarmac [r=roadmr][bug=1387843][author=sylvain-pineau]"

3390. By Rod Smith on 2014-11-06

"automatic merge of lp:~rodsmith/checkbox/dmitest/ by tarmac [r=roadmr][bug=][author=rodsmith]"

[Sylvain Pineau (sylvain-pineau)]

Only two minor comments, see below.

review: Needs Fixing

[lp:~kissiel/checkbox/package-checkbox-touch]

3391. By Sylvain Pineau on 2014-11-07

"Release_2014_Week45 [r=sylvain-pineau][bug=1331302,1341769,1347120,1383447,1387782,1387843,1388055,1388747,1389253][author=checkbox-dev]"

3392. By Sylvain Pineau on 2014-11-07

Restore dev version

3393. By Launchpad Translations on behalf of checkbox-dev on 2014-11-08

Launchpad automatic translations update.

3394. By Maciej Kisielewski on 2014-11-11

checkbox-touch: add click packaging stuff

This patch adds scripts building click package.

3395. By Maciej Kisielewski on 2014-11-11

checkbox-touch: documentation update

[Maciej Kisielewski (kissiel)]

Fixed issues pointed by Sylvain.
Repushed.

[Sylvain Pineau (sylvain-pineau)]

Thanks for the last minutes fixes, +1.

review: Approve

=== removed file 'checkbox-touch/README.md'
--- checkbox-touch/README.md	2014-08-21 19:13:22 +0000
+++ checkbox-touch/README.md	1970-01-01 00:00:00 +0000
@@ -1,51 +0,0 @@
-The Checkbox Touch
-==================
-
-This directory contains the implementation of Checkbox Touch. The Ubuntu-SDK
-based touch application that initially, will target the phone form factor (but
-will work on all the form factors).
-
-It is implemented according to a design document (we need to publish that
-document before it can be referenced here) that describes a minimum viable
-product for v1.0
-
-The application works well in an x86 and armhf emulator as well as on the
-desktop. On a desktop system we recommend to use packaged dependencies
-(python3-plainbox and pyotherside). On any of the touch devices you will need
-to build a suitable click package (see below for details) or get a copy from
-the Ubuntu store, once it gets published.
-
-Building the click package
---------------------------
-
-The click package is built from QML/JavaScript/Python code contained in the
-`py` and `components` directories. It also has `lib` directory that contains
-all necessary libraries needed to run checkbox-touch.
-
-Before building click package make sure you run `./get-libs` to initialize and
-populate `./lib` directory.
-To build the click package run `$ click build path_to_checkbox-touch`.
-
-Deploying on the device
------------------------
-
-To run install package on the device/emulator run :
-
-`$ adb push com.canonical.certification.checkbox-touch_0.2_armhf.click`
-`/home/phablet/`
-
-`$ phablet-shell`
-
-`phablet@ubuntu-phablet:$ pkcon install-local`
-`com.canonical.certification.checkbox-touch_0.2_armhf.click`
-
-`phablet@ubuntu-phablet:$ exit`
-
-
-Running on a desktop
---------------------
-
-To run on a desktop run `qmlscene main.qml`
-Note: Make sure you've ran `./get-libs` first.
-
-

=== added file 'checkbox-touch/README.rst'
--- checkbox-touch/README.rst	1970-01-01 00:00:00 +0000
+++ checkbox-touch/README.rst	2014-11-11 09:54:23 +0000
@@ -0,0 +1,83 @@
+The Checkbox Touch
+==================
+
+This directory contains the implementation of Checkbox Touch. The Ubuntu-SDK
+based touch application that initially, will target the phone form factor (but
+will work on all the form factors).
+
+It is implemented according to a design document (http://goo.gl/2agB51),
+that describes a minimum viable product for v1.0
+
+The application works well in an x86 and armhf emulator as well as on the
+desktop. On a desktop system we recommend to use packaged dependencies
+(python3-plainbox and pyotherside). On any of the touch devices you will need
+to build a suitable click package (see below for details) or get a copy from
+the Ubuntu store, once it gets published.
+
+Getting dependencies
+--------------------
+
+The click package is built from QML/JavaScript/Python code contained in the
+`py` and `components` directories. It also has `lib` directory that contains
+all necessary libraries needed to run checkbox-touch.
+
+Before building click package make sure you run `./get-libs` to initialize and
+populate `./lib` directory. Use --get-local-plainbox to embed plainbox code
+that's available in the ../plainbox directory.
+
+Building and installing the click package
+-----------------------------------------
+
+To build Checkbox-Touch click package run:
+
+.. code-block:: bash
+
+    $ ./build-me
+
+to build and install the package run:
+
+.. code-block:: bash
+
+    $ ./build-me --install
+
+Running Checkbox-Touch on a desktop
+-----------------------------------
+
+To run on a desktop run `qmlscene main.qml`
+Note: Make sure you've ran `./get-libs` first.
+
+
+Choosing the default test-plan
+------------------------------
+
+If you wish to run one particular test plan, you may do so, by providing
+./build-me script with --testplan option. E.g.:
+
+.. code-block:: bash
+
+    $ ./build-me --testplan="2013.com.canonical.plainbox::stub"
+
+
+Embedding providers into click package
+--------------------------------------
+
+If you wish to provide extra providers, copy them into `providers` directory.
+Every provider in `providers` directory should have same structure as one
+generated by `plainbox startprovider` command
+
+Default Checkbox-Touch settings
+-------------------------------
+During execution of `./build-me` script, `settings.json` file is generated.
+It contains values that Checkbox-Touch will use as its default ones.
+Altough not required, you may edit this file to suit your needs.
+
+Further assistance
+------------------
+
+For further assistance on packaging Checkbox-Touch, run:
+
+.. code-block:: bash
+
+    $ ./build-me --help
+
+

=== added file 'checkbox-touch/build-me'
--- checkbox-touch/build-me	1970-01-01 00:00:00 +0000
+++ checkbox-touch/build-me	2014-11-11 09:54:23 +0000
@@ -0,0 +1,99 @@
+#!/usr/bin/env python3
+import argparse
+from distutils.dir_util import copy_tree
+import json
+import os
+import re
+import subprocess
+import sys
+
+
+def get_revision_string(path='.'):
+
+    # Try getting revno from bazaar vcs
+    try:
+        revno = int(subprocess.check_output(
+            ["bzr", "revno", path], stderr=subprocess.STDOUT))
+        return "bzr revision r{}".format(revno)
+    except subprocess.CalledProcessError:
+        # problem encountered when run bzr revno - falling through
+        pass
+
+    # Try getting version from git
+    try:
+        revno = subprocess.check_output(
+            ["git", "-C", path, "show", "-s", "--format=%H", "HEAD"],
+            stderr=subprocess.STDOUT).decode(
+                sys.stdout.encoding).strip()
+        return "git revision {}".format(revno)
+    except subprocess.CalledProcessError:
+        # problem encountered when run git revision - falling through
+        pass
+
+    return "Unknown revision"
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Get necessary libs for checkbox-touch")
+    parser.add_argument("--embedded-providers-path", action='store', type=str,
+                        nargs='*', help="Paths to directories with providers")
+    parser.add_argument("--install",
+                        action='store_true',
+                        help=("Use adb to push and install click package on"
+                              " the device"))
+    parser.add_argument("--testplan",
+                        action='store', default="", type=str,
+                        help="Test plan to set as the default one")
+
+    args = parser.parse_args()
+
+    # generate setting.json
+    settings = {
+        "_comment": "file generated automatically with {0}"
+                    .format(parser.prog),
+        "revision": get_revision_string(),
+        "testplan": args.testplan
+    }
+    settings_file = open('settings.json', 'w')
+    settings_file.write(json.dumps(settings, sort_keys=True, indent=4))
+    settings_file.close()
+
+    if args.embedded_providers_path is not None:
+        for path in args.embedded_providers_path:
+            copy_tree(path, 'providers')
+
+    if not os.path.exists('../build-cbt'):
+        os.makedirs('../build-cbt')
+
+    pkg = build_click()
+    if args.install:
+        install_click(pkg)
+
+
+def build_click():
+    os.chdir('../build-cbt')
+    print('Building click package')
+    click_source_path = '../checkbox-touch'
+    out = subprocess.check_output(['click', 'build', click_source_path])
+    pkg_name = re.search("'\.\/(.*)\.click'", str(out)).group(1) + '.click'
+    return pkg_name
+
+
+def install_click(pkg):
+    print('Pushing to the device')
+    try:
+        subprocess.check_output(['adb', 'push', pkg, '/tmp/'])
+    except subprocess.CalledProcessError:
+        sys.exit('Error ecountered while pushing to the device.')
+    print('Installing click package')
+    path = '/tmp/' + pkg
+    try:
+        subprocess.check_output(['adb', 'shell', ('pkcon install-local'
+                                ' --allow-untrusted -p -y {path}').format(
+                                path=path)])
+    except subprocess.CalledProcessError:
+        sys.exit('Error ecountered while installing click package.')
+
+if __name__ == "__main__":
+    main()

=== modified file 'checkbox-touch/main.qml'
--- checkbox-touch/main.qml	2014-11-05 10:56:36 +0000
+++ checkbox-touch/main.qml	2014-11-11 09:54:23 +0000
@@ -49,6 +49,32 @@
 
     useDeprecatedToolbar: false
 
+    // appSettings serves as application-wide storage for global variables
+    // it has to have at least one entry to be constructed
+    property var appSettings: {
+        "applicationName" : applicationName,
+        "revision": "unknown revision",
+        "testplan": ""
+    }
+
+    Component.onCompleted: {
+        var xhr = new XMLHttpRequest;
+        xhr.open("GET", "settings.json");
+        xhr.onreadystatechange = function() {
+            if (xhr.readyState == XMLHttpRequest.DONE) {
+                try {
+                    appSettings = JSON.parse(xhr.responseText);
+                } catch (x) {
+                    // if we cannot parse settings.json, we should leave
+                    // deafult values of appSettings
+                    console.log("Could not parse settings.json. Using default values")
+                }
+            }
+        }
+        xhr.send();
+    }
+
+
     // Pyotherside python object that we use to talk to all of plainbox
     Python {
         id: py
@@ -93,19 +119,25 @@
 
     WelcomePage {
         id: welcomePage
-        welcomeText: i18n.tr("Welcome to Checkbox Touch")
+        welcomeText: i18n.tr("Welcome to Checkbox Touch\nVersion: " + appSettings.revision)
         onStartTestingTriggered: {
-            app.getTestplans(function(response) {
-                var tp_list = response.testplan_info_list;
-                if(tp_list.length < 2) {
-                    app.rememberTestplan(tp_list[0].mod_id, function() {
-                        categorySelectionPage.setup();
-                    });
-                }
-                else {
-                    testplanSelectionPage.setup(tp_list)
-                }
-            });
+            if (appSettings.testplan != "") {
+                app.rememberTestplan(appSettings.testplan, function() {
+                    categorySelectionPage.setup();
+                });
+            } else {
+                app.getTestplans(function(response) {
+                    var tp_list = response.testplan_info_list;
+                    if (tp_list.length < 2) {
+                        app.rememberTestplan(tp_list[0].mod_id, function() {
+                            categorySelectionPage.setup();
+                        });
+                    }
+                    else {
+                        testplanSelectionPage.setup(tp_list)
+                    }
+                });
+            }
         }
     }
     ResumeSessionPage {