Merge ~sylvain-pineau/plainbox-provider-resource:udev_resource_filter_option into plainbox-provider-resource:master

[Sylvain Pineau]

When reviewing the plainbox-provider-snappy sru branch, I've found that we're still using the run/filter-template scripts and having to duplicate those legacy tools should be avoided.

Since they are only used to perform various filter operations, this MR proposes to port the feature to the udev_resource script itself.

A patch for the checkbox provider will follow.

[1] https://code.launchpad.net/~jocave/plainbox-provider-snappy/+git/plainbox-provider-snappy/+ref/sru-plans-and-jobs

[Sylvain Pineau (sylvain-pineau)]

self-approved

review: Approve

diff --git a/bin/udev_resource b/bin/udev_resource
index c389fee..3521530 100755
--- a/bin/udev_resource
+++ b/bin/udev_resource
@@ -19,6 +19,7 @@
 #
 import argparse
 import shlex
+import sys
 
 from collections import OrderedDict
 from subprocess import check_output, CalledProcessError
@@ -26,22 +27,21 @@ from subprocess import check_output, CalledProcessError
 from checkbox_support.parsers.udevadm import UdevadmParser
 
 categories = ("ACCELEROMETER", "AUDIO", "BLUETOOTH", "CAPTURE", "CARDREADER",
-              "DISK", "KEYBOARD", "MOUSE", "NETWORK", "OTHER", "TOUCHPAD",
-              "TOUCHSCREEN", "USB", "VIDEO", "WIRELESS")
+              "CDROM", "DISK", "KEYBOARD", "MOUSE", "NETWORK", "OTHER",
+              "TOUCHPAD", "TOUCHSCREEN", "USB", "VIDEO", "WIRELESS", "WWAN")
 
+attributes = ("path", "name", "bus", "category", "driver", "product_id",
+              "vendor_id", "subproduct_id", "subvendor_id", "product",
+              "vendor", "interface", "mac", "product_slug", "vendor_slug")
 
-class UdevResultDump:
 
-    attributes = ("path", "name", "bus", "category", "driver", "product_id",
-                  "vendor_id", "subproduct_id", "subvendor_id", "product",
-                  "vendor", "interface", "mac", "product_slug", "vendor_slug")
+class UdevResultDump:
 
     def addDevice(self, device):
-        for attribute in self.attributes:
+        for attribute in attributes:
             value = getattr(device, attribute)
             if value is not None:
                 print("%s: %s" % (attribute, value))
-
         print()
 
 
@@ -50,19 +50,33 @@ class UdevResultLister:
     def __init__(self, categories):
         self.categories = categories
         self._data = OrderedDict()
+        self._devices = []
         for c in categories:
             self._data[c] = []
 
     def display(self):
+        if not self._devices:
+            return 1
         for c, devices in self._data.items():
             print("{} ({}):".format(c, len(devices)))
             for d in devices:
                 print(" - {}".format(d))
             print()
 
+    def filter(self):
+        if not self._devices:
+            return 1
+        for device in self._devices:
+            for attribute in attributes:
+                value = getattr(device, attribute)
+                if value is not None:
+                    print("%s: %s" % (attribute, value))
+            print()
+
     def addDevice(self, device):
         c = getattr(device, "category", None)
         if c in self.categories:
+            self._devices.append(device)
             p = getattr(device, "product", "Unknow product")
             v = getattr(device, "vendor", "Unknow vendor")
             self._data[c].append("{} {}".format(v, p))
@@ -78,12 +92,18 @@ def main():
                         default="lsblk -i -n -P -o KNAME,TYPE,MOUNTPOINT",
                         help="""Command to execute to get lsblk information.
                               Only change it if you know what you're doing.""")
-    parser.add_argument('-l','--list', nargs='+', choices=categories,
+    parser.add_argument('-l', '--list', nargs='+', choices=categories,
                         metavar=("CATEGORY"),
                         help="""List devices found under the requested
                         categories.
                         Acceptable categories to list are: 
                         {}""".format(', '.join(categories)))
+    parser.add_argument('-f', '--filter', nargs='+', choices=categories,
+                        metavar=("CATEGORY"),
+                        help="""Filter devices found under the requested
+                        categories.
+                        Acceptable categories to list are: 
+                        {}""".format(', '.join(categories)))
     args = parser.parse_args()
     try:
         output = check_output(shlex.split(args.command))
@@ -98,11 +118,15 @@ def main():
     if args.list:
         result = UdevResultLister(args.list)
         udev.run(result)
-        result.display()
+        return result.display()
+    if args.filter:
+        result = UdevResultLister(args.filter)
+        udev.run(result)
+        return result.filter()
     else:
         result = UdevResultDump()
         udev.run(result)
 
 
 if __name__ == "__main__":
-    main()
+    sys.exit(main())