Add flag to 'spack stack create env' to promote warnings to errors (--treat-warnings-as-errors)

Author: climbfuji

spack-ext/lib/jcsda-emc/spack-stack/stack/cmd/stack_cmds/create.py

@@ -151,6 +151,11 @@ def setup_env_parser(subparser):
         help="Do not filter site/compilers.yaml (default is filter out different compiler versions of the same name)"
     )
 
+    subparser.add_argument(
+        "--treat-warnings-as-errors",
+        action='store_true',
+        help="Promote warnings from 'spack stack create env' to errors"
+    )
 
 def setup_create_parser(subparser):
     sp = subparser.add_subparsers(metavar="SUBCOMMAND", dest="env_type")
@@ -187,6 +192,7 @@ def dict_from_args(args):
     dict["modifypkg"] = args.modify_pkg
     dict["compiler"] = args.compiler
     dict["keep_all_compilers"] = args.keep_all_compilers
+    dict["treat_warnings_as_errors"] = args.treat_warnings_as_errors
 
     return dict
 

spack-ext/lib/jcsda-emc/spack-stack/stack/stack_env.py

@@ -111,6 +111,7 @@ def __init__(self, **kwargs):
         self.upstreams = kwargs.get("upstreams", None)
         self.modifypkg = kwargs.get("modifypkg", None)
         self.keepallcompilers = kwargs.get("keep_all_compilers", None)
+        self.treatwarningsaserrors = kwargs.get("treat_warnings_as_errors", None)
 
         if not self.name:
             # site = self.site if self.site else 'default'
@@ -187,7 +188,10 @@ def _copy_common_includes(self):
         (compiler_name, _) = compiler_name_and_version_from_string(self.compiler)
         packages_compiler_yaml_path = os.path.join(common_path, f"packages_{compiler_name}.yaml")
         if not os.path.exists(packages_compiler_yaml_path):
-            logging.warning(f"\nWARNING: {packages_compiler_yaml_path} not found, please check if this is correct\n")
+            if self.treatwarningsaserrors:
+                raise Exception(f"\n{packages_compiler_yaml_path} not found, please check if this is correct\n")
+            else:
+                logging.warning(f"\nWARNING: {packages_compiler_yaml_path} not found, please check if this is correct\n")
         destination = os.path.join(env_common_dir, "packages.yaml")
         self._copy_or_merge_includes("packages", packages_yaml_path, packages_compiler_yaml_path, destination)
 
@@ -222,7 +226,10 @@ def _copy_site_includes(self):
         packages_yaml_path = os.path.join(site_path, "packages.yaml")
         packages_compiler_yaml_path = os.path.join(site_path, f"packages_{self.compiler}.yaml")
         if not os.path.exists(packages_compiler_yaml_path):
-            logging.warning(f"\nWARNING: {packages_compiler_yaml_path} not found, please check if this is correct\n")
+            if self.treatwarningsaserrors:
+                raise Exception(f"\n{packages_compiler_yaml_path} not found, please check if this is correct\n")
+            else:
+                logging.warning(f"\nWARNING: {packages_compiler_yaml_path} not found, please check if this is correct\n")
         destination = os.path.join(env_site_dir, "packages.yaml")
         self._copy_or_merge_includes("packages", packages_yaml_path, packages_compiler_yaml_path, destination)
 

spack-ext/lib/jcsda-emc/spack-stack/tests/test_stack_create.py

@@ -317,8 +317,24 @@ def test_modifypkg():
     netcdfc_spack_path = spack_cmd(
         "--env-dir", env_dir, "location", "--package-dir", "netcdf_c", output=str
     ).strip()
-    print("DH DEBUG 1:", os.path.join(spack.config.get("repos")['builtin'], "packages/netcdf_c"))
-    print("DH DEBUG 2:", netcdfc_spack_path)
     assert (
         os.path.join(spack.config.get("repos")['builtin'].replace("${SPACK_STACK_DIR}", os.getenv("SPACK_STACK_DIR")), "packages/netcdf_c") == netcdfc_spack_path
     ), "Incorrect netcdf-c location in modifypkg_test"
+
+@pytest.mark.extension("stack")
+@pytest.mark.filterwarnings("ignore::UserWarning")
+def test_treatwarningsaserrors():
+    with pytest.raises(Exception, match="packages_fj.yaml not found"):
+        stack_create(
+            "create",
+            "env",
+            "--site",
+            "blueback",
+            "--name",
+            "treatwarningsaserrors_test",
+            "--dir",
+            test_dir,
+            "--compiler",
+            "fj",
+            "--treat-warnings-as-errors"
+        )