Re-enable artifact generation on Windows. (#408)

* Makes the existing `optional=` tag able to take an OS name like
"windows" or "linux" in order to control optionality in a system
specific way.

Progress on #36

Author: stellaraccident

CMakeLists.txt

@@ -370,7 +370,4 @@ endif()
 # Finalization
 ################################################################################
 therock_subproject_merge_compile_commands()
-if(NOT WIN32)
-  # TODO(#36): Enable on Windows (base/artifact.toml includes rocm_smi_lib that is excluded on Windows)
-  therock_create_dist()
-endif()
+therock_create_dist()

base/artifact.toml

@@ -4,10 +4,15 @@
 
 # rocm_smi_lib
 [components.dbg."base/rocm_smi_lib/stage"]
+optional = "windows"
 [components.dev."base/rocm_smi_lib/stage"]
+optional = "windows"
 [components.doc."base/rocm_smi_lib/stage"]
+optional = "windows"
 [components.lib."base/rocm_smi_lib/stage"]
+optional = "windows"
 [components.run."base/rocm_smi_lib/stage"]
+optional = "windows"
 include = [
   "bin/**",
   "libexec/**",
@@ -30,11 +35,17 @@ include = "libexec/**"
 
 # rocprofiler-register
 [components.dbg."base/rocprofiler-register/stage"]
+optional = "windows"
 [components.dev."base/rocprofiler-register/stage"]
+optional = "windows"
 [components.doc."base/rocprofiler-register/stage"]
+optional = "windows"
 [components.lib."base/rocprofiler-register/stage"]
+optional = "windows"
 [components.run."base/rocprofiler-register/stage"]
+optional = "windows"
 [components.test."base/rocprofiler-register/stage"]
+optional = "windows"
 include = [
   "share/rocprofiler-register/tests/**",
 ]

build_tools/fileset_tool.py

@@ -16,6 +16,7 @@
 from typing import Callable
 import argparse
 from pathlib import Path
+import platform
 import sys
 import shutil
 import tarfile
@@ -25,6 +26,26 @@
 from _therock_utils.pattern_match import PatternMatcher
 
 
+def evaluate_optional(optional_value) -> bool:
+    """Returns true if the given value should be considered optional on this platform.
+
+    It can be either a str, list of str, or a truthy value. If a str/list, then it will
+    return true if any of the strings match the case insensitive
+    `platform.system()`.
+    """
+    if optional_value is None:
+        return False
+    if isinstance(optional_value, str):
+        optional_value = [optional_value]
+    if isinstance(optional_value, list):
+        system_name = platform.system().lower()
+        for v in optional_value:
+            if str(v).lower() == system_name:
+                return True
+        return False
+    return bool(optional_value)
+
+
 class ComponentDefaults:
     """Defaults for to apply to artifact merging by component name."""
 
@@ -135,7 +156,11 @@ def do_artifact(args):
                         matched, force inclusion, regardless of whether they match
                         an exclude pattern.
                     "optional": if true and the directory does not exist, it
-                      is not an error. Use for optionally built projects
+                      is not an error. Use for optionally built projects. This
+                      can also be either a string or array of strings, which
+                      are interpreted as a platform name. If the case-insensitive
+                      `platform.system()` equals one of them, then it is
+                      considered optional.
 
     Most sections can typically be blank because by default they use
     component specific include/exclude patterns (see `COMPONENT_DEFAULTS` above)
@@ -164,7 +189,7 @@ def do_artifact(args):
     for basedir_relpath, basedir_record in component_record.items():
         use_default_patterns = basedir_record.get("default_patterns", True)
         basedir = args.root_dir / Path(basedir_relpath)
-        optional = basedir_record.get("optional")
+        optional = evaluate_optional(basedir_record.get("optional"))
         if optional and not basedir.exists():
             continue
         all_basedir_relpaths.append(basedir_relpath)

third-party/sysdeps/windows/artifact.toml

@@ -3,5 +3,5 @@
 [components.lib."third-party/sysdeps/windows/sqlite3/build/stage"]
 
 # zlib
-[components.dev."third-party/sysdeps/linux/zlib/build/stage"]
-[components.lib."third-party/sysdeps/linux/zlib/build/stage"]
+[components.dev."third-party/sysdeps/windows/zlib/build/stage"]
+[components.lib."third-party/sysdeps/windows/zlib/build/stage"]