Merge lp:~kissiel/checkbox/output-variable-in-launchers into lp:checkbox

[Maciej Kisielewski]

This MR adds 'output' setting to [ui] section for launchers.

    That setting specifies which jobs should have their command output printed on the screen. There are 3 options:
    * hide -> (Command output hidden) will be printed for all jobs
    * hide-resource-and-attachment -> will hide output from those two plugin types (as well from (deprecated) local jobs)
    * show (the default setting) -> will print output of all commands

    Note that job that have 'suppress_output' flag will have their output always hidden.

[Sylvain Pineau (sylvain-pineau)]

Just tested all combinations, they work as expected. Thanks

review: Approve

=== modified file 'checkbox-ng/docs/launcher-tutorial.rst'
--- checkbox-ng/docs/launcher-tutorial.rst	2016-09-08 07:18:23 +0000
+++ checkbox-ng/docs/launcher-tutorial.rst	2016-10-05 20:01:33 +0000
@@ -209,9 +209,31 @@
 
 ``dont_suppress_output``
 
+.. note::
+
+    This field is deprecated, use 'output' to specify which jobs should have
+    their output printed to the screen.
+
 Setting this field to ``yes`` disables hiding of command output for jobs of
 type ``local``, ``resource`` and ``attachment``. Default value: ``no``.
 
+``output``
+
+This setting lets you hide output of commands run by checkbox. It can be set to
+one of the following values:
+
+- ``show`` - output of all jobs will be printed
+- ``hide`` - commands' output will be hidden
+- ``hide-resource-and-attachment`` - output of resource and attachment jobs
+  will be hidden, output of other job types will be printed
+
+Default value: ``show``
+
+.. note::
+
+    Individual jobs can have their output hidden by specifying
+    'suppress-output' in their definition.
+
 Restart section
 ===============
 
@@ -421,6 +443,7 @@
 
     [ui]
     type = silent
+    output = hide
 
     [transport:certification]
     type = certification

=== modified file 'checkbox-ng/launchers/checkbox-cli'
--- checkbox-ng/launchers/checkbox-cli	2016-09-30 08:02:23 +0000
+++ checkbox-ng/launchers/checkbox-cli	2016-10-05 20:01:33 +0000
@@ -437,12 +437,15 @@
                 estimated_time -= job.estimated_duration
 
     def _get_ui_for_job(self, job):
-        if not self.launcher.dont_suppress_output and (job.plugin in (
-                'local', 'resource', 'attachment') or
-                'suppress-output' in job.get_flag_set()):
-            return CheckboxUI(self.C.c, show_cmd_output=False)
-        else:
-            return CheckboxUI(self.C.c, show_cmd_output=True)
+        show_out = True
+        if self.launcher.output == 'hide-resource-and-attachment':
+            if job.plugin in ('local', 'resource', 'attachment'):
+                show_out = False
+        elif self.launcher.output == 'hide':
+            show_out = False
+        if 'suppress-output' in job.get_flag_set():
+            show_out = False
+        return CheckboxUI(self.C.c, show_cmd_output=show_out)
 
     def _run_single_job_with_ui_loop(self, job, ui):
         print(self.C.header(job.tr_summary(), fill='-'))

=== modified file 'plainbox/plainbox/impl/launcher.py'
--- plainbox/plainbox/impl/launcher.py	2016-08-03 18:27:47 +0000
+++ plainbox/plainbox/impl/launcher.py	2016-10-05 20:01:33 +0000
@@ -248,6 +248,13 @@
             ['interactive', 'silent', 'converged', 'converged-silent'])],
         help_text=_('Type of stock user interface to use.'))
 
+    output = config.Variable(
+        section='ui',
+        default='show',
+        validator_list=[config.ChoiceValidator(
+            ['show', 'hide', 'hide-resource-and-attachment'])],
+        help_text=_('Silence or restrict command output'))
+
     dont_suppress_output = config.Variable(
         section="ui", kind=bool, default=False,
         help_text=_("Don't suppress the output of certain job plugin types."))