Merge pull request #30 from DilumAluthge-forks/dpa/project-depot-loadpath

By default, propagate `Base.active_project()`, `Base.LOAD_PATH`, and `Base.DEPOT_PATH` to the workers (but allow the user to override that behavior by specifying `JULIA_{PROJECT,LOAD_PATH,DEPOT_PATH}` in `params[:env]`)

Author: kleinhenz

src/slurmmanager.jl

@@ -73,12 +73,52 @@ elseif Base.VERSION < v"1.6.0"
 end
 
 function _new_environment_additions(params_env::Dict{String, String})
-  env2 = Dict{String, String}()
-  for (name, value) in pairs(params_env)
-    # For each key-value mapping in `params[:env]`, we respect that mapping and we pass it
-    # to the workers.
-    env2[name] = value
+  # For each key-value mapping in `params[:env]`, we respect that mapping and we pass it
+  # to the workers.
+  env2 = copy(params_env)
+
+  for name in ["JULIA_PROJECT", "JULIA_LOAD_PATH", "JULIA_DEPOT_PATH"]
+    if haskey(env2, name)
+      @debug "The user did specify $(name)=$(env2[name]) in the `env` kwarg to `addprocs()`. That value will be passed to the workers."
+    end
+  end
+
+  directory_separator = Sys.iswindows() ? ';' : ':'
+
+  # If the user did not specify `JULIA_PROJECT` in `params[:env]`, then we pass
+  # JULIA_PROJECT=Base.active_project() to the workers.
+  #
+  # This use case is commonly hit when the user does NOT set the `JULIA_PROJECT` environment
+  # variable but DOES start Julia with either `julia --project` or `julia --project=something`.
+  #
+  # https://github.com/kleinhenz/SlurmClusterManager.jl/issues/16
+  if !haskey(env2, "JULIA_PROJECT")
+    # Important note: We use Base.active_project() here.
+    # We do NOT use Base.ACTIVE_PROJECT[], because it is not part of Julia's public API.
+    env2["JULIA_PROJECT"] = Base.active_project()
+    @debug "Passing JULIA_PROJECT=Base.active_project()=$(env2["JULIA_PROJECT"]) to the workers"
   end
+
+  # If the user did not specify `JULIA_LOAD_PATH` in `params[:env]`, then we pass
+  # JULIA_LOAD_PATH=Base.LOAD_PATH to the workers.
+  #
+  # This is a bit of an edge case, and I doubt that most users will need it.
+  # But upstream Distributed.jl does it, so we might as well do it too.
+  if !haskey(env2, "JULIA_LOAD_PATH")
+    env2["JULIA_LOAD_PATH"] = join(Base.LOAD_PATH, directory_separator)
+    @debug "Passing JULIA_LOAD_PATH=Base.LOAD_PATH=$(env2["JULIA_LOAD_PATH"]) to the workers"
+  end
+
+  # If the user did not specify `JULIA_DEPOT_PATH` in `params[:env]`, then we pass
+  # JULIA_DEPOT_PATH=Base.DEPOT_PATH to the workers.
+  #
+  # This is a bit of an edge case, and I doubt that most users will need it.
+  # But upstream Distributed.jl does it, so we might as well do it too.
+  if !haskey(env2, "JULIA_DEPOT_PATH")
+    env2["JULIA_DEPOT_PATH"] = join(Base.DEPOT_PATH, directory_separator)
+    @debug "Passing JULIA_DEPOT_PATH=Base.DEPOT_PATH=$(env2["JULIA_DEPOT_PATH"]) to the workers"
+  end
+
   return env2
 end
 
@@ -91,12 +131,8 @@ function launch(manager::SlurmManager, params::Dict, instances_arr::Array, c::Co
         _srun_cmd_without_env = `srun -D $exehome $exename $exeflags --worker`
 
         @static if Base.VERSION >= v"1.6.0"
-          env_arr = params[:env]
           # Pass the key-value pairs from `params[:env]` to the `srun` command:
-          env2 = Dict{String,String}()
-          for (name, value) in pairs(Dict{String,String}(env_arr))
-            env2[name] = value
-          end
+          env2 = _new_environment_additions(Dict{String,String}(params[:env]))
           srun_cmd_with_env = addenv(_srun_cmd_without_env, env2)
         else
           # See discussion above for why we don't support this functionality on Julia 1.5 and earlier.