Merge lp:~sylvain-pineau/checkbox/fix-1618197 into lp:checkbox

[Sylvain Pineau]

Fixes the linked bug where on snappy all docker commands fail to run with this error:

unable to change to original directory. errmsg: No such file or directory

It might be a bug or a limitation of the docker executable but since it works from the command line but not from a plainbox job command, it's better to fix it first on our side.

I created a new job flag to avoid running those command from a temp dir (tested on snappy device with the docker snap it works).

[Maciej Kisielewski (kissiel)]

Code looks good.

I'm still digesting the idea, tho.
Does this mean that those docker jobs will require checkbox to be run in a particular directory (outside the nest)?

review: Approve

[Sylvain Pineau (sylvain-pineau)]

Let's land it. I'll issue another post release of plainbox to pypi to use the new flag in the docker snap provider.

review: Approve

=== modified file 'plainbox/docs/manpages/plainbox-job-units.rst'
--- plainbox/docs/manpages/plainbox-job-units.rst	2015-11-04 14:35:46 +0000
+++ plainbox/docs/manpages/plainbox-job-units.rst	2016-08-30 08:23:40 +0000
@@ -301,6 +301,14 @@
             command: echo "Jobs are simple!"
             flags: simple
 
+.. _job_flag_preserve_cwd:
+
+    ``preserve-cwd``:
+        This flag makes plainbox run the job command in the current working
+        directory without creating a temp folder (and running the command from
+        this temp folder). Sometimes needed on snappy
+        (See http://pad.lv/1618197)
+
     Additional flags may be present in job definition; they are ignored.
 
 ``imports``:

=== modified file 'plainbox/plainbox/impl/ctrl.py'
--- plainbox/plainbox/impl/ctrl.py	2016-08-17 07:57:21 +0000
+++ plainbox/plainbox/impl/ctrl.py	2016-08-30 08:23:40 +0000
@@ -551,9 +551,15 @@
                 job, job_state, config, session_dir, nest_dir)
             with self.temporary_cwd(job, config) as cwd_dir:
                 # run the command
-                logger.debug(_("job[%s] executing %r with env %r in cwd %r"),
-                             job.id, cmd, env, cwd_dir)
-                return_code = extcmd_popen.call(cmd, env=env, cwd=cwd_dir)
+                if 'preserve-cwd' in job.get_flag_set():
+                    logger.debug(_("job[%s] executing %r with env %r"),
+                                 job.id, cmd, env)
+                    return_code = extcmd_popen.call(cmd, env=env)
+                else:
+                    logger.debug(_("job[%s] executing %r with env %r "
+                                   "in cwd %r"),
+                                 job.id, cmd, env, cwd_dir)
+                    return_code = extcmd_popen.call(cmd, env=env, cwd=cwd_dir)
                 if 'noreturn' in job.get_flag_set():
                     self._halt()
                 return return_code

=== modified file 'plainbox/plainbox/impl/unit/job.py'
--- plainbox/plainbox/impl/unit/job.py	2016-05-11 14:36:13 +0000
+++ plainbox/plainbox/impl/unit/job.py	2016-08-30 08:23:40 +0000
@@ -979,6 +979,15 @@
                         'has-leftovers makes no sense without a command'
                     ),
                     onlyif=lambda unit: unit.command is None),
+                # The preserve-cwd flag is useless without a command
+                CorrectFieldValueValidator(
+                    lambda value, unit: (
+                        'preserve-cwd' not in unit.get_flag_set()),
+                    Problem.useless, Severity.advice,
+                    message=_(
+                        'preserve-cwd makes no sense without a command'
+                    ),
+                    onlyif=lambda unit: unit.command is None),
             ],
             fields.qml_file: [
                 UntranslatableFieldValidator,