Fix ros2cli + rosidl_cli auto-completion

[rhaschke]

Port of RoboStack/ros-humble#276
Fixes #202

[rhaschke]

The backport from ros-humble doesn't actually work for me 😞. pixi's configured shell-hook is simply wrong:

$ pixi shell-hook -e jazzy
...
source /vol/robostack/.pixi/envs/jazzy/share/bash-completion/completions/*
...

The source command just considers the first file argument. It cannot be used to source multiple files at once!

However, I don't understand, why sourcing $CONDA_PREFIX/setup.sh in /vol/robostack/.pixi/envs/jazzy/etc/conda/activate.d/ros-jazzy-ros-workspace_activate.sh doesn't activate completion in first place. Enabling tracing (export AMENT_TRACE_SETUP_FILES=1) reveals that the corresponding command is correctly created (and evaluated):

# Package: ros2cli
# /vol/robostack/.pixi/envs/jazzy/share/ros2cli/package.dsv
AMENT_CURRENT_PREFIX="/vol/robostack/.pixi/envs/jazzy" _ament_prefix_sh_source_script "/vol/robostack/.pixi/envs/jazzy/share/ros2cli/environment/ros2-argcomplete.bash"

Is it possible that pixi's activation mechanism has changed and executes the activation scripts within a subshell? I'm using pixi 0.67.0.

[Tobias-Fischer]

Cc @wolfv @ruben-arts

[rhaschke]

Manually sourcing .pixi/envs/jazzy/etc/conda/activate.d/ros-jazzy-ros-workspace_activate.sh enables completion as expected. So, this indeed seems to be a pixi issue.
eval "$(pixi shell-hook -e jazzy)" works as well.

In any case, the following change needs to be applied to that file:

- source $CONDA_PREFIX/setup.sh
+ source $CONDA_PREFIX/setup.bash

[rhaschke]

Is this issue related: prefix-dev/pixi#2330?

[Tobias-Fischer]

Hi @wolfv @ruben-arts @baszalmstra - you probably understand this better than me, could you please take a look?

[Tobias-Fischer]

Quick ping @wolfv @ruben-arts @baszalmstra @traversaro

[zimmerman-pliant]

A workaround for this in the interim seems to be the following:

sudo apt install python3-argcomplete

then in .bashrc

eval "$(register-python-argcomplete ros2)"
eval "$(register-python-argcomplete colcon)"

Would love this to work out of the box on Robostack installations, however.

[rhaschke]

A workaround for this in the interim seems to be ...

Easier than manually registering all relevant programs, is to source:
.pixi/envs/<distro>/etc/conda/activate.d/ros-<distro>-ros-workspace_activate.sh

as suggested in #206 (comment)

[traversaro]

Manually sourcing .pixi/envs/jazzy/etc/conda/activate.d/ros-jazzy-ros-workspace_activate.sh enables completion as expected. So, this indeed seems to be a pixi issue. eval "$(pixi shell-hook -e jazzy)" works as well.

In any case, the following change needs to be applied to that file:

- source $CONDA_PREFIX/setup.sh
+ source $CONDA_PREFIX/setup.bash

I think the problem is pixi is not actually executing the scripts in the shell, it executes the scripts, capture how they modified the environment, and then set the modification in the shell. So the autocomplete do not work, see prefix-dev/pixi#2366 . To be honest, I am not sure if this we can fix on the robostack side, or we need to fix something on pixi. fyi @ruben-arts @wolfv

[ruben-arts]

Pixi doesn't leave bash functions in the environment after an activation (with pixi shell). For that to work you have to add them to the completions folder. The change in this PR makes sense as it would then support this workflow: https://rattler-build.prefix.dev/latest/system_integration/#installing-shell-completion-scripts

[rhaschke]

@ruben-arts: Thanks for the explanation.
However, this PR doesn't yet resolve the problem, because of pixi's configured shell-hook is wrong:

$ pixi shell-hook -e jazzy
...
source /vol/robostack/.pixi/envs/jazzy/share/bash-completion/completions/*
...

The source command just considers the first file argument only. It cannot be used to source multiple files at once!

[ruben-arts]

@ruben-arts: Thanks for the explanation. However, this PR doesn't yet resolve the problem, because of pixi's configured shell-hook is wrong:

$ pixi shell-hook -e jazzy
...
source /vol/robostack/.pixi/envs/jazzy/share/bash-completion/completions/*
...

The source command just considers the first file argument only. It cannot be used to source multiple files at once!

Let me fix that in Pixi!

[ruben-arts]

That was actually fixed in Pixi already, could you try with the latest version?

[ruben-arts]

I've added similiar changes to the other distros:

• fix: ros2 cli autocompletions ros-kilted#101
• fix: ros2 cli autocompletions ros-lyrical#42
• fix: ros2 cli autocompletions ros-rolling#45

[ruben-arts]

Thanks for your input, I've moved the changes to another branch (#287) as I wasn't allowed to commit to your branch. Closing this PR.

[rhaschke]

@ruben-arts: thanks for addressing this issue.
@traversaro: could you please merge the PRs for kilted + lyrical too (#206 (comment))?