Merge pull request #87 from ProjectTorreyPines/ind_tests

Individual testing without using ArgParse

Now to run individual tests, one can use
```
julia --project test/test.jl help
```
to see the options.

`test/runtests.jl` can not be called directly from outside now, it must be called through `Pkg.test()`.
It directly uses `ARGS` now, so we do not need to use ArgParse anymore.

`test/test.jl` uses Standard julia libraries only, so it can be called from project environment directly.

Author: anchal-physics

Project.toml

@@ -1,21 +1,18 @@
 name = "IMASggd"
 uuid = "b7b5e640-9b39-4803-84eb-376048795def"
 authors = ["Anchal Gupta <[email protected]>"]
-version = "3.3.1"
+version = "3.3.2"
 
 [deps]
-ArgParse = "c7e460c6-2fb9-53a9-8c5b-16f535851c63"
 ColorSchemes = "35d6a980-a343-548e-a6ea-1d62b119f2f4"
 IMASdd = "c5a45a97-b3f9-491c-b9a7-aa88c3bc0067"
 Interpolations = "a98d9a8b-a2ab-59e6-89dd-64a1c18fca59"
 NearestNeighbors = "b8a86587-4115-5ab1-83bc-aa920d37bbce"
 RecipesBase = "3cdcf5f2-1ef4-517c-9805-6587b60abb01"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
-Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [compat]
-ArgParse = "1"
 ColorSchemes = "3"
 IMASdd = "2, 3, 4, 5, 6, 7"
 Interpolations = "0.15, 0.16"

README.md

@@ -15,3 +15,56 @@ For installation:
 using Pkg
 Pkg.add("IMASggd")
 ```
+
+## For developers
+
+If you are contributing to this project, you would need to install [dvc](https://dvc.org/) to fetch sample files for testing. Once installed, please configure your ssh so that you can ssh into omega tunneling through cybele without requiring to enter password. This is optional but will make it much easier for you.
+
+Once you have completed above steps, inside the git repo, simply do:
+```bash
+dvc pull
+```
+
+This would download the sample files in the `samples` directory. Then to run tests, you would first need to instantiate the project:
+```bash
+julia --project
+```
+Then press `]`:
+```julia
+               _
+   _       _ _(_)_     |  Documentation: https://docs.julialang.org
+  (_)     | (_) (_)    |
+   _ _   _| |_  __ _   |  Type "?" for help, "]?" for Pkg help.
+  | | | | | | |/ _` |  |
+  | | |_| | | | (_| |  |  Version 1.11.5 (2025-04-14)
+ _/ |\__'_|_|_|\__'_|  |  Official https://julialang.org/ release
+|__/                   |
+
+julia> ]
+```
+Then type:
+```julia
+(IMASggd) pkg> instantiate
+```
+Once the package has been instantiated, you can run the tests using:
+```julia
+(IMASggd) pkg> test
+```
+This would run all the tests though. To run specific tests, you can do following from the command line to see help options (this works after you ahve instantiated the project like mentioned above):
+```bash
+% julia --project test/test.jl help
+Usage (from inside IMASggd.jl): 
+julia --project test/test.jl [interp] [projection] [in] [subset_tools] [types] [h] [help]
+
+Run tests. Default is all tests.
+
+Optional arguments:
+    interp       Test interp                    
+    projection   Test project_prop_on_subset!() 
+    in           Test ∈                         
+    subset_tools Test subset tools              
+    types        Test types                     
+    h            Show this help message and exit
+    help         Show this help message and exit
+
+```

test/Project.toml

@@ -0,0 +1,2 @@
+[deps]
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

test/runtests.jl

@@ -1,54 +1,18 @@
 import IMASggd:
     interp, get_kdtree, project_prop_on_subset!, get_grid_subset, get_grid_ggd,
-    get_subset_boundary, subset_do, deepcopy_subset, get_TPS_mats, get_space
-using IMASdd: IMASdd
-import Statistics: mean
+    get_subset_boundary, subset_do, deepcopy_subset, get_TPS_mats, get_space, IMASdd,
+    mean
 using Test
-using ArgParse: ArgParse
 
 allowed_rtol = 1e-4
 
-function parse_commandline()
-    s = ArgParse.ArgParseSettings(; description="Run tests. Default is all tests.")
-
-    ArgParse.add_arg_table!(s,
-        ["--interp"],
-        Dict(:help => "Test interp",
-            :action => :store_true),
-        ["--projection"],
-        Dict(:help => "Test project_prop_on_subset!()",
-            :action => :store_true),
-        ["--in"],
-        Dict(:help => "Test ∈",
-            :action => :store_true),
-        ["--interpeqt"],
-        Dict(:help => "Test interpolation of equilibrium time slice",
-            :action => :store_true),
-        ["--subset_tools"],
-        Dict(:help => "Test subset tools",
-            :action => :store_true),
-        ["--types"],
-        Dict(:help => "Test types",
-            :action => :store_true),
-    )
-    args = ArgParse.parse_args(s)
-    if !any(values(args)) # If no flags are set, run all tests
-        for k ∈ keys(args)
-            args[k] = true
-        end
-    end
-    return args
-end
-args = parse_commandline()
-
 print("json2imas() time: ")
 @time ids = IMASdd.json2imas(
     "$(@__DIR__)/../samples/time_dep_edge_profiles_last_step_only.json",
 )
 
-if args["interp"]
+if isempty(ARGS) || "interp" in ARGS
     @testset "interp" begin
-        # ids = h5i2imas("$(@__DIR__)/../samples/edge_profiles.h5")
         b2gmtry = "$(@__DIR__)/../samples/b2fgmtry"
         b2output = "$(@__DIR__)/../samples/b2time.nc"
         gsdesc = "$(@__DIR__)/../samples/gridspacedesc.yml"
@@ -156,8 +120,8 @@ if args["interp"]
     end
 end
 
-if args["projection"]
-    @testset "project_prop_on_subset!" begin
+if isempty(ARGS) || "projection" in ARGS
+    @testset "Test project_prop_on_subset!" begin
         prop = ids.edge_profiles.ggd[1].electrons.density
         # All cells
         from_subset = get_grid_subset(ids.edge_profiles.grid_ggd[1], -5)
@@ -205,8 +169,8 @@ if args["projection"]
     end
 end
 
-if args["subset_tools"]
-    @testset "test subset_tools" begin
+if isempty(ARGS) || "subset_tools" in ARGS
+    @testset "Test subset tools" begin
         grid_ggd = ids.edge_profiles.grid_ggd[1]
         space = grid_ggd.space[1]
 
@@ -280,8 +244,8 @@ if args["subset_tools"]
     end
 end
 
-if args["in"]
-    @testset "test ∈" begin
+if isempty(ARGS) || "in" in ARGS
+    @testset "Test ∈" begin
         grid_ggd = ids.edge_profiles.grid_ggd[1]
         space = grid_ggd.space[1]
         subset_corebnd = get_grid_subset(grid_ggd, 15)
@@ -297,8 +261,8 @@ if args["in"]
     end
 end
 
-if args["types"]
-    @testset "test types" begin
+if isempty(ARGS) || "types" in ARGS
+    @testset "Test types" begin
         grid_ggd = ids.edge_profiles.grid_ggd[1]
         resize!(ids.radiation.grid_ggd, 1)
         ids.radiation.grid_ggd[1].path = "edge_profiles/grid_ggd(1)"

test/test.jl

@@ -0,0 +1,82 @@
+
+using Pkg
+using Printf
+
+pkg_name = "IMASggd"
+
+valid_arguments = [
+    ("interp", "Test interp"),
+    ("projection", "Test project_prop_on_subset!()"),
+    ("in", "Test ∈"),
+    ("subset_tools", "Test subset tools"),
+    ("types", "Test types"),
+    ("h", "Show this help message and exit"),
+    ("help", "Show this help message and exit"),
+]
+
+function get_options_string(
+    valid_arguments::Vector{Tuple{String, String}};
+    indent::Int=4,
+)
+    keys_arr = [k for (k, v) ∈ valid_arguments]
+    values_arr = [v for (k, v) ∈ valid_arguments]
+
+    # Determine the maximum width of each column (keys and values)
+    max_width_keys = maximum(length.(string.(keys_arr)))
+    max_width_values = maximum(length.(string.(values_arr)))
+
+    # Create the format string with indentation
+    format_str = repeat(" ", indent) * "%-$(max_width_keys)s %-$(max_width_values)s\n"
+
+    # Create a Format object
+    fmt = Printf.Format(format_str)
+
+    # Build the combined string
+    combined_string = ""
+    for (key, value) ∈ valid_arguments
+        combined_string *= Printf.format(fmt, string(key), string(value))
+    end
+
+    return combined_string
+end
+
+function check_args(
+    args::Vector{String},
+    valid_arguments::Vector{Tuple{String, String}},
+)
+    valid_keys = Set(t[1] for t ∈ valid_arguments)
+
+    any_valid = false
+    for arg ∈ args
+        if arg in valid_keys
+            any_valid = true
+        else
+            println("Error: Invalid argument found: \"", arg, "\"")
+            println()
+            return false
+        end
+    end
+
+    if !any_valid && !isempty(args)
+        println("Error: No valid arguments found.")
+        return false
+    end
+    return true
+end
+
+usage_string = "Usage (from inside $(pkg_name).jl): \njulia --project test/test.jl "
+usage_string *= "[" * join([k for (k, v) ∈ valid_arguments], "] [") * "]\n\n"
+usage_string *= "Run tests. Default is all tests.\n\nOptional arguments:\n"
+usage_string *= get_options_string(valid_arguments)
+
+if "h" in ARGS || "help" in ARGS || !check_args(ARGS, valid_arguments)
+    println(usage_string)
+    exit()
+end
+try
+    Pkg.test("$(pkg_name)"; test_args=ARGS)
+catch e
+    println("Error occured.")
+    println(e)
+    println(usage_string)
+end