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

[Marc Tardif]

Merged fix to touchpad scroll tests and replacement of touchpad_scroll_resource script by cr3.

This merge request fixes a problem noticed by spideyman where the scroll tests prompt the user on an all-in-one system. While fixing this problem, I took the opportunity to replace the touchpad_scroll_resource script to reuse the more general xinput_resource script.

[Jeff Marcom (jeffmarcom)]

Okay, so a few problems here.

1.) This works pretty well in an all-in-one config now, however my tested this on my laptop (which is capable of vertical scrolling) and the test was skipped.

2.) Please add this requires line to the automated multitouch touchpad test: dmi.product in ['Notebook','Laptop','Portable']

review: Needs Fixing

[lp:~cr3/checkbox/touchpad_scroll_resource_deprecate]

1786. By Marc Tardif on 2012-10-19

Fixed strings in touchpad/vertical requires line.

1787. By Marc Tardif on 2012-10-19

Added requires line to touchpad/multitouch-automated.

[Marc Tardif (cr3)]

For 1, you're absolutely right, fixed!

For 2, I left that out on purpose because it would automatically report fail if there was no touchpad. However, it would probably make more sense for that test to report unsupported. Also fixed.

review: Needs Resubmitting

[Jeff Marcom (jeffmarcom)]

> For 1, you're absolutely right, fixed!
>
> For 2, I left that out on purpose because it would automatically report fail
> if there was no touchpad. However, it would probably make more sense for that
> test to report unsupported. Also fixed.

Thanks, and for 2 I agree. I would rather see it say unsupported for both single and multi. It shouldn't fail if it doesn't meet the criteria for one or the other. I realize my initial request did not recover this, and I was just looking for their to be a check before initiating the test at all.

Let me know and we can have a follow up discussion on this. I'd rather have this decided before a commit.

Thanks

review: Needs Information

[Jeff Marcom (jeffmarcom)]

In case it wasn't clear from the above statement, it's still marking single-touch automated as "fail" on my laptop.

[Marc Tardif (cr3)]

What makes you say that your touchpad is not multitouch on your laptop?

[lp:~cr3/checkbox/touchpad_scroll_resource_deprecate]

1788. By Marc Tardif on 2012-10-22

Renamed class to device_class in xinput parser so that it doesn't conflict with the Python name.

1789. By Marc Tardif on 2012-10-22

Improved touchpad/singletouch-automated, touchpad/multitouch-automated, touchscreen/nontouch-automated and touchscreen/multitouch-automated so that they return unsupported instead of fail when the device is not singletouch for example.

[Marc Tardif (cr3)]

Done, the touchpad/singletouch should now return as unsupported on your laptop. When testing again, please make sure to branch in a new directory instead of pulling the latest changes. That way, you make sure there's no cache and no store from your previous run. Thanks!

review: Needs Resubmitting

[Jeff Marcom (jeffmarcom)]

Awesome, thanks for your patience!

review: Approve

=== modified file 'checkbox/parsers/tests/test_xinput.py'
--- checkbox/parsers/tests/test_xinput.py	2012-10-09 13:32:06 +0000
+++ checkbox/parsers/tests/test_xinput.py	2012-10-22 19:47:20 +0000
@@ -118,7 +118,7 @@
         self.assertEquals(len(devices), 1)
 
         classes = [cls for cls in devices[0]["classes"]
-            if cls["class"] == "XITouchClass"]
+            if cls["device_class"] == "XITouchClass"]
         self.assertEquals(len(classes), 1)
         self.assertEquals(classes[0]["touch_mode"], "dependent")
 
@@ -130,6 +130,6 @@
         self.assertEquals(len(devices), 1)
 
         classes = [cls for cls in devices[0]["classes"]
-            if cls["class"] == "XITouchClass"]
+            if cls["device_class"] == "XITouchClass"]
         self.assertEquals(len(classes), 1)
         self.assertEquals(classes[0]["touch_mode"], "direct")
 
=== modified file 'checkbox/parsers/xinput.py'
--- checkbox/parsers/xinput.py	2012-09-14 19:52:57 +0000
+++ checkbox/parsers/xinput.py	2012-10-22 19:47:20 +0000
@@ -69,7 +69,7 @@
         "Buttons supported": "buttons_supported",
         "Button labels": "button_labels",
         "Button state": "button_state",
-        "Class originated from": "class",
+        "Class originated from": "device_class",
         "Keycodes supported": "keycodes_supported",
         "Touch mode": "touch_mode",
         "Max number of touches": "max_touch",
@@ -185,7 +185,7 @@
                 value = self._parseValue(match.group("value"))
 
                 # Special case for the class
-                if key == "class" and device_class:
+                if key == "device_class" and device_class:
                     result.addXinputDeviceClass(device, device_class)
                     device_class = {}
                     prefix = ""
 
=== modified file 'data/whitelists/default.whitelist'
--- data/whitelists/default.whitelist	2012-10-15 20:03:32 +0000
+++ data/whitelists/default.whitelist	2012-10-22 19:47:20 +0000
@@ -14,9 +14,9 @@
 optical_drive
 package
 sleep
-touchpad_scroll
 uname
 usb
+xinput
 __info__
 codecs_attachment
 cpuinfo_attachment
 
=== modified file 'debian/changelog'
--- debian/changelog	2012-10-22 14:38:54 +0000
+++ debian/changelog	2012-10-22 19:47:20 +0000
@@ -36,6 +36,8 @@
   * debian/control: Added python3-gi to run checkbox-qt.
   * jobs/input.txt.in, jobs/touchpad.txt.in: Added input/pointing tests
     and simplified horizontal/vertical scrolling tests.
+  * scripts/touchpad_scroll_resource, scripts/xinput_resource: Replaced
+    the touchpad_scroll_resource by reusing the xinput_resource script.
 
   [Sean Feole]
   * [FEATURE] jobs/optical.txt.in: modified existing automation test
 
=== modified file 'jobs/resource.txt.in'
--- jobs/resource.txt.in	2012-10-16 20:45:22 +0000
+++ jobs/resource.txt.in	2012-10-22 19:47:20 +0000
@@ -12,7 +12,7 @@
 name: dpkg
 plugin: resource
 command: dpkg_resource
-description:Gets info on the version of dpkg installed
+description: Gets info on the version of dpkg installed
 
 name: gconf
 plugin: resource
@@ -88,10 +88,10 @@
      lsusb |grep -q "Linux Foundation ${version}.0 root hub" && echo "supported" || echo "unsupported"
  done
 
-name: touchpad_scroll
+name: xinput
 plugin: resource
-command: touchpad_scroll_resource
-description: gives information on a touchpad's scroll support
+command: xinput_resource
+description: Creates resource info from xinput output.
 
 name: environment
 plugin: resource
 
=== modified file 'jobs/touchpad.txt.in'
--- jobs/touchpad.txt.in	2012-10-16 15:57:00 +0000
+++ jobs/touchpad.txt.in	2012-10-22 19:47:20 +0000
@@ -1,5 +1,6 @@
 plugin: manual
 name: touchpad/basic
+requires: dmi.product in ['Notebook','Laptop','Portable']
 _description:
  PURPOSE:
      Touchpad verification
@@ -11,7 +12,9 @@
 
 plugin: manual
 name: touchpad/horizontal
-requires: touchpad_scroll.horizontal_scroll == 'supported'
+requires:
+  xinput.touch_mode == 'dependent'
+  'Button Horiz Wheel Left' in xinput.button_labels and 'Button Horiz Wheel Right' in xinput.button_labels
 command: touchpad_test right left
 _description:
  PURPOSE:
@@ -24,7 +27,9 @@
 
 plugin: manual
 name: touchpad/vertical
-requires: touchpad_scroll.vertical_scroll == 'supported'
+requires:
+  xinput.touch_mode == 'dependent'
+  'Button Wheel Up' in xinput.button_labels and 'Button Wheel Down' in xinput.button_labels
 command: touchpad_test up down
 _description:
  PURPOSE:
@@ -37,13 +42,19 @@
 
 plugin: shell
 name: touchpad/singletouch-automated
-command: !(xinput_resource | filter_templates -w 'class=XITouchClass' | grep -q 'touch_mode: dependent')
+requires:
+  dmi.product in ['Notebook','Laptop','Portable']
+  xinput.device_class == 'XITouchClass' and xinput.touch_mode != 'dependent'
+command: true
 _description:
  Determine whether the touchpad is detected as a singletouch device automatically.
 
 plugin: shell
 name: touchpad/multitouch-automated
-command: xinput_resource | filter_templates -w 'class=XITouchClass' | grep -q 'touch_mode: dependent'
+requires:
+  dmi.product in ['Notebook','Laptop','Portable']
+  xinput.device_class == 'XITouchClass' and xinput.touch_mode == 'dependent'
+command: true
 _description:
  Determine whether the touchpad is detected as a multitouch device automatically.
 
 
=== modified file 'jobs/touchscreen.txt.in'
--- jobs/touchscreen.txt.in	2012-09-28 21:57:21 +0000
+++ jobs/touchscreen.txt.in	2012-10-22 19:47:20 +0000
@@ -32,13 +32,17 @@
 
 plugin: shell
 name: touchscreen/nontouch-automated
-command: !(xinput_resource | filter_templates -w 'class=XITouchClass' | grep -q 'touch_mode: direct')
+requires:
+  xinput.device_class == 'XITouchClass' and xinput.touch_mode != 'direct'
+command: true
 _description:
  Determine whether the screen is detected as a non-touch device automatically.
 
 plugin: shell
 name: touchscreen/multitouch-automated
-command: xinput_resource | filter_templates -w 'class=XITouchClass' | grep -q 'touch_mode: direct'
+requires:
+  xinput.device_class == 'XITouchClass' and xinput.touch_mode == 'direct'
+command: true
 _description:
  Determine whether the screen is detected as a multitouch device automatically.
 
 
=== removed file 'scripts/touchpad_scroll_resource'
--- scripts/touchpad_scroll_resource	2012-09-04 09:15:17 +0000
+++ scripts/touchpad_scroll_resource	1970-01-01 00:00:00 +0000
@@ -1,71 +0,0 @@
-#!/usr/bin/env python3
-
-import re
-from io import StringIO
-from subprocess import Popen, PIPE
-from checkbox.parsers.udevadm import UdevadmParser
-
-# Command to retrieve udev information.
-COMMAND = 'udevadm info --export-db'
-
-
-class TouchResult:
-
-    attributes = {}
-
-    def addDevice(self, device):
-        if getattr(device, 'category') == 'TOUCH':
-            self.attributes['product'] = getattr(device, 'product')
-
-
-def get_touch_attributes():
-    output, err = Popen(COMMAND, stdout=PIPE, shell=True).communicate()
-    if err:
-        return None
-
-    udev = UdevadmParser(StringIO(output.decode("unicode-escape")))
-
-    result = TouchResult()
-    udev.run(result)
-
-    return result.attributes.get('product')
-
-
-def can_scroll(touchpad):
-    COMMAND = "xinput list '%s'" % touchpad
-    horizontal_supported = ""
-    vertical_supported = ""
-    bl = re.compile("Button labels")
-    vert_up = re.compile(".*Button Wheel Up.*")
-    vert_down = re.compile(".*Button Wheel Down.*")
-    horiz_left = re.compile(".*Button Horiz Wheel Left.*")
-    horiz_right = re.compile(".*Button Horiz Wheel Right.*")
-    proc = Popen(COMMAND, stdout=PIPE, shell=True, universal_newlines=True)
-    output = proc.stdout.read()
-    if bl.findall(output):
-        if vert_up.search(output) and vert_down.search(output):
-            vertical_supported = "supported"
-        else:
-            vertical_supported = "unsupported"
-        if horiz_left.search(output) and horiz_right.search(output):
-            horizontal_supported = "supported"
-        else:
-            horizontal_supported = "unsupported"
-    else:
-        return "unuspported", "unsupported"
-    return horizontal_supported, vertical_supported
-
-
-def main():
-    product = get_touch_attributes()
-    if product:
-        print("device_name: %s" % product)
-        horiz,vert = can_scroll(product)
-        print("horizontal_scroll: %s" % horiz)
-        print("vertical_scroll: %s" % vert)
-    else:
-        print("device_name: None")
-
-
-if __name__ == "__main__":
-    main()