InstalledCode: Allow relative path for filepath_executable
#5879
Conversation
| :raises `~aiida.common.exceptions.ValidationError`: if no transport could be opened or if the defined executable | ||
| does not exist on the remote computer. | ||
| """ | ||
| if not self.filepath_executable.is_absolute(): | ||
| return |
There was a problem hiding this comment.
just checking: what effect does this have in verdi computer test (or wherever this validation is used)?
will the check be shown as skipped or as passed?
There was a problem hiding this comment.
This check is only run by verdi code test. It will show that all tests have passed. But this is also the case for codes that are not InstalledCode even though no test was run.
There was a problem hiding this comment.
@sphuber I would note that ideally what you want to do, if the path is not absolute, is load the same environment that you would have, then check that the executable is on the $PATH.
Perhaps there could be an option in the code test, to run the prepend text (from both computer and code) then look for the executable
this would be a more "complete" test of whether the code might have issues running
I did do a search, which is how I found the section that was updated in the PR. |
The `InstalledCode` required the `filepath_executable` to be an absolute path. The original reasoning behind this design choice was that this improves the provenance of data produced with this code slightly as it would be more difficult to accidentally change the version of the code that was associated with the executable. For relative paths, the actual linked code could be easily changed through, for example, environment variables. However, this restriction also has downsides. On many compute clusters the preferred approach is to load specific modules that provide the software of interest in which relative executables are provided. The absolute paths can change depending on microarchitecture of the system or other system variables. Requiring the user to provide the absolute path to the executable defeats the purpose of this system. Therefore the requirement of the executable path having to be absolute is dropped.
sphuber
force-pushed
the
fix/5867/code-installed-executable-absolute
branch
from
21149a0 to
1ebf91b
Compare
Thanks @ltalirz . I have added a test. |
Fixes #5867
The
InstalledCoderequired thefilepath_executableto be an absolute path. The original reasoning behind this design choice was that this improves the provenance of data produced with this code slightly as it would be more difficult to accidentally change the version of the code that was associated with the executable. For relative paths, the actual linked code could be easily changed through, for example, environment variables.However, this restriction also has downsides. On many compute clusters the preferred approach is to load specific modules that provide the software of interest in which relative executables are provided. The absolute paths can change depending on microarchitecture of the system or other system variables. Requiring the user to provide the absolute path to the executable defeats the purpose of this system.
Therefore the requirement of the executable path having to be absolute is dropped.