Merge lp:~sylvain-pineau/checkbox/fix-1561821 into lp:checkbox

[Sylvain Pineau]

Fixes the linked bug, but without modifying the udev parser to add an extra input-id field.

[Pierre Equoy (pieq)]

It's very smart!

When I was testing it and checking how it worked, I realized there are other jobs where we need to remove the {path} parameter in the description or else it will fail the same way:

  - suspend/pointing-after-suspend_{product_slug}_{category}_{__index__}
  - suspend/clicking-after-suspend_{product_slug}_{category}_{__index__}

Other than that, it looks great. Thanks!

review: Needs Fixing

[lp:~sylvain-pineau/checkbox/fix-1561821]

4290. By Sylvain Pineau on 2016-03-30

providers:checkbox: Remove {path} requirement in input jobs

As those may change if the same device is unplugged/re-plugged
(even on the same port).

[Sylvain Pineau (sylvain-pineau)]

I've fixed the suspend jobs

review: Needs Resubmitting

[Pierre Equoy (pieq)]

+1

Thanks!

review: Approve

=== modified file 'plainbox/plainbox/impl/unit/template.py'
--- plainbox/plainbox/impl/unit/template.py	2016-03-03 16:04:58 +0000
+++ plainbox/plainbox/impl/unit/template.py	2016-03-30 08:11:28 +0000
@@ -32,6 +32,7 @@
 from plainbox.impl.secure.origin import Origin
 from plainbox.impl.symbol import SymbolDef
 from plainbox.impl.unit import all_units
+from plainbox.impl.unit import get_accessed_parameters
 from plainbox.impl.unit._legacy import TemplateUnitLegacyAPI
 from plainbox.impl.unit._legacy import TemplateUnitValidatorLegacyAPI
 from plainbox.impl.unit.unit import Unit
@@ -366,6 +367,16 @@
         # XXX: extract raw dictionary from the resource object, there is no
         # normal API for that due to the way resource objects work.
         parameters = dict(object.__getattribute__(resource, '_data'))
+        accessed_parameters = set(itertools.chain(*{
+            get_accessed_parameters(value) for value in data.values()}))
+        # Recreate the parameters with only the subset that will actually be
+        # used by the template. Doing this filter can prevent exceptions like
+        # DependencyDuplicateError where an unused resource property can differ
+        # when resuming and bootstrapping sessions, causing job checksums
+        # mismatches.
+        # See https://bugs.launchpad.net/bugs/1561821
+        parameters = {
+            k: v for k, v in parameters.items() if k in accessed_parameters}
         # Add the special __index__ to the resource namespace variables
         parameters['__index__'] = index
         # Instantiate the class using the instantiation API

=== modified file 'providers/plainbox-provider-checkbox/jobs/input.txt.in'
--- providers/plainbox-provider-checkbox/jobs/input.txt.in	2016-03-02 14:01:49 +0000
+++ providers/plainbox-provider-checkbox/jobs/input.txt.in	2016-03-30 08:11:28 +0000
@@ -5,7 +5,6 @@
 category_id: 2013.com.canonical.plainbox::input
 id: input/pointing_{product_slug}_{category}_{__index__}
 estimated_duration: 30.0
-requires: device.path == '{path}'
 _summary: Check pointing functionality for {product}
 _purpose:
     This will test your {product} device
@@ -78,7 +77,6 @@
 category_id: 2013.com.canonical.plainbox::input
 id: input/clicking_{product_slug}_{category}_{__index__}
 estimated_duration: 30.0
-requires: device.path == '{path}'
 _summary: Check button functionality for {product}
 _purpose:
     This will test the buttons of your {product} device

=== modified file 'providers/plainbox-provider-checkbox/jobs/suspend.txt.in'
--- providers/plainbox-provider-checkbox/jobs/suspend.txt.in	2016-03-11 14:36:34 +0000
+++ providers/plainbox-provider-checkbox/jobs/suspend.txt.in	2016-03-30 08:11:28 +0000
@@ -2673,7 +2673,6 @@
 category_id: 2013.com.canonical.plainbox::suspend
 id: suspend/pointing-after-suspend_{product_slug}_{category}_{__index__}
 depends: suspend/suspend_advanced
-requires: device.path == "{path}"
 _description:
  PURPOSE:
      This will test your {product} device after suspend.
@@ -2690,7 +2689,6 @@
 estimated_duration: 30.0
 id: suspend/clicking-after-suspend_{product_slug}_{category}_{__index__}
 depends: suspend/suspend_advanced
-requires: device.path == "{path}"
 _summary: Check post suspend button functionality for {product}
 _description:
  PURPOSE: