Fail hard on first error in batch script #177
Conversation
Bash generally keeps executing code line by line even if any of the lines fail. For example, if your path is not set properly, `batchspawner-singleuser` will not be found by `which`. This should terminate execution. However, without `set -e`, execution will just continue and fail with a different error. This patch does `set -euo pipefail` for all submission scripts. This causes them to fail on: 1. Any non-zero command return code (-e) 2. On undefined environment variables (-u) 3. Treat failures in any part of a pipeline as failure, rather than just the last command (-o pipefail)
|
This is a good idea, and probably should have been done before. Could you add a note to the changelog as a potentially breaking change? At least in my prologue, I run stuff for debugging that is expected to fail (echoing environment variables), and I wouldn't be surprised if others do, too. (I can also add the note myself). It could be set in the default prologue, so that the minimum amount is hardcoded (of course, if someone wants it off then they can disable in their own prologue. Maybe it's better to have someone explicitely disable, than risk turning it off. I'd recommend to leave it as is.) Thanks! |
|
Agree, this seems like a sensible change. Likewise agree with the reasoning about putting it in the base templates rather than the |
|
Congrats on your first merged pull request in this project! 🎉 |
|
I just realized an issue here, some of the scripts use |
- `-o pipefail` is a bashism, so that the spawner scripts that use `/bin/sh` can't possibly work if it's not linked to bash. As a immediate workaround, remove the option on the non-bash scripts. A long-term plan will come later. - Closes: jupyterhub#184, Discussion: jupyterhub#184 - Fixes up: jupyterhub#177 - Follow-up in: jupyterhub#188
Bash generally keeps executing code line by line even
if any of the lines fail. For example, if your path is
not set properly,
batchspawner-singleuserwill notbe found by
which. This should terminate execution.However, without
set -e, execution will just continueand fail with a different error.
This patch does
set -euo pipefailfor all submissionscripts. This causes them to fail on:
rather than just the last command (-o pipefail)