Refactor to use ParallelTestRunner in the tests (#4119)

Author: odow

Project.toml

@@ -1,16 +1,16 @@
 name = "JuMP"
 uuid = "4076af6c-e467-56ae-b986-b466b2749572"
-repo = "https://github.com/jump-dev/JuMP.jl.git"
 version = "1.29.4"
+repo = "https://github.com/jump-dev/JuMP.jl.git"
 
 [deps]
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 MacroTools = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
 MathOptInterface = "b8f27783-ece8-5eb3-8dc8-9495eed66fee"
 MutableArithmetics = "d8a4904e-b15c-11e9-3269-09a3773c0cb0"
 OrderedCollections = "bac558e1-5e72-5ebc-8fee-abe8a469f55d"
-Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 PrecompileTools = "aea7be01-6a6a-4083-8856-8a6e6704d82a"
+Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 
 [weakdeps]
@@ -26,6 +26,7 @@ MacroTools = "0.5"
 MathOptInterface = "1.38.0"
 MutableArithmetics = "1.6"
 OrderedCollections = "1"
+ParallelTestRunner = "2.4.0"
 PrecompileTools = "1"
 Printf = "1"
 SparseArrays = "1"
@@ -34,7 +35,8 @@ julia = "1.10"
 
 [extras]
 DimensionalData = "0703355e-b756-11e9-17c0-8b28908087d0"
+ParallelTestRunner = "d3525ed8-44d0-4b2c-a655-542cee43accc"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["DimensionalData", "Test"]
+test = ["DimensionalData", "ParallelTestRunner", "Test"]

docs/src/developers/extensions.md

@@ -405,21 +405,30 @@ implements an [`AbstractModel`](@ref) is [InfiniteOpt.jl](https://github.com/inf
 ### Testing JuMP extensions
 
 The JuMP test suite contains a large number of tests for JuMP extensions. You
-can run these tests by copying the MIT-licensed [`Kokako.jl`](https://github.com/jump-dev/JuMP.jl/blob/master/test/Kokako.jl)
-file in the JuMP tests into your `/test` folder, and then adding this snippet to
-your `/test/runtests.jl` file:
+can run these tests by copying the following snippet to your `/test/runtests.jl`
+file:
 
 ```julia
 using MyJuMPExtension
 import JuMP
-include("Kokako.jl")
-const MODULES_TO_TEST = Kokako.include_modules_to_test(JuMP)
-Kokako.run_tests(
-    MODULES_TO_TEST,
-    MyJuMPExtension.MyModel,
-    MyJuMPExtension.MyVariableRef;
-    test_prefix = "test_extension_",
-)
+import Test
+function runtests(mod::Module)
+    is_test_extension(f) = startswith("$f", "test_extension_")
+    for f in filter(is_test_extension, names(mod; all = true))
+        Test.@testset "$f" begin
+            getfield(mod, f)(
+                MyJuMPExtension.MyModel,
+                MyJuMPExtension.MyVariableRef,
+            )
+        end
+    end
+end
+is_test_file(f) = startswith(f, "test_") && endswith(f, ".jl")
+for (root, dirs, files) in walkdir(joinpath(pkgdir(JuMP), "test"))
+    Test.@testset "$file" for file in filter(is_test_file, files)
+        runtests(include(joinpath(root, file)))
+    end
+end
 ```
 
 ## Set an `optimize!` hook

src/nlp_expr.jl

@@ -553,9 +553,15 @@ function check_belongs_to_model(
     expr::GenericNonlinearExpr,
     model::AbstractModel,
 )
-    for arg in expr.args
-        if arg isa AbstractJuMPScalar
-            check_belongs_to_model(arg, model)
+    stack = Any[expr]
+    while !isempty(stack)
+        child = pop!(stack)
+        if child isa GenericNonlinearExpr
+            for arg in child.args
+                push!(stack, arg)
+            end
+        elseif child isa AbstractJuMPScalar
+            check_belongs_to_model(child, model)
         end
     end
     return

test/JuMPExtension.jl

@@ -605,82 +605,4 @@ function JuMP.constraints_string(print_mode, model::MyModel)
     ]
 end
 
-###
-### Tests
-###
-
-# Test printing of models of type `ModelType` for which the model is stored in
-# its JuMP form, for example, as `AbstractVariable`s and `AbstractConstraint`s.
-# This is used by `JuMPExtension` but can also be used by external packages such
-# as `StructJuMP`, see https://github.com/jump-dev/JuMP.jl/issues/1711
-
-function test_model_extension_printing()
-    repl(s) = JuMP._math_symbol(MIME("text/plain"), s)
-
-    model_1 = MyModel()
-    JuMP.@variable(model_1, a >= 1)
-    JuMP.@variable(model_1, b <= 1)
-    JuMP.@variable(model_1, -1 <= c <= 1)
-    JuMP.@variable(model_1, a1 >= 1, Int)
-    JuMP.@variable(model_1, b1 <= 1, Int)
-    JuMP.@variable(model_1, -1 <= c1 <= 1, Int)
-    JuMP.@variable(model_1, x, Bin)
-    JuMP.@variable(model_1, y)
-    JuMP.@variable(model_1, z, Int)
-    JuMP.@variable(model_1, u[1:3], Bin)
-    JuMP.@variable(model_1, fi == 9)
-    JuMP.@objective(model_1, Max, a - b + 2a1 - 10x)
-    JuMP.@constraint(model_1, a + b - 10c - 2x + c1 <= 1)
-    JuMP.@constraint(model_1, a * b <= 2)
-    JuMP.@constraint(model_1, [1 - a; u] in JuMP.SecondOrderCone())
-
-    model_2 = MyModel()
-    JuMP.@variable(model_2, x, Bin)
-    JuMP.@variable(model_2, y, Int)
-    JuMP.@constraint(model_2, x * y <= 1)
-
-    model_3 = MyModel()
-    JuMP.@variable(model_3, x)
-    JuMP.@constraint(model_3, x <= 3)
-
-    Test.@test JuMP.model_string(MIME("text/plain"), model_1) == """
-Max a - b + 2 a1 - 10 x
-Subject to
- a + b - 10 c - 2 x + c1 $(repl(:leq)) 1
- a*b $(repl(:leq)) 2
- [-a + 1, u[1], u[2], u[3]] $(repl(:in)) MathOptInterface.SecondOrderCone(4)
-"""
-
-    Test.@test JuMP.model_string(MIME("text/latex"), model_1) == """
-\$\$ \\begin{aligned}
-\\max\\quad & a - b + 2 a1 - 10 x\\\\
-\\text{Subject to} \\quad & a + b - 10 c - 2 x + c1 \\leq 1\\\\
- & a\\times b \\leq 2\\\\
- & [-a + 1, u_{1}, u_{2}, u_{3}] \\in \\text{MathOptInterface.SecondOrderCone(4)}\\\\
-\\end{aligned} \$\$"""
-
-    Test.@test sprint(show, model_1) == """
-An Abstract JuMP Model
-Maximization problem with:
-Variables: 13
-Objective function type: $(JuMP.GenericAffExpr{Float64,MyVariableRef})
-Constraints: 3
-Names registered in the model: a, a1, b, b1, c, c1, fi, u, x, y, z"""
-
-    Test.@test sprint(show, model_2) == """
-An Abstract JuMP Model
-Feasibility problem with:
-Variables: 2
-Constraint: 1
-Names registered in the model: x, y"""
-
-    Test.@test sprint(show, model_3) == """
-An Abstract JuMP Model
-Feasibility problem with:
-Variable: 1
-Constraint: 1
-Names registered in the model: x"""
-    return
-end
-
 end

test/Kokako.jl

@@ -0,0 +1,40 @@
+#  Copyright 2017, Iain Dunning, Joey Huchette, Miles Lubin, and contributors
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#############################################################################
+# JuMP
+# An algebraic modeling language for Julia
+# See https://github.com/jump-dev/JuMP.jl
+#############################################################################
+
+import JuMP
+import Test
+
+include(joinpath(@__DIR__, "JuMPExtension.jl"))
+
+function run_tests(m::Module)
+    _startswith(k) = f -> startswith("$f", k)
+    # Default tests
+    for f in filter(_startswith("test_"), names(m; all = true))
+        Test.@testset "$f" begin
+            getfield(m, f)()
+        end
+    end
+    # Test with {Float32}
+    for f in filter(_startswith("test_extension_"), names(m; all = true))
+        Test.@testset "$f::Float32" begin
+            getfield(m, f)(
+                JuMP.GenericModel{Float32},
+                JuMP.GenericVariableRef{Float32},
+            )
+        end
+    end
+    # Test JuMP extension
+    for f in filter(_startswith("test_extension_"), names(m; all = true))
+        Test.@testset "$f::JuMPExtension" begin
+            getfield(m, f)(JuMPExtension.MyModel, JuMPExtension.MyVariableRef)
+        end
+    end
+    return
+end