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

[Sylvain Pineau]

MR for plainbox

checkbox submissions usually include the reason why a job is not supported/initiated.
This merge proposal allows plainbox to export the same information in the job results comments.

[Zygmunt Krynicki (zyga)]

I was initially opposed using comments for that but given the limitations of the server side evolution I think this is a good idea, thanks.

+1

review: Approve

[Zygmunt Krynicki (zyga)]

The attempt to merge lp:~sylvain-pineau/checkbox/export_comments into lp:checkbox failed. Below is the output from the failed tests.

[precise] Importing base box 'precise-cloud-i386'...
[precise]
[precise] Progress: 90%[precise]
[precise] No guest additions were detected on the base box for this VM! Guest
additions are required for forwarded ports, shared folders, host only
networking, and more. If SSH fails on this machine, please install
the guest additions and repackage the box to continue.

This is not an error message; everything may continue to work properly,
in which case you may ignore this message.
[precise] Matching MAC address for NAT networking...
[precise] Clearing any previously set forwarded ports...
[precise] Forwarding ports...
[precise] -- 22 => 2222 (adapter 1)
[precise] Creating shared folders metadata...
[precise] Clearing any previously set network interfaces...
[precise] Booting VM...
[precise] Waiting for VM to boot. This can take a few minutes.
[precise] VM booted and ready for use!
[precise] Mounting shared folders...
[precise] -- v-root: /vagrant
[precise] Running provisioner: Vagrant::Provisioners::Shell...
stdin: is not a tty
Ign http://security.ubuntu.com precise-security InRelease
Ign http://archive.ubuntu.com precise InRelease
Ign http://archive.ubuntu.com precise-updates InRelease
Get:1 http://security.ubuntu.com precise-security Release.gpg [198 B]
Get:2 http://security.ubuntu.com precise-security Release [49.6 kB]
Hit http://archive.ubuntu.com precise Release.gpg
Get:3 http://archive.ubuntu.com precise-updates Release.gpg [198 B]
Hit http://archive.ubuntu.com precise Release
Get:4 http://archive.ubuntu.com precise-updates Release [49.6 kB]
Get:5 http://security.ubuntu.com precise-security/main i386 Packages [239 kB]
Hit http://archive.ubuntu.com precise/main i386 Packages
Hit http://archive.ubuntu.com precise/restricted i386 Packages
Hit http://archive.ubuntu.com precise/universe i386 Packages
Hit http://archive.ubuntu.com precise/multiverse i386 Packages
Hit http://archive.ubuntu.com precise/main TranslationIndex
Hit http://archive.ubuntu.com precise/multiverse TranslationIndex
Hit http://archive.ubuntu.com precise/restricted TranslationIndex
Get:6 http://security.ubuntu.com precise-security/restricted i386 Packages [3968 B]
Hit http://archive.ubuntu.com precise/universe TranslationIndex
Get:7 http://security.ubuntu.com precise-security/universe i386 Packages [69.9 kB]
Get:8 http://archive.ubuntu.com precise-updates/main i386 Packages [594 kB]
Get:9 http://security.ubuntu.com precise-security/multiverse i386 Packages [2362 B]
Get:10 http://security.ubuntu.com precise-security/main TranslationIndex [74 B]
Get:11 http://security.ubuntu.com precise-security/multiverse TranslationIndex [71 B]
Get:12 http://archive.ubuntu.com precise-updates/restricted i386 Packages [9503 B]
Get:13 http://security.ubuntu.com precise-security/restricted TranslationIndex [71 B]
Get:14 http://security.ubuntu.com precise-security/universe TranslationIndex [73 B]
Get:15 http://security.ubuntu.com precise-security/main Translation-en [112 kB]
Get:16 http://archive.ubuntu.com precise-updates/universe i386 Packages [184 kB]
G...

[Zygmunt Krynicki (zyga)]

The attempt to merge lp:~sylvain-pineau/checkbox/export_comments into lp:checkbox failed. Below is the output from the failed tests.

[precise] Bringing VM 'up'
[precise] Starting tests...
[precise] CheckBox test suite: pass
[precise] PlainBox test suite: fail
[precise] stdout: http://paste.ubuntu.com/5586418/
[precise] stderr: http://paste.ubuntu.com/5586419/
[precise] Integration tests: fail
[precise] stdout:
[precise] stderr: http://paste.ubuntu.com/5586420/
[precise] Suspending VM
[quantal] Bringing VM 'up'
[quantal] Starting tests...
[quantal] CheckBox test suite: pass
[quantal] PlainBox test suite: pass
[quantal] Integration tests: pass
[quantal] Suspending VM

You are trying to send an empty document, exiting.

[Zygmunt Krynicki (zyga)]

The attempt to merge lp:~sylvain-pineau/checkbox/export_comments into lp:checkbox failed. Below is the output from the failed tests.

[precise] Bringing VM 'up'
[precise] Starting tests...
[precise] CheckBox test suite: pass
[precise] PlainBox test suite: fail
[precise] stdout: http://paste.ubuntu.com/5586624/
[precise] stderr: http://paste.ubuntu.com/5586625/
[precise] Integration tests: fail
[precise] stdout:
[precise] stderr: http://paste.ubuntu.com/5586626/
[precise] Suspending VM
[quantal] Bringing VM 'up'
[quantal] Starting tests...
[quantal] CheckBox test suite: pass
[quantal] PlainBox test suite: pass
[quantal] Integration tests: pass
[quantal] Suspending VM

You are trying to send an empty document, exiting.

[Zygmunt Krynicki (zyga)]

The attempt to merge lp:~sylvain-pineau/checkbox/export_comments into lp:checkbox failed. Below is the output from the failed tests.

[precise] Bringing VM 'up'
[precise] Starting tests...
[precise] CheckBox test suite: pass
[precise] Running 'plainbox/setup.py egg_info' failed
[precise] stdout: http://paste.ubuntu.com/5593668/
[precise] stderr: http://paste.ubuntu.com/5593670/
[precise] NOTE: unable to execute tests, marked as failed
[precise] PlainBox test suite: fail
[precise] stdout: http://paste.ubuntu.com/5593671/
[precise] stderr: http://paste.ubuntu.com/5593672/
[precise] Integration tests: fail
[precise] stdout:
[precise] stderr: http://paste.ubuntu.com/5593673/
[precise] Suspending VM
[quantal] Bringing VM 'up'
[quantal] Starting tests...
[quantal] CheckBox test suite: pass
[quantal] PlainBox test suite: pass
[quantal] Integration tests: pass
[quantal] Suspending VM

You are trying to send an empty document, exiting.

[Zygmunt Krynicki (zyga)]

The attempt to merge lp:~sylvain-pineau/checkbox/export_comments into lp:checkbox failed. Below is the output from the failed tests.

[precise] Bringing VM 'up'
[precise] Starting tests...
[precise] CheckBox test suite: pass
[precise] Running 'plainbox/setup.py egg_info' failed
[precise] stdout: http://paste.ubuntu.com/5594383/
[precise] stderr: http://paste.ubuntu.com/5594384/
[precise] NOTE: unable to execute tests, marked as failed
[precise] PlainBox test suite: fail
[precise] stdout: http://paste.ubuntu.com/5594385/
[precise] stderr: http://paste.ubuntu.com/5594386/
[precise] Integration tests: fail
[precise] stdout:
[precise] stderr: http://paste.ubuntu.com/5594387/
[precise] Suspending VM
[quantal] Bringing VM 'up'
[quantal] Starting tests...
[quantal] CheckBox test suite: pass
[quantal] PlainBox test suite: pass
[quantal] Integration tests: pass
[quantal] Suspending VM

You are trying to send an empty document, exiting.

[Zygmunt Krynicki (zyga)]

The attempt to merge lp:~sylvain-pineau/checkbox/export_comments into lp:checkbox failed. Below is the output from the failed tests.

[precise] Bringing VM 'up'
[precise] Unable to 'up' VM!
[precise] stdout: http://paste.ubuntu.com/5595849/
[precise] stderr: http://paste.ubuntu.com/5595850/
[precise] NOTE: unable to execute tests, marked as failed
[quantal] Bringing VM 'up'
[quantal] Unable to 'up' VM!
[quantal] stdout: http://paste.ubuntu.com/5595851/
[quantal] stderr: http://paste.ubuntu.com/5595852/
[quantal] NOTE: unable to execute tests, marked as failed

=== modified file 'plainbox/plainbox/impl/box.py'
--- plainbox/plainbox/impl/box.py	2013-02-26 13:53:45 +0000
+++ plainbox/plainbox/impl/box.py	2013-03-03 16:45:25 +0000
@@ -415,7 +415,8 @@
         else:
             job_result = JobResult({
                 'job': job,
-                'outcome': JobResult.OUTCOME_NOT_SUPPORTED
+                'outcome': JobResult.OUTCOME_NOT_SUPPORTED,
+                'comments': job_state.get_readiness_description()
             })
         if job_result is None and not ns.dry_run:
             logger.warning("Job %s did not return a result", job)

=== modified file 'plainbox/plainbox/impl/exporter/__init__.py'
--- plainbox/plainbox/impl/exporter/__init__.py	2013-02-25 11:02:59 +0000
+++ plainbox/plainbox/impl/exporter/__init__.py	2013-03-03 16:45:25 +0000
@@ -73,6 +73,7 @@
     OPTION_WITH_RESOURCE_MAP = 'with-resource-map'
     OPTION_WITH_JOB_DEFS = 'with-job-defs'
     OPTION_WITH_ATTACHMENTS = 'with-attachments'
+    OPTION_WITH_COMMENTS = 'with-comments'
 
     SUPPORTED_OPTION_LIST = (
         OPTION_WITH_IO_LOG,
@@ -83,6 +84,7 @@
         OPTION_WITH_RESOURCE_MAP,
         OPTION_WITH_JOB_DEFS,
         OPTION_WITH_ATTACHMENTS,
+        OPTION_WITH_COMMENTS,
     )
 
     def __init__(self, option_list=None):
@@ -139,6 +141,9 @@
                 continue
             data['result_map'][job_name] = OrderedDict()
             data['result_map'][job_name]['outcome'] = job_state.result.outcome
+            if self.OPTION_WITH_COMMENTS in self._option_list:
+                data['result_map'][job_name]['comments'] = \
+                    job_state.result.comments
 
             # Add Job definitions if requested
             if self.OPTION_WITH_JOB_DEFS in self._option_list:

=== modified file 'plainbox/plainbox/impl/exporter/test_init.py'
--- plainbox/plainbox/impl/exporter/test_init.py	2013-02-21 11:17:48 +0000
+++ plainbox/plainbox/impl/exporter/test_init.py	2013-03-03 16:45:25 +0000
@@ -124,6 +124,7 @@
             'job': job_b,
             'outcome': 'pass',
             'return_code': 0,
+            'comments': 'foo',
             'io_log': make_io_log(
                 (IOLogRecord(0, 'stdout', b'ready: yes\n'),),
                 session_dir)
@@ -160,13 +161,15 @@
                     'plugin': 'shell',
                     'command': 'echo testing && true',
                     'io_log': ['dGVzdGluZwo='],
-                    'requires': 'job_b.ready == "yes"'
+                    'requires': 'job_b.ready == "yes"',
+                    'comments': None,
                 },
                 'job_b': {
                     'outcome': 'pass',
                     'plugin': 'resource',
                     'command': 'echo ready: yes',
                     'io_log': ['cmVhZHk6IHllcwo='],
+                    'comments': 'foo',
                 }
             },
             'attachment_map': {

=== modified file 'plainbox/plainbox/impl/test_box.py'
--- plainbox/plainbox/impl/test_box.py	2013-02-26 14:55:20 +0000
+++ plainbox/plainbox/impl/test_box.py	2013-03-03 16:45:25 +0000
@@ -338,9 +338,9 @@
             self.assertEqual(call.exception.args, (0,))
         expected = """
         Each format may support a different set of options
-        json: with-io-log, squash-io-log, flatten-io-log, with-run-list, with-job-list, with-resource-map, with-job-defs, with-attachments, machine-json
-        rfc822: with-io-log, squash-io-log, flatten-io-log, with-run-list, with-job-list, with-resource-map, with-job-defs, with-attachments
-        text: with-io-log, squash-io-log, flatten-io-log, with-run-list, with-job-list, with-resource-map, with-job-defs, with-attachments
+        json: with-io-log, squash-io-log, flatten-io-log, with-run-list, with-job-list, with-resource-map, with-job-defs, with-attachments, with-comments, machine-json
+        rfc822: with-io-log, squash-io-log, flatten-io-log, with-run-list, with-job-list, with-resource-map, with-job-defs, with-attachments, with-comments
+        text: with-io-log, squash-io-log, flatten-io-log, with-run-list, with-job-list, with-resource-map, with-job-defs, with-attachments, with-comments
         """
         self.assertEqual(io.combined, cleandoc(expected) + "\n")