fix: show methods for ComputeConfig and NodeSpec (#34)

* fix: show methods for ComputeConfig and NodeSpec

* add changelog

* update doctests

---------

Co-authored-by: Sebastian Pfitzner <[email protected]>

Author: mortenpi

CHANGELOG.md

@@ -8,6 +8,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 
 * Fixed the submission of application-type jobs. (#31, #32, #33, #35)
 * `JuliaHub.applications()` no longer throws a type error when the user has no registered and user applications. (#33)
+* Fixed the `show(io, x)` methods for `ComputeConfig` and `NodeSpec`. (#34)
 
 ## Version v0.1.4 - 2023-08-21
 

docs/src/reference/job-submission.md

@@ -46,15 +46,15 @@ A list of these node specifications can be obtained with the [`nodespecs`](@ref)
 ```jldoctest
 julia> JuliaHub.nodespecs()
 9-element Vector{JuliaHub.NodeSpec}:
- JuliaHub.nodespec(#= m6: 3.5 GHz Intel Xeon Platinum 8375C, 0.33/hr =#; ncpu=4, memory=16, gpu=false)
- JuliaHub.nodespec(#= m6: 3.5 GHz Intel Xeon Platinum 8375C, 0.65/hr =#; ncpu=8, memory=32, gpu=false)
- JuliaHub.nodespec(#= m6: 3.5 GHz Intel Xeon Platinum 8375C, 2.4/hr =#; ncpu=32, memory=128, gpu=false)
- JuliaHub.nodespec(#= r6: 3.5 GHz Intel Xeon Platinum 8375C, 0.22/hr =#; ncpu=2, memory=16, gpu=false)
- JuliaHub.nodespec(#= r6: 3.5 GHz Intel Xeon Platinum 8375C, 0.42/hr =#; ncpu=4, memory=32, gpu=false)
- JuliaHub.nodespec(#= m6: 3.5 GHz Intel Xeon Platinum 8375C, 0.17/hr =#; ncpu=2, memory=8, gpu=false)
- JuliaHub.nodespec(#= r6: 3.5 GHz Intel Xeon Platinum 8375C, 1.3/hr =#; ncpu=8, memory=64, gpu=false)
- JuliaHub.nodespec(#= p2: Intel Xeon E5-2686 v4 (Broadwell), 1.4/hr =#; ncpu=4, memory=61, gpu=true)
- JuliaHub.nodespec(#= p3: Intel Xeon E5-2686 v4 (Broadwell), 4.5/hr =#; ncpu=8, memory=61, gpu=true)
+ JuliaHub.nodespec(#= m6: 3.5 GHz Intel Xeon Platinum 8375C, 0.33/hr =#; ncpu=4, memory=16, ngpu=false, exactmatch=true)
+ JuliaHub.nodespec(#= m6: 3.5 GHz Intel Xeon Platinum 8375C, 0.65/hr =#; ncpu=8, memory=32, ngpu=false, exactmatch=true)
+ JuliaHub.nodespec(#= m6: 3.5 GHz Intel Xeon Platinum 8375C, 2.4/hr =#; ncpu=32, memory=128, ngpu=false, exactmatch=true)
+ JuliaHub.nodespec(#= r6: 3.5 GHz Intel Xeon Platinum 8375C, 0.22/hr =#; ncpu=2, memory=16, ngpu=false, exactmatch=true)
+ JuliaHub.nodespec(#= r6: 3.5 GHz Intel Xeon Platinum 8375C, 0.42/hr =#; ncpu=4, memory=32, ngpu=false, exactmatch=true)
+ JuliaHub.nodespec(#= m6: 3.5 GHz Intel Xeon Platinum 8375C, 0.17/hr =#; ncpu=2, memory=8, ngpu=false, exactmatch=true)
+ JuliaHub.nodespec(#= r6: 3.5 GHz Intel Xeon Platinum 8375C, 1.3/hr =#; ncpu=8, memory=64, ngpu=false, exactmatch=true)
+ JuliaHub.nodespec(#= p2: Intel Xeon E5-2686 v4 (Broadwell), 1.4/hr =#; ncpu=4, memory=61, ngpu=true, exactmatch=true)
+ JuliaHub.nodespec(#= p3: Intel Xeon E5-2686 v4 (Broadwell), 4.5/hr =#; ncpu=8, memory=61, ngpu=true, exactmatch=true)
 ```
 
 While you can manually index into the list returned by [`nodespecs`](@ref), that is generally inconvenient.

src/jobsubmission.jl

@@ -262,8 +262,15 @@ end
 
 function Base.show(io::IO, c::ComputeConfig)
     print(io, typeof(c), "(", c.node, "; ")
-    print(io, "nnodes = ", c.nnodes, ", ")
-    print(io, "process_per_node = ", c.process_per_node)
+    print(io, "nnodes = ")
+    if !isnothing(c.nnodes_min)
+        print(io, "(", c.nnodes_min, ", ", c.nnodes_max, ")")
+    else
+        print(io, c.nnodes_max)
+    end
+    print(io, ", ")
+    print(io, "process_per_node = ", c.process_per_node, ", ")
+    print(io, "elastic = ", c.elastic)
     print(io, ")")
 end
 

src/node.jl

@@ -55,7 +55,7 @@ end
 function Base.show(io::IO, node::NodeSpec)
     print(io, "JuliaHub.nodespec(")
     print(io, "#= $(node.nodeClass): $(node.desc), $(node.priceHr)/hr =#")
-    print(io, "; ncpu=$(node.vcores), memory=$(node.mem), gpu=$(node.hasGPU))")
+    print(io, "; ncpu=$(node.vcores), memory=$(node.mem), ngpu=$(node.hasGPU), exactmatch=true)")
 end
 
 function Base.show(io::IO, ::MIME"text/plain", node::NodeSpec)

test/jobs.jl

@@ -149,24 +149,45 @@ end
     end
 end
 
+# This testset uses the show(::IO, ::JuliaHub.ComputeConfig) representation of ComputeConfig,
+# makes sure it parses, and then also makes sure it parses into the same object (i.e. all
+# fields are restored accurately).
+function ComputeConfig_eval_tests(cc::JuliaHub.ComputeConfig)
+    cc_expr = Meta.parse(string(cc))
+    @test cc_expr.head == :call
+    @test cc_expr.args[1] == :(JuliaHub.ComputeConfig)
+    @test cc_expr.args[3].head == :call
+    # Indirectly, we're also testing the parsing of the nodespec() function
+    cc_eval = Mocking.apply(mocking_patch) do
+        eval(cc_expr)
+    end
+    @test cc_eval isa JuliaHub.ComputeConfig
+    for fieldname in fieldnames(JuliaHub.ComputeConfig)
+        @test getfield(cc_eval, fieldname) == getfield(cc, fieldname)
+    end
+end
+
 @testset "JuliaHub.ComputeConfig" begin
     let cc = JuliaHub.ComputeConfig(ns_cheapest)
         @test cc.nnodes_max === 1
         @test cc.nnodes_min === nothing
         @test cc.process_per_node === true
         @test cc.elastic === false
+        ComputeConfig_eval_tests(cc)
     end
     let cc = JuliaHub.ComputeConfig(ns_cheapest; nnodes = 5, elastic=true)
         @test cc.nnodes_max === 5
         @test cc.nnodes_min === nothing
         @test cc.process_per_node === true
         @test cc.elastic === true
+        ComputeConfig_eval_tests(cc)
     end
     let cc = JuliaHub.ComputeConfig(ns_cheapest; nnodes = (10, 20))
         @test cc.nnodes_max === 20
         @test cc.nnodes_min === 10
         @test cc.process_per_node === true
         @test cc.elastic === false
+        ComputeConfig_eval_tests(cc)
     end
     @test_throws ArgumentError JuliaHub.ComputeConfig(ns_cheapest; nnodes=-20)
     @test_throws ArgumentError JuliaHub.ComputeConfig(ns_cheapest; nnodes=(-5, 3))