dmiller15
commented
3 years ago Hey just following up with some investigation of my own.
If we interrogate what sbpack is running after it's installed we can see a pretty simple wrapper for the main function:
root@41463c4572c2:/sbpack# cat `which sbpack`
#!/usr/bin/python3
# -*- coding: utf-8 -*-
import re
import sys
from sbpack.pack import main
if __name__ == '__main__':
sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0])
sys.exit(main())Basically taking the output, if any, from main() and using that as the argument for sys.exit. So what are we getting as an output from main()?
https://github.com/rabix/sbpack/blob/master/sbpack/pack.py#L361-L367
try:
app = api.apps.get(appid)
logger.debug("Creating revised app: {}".format(appid))
return api.apps.create_revision(id=appid, raw=cwl, revision=app.revision + 1)
except sbgerr.NotFound:
logger.debug("Creating new app: {}".format(appid))
return api.apps.install_app(id=appid, raw=cwl)The main function can end in two ways, either providing the output of the sevenbridges.api.apps create_revision or install_app function. Looking at these then we can see both returns an app object:
https://github.com/sbg/sevenbridges-python/blob/b3e14016066563470d978c9b13e1a236a41abea8/sevenbridges/models/app.py#L136
https://github.com/sbg/sevenbridges-python/blob/b3e14016066563470d978c9b13e1a236a41abea8/sevenbridges/models/app.py#L159
return App(api=api, **app_wrapper)So either way we have main() returning an App object. In retrospect this fact should be obvious as we can see the commands from the original issue returning the app as their last line:
<App: id=kfdrc-harmonization/kf-reference-pipeline/kfdrc-jointgenotyping-refinement-workflow rev=6>What I assumed was a log is actually the output of sys.exit().
So why does this result in an exit code of 1? Well I think that's just due to the nature of sys.exit(): https://docs.python.org/3/library/sys.html#sys.exit. In the documentation for the code we can see that:
The optional argument arg can be an integer giving the exit status (defaulting to zero), or another type of object...If another type of object is passed, None is equivalent to passing zero, and any other object is printed to stderr and results in an exit code of 1.
Now the behavior makes sense: create_revision() or install_app() return the App to main() which returns that App as its output. The App from main() is then interpreted by the sys.exit() as the stderr so it prints it and returns exit code 1 indicating failure.
Possible resolution:
- Do not have the pack main function return the App object. I'm unsure of the desired utility here. If the desire is to simply return information on the pack process, it can be accomplished by simply printing the object.
bogdang989
migbro
Having an issue where sbpack will return a non-zero exit code when pushing apps. Example:
This exit code characteristic is not universal for sbpack. Running with the help command gives the expected 0 exit code.
I've reproduced this behavior in a docker environment with the most up to date version of sbpack and different cwl files.
In all it's not terribly critical as the packing and pushing still works, but it becomes problematic when trying to use the tool in any sort of automated testing. Tests that check the exit code indicate the task failed when it appears to have succeeded.
I was just wondering if this behavior was expected, and perhaps I'm missing something.