False positive import error of main package when analyzing test file

[MilesCranmer]

From test/runtests.jl in BorrowChecker.jl, I see the following issue:

ArgumentError: Package BorrowChecker not found in current path.
- Run `import Pkg; Pkg.add("BorrowChecker")` to install the BorrowChecker package.
Stacktrace:
 [1] macro expansion
   @ ./loading.jl:2403 [inlined]
 [2] macro expansion
   @ ./lock.jl:376 [inlined]
 [3] __require(into::Module, mod::Symbol)
   @ Base ./loading.jl:2386
 [4] require(into::Module, mod::Symbol)
   @ Base ./loading.jl:2362

[dhanak]

I came here to report the same issue. I can't figure out how I can convince JetLS that the test files can load the main module just fine. Here's a minimal project to reproduce the issue:

$ cat Project.toml
name = "JetlsTest"
uuid = "63b202f8-4d09-4f2b-a629-e0ff111cae12"
version = "0.1.0"

$ cat src/JetlsTest.jl
module JetlsTest

greet() = print("Hello World!")

end # module JetlsTest

$ cat test/Project.toml
[deps]
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

$ cat test/runtests.jl
using Test

using JetlsTest: greet

@test greet isa Function

This simple project loads and tests just fine, yet:

$ jetls check src/*.jl test/*.jl
# Analyzed 2 files in 9.27s                                              
# Found 2 diagnostics in 1 files (1 errors, 1 warnings)

# @ test/runtests.jl:3,1
using Test

using JetlsTest: greet
└────────────────────┘ ── ArgumentError: Package JetlsTest not found in current path.
- Run `import Pkg; Pkg.add("JetlsTest")` to install the JetlsTest package.
Stacktrace:
  [1] macro expansion
    @ ./loading.jl:2403 [inlined]
  [2] macro expansion
    @ ./lock.jl:376 [inlined]
  [3] __require(into::Module, mod::Symbol)
    @ Base ./loading.jl:2386
  [4] require(into::Module, mod::Symbol)
    @ Base ./loading.jl:2362
  [5] eval(m::Module, e::Any)
    @ Core ./boot.jl:489
  [6] #usemodule_with_err_handling##4
    @ ~/.julia/packages/JET/wAXN9/src/toplevel/virtualprocess.jl:1613
  [7] #with_err_handling#75
    @ ~/.julia/packages/JET/wAXN9/src/toplevel/virtualprocess.jl:1861
  [8] usemodule_with_err_handling
    @ ~/.julia/packages/JET/wAXN9/src/toplevel/virtualprocess.jl:1541
  [9] step_expr!
    @ ~/.julia/packages/JET/wAXN9/src/toplevel/virtualprocess.jl:1623
 [10] step_expr!
    @ ~/.julia/packages/JETLS/aeeLq/src/analysis/Interpreter.jl:302
 [11] step_expr!
    @ ~/.julia/packages/JuliaInterpreter/rYU8v/src/interpret.jl:627
 [12] step_expr!
    @ ~/.julia/packages/LoweredCodeUtils/7rtET/src/codeedges.jl:1055
 [13] finish!
    @ ~/.julia/packages/JuliaInterpreter/rYU8v/src/commands.jl:14
 [14] finish_and_return!
    @ ~/.julia/packages/JuliaInterpreter/rYU8v/src/commands.jl:30
 [15] selective_eval!
    @ ~/.julia/packages/LoweredCodeUtils/7rtET/src/codeedges.jl:1090
 [16] selective_eval_fromstart!
    @ ~/.julia/packages/LoweredCodeUtils/7rtET/src/codeedges.jl:1103
 [17] partially_interpret!
    @ ~/.julia/packages/JET/wAXN9/src/toplevel/virtualprocess.jl:1292
 [18] #_virtual_process!#61
    @ ~/.julia/packages/JET/wAXN9/src/toplevel/virtualprocess.jl:1080
 [19] _virtual_process!
    @ ~/.julia/packages/JET/wAXN9/src/toplevel/virtualprocess.jl:908
 [20] #_virtual_process!#51
    @ ~/.julia/packages/JET/wAXN9/src/toplevel/virtualprocess.jl:802
 [21] _virtual_process!
    @ ~/.julia/packages/JET/wAXN9/src/toplevel/virtualprocess.jl:784
 [22] virtual_process!
    @ ~/.julia/packages/JET/wAXN9/src/toplevel/virtualprocess.jl:673
 [23] virtual_process!
    @ ~/.julia/packages/JETLS/aeeLq/src/analysis/Interpreter.jl:252
 [24] #virtual_process#43
    @ ~/.julia/packages/JET/wAXN9/src/toplevel/virtualprocess.jl:653
 [25] virtual_process
    @ ~/.julia/packages/JET/wAXN9/src/toplevel/virtualprocess.jl:606 [inlined]
 [26] #analyze_and_report_text!#136
    @ ~/.julia/packages/JET/wAXN9/src/JETBase.jl:1015 [inlined]
 [27] analyze_and_report_file!(interp::JETLS.Interpreter.LSInterpreter{JETLS.Server{Returns{Nothing}}}, filename::String, pkgid::Nothing; jetconfigs::@Kwargs{concretization_patterns::Vector{Expr}, analyze_from_definitions::Bool, toplevel_logger::Nothing})
    @ JET ~/.julia/packages/JET/wAXN9/src/JETBase.jl:819
 [28] analyze_and_report_file!
    @ ~/.julia/packages/JET/wAXN9/src/JETBase.jl:814 [inlined]
 [29] analyze_parsed_if_exist(::JETLS.Server{Returns{Nothing}}, ::JETLS.AnalysisRequest; activation_done::Base.Event)
    @ JETLS ~/.julia/packages/JETLS/aeeLq/src/analysis/full-analysis.jl:589
 [30] (::JETLS.var"#activate_with_early_release##2#activate_with_early_release##3"{JETLS.var"#execute_analysis_request##2#execute_analysis_request##3"{JETLS.Server{Returns{Nothing}}, JETLS.AnalysisRequest}, Base.Event})()
    @ JETLS ~/.julia/packages/JETLS/aeeLq/src/utils/pkg.jl:136 [error:toplevel/error]

@test greet isa Function

# @ test/runtests.jl:5,1
using JetlsTest: greet

@test greet isa Function
└──────────────────────┘ ── `greet` is not defined [warn:inference/undef-global-var]

And the same issues are also reported via the language server.

[dhanak]

A workaround for this is to include the test dependencies in the main Project.toml as extras, and get rid of the test/Project.toml and test/Manifest.toml files:

$ cat Project.toml
name = "JetlsTest"
uuid = "63b202f8-4d09-4f2b-a629-e0ff111cae12"
version = "0.1.0"

[extras]
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

[targets]
test = ["Test"]

Except that even this workaround doesn't work when the test has any additional external dependencies, e.g.:

$ cat Project.toml
name = "JetlsTest"
uuid = "63b202f8-4d09-4f2b-a629-e0ff111cae12"
version = "0.1.0"

[extras]
StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

[targets]
test = ["StatsBase", "Test"]

$ cat test/runtests.jl
using Test

using JetlsTest: greet
using StatsBase: mean

@test greet isa Function
@test mean isa Function

In this case, the tests run fine, but JetLS complains about not finding StatsBase.

[dhanak]

Second workaround: add the main project as a dependency with a source spec to the test/Project.toml:

$ cat test/Project.toml
[deps]
JetlsTest = "63b202f8-4d09-4f2b-a629-e0ff111cae12"
StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

[sources]
JetlsTest = {path = ".."}

This seems to do the trick.