Env Check: Re-enable validation of Spack build env context (#4)

The shell script version of the Spack compiler wrapper (in the main
Spack repo) validates that there is a well formed Spack env by testing
for the presence of environment variables. Re-enable the same
functionality in the MSVC wrapper. 

Additionally updates the MSVC wrapper validation to reflect the current
state of env validation in the sh wrapper.

Author: johnwparent

src/main.cxx

@@ -58,9 +58,9 @@ int main(int argc, const char* argv[]) {
     }
     else {
         // Ensure required variables are set
-        // if(!ValidateSpackEnv()) {
-        //     return -99;
-        // }
+        if(!ValidateSpackEnv()) {
+            return -99;
+        }
         // Determine which tool we're trying to run
         std::unique_ptr<ToolChainInvocation> tchain(ToolChainFactory::ParseToolChain(argv));
         if(!tchain) {

src/utils.cxx

@@ -206,27 +206,20 @@ StrList GetEnvList(const std::string &envVar, const std::string &delim) {
         return StrList();
 }
 
-int ValidateSpackEnv() {
+bool ValidateSpackEnv() {
     std::vector<std::string> SpackEnv{
-"SPACK_ENV_PATH",
+"SPACK_COMPILER_WRAPPER_PATH",
 "SPACK_DEBUG_LOG_DIR",
-// "SPACK_DEBUG_LOG_ID"
-"SPACK_COMPILER_SPEC",
-// "SPACK_CC_RPATH_ARG"
-// "SPACK_CXX_RPATH_ARG"
-// "SPACK_F77_RPATH_ARG"
-// "SPACK_FC_RPATH_ARG"
-// "SPACK_LINKER_ARG"
-// "SPACK_SHORT_SPEC"
+"SPACK_DEBUG_LOG_ID",
+"SPACK_SHORT_SPEC",
 "SPACK_SYSTEM_DIRS",
-"SPACK_CC",
-"SPACK_LD",};
+"SPACK_MANAGED_DIRS"};
     for(auto &var: SpackEnv)
         if(!getenv(var.c_str())){
             std::cerr << var + " isn't set in the environment and is expected to be\n";
-            return 0;
+            return false;
         }
-    return 1;
+    return true;
 }
 
 std::string stem(const std::string &file)
@@ -301,8 +294,9 @@ std::string LibraryFinder::FindLibrary(const std::string &lib_name, const std::s
     // next search the CWD
     std::string cwd(GetCWD());
     auto res = this->Finder(cwd, lib_name);
-    if (!res.empty())
-        return res;
+    if (!res.empty()){
+        return res;        
+    }
     this->EvalSearchPaths();
     if (this->evald_search_paths.empty()) {
         return std::string();
@@ -312,8 +306,9 @@ std::string LibraryFinder::FindLibrary(const std::string &lib_name, const std::s
         std::vector<std::string> searchable_paths = this->evald_search_paths.at(var);
         for (std::string pth: searchable_paths) {
             auto res = this->Finder(pth, lib_name);
-            if (!res.empty())
+            if (!res.empty()){
                 return res;
+            }
         }
     }
     return std::string();
@@ -324,8 +319,10 @@ void LibraryFinder::EvalSearchPaths() {
         return;
     for (std::string var: this->search_vars) {
         std::string envVal = GetSpackEnv(var.c_str());
-        if (!envVal.empty())
+        if (!envVal.empty()) {
             this->evald_search_paths[var] = split(envVal, ";");
+        }
+            
     }
 }
 

src/utils.h

@@ -29,7 +29,7 @@ typedef std::vector<std::string> StrList;
 std::string GetSpackEnv(const char* env);
 std::string GetSpackEnv(const std::string &env);
 StrList GetEnvList(const std::string &envVar, const std::string &delim = ";");
-int ValidateSpackEnv();
+bool ValidateSpackEnv();
 
 // String helper methods adding cxx20 features to cxx14 //
 

test/setup_and_drive_test.bat

@@ -11,10 +11,12 @@ FOR /F "tokens=* USEBACKQ" %%F IN (`where link`) DO (
 SET SPACK_LD=%%F
 )
 popd
-SET SPACK_ENV_PATH=%PATH%
+SET SPACK_COMPILER_WRAPPER_PATH=%~dp0..
 SET SPACK_DEBUG_LOG_DIR=%CD%
-SET SPACK_COMPILER_SPEC=%msvc
+SET SPACK_DEBUG_LOG_ID=TEST
+SET SPACK_SHORT_SPEC=test%msvc
 SET SPACK_SYSTEM_DIRS=%PATH%
+SET SPACK_MANAGED_DIRS=%CD%\tmp
 SET SPACK_RELOCATE_PATH=%CD%\tmp
 
 nmake test