ros2_batch_job --workspace-path option does not work

[jacobperron]

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

ci/ros2_batch_job/__main__.py

Lines 238 to 240 in eb8d0ad

	parser.add_argument(
	'--workspace-path', default=None,
	help="base path of the workspace")

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:

ci/ros2_batch_job/__main__.py

Line 427 in eb8d0ad

args.workspace = 'work space' if 'workspace' in args.white_space_in else 'ws'

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

ci/ros2_batch_job/__main__.py

Lines 267 to 270 in eb8d0ad

	for name in ('sourcespace', 'buildspace', 'installspace'):
	space_directory = getattr(args, name)
	if name in args.white_space_in and space_directory is not None:
	raise Exception('Argument {} and "--white-space-in" cannot both be used'.format(name))

---

Here are other references to the option I could find:

ci/job_templates/ci_job.xml.em

Line 123 in eb8d0ad

export CI_ARGS="--do-venv --force-ansi-color --workspace-path $WORKSPACE"

ci/job_templates/ci_job.xml.em

Line 265 in eb8d0ad

set "CI_ARGS=--force-ansi-color --workspace-path !WORKSPACE!"

ci/job_templates/ci_job.xml.em

Line 368 in eb8d0ad

set "CI_ARGS=--force-ansi-color --workspace-path !WORKSPACE!"

[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?