Merge ~sylvain-pineau/checkbox-ng:no_resource_no_templates into checkbox-ng:master

[Sylvain Pineau]

Fix the crash observed while running the sru test plan on pi2 where the graphics_card resource job returns nothing. Templates were still checked as checkbox then creates an empty record (to avoid another kind of crash ; IIRC "package.name == foo" checks on UC).

The proposed fix is to simply bypass instantiate all when such fake record is the only resource object known for this resource job.

Bonus a commit to handle KeyboardInterrrupt with the Run command.

[Jonathan Cave (jocave)]

On the other MR that triggered this you say:

> The proposed solution fixes the crash and removes all those warnings about missing parameters.

So does this actually only remove the warnings when the fake record is the only resource object? i.e. there are still warnings if there is a real resource object but the key the job is using is missing? I think we want to keep those warnings as it helps debug job creation.

review: Needs Information

[Sylvain Pineau (sylvain-pineau)]

Tested by adding a typo (s/name/foo)in the following job def:

unit: template
template-resource: fwts
plugin: shell
category_id: com.canonical.plainbox::firmware
id: firmware/fwts_{name}
estimated_duration: 1.2
requires: executable.name == 'fwts'
user: root
command: checkbox-support-fwts_test -t {foo} -l $PLAINBOX_SESSION_SHARE/fwts_{name}.log
_description: Run {name} test from Firmware Test Suite.
_summary: Run {name} test from Firmware Test Suite.

Checkbox still complains and issues the following warnings:

$ checkbox-cli run com.canonical.certification::client-cert-18-04
Ignoring firmware/fwts_{name} with missing template parameter foo
Ignoring firmware/fwts_{name} with missing template parameter foo
Ignoring firmware/fwts_{name} with missing template parameter foo
Ignoring firmware/fwts_{name} with missing template parameter foo
Ignoring firmware/fwts_{name} with missing template parameter foo
Ignoring firmware/fwts_{name} with missing template parameter foo
Ignoring firmware/fwts_{name} with missing template parameter foo
Ignoring firmware/fwts_{name} with missing template parameter foo
Ignoring firmware/fwts_{name} with missing template parameter foo
Ignoring firmware/fwts_{name} with missing template parameter foo
Ignoring firmware/fwts_{name} with missing template parameter foo
Ignoring firmware/fwts_{name} with missing template parameter foo
Ignoring firmware/fwts_{name} with missing template parameter foo
Ignoring firmware/fwts_{name} with missing template parameter foo
Ignoring firmware/fwts_{name} with missing template parameter foo
Ignoring firmware/fwts_{name} with missing template parameter foo
Ignoring firmware/fwts_{name} with missing template parameter foo
Ignoring firmware/fwts_{name} with missing template parameter foo
Ignoring firmware/fwts_{name} with missing template parameter foo
=========================[ Running Selected Test Plan ]=========================
-------------[ Running job 1 / 347. Estimated time left: unknown ]--------------
---------------[ Collect the hardware manifest (interactively) ]----------------
ID: com.canonical.plainbox::collect-manifest
Category: com.canonical.plainbox::uncategorised

[Sylvain Pineau (sylvain-pineau)]

Landing this one to avoid failing SRU tests

review: Approve

[Jonathan Cave (jocave)]

Thanks for the extra info, the warnings are still present when required by the looks of it.

review: Approve

diff --git a/checkbox_ng/launcher/subcommands.py b/checkbox_ng/launcher/subcommands.py
index 8dd3873..87e4698 100644
--- a/checkbox_ng/launcher/subcommands.py
+++ b/checkbox_ng/launcher/subcommands.py
@@ -756,40 +756,43 @@ class Run(Command, MainLoopStage):
                 self.ctx.args.non_interactive)
 
     def invoked(self, ctx):
-        self._C = Colorizer()
-        self.ctx = ctx
-        ctx.sa = SessionAssistant(
-            "com.canonical:checkbox-cli",
-            self.get_cmd_version(),
-            "0.99",
-            ["restartable"],
-        )
-        self._configure_restart()
-        try_selecting_providers(self.sa, '*')
-        self.sa.start_new_session('checkbox-run')
-        tps = self.sa.get_test_plans()
-        self._configure_report()
-        selection = ctx.args.PATTERN
-        if len(selection) == 1 and selection[0] in tps:
-            self.ctx.sa.update_app_blob(json.dumps(
-                {'testplan_id': selection[0]}).encode("UTF-8"))
-            self.just_run_test_plan(selection[0])
-        else:
-            self.ctx.sa.update_app_blob(json.dumps(
-                {}).encode("UTF-8"))
-            self.sa.hand_pick_jobs(selection)
-            print(self.C.header(_("Running Selected Jobs")))
-            self._run_jobs(self.sa.get_dynamic_todo_list())
-            # there might have been new jobs instantiated
-            while True:
-                self.sa.hand_pick_jobs(ctx.args.PATTERN)
-                todos = self.sa.get_dynamic_todo_list()
-                if not todos:
-                    break
+        try:
+            self._C = Colorizer()
+            self.ctx = ctx
+            ctx.sa = SessionAssistant(
+                "com.canonical:checkbox-cli",
+                self.get_cmd_version(),
+                "0.99",
+                ["restartable"],
+            )
+            self._configure_restart()
+            try_selecting_providers(self.sa, '*')
+            self.sa.start_new_session('checkbox-run')
+            tps = self.sa.get_test_plans()
+            self._configure_report()
+            selection = ctx.args.PATTERN
+            if len(selection) == 1 and selection[0] in tps:
+                self.ctx.sa.update_app_blob(json.dumps(
+                    {'testplan_id': selection[0]}).encode("UTF-8"))
+                self.just_run_test_plan(selection[0])
+            else:
+                self.ctx.sa.update_app_blob(json.dumps(
+                    {}).encode("UTF-8"))
+                self.sa.hand_pick_jobs(selection)
+                print(self.C.header(_("Running Selected Jobs")))
                 self._run_jobs(self.sa.get_dynamic_todo_list())
-        self.sa.finalize_session()
-        self._print_results()
-        return 0 if self.sa.get_summary()['fail'] == 0 else 1
+                # there might have been new jobs instantiated
+                while True:
+                    self.sa.hand_pick_jobs(ctx.args.PATTERN)
+                    todos = self.sa.get_dynamic_todo_list()
+                    if not todos:
+                        break
+                    self._run_jobs(self.sa.get_dynamic_todo_list())
+            self.sa.finalize_session()
+            self._print_results()
+            return 0 if self.sa.get_summary()['fail'] == 0 else 1
+        except KeyboardInterrupt:
+            return 1
 
     def just_run_test_plan(self, tp_id):
         self.sa.select_test_plan(tp_id)
diff --git a/plainbox/impl/ctrl.py b/plainbox/impl/ctrl.py
index 471dd5f..4aefe11 100644
--- a/plainbox/impl/ctrl.py
+++ b/plainbox/impl/ctrl.py
@@ -270,8 +270,9 @@ class CheckBoxSessionStateController(ISessionStateController):
         or replace resource records.
         """
         self._parse_and_store_resource(session_state, job, result)
-        self._instantiate_templates(
-            session_state, job, result, fake_resources)
+        if session_state.resource_map[job.id] != [Resource({})]:
+            self._instantiate_templates(
+                session_state, job, result, fake_resources)
 
     def _parse_and_store_resource(self, session_state, job, result):
         # NOTE: https://bugs.launchpad.net/checkbox/+bug/1297928