Merge lp:~cr3/checkbox/xinput_resource into lp:checkbox

[Marc Tardif]

Added xinput_resource script and xinput parser by cr3.

This is just the xinput_resource script with unit tests using fixtures for xinput values from a toshiba laptop and a quantal all-in-one system.

[Zygmunt Krynicki (zyga)]

40 - raise Excepion("Key not found: %s" % field)
41 + raise Exception("Key not found: %s" % field)

Just bike shedding, sorry, I'd use KeyError here

609 +<<<<<<< TREE
610 * patch/0.14.2: Fixed patch to rmtree instead of rmdir scripts directory.
611 * [FEATURE] debian/checkbox.templates, debian/checkbox.config: Added support to
612 preseed properties in environment_info plugin.
613 +=======
614 + * [FEATURE] scripts/xinput_resource, checkbox/parsers/xinput.py: Xinput
615 + resource script to test multitouch devices.
616 +>>>>>>> MERGE-SOURCE

There's a typical conflict in our changelogs but I guess we cannot avoid that with our current model

394 +class XinputResult:
395 +
396 + def __init__(self):
397 + self.devices = {}
398 +
399 + def addXinputDevice(self, device):
400 + self.devices[device["id"]] = device
401 +
402 + def addXinputDeviceClass(self, device, device_class):
403 + self.devices[device["id"]].setdefault("classes", [])
404 + self.devices[device["id"]]["classes"].append(device_class)

This should be in checkbox/parsers/xinput.py or there should be an interface that describes it. Otherwise if I want to use your parser I need to reverse engineer the interface that I'm expected to pass to XInputParser.run().

487 +DEVICE_RE = re.compile(
488 + r""".+?(?P<name>[%s].+?) *\sid=(?P<id>\d+)"""
489 + % ascii_uppercase)
490 +ATTRIBUTE_RE = re.compile(
491 + r"""(?P<key>[%s].+?): (?P<value>.+)"""
492 + % ascii_letters)
493 +CLASS_VALUE_RE = re.compile(
494 + r"""\d+\. Type: (?P<class>.+)""")
495 +LIST_VALUE_RE = re.compile(
496 + r"""((?:[^ "]|"[^"]*")+)""")

I would really document those, as in how the data looks like and what we parse out.

Otherwise okay, neat job!

[Zygmunt Krynicki (zyga)]

Oh, and generally, some more documentation is always better, especially on stuff that lands in checkbox.*

[Marc Tardif (cr3)]

* Zygmunt Krynicki <email address hidden> [2012-09-14 08:21 -0000]:
> 40 - raise Excepion("Key not found: %s" % field)
> 41 + raise Exception("Key not found: %s" % field)
>
> Just bike shedding, sorry, I'd use KeyError here

Another way would be to just let the exception occur by removing
the conditional statement and just having this:

  return self._modinfo[field]

However, even though self._modinfo is a dictionary, the exception
is about a missing key expected in the modinfo output. In other
words, the exception is not intended to convey a Python thing
but a modinfo thing. So, I might suggest a ModinfoError instead
of just a generic Exception. What do you think about that for
parser errors in general?

> 609 +<<<<<<< TREE
> 610 * patch/0.14.2: Fixed patch to rmtree instead of rmdir scripts directory.
> 611 * [FEATURE] debian/checkbox.templates, debian/checkbox.config: Added support to
> 612 preseed properties in environment_info plugin.
> 613 +=======
> 614 + * [FEATURE] scripts/xinput_resource, checkbox/parsers/xinput.py: Xinput
> 615 + resource script to test multitouch devices.
> 616 +>>>>>>> MERGE-SOURCE
>
> There's a typical conflict in our changelogs but I guess we cannot
> avoid that with our current model

Agreed, everyone is annoyed by that :)

> 394 +class XinputResult:
> 395 +
> 396 + def __init__(self):
> 397 + self.devices = {}
> 398 +
> 399 + def addXinputDevice(self, device):
> 400 + self.devices[device["id"]] = device
> 401 +
> 402 + def addXinputDeviceClass(self, device, device_class):
> 403 + self.devices[device["id"]].setdefault("classes", [])
> 404 + self.devices[device["id"]]["classes"].append(device_class)
>
> This should be in checkbox/parsers/xinput.py or there should be an
> interface that describes it. Otherwise if I want to use your parser
> I need to reverse engineer the interface that I'm expected to pass to
> XInputParser.run().

You're right. Ideally, we could define an abstract base class or an
interface in the checkbox.parsers.xinput module. However, these patterns
are not supported natively in Python. How about something like this:

class XinputResult:

    def addXinputDevice(self, device):
        """Method to add an xinput device to this result."""

    def addXinputDeviceClass(self, device, device_class):
        """Method to add a class under an xinput device."""

> 487 +DEVICE_RE = re.compile(
> 488 + r""".+?(?P<name>[%s].+?) *\sid=(?P<id>\d+)"""
> 489 + % ascii_uppercase)
> 490 +ATTRIBUTE_RE = re.compile(
> 491 + r"""(?P<key>[%s].+?): (?P<value>.+)"""
> 492 + % ascii_letters)
> 493 +CLASS_VALUE_RE = re.compile(
> 494 + r"""\d+\. Type: (?P<class>.+)""")
> 495 +LIST_VALUE_RE = re.compile(
> 496 + r"""((?:[^ "]|"[^"]*")+)""")
>
> I would really document those, as in how the data looks like and what
> we parse out.

Agreed, would you have an example for documenting regular expressions that
I would gladly follow?

Thanks for the review!

[Zygmunt Krynicki (zyga)]

W dniu 14.09.2012 16:01, Marc Tardif pisze:
> * Zygmunt Krynicki <email address hidden> [2012-09-14 08:21 -0000]:
>> 40 - raise Excepion("Key not found: %s" % field)
>> 41 + raise Exception("Key not found: %s" % field)
>>
>> Just bike shedding, sorry, I'd use KeyError here
>
> Another way would be to just let the exception occur by removing
> the conditional statement and just having this:
>
> return self._modinfo[field]
>
> However, even though self._modinfo is a dictionary, the exception
> is about a missing key expected in the modinfo output. In other
> words, the exception is not intended to convey a Python thing
> but a modinfo thing. So, I might suggest a ModinfoError instead
> of just a generic Exception. What do you think about that for
> parser errors in general?

Hmm, I see.

I rarely use raw Exceptions, typically I wrap the logic so that you have
a function, feed it some data and if the data makes the function go boom
but there is no need for a dedicated exception subclass I use
ValueError. I don't claim it's superior much but one thing it allows you
to do to though is to catch ValueError[s] and not all Exception[s].

>> 394 +class XinputResult:
>> 395 +
>> 396 + def __init__(self):
>> 397 + self.devices = {}
>> 398 +
>> 399 + def addXinputDevice(self, device):
>> 400 + self.devices[device["id"]] = device
>> 401 +
>> 402 + def addXinputDeviceClass(self, device, device_class):
>> 403 + self.devices[device["id"]].setdefault("classes", [])
>> 404 + self.devices[device["id"]]["classes"].append(device_class)
>>
>> This should be in checkbox/parsers/xinput.py or there should be an
>> interface that describes it. Otherwise if I want to use your parser
>> I need to reverse engineer the interface that I'm expected to pass to
>> XInputParser.run().
>
> You're right. Ideally, we could define an abstract base class or an
> interface in the checkbox.parsers.xinput module. However, these patterns
> are not supported natively in Python. How about something like this:

Actually I grew fond of purely-A ABCs as interfaces.

from abc import ABCMeta, abstractmethod

class IXInputResult:
 metaclass = ABCMeta

 @abstractmethod
 def addXinputDevice(self, device):
  """
  docs
  """

The static part of you could even require isinstance(result,
IXInputResult) but in general it's a simple way to ensure we understand
the responsibilities of various classes without creating fat abstract
base classes.

(ps, any reason why you named it X{lowercase i}input and not XInput?

>> 487 +DEVICE_RE = re.compile(
>> 488 + r""".+?(?P<name>[%s].+?) *\sid=(?P<id>\d+)"""
>> 489 + % ascii_uppercase)
>> 490 +ATTRIBUTE_RE = re.compile(
>> 491 + r"""(?P<key>[%s].+?): (?P<value>.+)"""
>> 492 + % ascii_letters)
>> 493 +CLASS_VALUE_RE = re.compile(
>> 494 + r"""\d+\. Type: (?P<class>.+)""")
>> 495 +LIST_VALUE_RE = re.compile(
>> 496 + r"""((?:[^ "]|"[^"]*")+)""")
>>
>> I would really document those, as in how the data looks like and what
>> we parse out.
>
> Agreed, would you have an example for documenting regular expressions that
> I would gladly follow?

Not really, frankly I needed to look-up a few of the syntax pieces here
so maybe just explain that in a ...

[Marc Tardif (cr3)]

* Zygmunt Krynicki <email address hidden> [2012-09-14 14:13 -0000]:
[snip]
> Actually I grew fond of purely-A ABCs as interfaces.
>
> from abc import ABCMeta, abstractmethod
>
> class IXInputResult:
> metaclass = ABCMeta
>
> @abstractmethod
> def addXinputDevice(self, device):
> """
> docs
> """
>
> The static part of you could even require isinstance(result,
> IXInputResult) but in general it's a simple way to ensure we understand
> the responsibilities of various classes without creating fat abstract
> base classes.

Following discussions on IRC, I just declared a base class with empty
functions and comments.

> (ps, any reason why you named it X{lowercase i}input and not XInput?

Same reason as the DmidecodeParser class; "dmidecode" and "xinput" are
command names that I consider as one word.

> Not really, frankly I needed to look-up a few of the syntax pieces here
> so maybe just explain that in a few # comments what the thing being
> parsed is. More usefulness than form or convention.

Thanks for the advice, that inspired me to also add a unit test for each
regular expression. I hope you like all the comments!

[Marc Tardif (cr3)]

I need to learn how to set the review to "resubmit" by email...

review: Needs Resubmitting

[Zygmunt Krynicki (zyga)]

Awesome!

I'll merge it in a sec. Would you mind waiting a few more hours for the initial tarmac test setup?

review: Approve

[Zygmunt Krynicki (zyga)]

Attempt to merge into lp:checkbox failed due to conflicts:

text conflict in debian/changelog

[Zygmunt Krynicki (zyga)]

There are additional revisions which have not been approved in review. Please seek review and approval of these new revisions.

=== modified file 'checkbox/parsers/modinfo.py'
--- checkbox/parsers/modinfo.py	2012-08-30 16:03:05 +0000
+++ checkbox/parsers/modinfo.py	2012-09-21 13:35:25 +0000
@@ -17,6 +17,7 @@
 # along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
 #
 
+
 class ModinfoParser:
     """
     Parser for modinfo information.
@@ -57,25 +58,25 @@
         for line in stream.splitlines():
             # At this point, stream should be the stdout from the modinfo
             # command, in a list.
-            key, data = line.split(':',1)
+            key, data = line.split(':', 1)
             data = data.strip()
-            # First, we need to handle alias, parm, firmware, and depends 
+            # First, we need to handle alias, parm, firmware, and depends
             # because there can be multiple lines of output for these.
-            if key in ('alias', 'depend', 'firmware', 'parm'):
+            if key in ('alias', 'depend', 'firmware', 'parm',):
                 self._modinfo[key].append(data)
             # Now handle unknown keys
             elif key not in self._modinfo.keys():
                 self._modinfo[key] = ("WARNING: Unknown Key %s providing "
-                                     "data: %s") % (key,data)
+                                     "data: %s") % (key, data)
             # And finally known keys
             else:
                 self._modinfo[key] = data
-        
+
     def get_all(self):
         return self._modinfo
 
     def get_field(self, field):
         if field not in self._modinfo.keys():
-            raise Excepion("Key not found: %s" % field)
+            raise Exception("Key not found: %s" % field)
         else:
             return self._modinfo[field]

=== added directory 'checkbox/parsers/tests/fixtures'
=== added file 'checkbox/parsers/tests/fixtures/xinput_quantal.txt'
--- checkbox/parsers/tests/fixtures/xinput_quantal.txt	1970-01-01 00:00:00 +0000
+++ checkbox/parsers/tests/fixtures/xinput_quantal.txt	2012-09-21 13:35:25 +0000
@@ -0,0 +1,143 @@
+⎡ Virtual core pointer id=2 [master pointer (3)]
+Reporting 4 classes:
+Class originated from: 10. Type: XIButtonClass
+Buttons supported: 10
+Button labels: "Button Unknown" "Button Unknown" "Button Unknown" 
+"Button Wheel Up" "Button Wheel Down" "Button Horiz Wheel Left" "Button 
+Horiz Wheel Right" None None None
+Button state:
+Class originated from: 10. Type: XIValuatorClass
+Detail for Valuator 0:
+Label: Abs MT Position X
+Range: 0.000000 - 1919.000000
+Resolution: 0 units/m
+Mode: absolute
+Current value: 1664.000000
+Class originated from: 10. Type: XIValuatorClass
+Detail for Valuator 1:
+Label: Abs MT Position Y
+Range: 0.000000 - 1079.000000
+Resolution: 0 units/m
+Mode: absolute
+Current value: 932.000000
+Class originated from: 0. Type: XITouchClass
+Touch mode: direct
+Max number of touches: 17
+
+⎜ ↳ Virtual core XTEST pointer id=4 [slave pointer (2)]
+Reporting 3 classes:
+Class originated from: 4. Type: XIButtonClass
+Buttons supported: 10
+Button labels: "Button Left" "Button Middle" "Button Right" "Button 
+Wheel Up" "Button Wheel Down" "Button Horiz Wheel Left" "Button Horiz 
+Wheel Right" None None None
+Button state:
+Class originated from: 4. Type: XIValuatorClass
+Detail for Valuator 0:
+Label: Rel X
+Range: -1.000000 - -1.000000
+Resolution: 0 units/m
+Mode: relative
+Class originated from: 4. Type: XIValuatorClass
+Detail for Valuator 1:
+Label: Rel Y
+Range: -1.000000 - -1.000000
+Resolution: 0 units/m
+Mode: relative
+
+⎜ ↳ Quanta OpticalTouchScreen id=10 [slave pointer (2)]
+Reporting 4 classes:
+Class originated from: 10. Type: XIButtonClass
+Buttons supported: 5
+Button labels: "Button Unknown" "Button Unknown" "Button Unknown" 
+"Button Wheel Up" "Button Wheel Down"
+Button state:
+Class originated from: 10. Type: XIValuatorClass
+Detail for Valuator 0:
+Label: Abs MT Position X
+Range: 0.000000 - 1919.000000
+Resolution: 0 units/m
+Mode: absolute
+Current value: 1664.000000
+Class originated from: 10. Type: XIValuatorClass
+Detail for Valuator 1:
+Label: Abs MT Position Y
+Range: 0.000000 - 1079.000000
+Resolution: 0 units/m
+Mode: absolute
+Current value: 932.000000
+Class originated from: 0. Type: XITouchClass
+Touch mode: direct
+Max number of touches: 9
+
+⎜ ↳ MCE IR Keyboard/Mouse (nuvoton-cir) id=12 [slave pointer (2)]
+Reporting 4 classes:
+Class originated from: 12. Type: XIButtonClass
+Buttons supported: 5
+Button labels: "Button Left" "Button Unknown" "Button Right" "Button 
+Wheel Up" "Button Wheel Down"
+Button state:
+Class originated from: 12. Type: XIKeyClass
+Keycodes supported: 248
+Class originated from: 12. Type: XIValuatorClass
+Detail for Valuator 0:
+Label: Rel X
+Range: -1.000000 - -1.000000
+Resolution: 1 units/m
+Mode: relative
+Class originated from: 12. Type: XIValuatorClass
+Detail for Valuator 1:
+Label: Rel Y
+Range: -1.000000 - -1.000000
+Resolution: 1 units/m
+Mode: relative
+
+⎣ Virtual core keyboard id=3 [master keyboard (2)]
+Reporting 1 classes:
+Class originated from: 14. Type: XIKeyClass
+Keycodes supported: 248
+
+↳ Virtual core XTEST keyboard id=5 [slave keyboard (3)]
+Reporting 1 classes:
+Class originated from: 5. Type: XIKeyClass
+Keycodes supported: 248
+
+↳ Power Button id=6 [slave keyboard (3)]
+Reporting 1 classes:
+Class originated from: 6. Type: XIKeyClass
+Keycodes supported: 248
+
+↳ Power Button id=7 [slave keyboard (3)]
+Reporting 1 classes:
+Class originated from: 7. Type: XIKeyClass
+Keycodes supported: 248
+
+↳ Laptop_Integrated_Webcam_2M id=8 [slave keyboard (3)]
+Reporting 1 classes:
+Class originated from: 8. Type: XIKeyClass
+Keycodes supported: 248
+
+↳ HID 413c:8161 id=9 [slave keyboard (3)]
+Reporting 1 classes:
+Class originated from: 9. Type: XIKeyClass
+Keycodes supported: 248
+
+↳ Nuvoton w836x7hg Infrared Remote Transceiver id=11 [slave keyboard (3)]
+Reporting 1 classes:
+Class originated from: 11. Type: XIKeyClass
+Keycodes supported: 248
+
+↳ Dell AIO WMI hotkeys id=13 [slave keyboard (3)]
+Reporting 1 classes:
+Class originated from: 13. Type: XIKeyClass
+Keycodes supported: 248
+
+↳ Chicony USB Keyboard id=14 [slave keyboard (3)]
+Reporting 1 classes:
+Class originated from: 14. Type: XIKeyClass
+Keycodes supported: 248
+
+↳ Chicony USB Keyboard id=15 [slave keyboard (3)]
+Reporting 1 classes:
+Class originated from: 15. Type: XIKeyClass
+Keycodes supported: 248

=== added file 'checkbox/parsers/tests/fixtures/xinput_toshiba.txt'
--- checkbox/parsers/tests/fixtures/xinput_toshiba.txt	1970-01-01 00:00:00 +0000
+++ checkbox/parsers/tests/fixtures/xinput_toshiba.txt	2012-09-21 13:35:25 +0000
@@ -0,0 +1,166 @@
+⎡ Virtual core pointer                    	id=2	[master pointer  (3)]
+	Reporting 8 classes:
+		Class originated from: 12. Type: XIButtonClass
+		Buttons supported: 12
+		Button labels: "Button Left" "Button Middle" "Button Right" "Button Wheel Up" "Button Wheel Down" "Button Horiz Wheel Left" "Button Horiz Wheel Right" None None None None None
+		Button state:
+		Class originated from: 12. Type: XIValuatorClass
+		Detail for Valuator 0:
+		  Label: Rel X
+		  Range: 0.000000 - 2000.000000
+		  Resolution: 0 units/m
+		  Mode: relative
+		Class originated from: 12. Type: XIValuatorClass
+		Detail for Valuator 1:
+		  Label: Rel Y
+		  Range: 0.000000 - 1400.000000
+		  Resolution: 0 units/m
+		  Mode: relative
+		Class originated from: 12. Type: XIValuatorClass
+		Detail for Valuator 2:
+		  Label: Rel Horiz Scroll
+		  Range: 0.000000 - -1.000000
+		  Resolution: 0 units/m
+		  Mode: relative
+		Class originated from: 12. Type: XIValuatorClass
+		Detail for Valuator 3:
+		  Label: Rel Vert Scroll
+		  Range: 0.000000 - -1.000000
+		  Resolution: 0 units/m
+		  Mode: relative
+		Class originated from: 12. Type: XIScrollClass
+		Scroll info for Valuator 2
+		  type: 2 (horizontal)
+		  increment: 48.000000
+		  flags: 0x0
+		Class originated from: 12. Type: XIScrollClass
+		Scroll info for Valuator 3
+		  type: 1 (vertical)
+		  increment: 48.000000
+		  flags: 0x0
+		Class originated from: 0. Type: XITouchClass
+		Touch mode: dependent
+		Max number of touches: 2
+
+⎜   ↳ Virtual core XTEST pointer              	id=4	[slave  pointer  (2)]
+	Reporting 3 classes:
+		Class originated from: 4. Type: XIButtonClass
+		Buttons supported: 10
+		Button labels: "Button Left" "Button Middle" "Button Right" "Button Wheel Up" "Button Wheel Down" "Button Horiz Wheel Left" "Button Horiz Wheel Right" None None None
+		Button state:
+		Class originated from: 4. Type: XIValuatorClass
+		Detail for Valuator 0:
+		  Label: Rel X
+		  Range: -1.000000 - -1.000000
+		  Resolution: 0 units/m
+		  Mode: relative
+		Class originated from: 4. Type: XIValuatorClass
+		Detail for Valuator 1:
+		  Label: Rel Y
+		  Range: -1.000000 - -1.000000
+		  Resolution: 0 units/m
+		  Mode: relative
+
+⎜   ↳ DualPoint Stick                         	id=11	[slave  pointer  (2)]
+	Reporting 3 classes:
+		Class originated from: 11. Type: XIButtonClass
+		Buttons supported: 7
+		Button labels: "Button Left" "Button Middle" "Button Right" "Button Wheel Up" "Button Wheel Down" "Button Horiz Wheel Left" "Button Horiz Wheel Right"
+		Button state:
+		Class originated from: 11. Type: XIValuatorClass
+		Detail for Valuator 0:
+		  Label: Rel X
+		  Range: -1.000000 - -1.000000
+		  Resolution: 1 units/m
+		  Mode: relative
+		Class originated from: 11. Type: XIValuatorClass
+		Detail for Valuator 1:
+		  Label: Rel Y
+		  Range: -1.000000 - -1.000000
+		  Resolution: 1 units/m
+		  Mode: relative
+
+⎜   ↳ AlpsPS/2 ALPS DualPoint TouchPad        	id=12	[slave  pointer  (2)]
+	Reporting 8 classes:
+		Class originated from: 12. Type: XIButtonClass
+		Buttons supported: 12
+		Button labels: "Button Left" "Button Middle" "Button Right" "Button Wheel Up" "Button Wheel Down" "Button Horiz Wheel Left" "Button Horiz Wheel Right" None None None None None
+		Button state:
+		Class originated from: 12. Type: XIValuatorClass
+		Detail for Valuator 0:
+		  Label: Rel X
+		  Range: 0.000000 - 2000.000000
+		  Resolution: 0 units/m
+		  Mode: relative
+		Class originated from: 12. Type: XIValuatorClass
+		Detail for Valuator 1:
+		  Label: Rel Y
+		  Range: 0.000000 - 1400.000000
+		  Resolution: 0 units/m
+		  Mode: relative
+		Class originated from: 12. Type: XIValuatorClass
+		Detail for Valuator 2:
+		  Label: Rel Horiz Scroll
+		  Range: 0.000000 - -1.000000
+		  Resolution: 0 units/m
+		  Mode: relative
+		Class originated from: 12. Type: XIValuatorClass
+		Detail for Valuator 3:
+		  Label: Rel Vert Scroll
+		  Range: 0.000000 - -1.000000
+		  Resolution: 0 units/m
+		  Mode: relative
+		Class originated from: 12. Type: XIScrollClass
+		Scroll info for Valuator 2
+		  type: 2 (horizontal)
+		  increment: 48.000000
+		  flags: 0x0
+		Class originated from: 12. Type: XIScrollClass
+		Scroll info for Valuator 3
+		  type: 1 (vertical)
+		  increment: 48.000000
+		  flags: 0x0
+		Class originated from: 0. Type: XITouchClass
+		Touch mode: dependent
+		Max number of touches: 2
+
+⎣ Virtual core keyboard                   	id=3	[master keyboard (2)]
+	Reporting 1 classes:
+		Class originated from: 10. Type: XIKeyClass
+		Keycodes supported: 248
+
+    ↳ Virtual core XTEST keyboard             	id=5	[slave  keyboard (3)]
+	Reporting 1 classes:
+		Class originated from: 5. Type: XIKeyClass
+		Keycodes supported: 248
+
+    ↳ Power Button                            	id=6	[slave  keyboard (3)]
+	Reporting 1 classes:
+		Class originated from: 6. Type: XIKeyClass
+		Keycodes supported: 248
+
+    ↳ Video Bus                               	id=7	[slave  keyboard (3)]
+	Reporting 1 classes:
+		Class originated from: 7. Type: XIKeyClass
+		Keycodes supported: 248
+
+    ↳ Power Button                            	id=8	[slave  keyboard (3)]
+	Reporting 1 classes:
+		Class originated from: 8. Type: XIKeyClass
+		Keycodes supported: 248
+
+    ↳ CNF9055                                 	id=9	[slave  keyboard (3)]
+	Reporting 1 classes:
+		Class originated from: 9. Type: XIKeyClass
+		Keycodes supported: 248
+
+    ↳ AT Translated Set 2 keyboard            	id=10	[slave  keyboard (3)]
+	Reporting 1 classes:
+		Class originated from: 10. Type: XIKeyClass
+		Keycodes supported: 248
+
+    ↳ Toshiba input device                    	id=13	[slave  keyboard (3)]
+	Reporting 1 classes:
+		Class originated from: 13. Type: XIKeyClass
+		Keycodes supported: 248
+

=== added file 'checkbox/parsers/tests/xinput.py'
--- checkbox/parsers/tests/xinput.py	1970-01-01 00:00:00 +0000
+++ checkbox/parsers/tests/xinput.py	2012-09-21 13:35:25 +0000
@@ -0,0 +1,135 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Checkbox.
+#
+# Copyright 2012 Canonical Ltd.
+#
+# Checkbox 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, either version 3 of the License, or
+# (at your option) any later version.
+#
+# 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 os
+
+from unittest import TestCase
+
+from checkbox.parsers.xinput import (
+    DEVICE_RE,
+    ATTRIBUTE_RE,
+    CLASS_VALUE_RE,
+    LIST_VALUE_RE,
+    IXinputResult,
+    XinputParser,
+    )
+
+
+class TestDeviceRe(TestCase):
+
+    def test_string(self):
+        match = DEVICE_RE.match(
+            """⎡ Virtual core pointer                      """
+            """id=2    [master pointer  (3)]""")
+        self.assertTrue(match)
+        self.assertEquals(match.group("name"), "Virtual core pointer")
+        self.assertEquals(match.group("id"), "2")
+
+
+class TestAttributeRe(TestCase):
+
+    def test_string(self):
+        match = ATTRIBUTE_RE.match("""Buttons supported: 12""")
+        self.assertTrue(match)
+        self.assertEquals(match.group("key"), "Buttons supported")
+        self.assertEquals(match.group("value"), "12")
+
+
+class TestClassValueRe(TestCase):
+
+    def test_string(self):
+        match = CLASS_VALUE_RE.match("""12. Type: XIButtonClass""")
+        self.assertTrue(match)
+        self.assertEquals(match.group("class"), "XIButtonClass")
+
+
+class TestListValueRe(TestCase):
+
+    def test_string(self):
+        elements = LIST_VALUE_RE.split(
+            """"Button Horiz Wheel Right" None None""")[1::2]
+        self.assertTrue(elements)
+        self.assertEquals(len(elements), 3)
+        self.assertEquals(elements[0], '"Button Horiz Wheel Right"')
+        self.assertEquals(elements[1], "None")
+        self.assertEquals(elements[2], "None")
+
+
+class XinputResult(IXinputResult):
+
+    def __init__(self):
+        self.devices = {}
+
+    def addXinputDevice(self, device):
+        self.devices[device["id"]] = device
+
+    def addXinputDeviceClass(self, device, device_class):
+        self.devices[device["id"]].setdefault("classes", [])
+        self.devices[device["id"]]["classes"].append(device_class)
+
+
+class TestXinputParser(TestCase):
+
+    def getFixture(self, name):
+        return os.path.join(os.path.dirname(__file__), "fixtures", name)
+
+    def getParser(self, name):
+        fixture = self.getFixture(name)
+        stream = open(fixture)
+        return XinputParser(stream)
+
+    def getResult(self, name):
+        parser = self.getParser(name)
+        result = XinputResult()
+        parser.run(result)
+        return result
+
+    def test_number_of_devices_with_spaces(self):
+        """The toshiba xinput with spaces contains 12 devices."""
+        result = self.getResult("xinput_toshiba.txt")
+        self.assertEquals(len(result.devices), 12)
+
+    def test_number_of_devices_without_spaces(self):
+        """The quantal xinput without spaces contains 14 devices."""
+        result = self.getResult("xinput_quantal.txt")
+        self.assertEquals(len(result.devices), 14)
+
+    def test_multitouch_touchpad_device(self):
+        """The toshiba xinput contains a multitouch touchpad device."""
+        result = self.getResult("xinput_toshiba.txt")
+        devices = [device for device in result.devices.values()
+            if device["name"] == "AlpsPS/2 ALPS DualPoint TouchPad"]
+        self.assertEquals(len(devices), 1)
+
+        classes = [cls for cls in devices[0]["classes"]
+            if cls["class"] == "XITouchClass"]
+        self.assertEquals(len(classes), 1)
+        self.assertEquals(classes[0]["touch_mode"], "dependent")
+
+    def test_multitouch_touchscreen_device(self):
+        """The quantal xinput contains a multitouch touchscreen device."""
+        result = self.getResult("xinput_quantal.txt")
+        devices = [device for device in result.devices.values()
+            if device["name"] == "Quanta OpticalTouchScreen"]
+        self.assertEquals(len(devices), 1)
+
+        classes = [cls for cls in devices[0]["classes"]
+            if cls["class"] == "XITouchClass"]
+        self.assertEquals(len(classes), 1)
+        self.assertEquals(classes[0]["touch_mode"], "direct")

=== added file 'checkbox/parsers/xinput.py'
--- checkbox/parsers/xinput.py	1970-01-01 00:00:00 +0000
+++ checkbox/parsers/xinput.py	2012-09-21 13:35:25 +0000
@@ -0,0 +1,198 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Checkbox.
+#
+# Copyright 2012 Canonical Ltd.
+#
+# Checkbox 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, either version 3 of the License, or
+# (at your option) any later version.
+#
+# 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 re
+
+from string import (
+    ascii_letters,
+    ascii_uppercase,
+    )
+
+
+# Device string to match:
+#   ⎡ Virtual core pointer                      id=2    [master pointer  (3)]
+DEVICE_RE = re.compile(
+    r""".+?(?P<name>[%s].+?) *\sid=(?P<id>\d+)"""
+    % ascii_uppercase)
+
+# Attribute string to match:
+#   Buttons supported: 12
+ATTRIBUTE_RE = re.compile(
+    r"""(?P<key>[%s].+?): (?P<value>.+)"""
+    % ascii_letters)
+
+# Class string to match:
+#   12. Type: XIButtonClass
+CLASS_VALUE_RE = re.compile(
+    r"""\d+\. Type: (?P<class>.+)""")
+
+# List string to split:
+#   "Button Horiz Wheel Right" None None
+LIST_VALUE_RE = re.compile(
+    r"""((?:[^ "]|"[^"]*")+)""")
+
+
+class IXinputResult:
+    """
+    Base class for a result passed to the XinputParser run method.
+    """
+
+    def addXinputDevice(self, device):
+        """Method to add an xinput device to this result."""
+
+    def addXinputDeviceClass(self, device, device_class):
+        """Method to add a class under an xinput device."""
+
+
+class XinputParser:
+    """
+    Parser for the xinput command.
+    """
+
+    _key_map = {
+        "Buttons supported": "buttons_supported",
+        "Button labels": "button_labels",
+        "Button state": "button_state",
+        "Class originated from": "class",
+        "Keycodes supported": "keycodes_supported",
+        "Touch mode": "touch_mode",
+        "Max number of touches": "max_touch",
+        }
+
+    def __init__(self, stream):
+        """
+        Construct a parser with the given stream.
+
+        The stream is expected to contain the output of the command:
+        xinput --list --long
+        """
+        self.stream = stream
+
+    def _parseKey(self, key):
+        """
+        Parse the given key into a sanitized string.
+
+        Returns a string in lower case without any spaces, or None if
+        the key is not recognized.
+        """
+        if " " in key:
+            return self._key_map.get(key)
+        else:
+            return key.lower()
+
+    def _parseValue(self, value):
+        """
+        Parse the given value into a sanitized object.
+
+        Returns a string with leading and trailing spaces stripped,
+        or a list of the value contains double quotes, or None if the
+        value is empty.
+        """
+        if value is not None:
+            value = value.strip()
+            if not value:
+                return None
+
+            match = CLASS_VALUE_RE.match(value)
+            if match:
+                return match.group("class")
+
+            if '"' in value:
+                return list(self._parseList(value))
+
+        return value
+
+    def _parseList(self, string):
+        """
+        Parse the given string into a list.
+
+        The string can contain double quoted elements that are stripped
+        of the quotes, or the string "None" that is replaced by None,
+        or just space separated strings.
+        """
+        for element in LIST_VALUE_RE.split(string)[1::2]:
+            if element.startswith('"') and element.endswith('"'):
+                yield element.strip('"')
+            elif element == "None":
+                yield None
+
+    def run(self, result):
+        """
+        Run the parser on the stream and add to the given result.
+
+        The result is a derived instance of the IXinputResult base class
+        to which results are added incrementally as the stream is parsed.
+        """
+        output = self.stream.read()
+        for record in re.split(r"\n{2,}", output):
+            record = record.strip()
+
+            # Skip empty records
+            if not record:
+                continue
+
+            lines = record.split("\n")
+
+            # Parse device
+            line = lines.pop(0)
+            match = DEVICE_RE.match(line)
+            if not match:
+                continue
+
+            device = {
+                "id": int(match.group("id")),
+                "name": match.group("name"),
+                }
+            result.addXinputDevice(device)
+
+            # Parse device classes
+            device_class = {}
+            prefix = ""
+
+            for line in lines:
+                line = line.strip()
+
+                # Skip lines with an unsupported attribute
+                match = ATTRIBUTE_RE.match(line)
+                if not match:
+                    if line.startswith("Scroll"):
+                        prefix = "scroll_"
+                    elif line.startswith("Detail"):
+                        prefix = "detail_"
+                    continue
+
+                # Skip lines with an unsupported key
+                key = self._parseKey(match.group("key"))
+                if not key:
+                    continue
+
+                value = self._parseValue(match.group("value"))
+
+                # Special case for the class
+                if key == "class" and device_class:
+                    result.addXinputDeviceClass(device, device_class)
+                    device_class = {}
+                    prefix = ""
+
+                device_class[prefix + key] = value
+
+            if device_class:
+                result.addXinputDeviceClass(device, device_class)
+
+        return result

=== modified file 'debian/changelog'
--- debian/changelog	2012-09-21 02:16:21 +0000
+++ debian/changelog	2012-09-21 13:35:25 +0000
@@ -63,6 +63,8 @@
   [Marc Tardif]
   * scripts/touchpad_scroll_resource: Added support for systems without
     a touchpad (LP #1045066)
+  * [FEATURE] scripts/xinput_resource, checkbox/parsers/xinput.py: Xinput
+    resource script to test multitouch devices.
   * patch/0.14.2: Fixed patch to rmtree instead of rmdir scripts directory.
   * [FEATURE] debian/checkbox.templates, debian/checkbox.config: Added support to
     preseed properties in environment_info plugin.

=== added file 'scripts/xinput_resource'
--- scripts/xinput_resource	1970-01-01 00:00:00 +0000
+++ scripts/xinput_resource	2012-09-21 13:35:25 +0000
@@ -0,0 +1,74 @@
+#!/usr/bin/python3
+#
+# This file is part of Checkbox.
+#
+# Copyright 2012 Canonical Ltd.
+#
+# Checkbox 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, either version 3 of the License, or
+# (at your option) any later version.
+#
+# 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 os
+import sys
+
+from argparse import ArgumentParser
+
+from checkbox.lib.template import Template
+from checkbox.parsers.xinput import (
+    IXinputResult,
+    XinputParser,
+    )
+
+
+# Command to retrieve xinput information.
+COMMAND = "xinput --list --long"
+
+
+class XinputResult(IXinputResult):
+
+    def __init__(self):
+        self.elements = []
+
+    def addXinputDevice(self, device):
+        device["type"] = "device"
+        self.elements.append(device)
+
+    def addXinputDeviceClass(self, device, device_class):
+        device_class["type"] = "class"
+        device_class.update(device)
+        self.elements.append(device_class)
+
+
+def main():
+    parser = ArgumentParser()
+    parser.add_argument("filename", nargs='?',
+                        help="Optional filename containing xinput data")
+    args = parser.parse_args()
+
+    if args.filename:
+        stream = open(args.filename)
+    else:
+        stream = os.popen(COMMAND)
+
+    xinput = XinputParser(stream)
+
+    result = XinputResult()
+    xinput.run(result)
+
+    template = Template()
+    template.dump_file(result.elements, sys.stdout)
+
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())