rename cpp-headers-search-path option to search-path-cpp-headers

Author: lexming

easybuild/tools/config.py

@@ -206,7 +206,6 @@ def mk_full_default_path(name, prefix=DEFAULT_PREFIX):
         'backup_modules',
         'banned_linked_shared_libs',
         'checksum_priority',
-        'cpp_headers_search_path',
         'container_config',
         'container_image_format',
         'container_image_name',
@@ -262,6 +261,7 @@ def mk_full_default_path(name, prefix=DEFAULT_PREFIX):
         'rpath_filter',
         'rpath_override_dirs',
         'required_linked_shared_libs',
+        'search_path_cpp_headers',
         'skip',
         'software_commit',
         'stop',

easybuild/tools/options.py

@@ -101,7 +101,7 @@
 from easybuild.tools.run import run_shell_cmd
 from easybuild.tools.package.utilities import avail_package_naming_schemes
 from easybuild.tools.toolchain.compiler import DEFAULT_OPT_LEVEL, OPTARCH_MAP_CHAR, OPTARCH_SEP, Compiler
-from easybuild.tools.toolchain.toolchain import CPP_HEADERS_SEARCH_PATHS, DEFAULT_CPP_HEADERS_SEARCH_PATH
+from easybuild.tools.toolchain.toolchain import SEARCH_PATH_CPP_HEADERS, DEFAULT_SEARCH_PATH_CPP_HEADERS
 from easybuild.tools.toolchain.toolchain import SYSTEM_TOOLCHAIN_NAME
 from easybuild.tools.repository.repository import avail_repositories
 from easybuild.tools.systemtools import DARWIN, UNKNOWN, check_python_version, get_cpu_architecture, get_cpu_family
@@ -376,8 +376,6 @@ def override_options(self):
                                   'choice', 'store_or_None', DEFAULT_CHECKSUM_PRIORITY, CHECKSUM_PRIORITY_CHOICES),
             'cleanup-builddir': ("Cleanup build dir after successful installation.", None, 'store_true', True),
             'cleanup-tmpdir': ("Cleanup tmp dir after successful run.", None, 'store_true', True),
-            'cpp-headers-search-path': ("Search path used by EasyBuild to inject include directories", 'choice',
-                                        'store', DEFAULT_CPP_HEADERS_SEARCH_PATH, [*CPP_HEADERS_SEARCH_PATHS]),
             'color': ("Colorize output", 'choice', 'store', fancylogger.Colorize.AUTO, fancylogger.Colorize,
                       {'metavar': 'WHEN'}),
             'consider-archived-easyconfigs': ("Also consider archived easyconfigs", None, 'store_true', False),
@@ -626,6 +624,8 @@ def config_options(self):
                                 "(is passed as list of arguments to create the repository instance). "
                                 "For more info, use --avail-repositories."),
                                'strlist', 'store', self.default_repositorypath),
+            'search-path-cpp-headers': ("Search path used at build time for include directories", 'choice',
+                                        'store', DEFAULT_SEARCH_PATH_CPP_HEADERS, [*SEARCH_PATH_CPP_HEADERS]),
             'sourcepath': ("Path(s) to where sources should be downloaded (string, colon-separated)",
                            None, 'store', mk_full_default_path('sourcepath')),
             'subdir-modules': ("Installpath subdir for modules", None, 'store', DEFAULT_PATH_SUBDIRS['subdir_modules']),

easybuild/tools/toolchain/compiler.py

@@ -93,7 +93,7 @@ class Compiler(Toolchain):
         'vectorize': (None, "Enable compiler auto-vectorization, default except for noopt and lowopt"),
         'packed-linker-options': (False, "Pack the linker options as comma separated list"),  # ScaLAPACK mainly
         'rpath': (True, "Use RPATH wrappers when --rpath is enabled in EasyBuild configuration"),
-        'cpp-headers-search-path': (None, "Search path used by EasyBuild to inject include directories"),
+        'search-path-cpp-headers': (None, "Search path used at build time for include directories"),
         'extra_cflags': (None, "Specify extra CFLAGS options."),
         'extra_cxxflags': (None, "Specify extra CXXFLAGS options."),
         'extra_fflags': (None, "Specify extra FFLAGS options."),

easybuild/tools/toolchain/toolchain.py

@@ -97,15 +97,15 @@
 ]
 # modes to handle CPP header search paths
 # see: https://gcc.gnu.org/onlinedocs/cpp/Environment-Variables.html
-CPP_HEADERS_SEARCH_PATH_FLAGS = "CPPFLAGS"
-CPP_HEADERS_SEARCH_PATH_CPATH = "CPATH"
-CPP_HEADERS_SEARCH_PATH_INCLUDE = "INCLUDE_PATHS"
-CPP_HEADERS_SEARCH_PATHS = {
-    CPP_HEADERS_SEARCH_PATH_FLAGS: ["CPPFLAGS"],
-    CPP_HEADERS_SEARCH_PATH_CPATH: ["CPATH"],
-    CPP_HEADERS_SEARCH_PATH_INCLUDE: ["C_INCLUDE_PATH", "CPLUS_INCLUDE_PATH", "OBJC_INCLUDE_PATH"],
+SEARCH_PATH_CPP_HEADERS_FLAGS = "CPPFLAGS"
+SEARCH_PATH_CPP_HEADERS_CPATH = "CPATH"
+SEARCH_PATH_CPP_HEADERS_INCLUDE = "INCLUDE_PATHS"
+SEARCH_PATH_CPP_HEADERS = {
+    SEARCH_PATH_CPP_HEADERS_FLAGS: ["CPPFLAGS"],
+    SEARCH_PATH_CPP_HEADERS_CPATH: ["CPATH"],
+    SEARCH_PATH_CPP_HEADERS_INCLUDE: ["C_INCLUDE_PATH", "CPLUS_INCLUDE_PATH", "OBJC_INCLUDE_PATH"],
 }
-DEFAULT_CPP_HEADERS_SEARCH_PATH = CPP_HEADERS_SEARCH_PATH_FLAGS
+DEFAULT_SEARCH_PATH_CPP_HEADERS = SEARCH_PATH_CPP_HEADERS_FLAGS
 
 
 def is_system_toolchain(tc_name):
@@ -1090,26 +1090,26 @@ def _add_dependency_cpp_headers(self, dep_root, extra_dirs=None):
             header_dirs.extend(extra_dirs)
         header_dirs = set(header_dirs)  # remove duplicates
 
-        # mode of operation is defined by cpp-headers-search-path option
+        # mode of operation is defined by search-path-cpp-headers option
         # toolchain option has precedence over build option
-        cpp_headers_mode = DEFAULT_CPP_HEADERS_SEARCH_PATH
-        tc_opt = self.options.option("cpp-headers-search-path")
+        cpp_headers_mode = DEFAULT_SEARCH_PATH_CPP_HEADERS
+        tc_opt = self.options.option("search-path-cpp-headers")
         if tc_opt is not None:
-            self.log.debug("cpp-headers-search-path set by toolchain option: %s", cpp_headers_mode)
+            self.log.debug("search-path-cpp-headers set by toolchain option: %s", cpp_headers_mode)
             cpp_headers_mode = tc_opt
         else:
-            build_opt = build_option("cpp_headers_search_path")
+            build_opt = build_option("search_path_cpp_headers")
             if build_opt is not None:
-                self.log.debug("cpp-headers-search-path set by build option: %s", cpp_headers_mode)
+                self.log.debug("search-path-cpp-headers set by build option: %s", cpp_headers_mode)
                 cpp_headers_mode = build_opt
 
-        if cpp_headers_mode not in CPP_HEADERS_SEARCH_PATHS:
+        if cpp_headers_mode not in SEARCH_PATH_CPP_HEADERS:
             raise EasyBuildError(
-                "Unknown value selected for option cpp-headers-search-path. Choose one of: %s",
-                ", ".join(CPP_HEADERS_SEARCH_PATHS)
+                "Unknown value selected for option search-path-cpp-headers. Choose one of: %s",
+                ", ".join(SEARCH_PATH_CPP_HEADERS)
             )
 
-        for env_var in CPP_HEADERS_SEARCH_PATHS[cpp_headers_mode]:
+        for env_var in SEARCH_PATH_CPP_HEADERS[cpp_headers_mode]:
             self.log.debug("Adding header paths to toolchain variable '%s': %s", env_var, dep_root)
             self.variables.append_subdirs(env_var, dep_root, subdirs=header_dirs)
 

test/framework/toolchain.py

@@ -955,46 +955,46 @@ def test_precision_flags(self):
 
                 self.modtool.purge()
 
-    def test_cpp_headers_search_path(self):
-        """Test functionality behind cpp-headers-search-path option"""
+    def test_search_path_cpp_headers(self):
+        """Test functionality behind search-path-cpp-headers option"""
         cpp_headers_mode = {
             "CPPFLAGS": ["CPPFLAGS"],
             "CPATH": ["CPATH"],
             "INCLUDE_PATHS": ["C_INCLUDE_PATH", "CPLUS_INCLUDE_PATH", "OBJC_INCLUDE_PATH"],
         }
         # test without toolchain option
         for build_opt in cpp_headers_mode:
-            init_config(build_options={"cpp_headers_search_path": build_opt, "silent": True})
+            init_config(build_options={"search_path_cpp_headers": build_opt, "silent": True})
             tc = self.get_toolchain("foss", version="2018a")
             with self.mocked_stdout_stderr():
                 tc.prepare()
                 for env_var in cpp_headers_mode[build_opt]:
                     assert_fail_msg = (
-                        f"Variable {env_var} required by cpp-headers-search-path build option '{build_opt}' "
+                        f"Variable {env_var} required by search-path-cpp-headers build option '{build_opt}' "
                         "not found in toolchain environment"
                     )
                     self.assertIn(env_var, [*tc.variables], assert_fail_msg)
                 self.modtool.purge()
         # test with toolchain option
         for build_opt in cpp_headers_mode:
-            init_config(build_options={"cpp_headers_search_path": build_opt, "silent": True})
+            init_config(build_options={"search_path_cpp_headers": build_opt, "silent": True})
             for tc_opt in cpp_headers_mode:
                 tc = self.get_toolchain("foss", version="2018a")
-                tc.set_options({"cpp-headers-search-path": tc_opt})
+                tc.set_options({"search-path-cpp-headers": tc_opt})
                 with self.mocked_stdout_stderr():
                     tc.prepare()
                     for env_var in cpp_headers_mode[tc_opt]:
                         assert_fail_msg = (
-                            f"Variable {env_var} required by cpp-headers-search-path toolchain option '{tc_opt}' "
+                            f"Variable {env_var} required by search-path-cpp-headers toolchain option '{tc_opt}' "
                             "not found in toolchain environment"
                         )
                         self.assertIn(env_var, [*tc.variables], assert_fail_msg)
                 self.modtool.purge()
         # test wrong toolchain option
         tc = self.get_toolchain("foss", version="2018a")
-        tc.set_options({"cpp-headers-search-path": "WRONG_MODE"})
+        tc.set_options({"search-path-cpp-headers": "WRONG_MODE"})
         with self.mocked_stdout_stderr():
-            error_pattern = "Unknown value selected for option cpp-headers-search-path"
+            error_pattern = "Unknown value selected for option search-path-cpp-headers"
             self.assertErrorRegex(EasyBuildError, error_pattern, tc.prepare)
         self.modtool.purge()