Merge lp:~roadmr/checkbox/1172835-xml-exporter-comments-2 into lp:checkbox

[Daniel Manrique]

xml: Set OPTION_WITH_COMMENTS so they get exported. Actually set the comment when a job has OUTCOME_NOT_SUPPORTED.

xml: Set OPTION_WITH_COMMENTS so they get exported

I also stole a couple of commits from Zygmunt to actually set the comment when a job has OUTCOME_NOT_SUPPORTED.

[lp:~roadmr/checkbox/1172835-xml-exporter-comments-2]

2092. By Zygmunt Krynicki on 2013-04-26

applogic: add run_job_if_possible

This function serves as a reusable coupling point for session, runner
config and job objects. Keeping it in the applogic module will simplify
maintaining consistent behavior of various plainbox and checkbox tools

Signed-off-by: Zygmunt Krynicki <email address hidden>

2093. By Zygmunt Krynicki on 2013-04-26

commands: sru: use run_job_if_possible, drop local equivalent

This patch drops the local implementation of run_job_if_possible and
reuses the common function from the applogic module

Signed-off-by: Zygmunt Krynicki <email address hidden>

2094. By Daniel Manrique on 2013-04-26

exporters: xml: Set OPTION_WITH_COMMENTS so they get exported

[Zygmunt Krynicki (zyga)]

Thanks, and sorry for all the shake up, +1

review: Approve

=== modified file 'plainbox/plainbox/impl/applogic.py'
--- plainbox/plainbox/impl/applogic.py	2013-04-18 10:17:25 +0000
+++ plainbox/plainbox/impl/applogic.py	2013-04-26 21:18:27 +0000
@@ -31,6 +31,7 @@
 import re
 
 from plainbox.impl import config
+from plainbox.impl.result import JobResult
 
 
 class IJobQualifier(metaclass=ABCMeta):
@@ -106,6 +107,38 @@
     return [job for job in job_list if qualifier.designates(job)]
 
 
+def run_job_if_possible(session, runner, config, job):
+    """
+    Coupling point for session, runner, config and job
+
+    :returns: (job_state, job_result)
+    """
+    job_state = session.job_state_map[job.name]
+    if job_state.can_start():
+        job_result = runner.run_job(job, config)
+    else:
+        # Set the outcome of jobs that cannot start to
+        # OUTCOME_NOT_SUPPORTED _except_ if any of the inhibitors point to
+        # a job with an OUTCOME_SKIP outcome, if that is the case mirror
+        # that outcome. This makes 'skip' stronger than 'not-supported'
+        outcome = JobResult.OUTCOME_NOT_SUPPORTED
+        for inhibitor in job_state.readiness_inhibitor_list:
+            if inhibitor.cause != inhibitor.FAILED_DEP:
+                continue
+            related_job_state = session.job_state_map[
+                inhibitor.related_job.name]
+            if related_job_state.result.outcome == JobResult.OUTCOME_SKIP:
+                outcome = JobResult.OUTCOME_SKIP
+        job_result = JobResult({
+            'job': job,
+            'outcome': outcome,
+            'comments': job_state.get_readiness_description()
+        })
+    assert job_result is not None
+    session.update_job_result(job, job_result)
+    return job_state, job_result
+
+
 class PlainBoxConfig(config.Config):
     """
     Configuration for PlainBox itself

=== modified file 'plainbox/plainbox/impl/commands/sru.py'
--- plainbox/plainbox/impl/commands/sru.py	2013-04-26 15:29:16 +0000
+++ plainbox/plainbox/impl/commands/sru.py	2013-04-26 21:18:27 +0000
@@ -33,18 +33,18 @@
 from requests.exceptions import ConnectionError, InvalidSchema, HTTPError
 
 from plainbox.impl.applogic import get_matching_job_list
+from plainbox.impl.applogic import run_job_if_possible
 from plainbox.impl.checkbox import CheckBox, WhiteList
 from plainbox.impl.commands import PlainBoxCommand
+from plainbox.impl.commands.check_config import CheckConfigInvocation
 from plainbox.impl.config import ValidationError, Unset
 from plainbox.impl.depmgr import DependencyDuplicateError
 from plainbox.impl.exporter import ByteStringStreamTranslator
 from plainbox.impl.exporter.xml import XMLSessionStateExporter
-from plainbox.impl.result import JobResult
 from plainbox.impl.runner import JobRunner
 from plainbox.impl.session import SessionState
 from plainbox.impl.transport.certification import CertificationTransport
 from plainbox.impl.transport.certification import InvalidSecureIDError
-from plainbox.impl.commands.check_config import CheckConfigInvocation
 
 
 logger = logging.getLogger("plainbox.commands.sru")
@@ -178,28 +178,8 @@
 
     def _run_single_job(self, job):
         print("- {}:".format(job.name), end=' ')
-        job_state = self.session.job_state_map[job.name]
-        if job_state.can_start():
-            job_result = self.runner.run_job(job, self.config)
-        else:
-            # Set the outcome of jobs that cannot start to
-            # OUTCOME_NOT_SUPPORTED _except_ if any of the inhibitors point to
-            # a job with an OUTCOME_SKIP outcome, if that is the case mirror
-            # that outcome. This makes 'skip' stronger than 'not-supported'
-            outcome = JobResult.OUTCOME_NOT_SUPPORTED
-            for inhibitor in job_state.readiness_inhibitor_list:
-                if inhibitor.cause != inhibitor.FAILED_DEP:
-                    continue
-                related_job_state = self.session.job_state_map[
-                    inhibitor.related_job.name]
-                if related_job_state.result.outcome == JobResult.OUTCOME_SKIP:
-                    outcome = JobResult.OUTCOME_SKIP
-            job_result = JobResult({
-                'job': job,
-                'outcome': outcome,
-                'comments': job_state.get_readiness_description()
-            })
-        assert job_result is not None
+        job_state, job_result = run_job_if_possible(
+            self.session, self.runner, self.config, job)
         print("{0}".format(job_result.outcome))
         if job_result.comments is not None:
             print("comments: {0}".format(job_result.comments))

=== modified file 'plainbox/plainbox/impl/exporter/xml.py'
--- plainbox/plainbox/impl/exporter/xml.py	2013-04-09 20:24:11 +0000
+++ plainbox/plainbox/impl/exporter/xml.py	2013-04-26 21:18:27 +0000
@@ -149,6 +149,7 @@
             SessionStateExporterBase.OPTION_FLATTEN_IO_LOG,
             SessionStateExporterBase.OPTION_WITH_JOB_DEFS,
             SessionStateExporterBase.OPTION_WITH_RESOURCE_MAP,
+            SessionStateExporterBase.OPTION_WITH_COMMENTS,
             SessionStateExporterBase.OPTION_WITH_ATTACHMENTS)
         # Generate a dummy system hash if needed
         if system_id is None: