feature: testify not working with import alias

[gjermundgaraba]

Did you check docs and existing issues?

• I have read the documentation.
• I have searched the existing issues.

Neovim version (nvim -v)

0.10.3

Operating system/version

MacOS 15.2

Output from :checkhealth neotest-golang

==============================================================================
neotest-golang: require("neotest-golang.health").check()

Requirements ~
- OK Binary 'go' found on PATH: /usr/local/go/bin/go
- OK Found go.mod file for /Users/gg/code/ibc-go/testing/chain_test.go in /Users/gg/code/ibc-go/go.mod
- OK Treesitter parser for go is installed
- OK neotest is available
- OK nvim-treesitter is available
- OK nio is available
- OK plenary is available

DAP (optional) ~
- OK Binary 'dlv' found on PATH: /Users/gg/go/bin/dlv
- WARNING dap is not available
- WARNING dapui is not available
- WARNING dap-go is not available

Gotestsum (optional) ~
- OK Binary 'gotestsum' found on PATH: /Users/gg/go/bin/gotestsum
- Found gotestsum to be installed, but not set as test runner.

Sanitization (optional) ~
- OK Sanitization is disabled

Describe the bug

If the testify suite import has been aliased, running tests don't work.
More specifically, they are "not found" (testing: warning: no tests to run):

WARN | 2025-01-12T22:45:58Z+0100 | .../nvim/lazy/neotest-golang/lua/neotest-golang/logging.lua:92 | Test(s) not associated (not found/executed)

Steps To Reproduce

1. Alias the testify suite import testifysuite "github.com/stretchr/testify/suite"
2. Try to run a test

Expected Behavior

Ideally, it would work with aliased imports.

Your Lua setup

No response

[gjermundgaraba]

I would be more than happy to give this a shot, but I am not very familiar with the treesitter queries and if this can even be done with the current approach. If this is doable, it would be nice as a starting point, as I would love to expand the testify support (and this could be a good starting point).

[fredrikaverpil]

Hi @gjermundgaraba

I'm not sure if this can be done and maintain reliability. I believe it's in here that you need to somehow be able to detect the suite.Run or whatever.Run without matching it against "suite".

neotest-golang/lua/neotest-golang/features/testify/lookup.lua

Line 25 in b4dfab8

operand: (identifier) @suite_lib (#eq? @suite_lib "suite")

neotest-golang/lua/neotest-golang/features/testify/lookup.lua

Line 58 in b4dfab8

operand: (identifier) @suite_lib (#eq? @suite_lib "suite")

You can try removing (#eq? @suite_lib "suite") and see where that takes you. But I'm afraid then other potential operands will wrongly be detected as testify suites (examples: router.Run, gin.Engine.Run).

I just recently had a report that these operands were wrongly identified as vanilla go tests, and fixed in this PR: #244

[fredrikaverpil]

I should add that it's quite difficult to support testify well, as you might imagine 😅
For this reason, I don't really like testify and instead recommend looking into https://pkg.go.dev/gotest.tools/v3 (especially assert.DeepEqual) which works really well with https://pkg.go.dev/github.com/google/go-cmp/cmp/cmpopts and https://pkg.go.dev/google.golang.org/protobuf/testing/protocmp

[github-actions]

This issue has been open for 20 days with no activity. Remove the stale label or add a comment or it will be closed in 10 days.

[fredrikaverpil]

Hey again @gjermundgaraba could you please give the testify-regexp branch a try?

I've hardcoded support in #291 for testifysuite "github.com/stretchr/testify/suite" but I'm planning on making it configurable. Would love to hear if this works for you first though. 😄

{
  "fredrikaverpil/neotest-golang" ,
  branch = "testify-regexp",
}

[fredrikaverpil]

I've implemented support for this. You will have to add optional config to enable your use case. See the docs for more info:

https://fredrikaverpil.github.io/neotest-golang/config/#testify_import_identifier