Hooking into other neotest adapters?

[fredrikaverpil]

Hey @sluongng and nice work on this adapter!

I recently was pinged about bazel support in neotest-golang, but this is great that you've already got that covered here! 😄

I just wanted to reach out and mention I'm working on custom test runners in fredrikaverpil/neotest-golang#189
I don't know if this will help you at all, but in case you think it might help you to just hook into neotest-golang (instead of copying stuff over onto neotest-bazel), let me know - and how you would envision doing that.

Cheers!

[sluongng]

Hey @fredrikaverpil, many thanks for the project. I copied a lot from your work 🙇

I think it's nice to have Bazel support in neotest-golang. However, Bazel is often used in a multi-language repo and thus, may require more than just Go support. I think a better way to handle this would be to export some of the neotest-golang lua functions and conditionally import them in neotest-bazel and use it as-is. However I have yet to have the time to refactor neotest-golang to smaller importable functions and plug them into neotest-bazel.

One thing to note is that neotest does not have the knobs to discover all the tests under Bazel as neotest is currently tightly relying on file-walking to discover tests nvim-neotest/neotest#449.

In Bazel, the same userdb_test.go file could be used in multiple different Bazel test targets. For example https://github.com/buildbuddy-io/buildbuddy/blob/master/enterprise/server/backends/userdb/BUILD. So if you open userdb_test.go, neotest would not have a good way for you to pick which Bazel test target to run.

[fredrikaverpil]

I think a better way to handle this would be to export some of the neotest-golang lua functions and conditionally import them in neotest-bazel and use it as-is.

Exactly this was my thought too 😄
I was envisioning something like neotest-bazel having neotest-golang as a dependency (without initializing neotest with neotest-golang), and that your users would be able to take advantage of the same configuration as neotest-golang offers. But then neotest-bazel would hook into various logic inside neotest-golang so to avoid having to reimplement those and keep up with improvements made to neotest-golang. Meaning, something like this perhaps:

return {
  {
    "nvim-neotest/neotest",
    dependencies = {
      "nvim-neotest/nvim-nio",
      "nvim-lua/plenary.nvim",
      "antoinemadec/FixCursorHold.nvim",
      "nvim-treesitter/nvim-treesitter",
      { "sluongng/neotest-bazel", dependencies = { "fredrikaverpil/neotest-golang", version = "*" } },
    },
    config = function()
      require("neotest").setup({
        adapters = {
          require("neotest-bazel"),
        },
      })
    end,
  },
}

To begin with, I think you should be able to hook into neotest-golang's own test detection, instead of having to copy this into neotest-bazel: https://github.com/fredrikaverpil/neotest-golang/blob/33077c3662866a04af5f03d1dc6042d929fef037/lua/neotest-golang/init.lua#L58-L60

I think you should be able to do something like:

neotest_golang_query = require("neotest-golang.query")

function M.Adapter.discover_positions(file_path)
  if ext == "go" then
    return neotest_golang_query.detect_tests(file_path)
  end
end

[fredrikaverpil]

So if you open userdb_test.go, neotest would not have a good way for you to pick which Bazel test target to run.

It sounds like you have to create some sort of lookup?
I had to do this for when the user wants to run all tests in a file (aka the file strategy). I need to run go list to figure out which go package a file belongs to ... and the produce a regexp to filter on the test functions in that file. The end result is that the test command for a given looks like this: go test mypackage -run "^TestFunc1|TestFunc2|TestFunc3$" (I probably got the regexp a bit wrong there, but you get the idea).

I also had to do a lot of shenanigans to support testify test suites. I had to modify the neotest tree here, actually. It wasn't enough to just rely on treesitter AST parsing.

It kind of sounds like you would want to:

1. Parse Go tests using treesitter (like I do in neotest-golang).
2. Build a map/lookup which can tell us which bazel build target(s) a particular Go test function belongs to.
3. Conjure a bazel command based on the desired test to run and the lookup.
4. Parse the bazel test command output into Neotest result data and return it to Neotest.

[fredrikaverpil]

FYI: nvim-neotest/neotest#459
Maybe you should team up? 😄