Hi, As I’ve been working through some of the Base, Core and Julia packages, I’ve noted that the src-test mapping/layout conventions (or lack of), more often than not, increase the burden of exploring Julia and most Julia packages. One way to discover Julia best practices and understand what ‘works…

[image] taqtiqa-mark: src-test mapping/layout conventions (or lack of), more often than not, increase the burden of exploring Julia and most Julia packages. I am not sure about this, using grep (in particular, rg) I can find all invocations in an instant, without leaving my editor (Emacs). T…

[image] Tamas_Papp: I am not sure about this, using grep (in particular, rg ) I can find all invocations in an instant, without leaving my editor (Emacs). Agreed, there is nothing that cannot be worked around. Bear in mind your premise of a new user doing: git clone start emacs, navigate t…

[image] taqtiqa-mark: Under this (voluntary) convention, you’d know exactly where to look to find the tests relevant to each: To elaborate, consider 3 files: interface.jl which defines an interface on two objects, eg with the method stuff(a, b) foo.jl which defines Foo, bar.jl which defines…

[image] Tamas_Papp: Where should one test stuff(::Foo, ::Bar) ? If ./src/api/wire/interface.fl is where stuff(a, b) is defined then ./test/api/wire/interface.fl. Anything funky about Foo or Bar should be specified in the test files for the source files foo.jl and bar.jl, e.g. the different e…

[image] taqtiqa-mark: unless I’ve misunderstood some Julia-fu? I would consider this possibility. I think what you call iteractions/side-effects are a red herring. To make things concrete, consider LinearAlgebra . Following your recommendation, where would you put tests for *(a, b)? Base.* i…

[image] Tamas_Papp: I think what you call iteractions/side-effects are a red herring. Point taken. [image] Tamas_Papp: To make things concrete, consider LinearAlgebra . Following your recommendation, where would you put tests for *(a, b) ? Where is that function defined in that librar…

[image] taqtiqa-mark: Where is that function defined in that library? It isn’t. As I said above, it is defined in Base.

Then the Base tests suffice. Until they don’t (src/matmul.jl#L38): https://github.com/JuliaLang/julia/blob/master/stdlib/LinearAlgebra/src/matmul.jl#L38 In which case a new user would intuit to look in ../stdlib/LinearAlgebra/test/matmul.jl to find any/all tests related to that: https://github.c…

[image] taqtiqa-mark: Where should one test stuff(::Foo, ::Bar) ? If ./src/api/wire/interface.fl is where stuff(a, b) is defined then ./test/api/wire/interface.fl . Let me give a slightly different example. I define stuff(::Any) in interface.jl, stuff(::Foo) in foo.jl and stuff(::Bar) in b…

Unit-test mapping/layout convention/style-guide

General Usage

Tero_Frondelius January 6, 2019, 3:28pm 11

Maybe the convention could simply be: add the information of the test file location to the docstring? If done right, would it also work as a link in github?

Topic		Replies	Views
Trying to figure out what testing etc libraries I should be using for julia General Usage	2	1657	March 6, 2021
Rust-like source-file tests General Usage testing	7	382	May 2, 2024
Organizing Julia code New to Julia question , code-organization	11	3164	June 21, 2022
Why is `Test` so meta-programming heavy? Internals & Design testing , design	29	3363	February 20, 2023
Consistency testing when unit-testing is infeasible General Usage	25	1912	December 31, 2020

Unit-test mapping/layout convention/style-guide

Related topics