Don't allow duplicates, just give direct dependencies higher priority for headers

Author: ocaisa

easybuild/tools/toolchain/toolchain.py

@@ -1206,7 +1206,7 @@ def _add_dependency_variables(self, names=None, cpp=None, ld=None):
                     # and only use the configured option
                     # (our RPATH wrappers rely on LIBRARY_PATH so we need an exception for that)
                     if env_var != 'LIBRARY_PATH':
-                        self.variables.append(env_var, '')
+                        self.variables.setdefault(env_var, append_empty=True)
             for var in SEARCH_PATH[search_path_var][self.search_path[search_path_var]]:
                 self.variables.append_subdirs(var, '', subdirs=paths_list)
 
@@ -1240,6 +1240,14 @@ def _add_dependency_cpp_headers(self, dep_root, extra_dirs=None):
             header_dirs = unique_ordered_extend(header_dirs, extra_dirs)
 
             self.log.info(f"Adding header paths to toolchain variable '{env_var}': {dep_root} (subdirs: {header_dirs})")
+            # it may already exist, in which case we remove it to add it back with higher priority
+            for header_dir in header_dirs:
+                self.log.debug(f"Existing variables are {self.variables.keys()}")
+                if env_var in self.variables.keys():
+                    header_path = os.path.join(dep_root, header_dir)
+                    self.log.debug(f"Attempting to remove any previous instance of {header_path} from {env_var} list: {self.variables[env_var]}")
+                    self.variables[env_var].try_remove([header_path])
+                    self.log.debug(f"New value of {env_var} list: {self.variables[env_var]}")
             self.variables.append_subdirs(env_var, dep_root, subdirs=header_dirs)
 
     def _add_dependency_linker_paths(self, dep_root, extra_dirs=None):

test/framework/easyblock.py

@@ -3797,12 +3797,12 @@ def test_exts_deps_build_env(self):
                     f'software/zlib/{zlib_fn}/include',
                 ]
                 if env_var.endswith('PATH'):
-                    regex = re.compile(f'^{env_var}=' + ':'.join('[^ ]+/' + p for p in paths), re.M)
+                    regex = re.compile(f'^{env_var}=' + ':'.join('[^ ]+/' + p for p in paths) + '$', re.M)
                 elif env_var == 'CPPFLAGS':
-                    regex = re.compile(f'^{env_var}=' + ' '.join('-I/[^ ]+/' + p for p in paths), re.M)
+                    regex = re.compile(f'^{env_var}=' + ' '.join('-I/[^ ]+/' + p for p in paths) + '$', re.M)
                 else:
                     self.fail(f"Unknown type of environment variable: ${env_var}")
-                self.assertTrue(regex.search(log_txt), f"Pattern '{regex.pattern}' not found in log output")
+                self.assertTrue(regex.search(log_txt), f"Pattern '{regex.pattern}' not found in log output \n{log_txt}")
 
         # verify fix made in https://github.com/easybuilders/easybuild-framework/pull/5048
         test_ec_txt = read_file(toy_ec)