ros2_batch_job --workspace-path option does not work

[jacobperron]

Looking at the code we see that the argparse option declared here:

https://github.com/ros2/ci/blob/eb8d0ad3e9b74a71561c178bb5d8487f77206d35/ros2_batch_job/main.py#L238-L240

is not actually used anywhere in the code. So setting this option has no affect on the job.

I'm not sure exactly how to fix the argument because I don't understand the purpose of the --white-space-in option, which is coupled to determining the actual workspace named used:

https://github.com/ros2/ci/blob/eb8d0ad3e9b74a71561c178bb5d8487f77206d35/ros2_batch_job/main.py#L427

If I'm not mistaken, this section of code is relevant as well:

https://github.com/ros2/ci/blob/eb8d0ad3e9b74a71561c178bb5d8487f77206d35/ros2_batch_job/main.py#L267-L270

---

Here are other references to the option I could find:

https://github.com/ros2/ci/blob/eb8d0ad3e9b74a71561c178bb5d8487f77206d35/job_templates/ci_job.xml.em#L123

https://github.com/ros2/ci/blob/eb8d0ad3e9b74a71561c178bb5d8487f77206d35/job_templates/ci_job.xml.em#L265

https://github.com/ros2/ci/blob/eb8d0ad3e9b74a71561c178bb5d8487f77206d35/job_templates/ci_job.xml.em#L368

[clalancette]

I'm not sure exactly how to fix the argument because I don't understand the purpose of the --white-space-in option, which is coupled to determining the actual workspace named used:

The purpose of --white-space-in is to test out that our build and install stack (colcon and ament) handle whitespaces in paths properly. This is particularly relevant on Windows, where whitespaces are often found in paths.

That said, I'm guessing that this option is rarely, if ever, used. I'd be OK with removing the option altogether; while we should test whitespaces-in-path somehow, this doesn't seem like the right way to do it. Thoughts from anyone else?