Merge ~jocave/checkbox-ng:save-rejected-jobs-list into checkbox-ng:master

[Jonathan Cave]

This proposes that the list of jobs rejected by the user is stored as a property of the session meta data and is included in the submission json directly. This seems like the simplest approach and makes it easy for the information to parsed by c3 and displayed directly in the private site submission pages.

Another option may have been to include the job list as some type of standalone attachment (a text file for example) that is include in the tarball. This would be easier for human to read if their preferred method of checking a submission is to download the tarball and look at the contents.

Tested that the json entries are correct when run with remote and local invocations.

[Sheila Miguez (codersquid)]

lgtm

review: Approve

[Sheila Miguez (codersquid)]

In the future, will there be more metadata in the list of rejected jobs? I was wondering why it is a dict of one element and not a list of job ids.

[Jonathan Cave (jocave)]

It felt like it might be wise in case there was a request to include other details like which provider the job is in or the _summary.

[Jeff Lane  (bladernr)]

I just realized I'm directly tagged on this... LGTM too.

review: Approve

[Sylvain Pineau (sylvain-pineau)]

+1 for the list of dict, could be useful in the future.

review: Approve

diff --git a/plainbox/impl/providers/exporters/data/checkbox.json b/plainbox/impl/providers/exporters/data/checkbox.json
index d97d1d5..3fd0b6e 100644
--- a/plainbox/impl/providers/exporters/data/checkbox.json
+++ b/plainbox/impl/providers/exporters/data/checkbox.json
@@ -103,6 +103,13 @@
         }{%- if not loop.last -%},{%- endif %}
     {%- endfor %}
     ],
+    "rejected-jobs": [
+    {%- for job_id in state.metadata.rejected_jobs %}
+        {
+            "full_id": "{{ job_id }}"
+        }{%- if not loop.last -%},{%- endif %}
+    {%- endfor %}
+    ],
     "category_map": {
         {%- for cat_id, cat_name in category_map|dictsort %}
         "{{ cat_id }}": "{{ cat_name }}"{%- if not loop.last -%},{%- endif %}
diff --git a/plainbox/impl/session/assistant.py b/plainbox/impl/session/assistant.py
index 50abbeb..4888730 100644
--- a/plainbox/impl/session/assistant.py
+++ b/plainbox/impl/session/assistant.py
@@ -970,9 +970,14 @@ class SessionAssistant:
         """
         UsageExpectation.of(self).enforce()
         self._metadata.custom_joblist = True
-        desired_job_list = [
-            self._context.get_unit(job_id, 'job') for job_id in
-            self.get_static_todo_list() if job_id in selection]
+        desired_job_list = []
+        rejected_job_list = []
+        for job_id in self.get_static_todo_list():
+            if job_id in selection:
+                desired_job_list.append(self._context.get_unit(job_id, 'job'))
+            else:
+                rejected_job_list.append(job_id)
+        self._metadata.rejected_jobs = rejected_job_list
         self._context.state.update_desired_job_list(desired_job_list)
 
     @raises(UnexpectedMethodCall)
diff --git a/plainbox/impl/session/state.py b/plainbox/impl/session/state.py
index e33c290..9f623e7 100644
--- a/plainbox/impl/session/state.py
+++ b/plainbox/impl/session/state.py
@@ -85,6 +85,7 @@ class SessionMetaData:
         self._app_blob = app_blob
         self._app_id = app_id
         self._custom_joblist = custom_joblist
+        self._rejected_jobs = []
 
     def __repr__(self):
         """Get the representation of the session state meta-data."""
@@ -199,6 +200,14 @@ class SessionMetaData:
     def custom_joblist(self, value):
         self._custom_joblist = value
 
+    @property
+    def rejected_jobs(self):
+        return self._rejected_jobs
+
+    @rejected_jobs.setter
+    def rejected_jobs(self, value):
+        self._rejected_jobs = value
+
 
 class SessionDeviceContext: