Path maps for Docker

[lukas-reineke]

neotest uses the absolute path for files, but when the tests run in Docker, those paths don't match.

Would it be possible to add some kind of path mapping to fix this?
Something like DAPs localRoot and remoteRoot.

[rcarriga]

I'm not opposed to the idea of this but also I'm not sure how this should be implemented. Off the top of my head I believe this would have to be implemented by adapters rather than by neotest itself, as the usage of paths is completely up to them. Of course it'd be better if there was one implementation that could be shared, There could be a translate_path function somewhere for adapters to use 🤔

[lukas-reineke]

I haven't looked too deep into it, but from what I could tell, the adapters wouldn't need to change. The translation should be directly at the beginning from Neovim buffer to filepath. All adapter functions are called with the translated path, so adapters only ever look at things in Docker. And at the end when parsing the results.

[rcarriga]

Unfortunately that wouldn't work well. It would require adding translation logic to both consumers and the core code, and would also hide the translation from adapters which shouldn't be done in case they need to use the file path for some type of functionality (e.g. project root inference).

[lukas-reineke]

It would require adding translation logic to both consumers and the core code

I agree, consumers should not have to worry about this.

and would also hide the translation from adapters which shouldn't be done in case they need to use the file path for some type of functionality (e.g. project root inference).

IMO if the tests run inside docker, everything needed to run the tests should be inside docker too. Project root should resolve to the root inside docker, etc.

Maybe the translation can happen directly before calling the adapter, and directly after receiving results from the adapter.

[rcarriga]

Maybe I'm misunderstanding, but from what I understand the neovim process is outside of the container and the test commands are running docker exec ... commands (or something similar). That means that to read the files, an adapter needs to use the host OS paths, not the docker paths and so we can't hide mappings.

Unfortunately I believe the only route for this is to provide the mappings to the adapter when building commands/results and let them handle it manually

[lukas-reineke]

But that's only a problem if the adapter needs to read the file, would that ever be necessary outside of discover_positions? And discover_positions could be called with the original path (this does get a bit messy though I agree)

[rcarriga]

Yes unfortunately the adapters use the filesystem in both the root function and results

[pBorak]

If I were to use it solely for docker, would it be just matter of changing the root and results function (locally/forking), not to use absolute path, but rather the one matching the docker one?

[lukas-reineke]

yeah, it's not that easy.. root needs to run on the local file system as well, same as discover_positions.

You're probably right, the only way to not make this a total mess would be to provide translate functions that the adapter can use when they need to.

[rcarriga]

Yeah it wouldn't be any easier if you only used docker. The same changes would be needed unfortunately.

I'll get to working on this at some stage but I don't use docker for testing so I can't say it'll be a priority. If someone wants to work on this, I'd be happy to discuss 😄

[rcarriga]

A thought that I've had with this is that even if we implement some sort of path mappings in the adapter interface, several adapters won't be able to run without some very gnarly mounting. For example neotest-python uses a custom wrapper script which would have to be mounted as well as a temp file that would also have to be mounted separately.

It's looking like it'd be better to solve this problem doing what VSCode does and just install Neovim in the container along with plugins and run from there. There is https://github.com/esensar/nvim-dev-container which looks like it might work but I've no clue how much neotest would have to be aware of it. Just noting ideas down

[mmirus]

👋 For running rpec tests in a docker container, I suggested using a shell script as an intermediary over at olimorris/neotest-rspec#28 (comment).

1. Create a shell script that invokes rspec in docker with the args passed to it
2. Point neotest at the shell script as the rspec executable

It's easy to transform the paths as needed in the script.

#!/bin/bash

# Strip "/home/mmirus/git/repo/path/" from test paths sent to container
args="$(echo "$@" | sed 's/\/home\/mmirus\/git\/repo\/path\///g')"
docker compose exec web bundle exec rspec $args

Then you just do this:

require("neotest").setup({
  adapters = {
    require("neotest-rspec")({
      rspec_cmd = "my-script.sh",
    }),
  },
})

This works; with this setup, neotest can run the tests in the container.

The next problem is that neotest reports all the tests as failures, regardless of the actual result. The likely explanation is that when the rspec output comes from the container / script, it's different from what neotest expects.

@rcarriga Do you have any ideas on what the problem might be, or suggestions for troubleshooting it?