Question: Allow local executable

[yannikschaelte]

I want to use an executable in a local folder, bin/tool, by adding the local folder to PATH. However,

[testenv:test]
setenv =
    # add tool to path
    PATH = {env:PWD}/bin:{env:PATH}
allowlist_externals = *
commands =
    # doesn't work
    tool --version
    # works
    {env:PWD}/bin/tool --version

does not work, only with absolute path. Adding the folder to PATH outside tox works, however it would be preferable if those adjustments could be done within this config file. What am I doing wrong?

[gaborbernat]

PWD is not defined. You'd likely want to use {toxinidir} instead that points to the root of the project, where the tox.ini file lives. Also consider using {/} instead of / to make it cross-platform compatible, though you might care about that part here.

[yannikschaelte]

Thanks for the fast reply and moving to Discussions. With PATH = {toxinidir}/bin:{env:PATH} I have the same ERROR: InvocationError for command could not find executable tool:/. echo {env:PATH} shows in both cases the correct one.

Thanks for the pointer to {/}. Not relevant here, but useful in another project.

[gaborbernat]

Can you pos the full output with -vv, from your current description I can't tell.

[yannikschaelte]

Sure: Here is an updated config file:

[testenv:test]
setenv =
    PATH = {toxinidir}/bin:{env:PATH}
allowlist_externals = *
commands =
    echo {toxinidir}
    echo {env:PATH}
    {env:PWD}/bin/tool
    tool

tox -e test -vv gives out.txt

base dir is /home/yannik/fitmulticell/fit, the "tool" outputs "This TOOOOOOOOOOOOOOL worked"

[gaborbernat]

Generally, it's not recommended to invoke things by using the path resolution system. I'd recommend invoking the tool via {toxinidir}/bin/tool and not adding it to the path. This likely sounds like a bug in tox 3 that we don't use the extended path to discover commands, but you're better of invoking the command with fully qualified path. If you put in a PR to fix this in tox 3 I'd be happy to review it.

[yannikschaelte]

I'll consider that, however won't have time in the near future. Thanks for your fast replies! I'll then use a workaround without path modification here, as suggested.

[gaborbernat]

You're welcome! Hope you're enjoying using the tool. All the best, Bernat

[gaborbernat]

Closing due to inactivity. The fix is to use {toxinidir} and {/} for portable paths:

setenv =
    PATH = {toxinidir}{/}bin:{env:PATH}

Feel free to reopen if still relevant.