netcdf packages: filter compiler wrappers in the *-config files (#33025)

* netcdf packages: filter compiler wrappers in the *-config files

* netcdf-c: provide dependent packages with unfiltered nc-config

3 files changed, 26 insertions, 0 deletions

diff --git a/var/spack/repos/builtin/packages/netcdf-c/package.py b/var/spack/repos/builtin/packages/netcdf-c/package.py
index ec84339b48..55eb3e4b71 100644
--- a/var/spack/repos/builtin/packages/netcdf-c/package.py
+++ b/var/spack/repos/builtin/packages/netcdf-c/package.py
@@ -131,6 +131,8 @@ class NetcdfC(AutotoolsPackage):
     conflicts("+parallel-netcdf", when="@:4.0")
     conflicts("+hdf4", when="@:4.0")
 
+    filter_compiler_wrappers("nc-config", relative_root="bin")
+
     @property
     def force_autoreconf(self):
         # The patch for 4.7.0 touches configure.ac.
@@ -245,6 +247,22 @@ class NetcdfC(AutotoolsPackage):
 
         return config_args
 
+    def setup_dependent_build_environment(self, env, dependent_spec):
+        # Some packages, e.g. ncview, refuse to build if the compiler path returned by nc-config
+        # differs from the path to the compiler that the package should be built with. Therefore,
+        # we have to shadow nc-config from self.prefix.bin, which references the real compiler,
+        # with a backed up version, which references Spack compiler wrapper.
+        if os.path.exists(self._nc_config_backup_dir):
+            env.prepend_path("PATH", self._nc_config_backup_dir)
+
+    @run_after("install")
+    def backup_nc_config(self):
+        # We expect this to be run before filter_compiler_wrappers:
+        nc_config_file = self.prefix.bin.join("nc-config")
+        if os.path.exists(nc_config_file):
+            mkdirp(self._nc_config_backup_dir)
+            install(nc_config_file, self._nc_config_backup_dir)
+
     def check(self):
         # h5_test fails when run in parallel
         make("check", parallel=False)
@@ -253,3 +271,7 @@ class NetcdfC(AutotoolsPackage):
     def libs(self):
         shared = "+shared" in self.spec
         return find_libraries("libnetcdf", root=self.prefix, shared=shared, recursive=True)
+
+    @property
+    def _nc_config_backup_dir(self):
+        return join_path(self.metadata_dir, "spack-nc-config")
diff --git a/var/spack/repos/builtin/packages/netcdf-cxx4/package.py b/var/spack/repos/builtin/packages/netcdf-cxx4/package.py
index 9cac19aa7b..4f1ced35a9 100644
--- a/var/spack/repos/builtin/packages/netcdf-cxx4/package.py
+++ b/var/spack/repos/builtin/packages/netcdf-cxx4/package.py
@@ -29,6 +29,8 @@ class NetcdfCxx4(AutotoolsPackage):
 
     depends_on("doxygen", when="+doc", type="build")
 
+    filter_compiler_wrappers("ncxx4-config", relative_root="bin")
+
     def flag_handler(self, name, flags):
         if name == "cflags" and "+pic" in self.spec:
             flags.append(self.compiler.cc_pic_flag)
diff --git a/var/spack/repos/builtin/packages/netcdf-fortran/package.py b/var/spack/repos/builtin/packages/netcdf-fortran/package.py
index 63c8c016b2..69f4b51a3c 100644
--- a/var/spack/repos/builtin/packages/netcdf-fortran/package.py
+++ b/var/spack/repos/builtin/packages/netcdf-fortran/package.py
@@ -62,6 +62,8 @@ class NetcdfFortran(AutotoolsPackage):
     # derived from https://github.com/Unidata/netcdf-fortran/pull/211
     patch("no_parallel_build.patch", when="@4.5.2")
 
+    filter_compiler_wrappers("nf-config", relative_root="bin")
+
     def flag_handler(self, name, flags):
         if name == "cflags":
             if "+pic" in self.spec: