Merge lp:~sylvain-pineau/checkbox/mute_job_ouput_flag into lp:checkbox

[Sylvain Pineau]

A new job flag to mute commands a bit too verbose or potentially containing false alarms.

[Sylvain Pineau (sylvain-pineau)]

When landed, I'll propose to add it to all ipdt tests ;)

[Pierre Equoy (pieq)]

+1

I tested it by creating this job:

    plugin: shell
    id: smoke/list-dir
    command: ls /
    _description: List root directory

I ran it using both plainbox (plainbox run -i .*list-dir) and checkbox-cli and it produced the following output:

-------------------------------[ smoke/list-dir ]-------------------------------
ID: 2013.com.canonical.certification::smoke/list-dir
Category: 2013.com.canonical.plainbox::uncategorised
... 8< -------------------------------------------------------------------------
bin
boot
cdrom
dev
etc
home
initrd.img
initrd.img.old
lib
lib64
lost+found
media
mnt
opt
proc
root
run
sbin
snap
srv
sys
tmp
usr
var
vmlinuz
vmlinuz.old
------------------------------------------------------------------------- >8 ---
Outcome: job passed
 ☑ : smoke/list-dir

I then added the `suppress-output` flag in the job definition:

    plugin: shell
    id: smoke/list-dir
    flags: suppress-output
    command: ls /
    _description: List root directory

and rerun the test and got the following output:

-------------------------------[ smoke/list-dir ]-------------------------------
ID: 2013.com.canonical.certification::smoke/list-dir
Category: 2013.com.canonical.plainbox::uncategorised
(Command output hidden)
Outcome: job passed
 ☑ : smoke/list-dir

Looks good to me!

review: Approve

=== modified file 'checkbox-ng/launchers/checkbox-cli'
--- checkbox-ng/launchers/checkbox-cli	2016-09-21 03:35:24 +0000
+++ checkbox-ng/launchers/checkbox-cli	2016-09-22 18:56:29 +0000
@@ -437,8 +437,9 @@
                 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'):
+        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)

=== modified file 'plainbox/plainbox/impl/commands/inv_run.py'
--- plainbox/plainbox/impl/commands/inv_run.py	2016-02-05 10:48:12 +0000
+++ plainbox/plainbox/impl/commands/inv_run.py	2016-09-22 18:56:29 +0000
@@ -756,8 +756,9 @@
         self.run_single_job_with_ui(job, self.get_ui_for_job(job))
 
     def get_ui_for_job(self, job):
-        if self.ns.dont_suppress_output is False and job.plugin in (
-                'local', 'resource', 'attachment'):
+        if self.ns.dont_suppress_output is False and (job.plugin in (
+                'local', 'resource', 'attachment') or
+                'suppress-output' in job.get_flag_set()):
             return NormalUI(self.C.c, show_cmd_output=False)
         else:
             return NormalUI(self.C.c, show_cmd_output=True)

=== modified file 'plainbox/plainbox/impl/unit/job.py'
--- plainbox/plainbox/impl/unit/job.py	2016-08-30 08:09:18 +0000
+++ plainbox/plainbox/impl/unit/job.py	2016-09-22 18:56:29 +0000
@@ -988,6 +988,15 @@
                         'preserve-cwd makes no sense without a command'
                     ),
                     onlyif=lambda unit: unit.command is None),
+                # The suppress-output flag is useless without a command
+                CorrectFieldValueValidator(
+                    lambda value, unit: (
+                        'suppress-output' not in unit.get_flag_set()),
+                    Problem.useless, Severity.advice,
+                    message=_(
+                        'suppress-output makes no sense without a command'
+                    ),
+                    onlyif=lambda unit: unit.command is None),
             ],
             fields.qml_file: [
                 UntranslatableFieldValidator,