Merge lp:~cypressyew/checkbox/bt4-HOGP into lp:checkbox

[Po-Hsu Lin]

Add a manifest request for asking tester about BT 4.x capability of this system.
Add a BT 4.x specific test case for HID devices (keyboard / mouse)

[Po-Hsu Lin (cypressyew)]

The reason why we're only adding a new test case for HID is that, this HID Over GATT Profile is a new feature for Bluetooth 4.x devices. For those old profiles like obex, they are not a new stuff, so leave it as-is for back-ward compatibility test.

[Ara Pulido (ara)]

Can we do the test more automated, please?

Things that we can automate: The name of the device may be configurable, enabling bluetooth and selecting the configured BT device should be automated.

Thanks,
Ara.

review: Needs Fixing

[Yung Shen (kaxing)]

About the job naming with 4.x, there is a small quirk between versions: 4.1 is software upgrade but for 4.2 some feature requires hardware upgrade. It might be better to left the x for the future job.

[Yung Shen (kaxing)]

About automation, a note for HOGP devices, at least the two mouses that I've handed on, they will changing MAC address from each pairing reset.

And since this set of bluetooth jobs will be used on Desktop releases, I think the interactive part of testing would be more closer to real-life scenario.

[Ara Pulido (ara)]

We don't want to mimic real-life scenario. We want to be efficient in our testing.

[lp:~cypressyew/checkbox/bt4-HOGP]

4265. By Po-Hsu Lin on 2016-03-16

p-p-c: Add BT automated script for mouse, and corresponding test case.

Add BT automated script, which will ask tester to enter MAC address,
Split the BT4 HOGP test cases into 2, mouse and keyboard.
Improve the term "BT 4.x" with "Bluetooth Smart".

4266. By Po-Hsu Lin on 2016-03-16

p-p-c: Convert bt_connect script to python3.

Apply to try statement to convert this script to python3,
add some docstrings and change the todo list

4267. By Po-Hsu Lin on 2016-03-17

Merging Yung's patch to align Bluetooth Smart naming.

Aligning bluetooth 4.x naming

4268. By Po-Hsu Lin on 2016-03-17

Add scanning feature and improve the keyboard test case.

Add scanning feature and class code dictionary to determine which device to connect.
Improve the keyboard test case.

[Po-Hsu Lin (cypressyew)]

Hi Yung, please modify the executable base on Maciej's bt_helper
https://github.com/kissiel/bt_helper

[Yung Shen (kaxing)]

Bluez 5.x version moving to this MR:
https://code.launchpad.net/~kaxing/checkbox/bt4-bluez5/+merge/290716

review: Abstain

Unmerged revisions

=== added file 'providers/plainbox-provider-checkbox/bin/bt_connect'
--- providers/plainbox-provider-checkbox/bin/bt_connect	1970-01-01 00:00:00 +0000
+++ providers/plainbox-provider-checkbox/bin/bt_connect	2016-03-17 10:36:36 +0000
@@ -0,0 +1,221 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# This file is part of Checkbox.
+#
+# Copyright 2016 Canonical Ltd.
+#
+# Authors:
+#    Po-Hsu Lin <[e-mail]>
+#    Yung Shen <[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/>.
+
+# possibility to lockup, if it times out
+# TODO: 5. better exception handling (wrong PIN, authentication rejected)
+#       6. different PIN selection
+#       7. MAC address validator
+#       8. Use logging for information
+#       9. PEP8
+try:
+    from gi.repository import GObject
+except ImportError:
+    import gobject as GObject
+
+import time
+import dbus
+import dbus.service
+from dbus.mainloop.glib import DBusGMainLoop
+from argparse import ArgumentParser
+
+PIN = '0000'
+CLASS_CODE = {'mouse': [0x580, 0x2580], 'keyboard': [0x540, 0x2540]}
+mainloop = GObject.MainLoop()
+
+
+class Rejected(dbus.DBusException):
+    _dbus_error_name = "org.bluez.Error.Rejected"
+
+
+class Agent(dbus.service.Object):
+    exit_on_release = True
+
+    def set_exit_on_release(self, exit_on_release):
+        self.exit_on_release = exit_on_release
+
+    @dbus.service.method("org.bluez.Agent",
+                         in_signature="", out_signature="")
+    def Release(self):
+        if self.exit_on_release:
+            mainloop.quit()
+
+    @dbus.service.method("org.bluez.Agent",
+                         in_signature="os", out_signature="")
+    def Authorize(self, device, uuid):
+        print("Authorize {}, {}".format(device, uuid))
+        authorize = raw_input("Authorize connection (yes/no): ")
+        if (authorize == "yes"):
+            return
+        raise Rejected("Connection rejected by user")
+
+    @dbus.service.method("org.bluez.Agent",
+                         in_signature="o", out_signature="s")
+    def RequestPinCode(self, device):
+        print("Sending PIN: {} to your device.".format(PIN))
+        if TARGET is not 'mouse':
+            print("For keyboard, please type this PIN on it and hit Enter.")
+        # need to figure out how to send 0000 / 1111 / 1234
+        return PIN
+        # return raw_input("Enter PIN Code: ")
+
+    @dbus.service.method("org.bluez.Agent",
+                         in_signature="o", out_signature="u")
+    def RequestPasskey(self, device):
+        print("RequestPasskey {}".format(device))
+        passkey = raw_input("Enter passkey: ")
+        return dbus.UInt32(passkey)
+
+    @dbus.service.method("org.bluez.Agent",
+                         in_signature="ou", out_signature="")
+    def DisplayPasskey(self, device, passkey):
+        print("Please enter the passkey: {} on your device".format(passkey))
+
+    @dbus.service.method("org.bluez.Agent",
+                         in_signature="ou", out_signature="")
+    def RequestConfirmation(self, device, passkey):
+        print("RequestConfirmation {}, {})".format(device, passkey))
+        confirm = raw_input("Confirm passkey (yes/no): ")
+        if (confirm == "yes"):
+            return
+        raise Rejected("Passkey doesn't match")
+
+    @dbus.service.method("org.bluez.Agent",
+                         in_signature="s", out_signature="")
+    def ConfirmModeChange(self, mode):
+        print("ConfirmModeChange {}".format(mode))
+        authorize = raw_input("Authorize mode change (yes/no): ")
+        if (authorize == "yes"):
+            return
+        raise Rejected("Mode change by user")
+
+    @dbus.service.method("org.bluez.Agent",
+                         in_signature="", out_signature="")
+    def Cancel(self):
+        print("Cancel")
+
+
+def create_device_reply(device):
+    print("New device {}".format(device))
+    mainloop.quit()
+
+
+def create_device_error(error):
+    if error._dbus_error_name == 'org.bluez.Error.AuthenticationFailed':
+        print("ERROR: Passcode Authentication Failed, wrong passcode?")
+    else:
+        print("Creating device failed: {}".format(error))
+    mainloop.quit()
+
+
+def property_changed(name, value):
+    """handler function for "PropertyChanged" signal."""
+    if (name == "Discovering" and not value):
+        mainloop.quit()
+
+
+def device_found(address, properties):
+    global DEVICE_MAC
+    """handler function for "DeviceFound" signal."""
+    if properties['Class'] in CLASS_CODE[TARGET]:
+        print("Device found: {}".format(properties['Name']))
+        print("MAC address: {}".format(properties['Address']))
+        DEVICE_MAC = properties['Address']
+
+
+def main():
+    """Add argument parser here and do most of the job."""
+    global TARGET
+    global DEVICE_MAC
+    DEVICE_MAC = None
+    parser = ArgumentParser(description="Bluetooth auto paring and connect. Please select one option.")
+    group = parser.add_mutually_exclusive_group(required=True)
+    group.add_argument("--mac", type=str,
+                       help="Pair with a given MAC, not using scan result,")
+    group.add_argument("--mouse", action="store_const",
+                       const="mouse", dest='target',
+                       help="Pair with the last mouse found from scan result.")
+    group.add_argument("--keyboard", action="store_const",
+                       const="keyboard", dest='target',
+                       help="Pair with the last keyboard found from scan result.")
+    parser.add_argument("-i", "--interface", type=str,
+                        help="Device interface, e.g. hci0")
+    parser.add_argument("-c", "--capability", type=str, default="DisplayYesNo")
+    args = parser.parse_args()
+
+    DBusGMainLoop(set_as_default=True)
+    bus = dbus.SystemBus()
+    manager = dbus.Interface(bus.get_object("org.bluez", "/"),
+                             "org.bluez.Manager")
+    if args.interface:
+        path = manager.FindAdapter(args.interface)
+    else:
+        path = manager.DefaultAdapter()
+
+    adapter = dbus.Interface(bus.get_object("org.bluez", path),
+                             "org.bluez.Adapter")
+
+    path = "/test/agent"
+    agent = Agent(bus, path)
+    if not args.mac:
+        # Activate scan and auto pairing
+        TARGET = args.target
+        print("Trying to scan and pair with a {}.".format(TARGET))
+        bus.add_signal_receiver(device_found,
+                                signal_name="DeviceFound",
+                                dbus_interface="org.bluez.Adapter")
+        bus.add_signal_receiver(property_changed,
+                                signal_name="PropertyChanged",
+                                dbus_interface="org.bluez.Adapter")
+        adapter.StartDiscovery()
+        mainloop.run()
+        adapter.StopDiscovery()
+        if not DEVICE_MAC:
+            print("ERROR: No pairable device found, terminating")
+            return 1
+    else:
+        DEVICE_MAC = args.mac
+
+    # Try to remove the Device entry if exist
+    try:
+        device = adapter.FindDevice(DEVICE_MAC)
+        print("Device already exist, remove it first")
+        adapter.RemoveDevice(device)
+    except dbus.exceptions.DBusException:
+        print("Creating device entry")
+    agent.set_exit_on_release(False)
+    print("Paring device")
+    adapter.CreatePairedDevice(DEVICE_MAC, path, args.capability,
+                               reply_handler=create_device_reply,
+                               error_handler=create_device_error)
+
+    mainloop.run()
+
+    time.sleep(3)
+    print("Connecting device...")
+    device = adapter.FindDevice(DEVICE_MAC)
+    hid = dbus.Interface(bus.get_object("org.bluez", device),
+                         "org.bluez.Input")
+    hid.Connect()
+
+if __name__ == "__main__":
+    main()

=== modified file 'providers/plainbox-provider-checkbox/jobs/bluetooth.txt.in'
--- providers/plainbox-provider-checkbox/jobs/bluetooth.txt.in	2016-01-12 10:28:35 +0000
+++ providers/plainbox-provider-checkbox/jobs/bluetooth.txt.in	2016-03-17 10:36:36 +0000
@@ -1,3 +1,10 @@
+unit: manifest entry
+id: has_bt_smart
+_name: Bluetooth Smart (4.0 or later) Support
+requires:
+ device.category == 'BLUETOOTH'
+value-type: bool
+
 plugin: shell
 category_id: 2013.com.canonical.plainbox::bluetooth
 id: bluetooth/detect-output
@@ -157,3 +164,42 @@
  retrieves it again using Bluetooth and verifies the checksum to ensure the
  transfer didn't corrupt the file.
 
+plugin: user-interact-verify
+category_id: 2013.com.canonical.plainbox::bluetooth
+id: bluetooth4/HOGP-mouse
+depends: bluetooth/detect-output
+requires:
+ manifest.has_bt_smart == 'True'
+ package.name == 'zenity'
+estimated_duration: 30.0
+command: bt_connect --mac `zenity --entry --title="device MAC" --text="Please enter the MAC address for testing"`
+_description:
+ PURPOSE:
+     This test will check that you can use a HID Over GATT Profile (HOGP) with your Bluetooth Smart mouse.
+ STEPS:
+     1. Enable a Bluetooth smart mouse, and put it into paring mode.
+     2. Use "hcitool scan" command in another terminal to get the MAC address of it.
+     3. Commence the test to do the auto-pairing, you will be asked to enter the MAC address.
+     4. After it's paired and connected, perform actions such as moving the pointer, right and left button clicks and double clicks.
+ VERIFICATION:
+     Did the Bluetooth Smart mouse work as expected?
+
+plugin: user-interact-verify
+category_id: 2013.com.canonical.plainbox::bluetooth
+id: bluetooth4/HOGP-keyboard
+depends: bluetooth/detect-output
+requires:
+ manifest.has_bt_smart == 'True'
+ package.name == 'zenity'
+estimated_duration: 30.0
+command: bt_connect --mac `zenity --entry --title="device MAC" --text="Please enter the MAC address for testing"` && keyboard_test
+_description:
+ PURPOSE:
+     This test will check that you can use a HID Over GATT Profile (HOGP) with your Bluetooth Smart keyboard.
+ STEPS:
+     1. Enable a Bluetooth Smart keyboard, and put it into paring mode.
+     2. Use "hcitool scan" command in another terminal to get the MAC address of it.
+     3. Commence the test to do the auto-pairing, you will be asked to enter the MAC address and PIN code.
+     4. After it's paired and connected, enter some text with your keyboard and close the small input test tool.
+ VERIFICATION:
+     Did the Bluetooth Smart keyboard work as expected?