Changed Pkg.test to prioritise julia_args --threads over current process threads (#4141)

Co-authored-by: Ian Butterworth <[email protected]>
(cherry picked from commit f517489)

Author: 2 people

src/Operations.jl

@@ -1985,14 +1985,18 @@ end
 
 
 function get_threads_spec()
-    if Threads.nthreads(:interactive) > 0
+    if haskey(ENV, "JULIA_NUM_THREADS")
+        # if set, prefer JULIA_NUM_THREADS because this is passed to the test worker via --threads
+        # which takes precedence in the worker
+        ENV["JULIA_NUM_THREADS"]
+    elseif Threads.nthreads(:interactive) > 0
         "$(Threads.nthreads(:default)),$(Threads.nthreads(:interactive))"
     else
         "$(Threads.nthreads(:default))"
     end
 end
 
-function gen_subprocess_flags(source_path::String; coverage, julia_args)
+function gen_subprocess_flags(source_path::String; coverage, julia_args::Cmd)
     coverage_arg = if coverage isa Bool
         # source_path is the package root, not "src" so "ext" etc. is included
         coverage ? string("@", source_path) : "none"
@@ -2330,7 +2334,7 @@ function test(ctx::Context, pkgs::Vector{PackageSpec};
             test_fn !== nothing && test_fn()
             sandbox_ctx = Context(;io=ctx.io)
             status(sandbox_ctx.env, sandbox_ctx.registries; mode=PKGMODE_COMBINED, io=sandbox_ctx.io, ignore_indent = false, show_usagetips = false)
-            flags = gen_subprocess_flags(source_path; coverage,julia_args)
+            flags = gen_subprocess_flags(source_path; coverage, julia_args)
 
             if should_autoprecompile()
                 cacheflags = Base.CacheFlags(parse(UInt8, read(`$(Base.julia_cmd()) $(flags) --eval 'show(ccall(:jl_cache_flags, UInt8, ()))'`, String)))
@@ -2340,7 +2344,7 @@ function test(ctx::Context, pkgs::Vector{PackageSpec};
             printpkgstyle(ctx.io, :Testing, "Running tests...")
             flush(ctx.io)
             code = gen_test_code(source_path; test_args)
-            cmd = `$(Base.julia_cmd()) $(flags) --threads=$(get_threads_spec()) --eval $code`
+            cmd = `$(Base.julia_cmd()) --threads=$(get_threads_spec()) $(flags) --eval $code`
             p, interrupted = subprocess_handler(cmd, ctx.io, "Tests interrupted. Exiting the test process")
             if success(p)
                 printpkgstyle(ctx.io, :Testing, pkg.name * " tests passed ")

test/new.jl

@@ -2014,6 +2014,62 @@ end
         Pkg.test("TestArguments"; test_args=`a b`, julia_args=`--quiet --check-bounds=no`)
         Pkg.test("TestArguments"; test_args=["a", "b"], julia_args=["--quiet", "--check-bounds=no"])
     end end
+
+    @testset "threads" begin
+        mktempdir() do dir
+            path = copy_test_package(dir, "TestThreads")
+            cd(path) do
+                with_current_env() do
+                    default_nthreads_default = Threads.nthreads(:default)
+                    default_nthreads_interactive = Threads.nthreads(:interactive)
+                    other_nthreads_default = default_nthreads_default == 1 ? 2 : 1
+                    other_nthreads_interactive = default_nthreads_interactive == 0 ? 1 : 0
+                    @testset "default" begin
+                        withenv(
+                            "EXPECTED_NUM_THREADS_DEFAULT" => "$default_nthreads_default",
+                            "EXPECTED_NUM_THREADS_INTERACTIVE" => "$default_nthreads_interactive",
+                        ) do
+                            Pkg.test("TestThreads")
+                        end
+                    end
+                    @testset "JULIA_NUM_THREADS=other_nthreads_default" begin
+                        withenv(
+                            "EXPECTED_NUM_THREADS_DEFAULT" => "$other_nthreads_default",
+                            "EXPECTED_NUM_THREADS_INTERACTIVE" => "$default_nthreads_interactive",
+                            "JULIA_NUM_THREADS" => "$other_nthreads_default",
+                        ) do
+                            Pkg.test("TestThreads")
+                        end
+                    end
+                    @testset "JULIA_NUM_THREADS=other_nthreads_default,other_nthreads_interactive" begin
+                        withenv(
+                            "EXPECTED_NUM_THREADS_DEFAULT" => "$other_nthreads_default",
+                            "EXPECTED_NUM_THREADS_INTERACTIVE" => "$other_nthreads_interactive",
+                            "JULIA_NUM_THREADS" => "$other_nthreads_default,$other_nthreads_interactive",
+                        ) do
+                            Pkg.test("TestThreads")
+                        end
+                    end
+                    @testset "--threads=other_nthreads_default" begin
+                        withenv(
+                            "EXPECTED_NUM_THREADS_DEFAULT" => "$other_nthreads_default",
+                            "EXPECTED_NUM_THREADS_INTERACTIVE" => "$default_nthreads_interactive",
+                        ) do
+                            Pkg.test("TestThreads"; julia_args=`--threads=$other_nthreads_default`)
+                        end
+                    end
+                    @testset "--threads=other_nthreads_default,other_nthreads_interactive" begin
+                        withenv(
+                            "EXPECTED_NUM_THREADS_DEFAULT" => "$other_nthreads_default",
+                            "EXPECTED_NUM_THREADS_INTERACTIVE" => "$other_nthreads_interactive",
+                        ) do
+                            Pkg.test("TestThreads"; julia_args=`--threads=$other_nthreads_default,$other_nthreads_interactive`)
+                        end
+                    end
+                end
+            end
+        end
+    end    
 end
 
 #

test/test_packages/.gitignore

@@ -0,0 +1 @@
+Manifest.toml

test/test_packages/TestThreads/Project.toml

@@ -0,0 +1,2 @@
+name = "TestThreads"
+uuid = "79df5fe7-ed23-44ca-b7b9-b3881e57664d"

test/test_packages/TestThreads/src/TestThreads.jl

@@ -0,0 +1,2 @@
+module TestThreads
+end

test/test_packages/TestThreads/test/runtests.jl

@@ -0,0 +1,7 @@
+@assert haskey(ENV, "EXPECTED_NUM_THREADS_DEFAULT")
+@assert haskey(ENV, "EXPECTED_NUM_THREADS_INTERACTIVE")
+EXPECTED_NUM_THREADS_DEFAULT = parse(Int, ENV["EXPECTED_NUM_THREADS_DEFAULT"])
+EXPECTED_NUM_THREADS_INTERACTIVE = parse(Int, ENV["EXPECTED_NUM_THREADS_INTERACTIVE"])
+@assert Threads.nthreads() == EXPECTED_NUM_THREADS_DEFAULT
+@assert Threads.nthreads(:default) == EXPECTED_NUM_THREADS_DEFAULT
+@assert Threads.nthreads(:interactive) == EXPECTED_NUM_THREADS_INTERACTIVE