fix: quote jobid passed to status script to support multi-cluster Slurm setup

[jdblischak]

Note: This is a resubmission of my previous PR #977. I closed it temporarily and rebased it onto main, but since I force pushed it I couldn't re-open it. I apologize for the extra noise. This is a minor fix that comes with a test, and I think is a nice complement to the recent cluster feature updates (e.g. cluster-cancel) and the Slurm overhaul in PR #1015

---

I'm a first-time contributor but long-time user, so I wanted to start by saying: Snakemake is awesome! I really appreciate all the effort to develop and maintain this awesome resource.

Description

Motivation

I am trying to use --cluster-status with a multi-cluster Slurm setup. To check the status of the job, both sacct and scontrol require the jobid and the name of the cluster. When I use the sbatch option --parsable, it returns both in the format jobid;cluster_name. This entire string gets passed to the custom script I pass to --cluster-status, which is great since it provides all the information that the script requires. The problem is that the string isn't quoted, thus the semicolon delimiter is misinterpreted as the end of a line. Thus the shell attempts to execute the name of the cluster. I discovered this behavior with Snakemake 6.2.1.

This happens because the first argument passed to the cluster status script isn't quoted:

snakemake/snakemake/executors/__init__.py

Lines 1078 to 1086 in b3c4e68

	def job_status(job, valid_returns=["running", "success", "failed"]):
	try:
	# this command shall return "success", "failed" or "running"
	ret = subprocess.check_output(
	"{statuscmd} {jobid}".format(
	jobid=job.jobid, statuscmd=self.statuscmd
	),
	shell=True,
	).decode()

Proposed solution

This PR quotes the jobid string passed as the first argument to the cluster status script. I confirmed it works both in a standard Slurm setup (i.e. when --parsable returns only the job id) and also when specifying the cluster name with --clusters.

QC

• The PR contains a test case for the changes or the changes are already covered by an existing test case.
• The documentation (docs/) is updated to reflect the changes or this is not necessary (e.g. if the change does neither modify the language nor the behavior or functionalities of Snakemake).

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication