Add os_purpose field and output info.

I had to do some improvements how we check mandatory and non-mandatory
properties.
- We had no way to count warnings for properties. Address this by having
  a Property.check() function that returns a pair (ok, nowarn) and then
  wrappers is_ok() and is_nowarn().
- Prefix missing mandatory images with ERROR (as they are counted as
  such).
- When in verbose mode, still report no of errors and warns of img.

Signed-off-by: Kurt Garloff <[email protected]>

Author: garloff

Tests/iaas/image-metadata/image-md-check.py

@@ -91,38 +91,56 @@ def __init__(self, name, mand, values, desc = ""):
         else:
             self.desc = name
 
-    def is_ok(self, props, warn = ""):
+    def check(self, props, warn):
         "Check validity of properties"
         if self.name in props:
+            # Property exists but is not in allowed value list => ERROR
             if self.values and not props[self.name] in self.values:
                 if warn:
                     print(f'ERROR: Image "{warn}": value "{props[self.name]}" for property '
                           f'"{self.name}" not allowed', file=sys.stderr)
-                return False
-            if not props[self.name] and not self.values:
-                err = "ERROR"
-                ret = False
+                return (False, True)
+            # Non-empty: OK
+            if props[self.name]:
+                return (True, True)
+            # Empty property without an allowed value list => ERROR
+            if not self.values:
+                ok = True
             else:
-                err = "WARNING"
-                ret = True
-            if not props[self.name] and (verbose or not self.values) and warn:
-                print(f'{err}: Image "{warn}": empty value for property "{self.name}" not recommended',
+                ok = False
+            # Property empty => WARN (or ERROR if no allowed value list)
+            if (verbose or not self.values) and warn:
+                errstr = "WARNING" if ok else "ERROR"
+                print(f'{errstr}: Image "{warn}": empty value for property "{self.name}" not recommended',
                       file=sys.stderr)
-            return ret
+            return (ok, not ok)
+        # Property does not exist but is mandatory => ERROR
         if self.ismand:
             if warn:
                 print(f'ERROR: Image "{warn}": Mandatory property "{self.name}" is missing',
                       file=sys.stderr)
-            return False
+            return (False, True)
+        # Property does not exist => WARN/INFO
         if warn and verbose:
             print(f'INFO: Image "{warn}": Optional property "{self.name}" is missing')  # , file=sys.stderr)
-        return True
+        return (True, False)
+
+    def is_ok(self, props, warn = ""):
+        "Return True if no hard error is found"
+        ok, nowarn = self.check(props, warn)
+        return ok
+
+    def is_nowarn(self, props, warn = ""):
+        "Return True if nothing to warn about is found"
+        ok, nowarn = self.check(props, warn)
+        return nowarn
 
 
 # From the image metadata specification
 # https://github.com/SovereignCloudStack/Docs/blob/main/Design-Docs/Image-Properties-Spec.md
 os_props = (Property("os_distro", True, ()),
-            Property("os_version", True, ()))
+            Property("os_version", True, ()),
+            Property("os_purpose", False, ("generic", "minimal", "k8snode", "gpu", "network", "custom")))
 arch_props = (Property("architecture", True, ("x86_64", "aarch64", "risc-v"), "CPU architecture"),
               Property("hypervisor_type", True, ("qemu", "kvm", "xen", "hyper-v", "esxi", None)))
 hw_props = (Property("hw_rng_model", False, ("virtio", None), "Random Number Generator"),
@@ -204,16 +222,24 @@ def validate_imageMD(img, outd_list):
     # Now the hard work: Look at properties ....
     errors = 0
     warnings = 0
-    # (1) recommended os_* and hw_*
+    # (1) mandatory and recommended os_* and hw_*
     # (4) image_build_date, image_original_user, image_source (opt image_description)
     # (5) maintained_until, provided_until, uuid_validity, replace_frequency
     for prop in (*os_props, *arch_props, *hw_props):
         if not prop.is_ok(img, imgnm):
             errors += 1
+        elif not prop.is_nowarn(img, ""):
+            warnings += 1
+    # We do not count missing optional fields in these
     for prop in (*build_props, *maint_props):
         if not prop.is_ok(img.properties, imgnm):
             errors += 1
+    # Construct a name from os_distro and os_version
     constr_name = f"{img.os_distro} {img.os_version}"
+    # TODO: Could add warnings for
+    # - os_distro not being all-lowercase (they all should be acc. to
+    #   https://docs.openstack.org/glance/2025.1/admin/useful-image-properties.html
+    # - os_version not matching regexp r'[0-9\.]*' (should be a numeric version no)
     # (3) os_hash
     if img.hash_algo not in ('sha256', 'sha512'):
         print(f'WARNING: Image "{imgnm}": no valid hash algorithm {img.hash_algo}', file=sys.stderr)
@@ -278,9 +304,9 @@ def validate_imageMD(img, outd_list):
         outd_list.append(imgnm)
     elif outd:
         outd_list.append(imgnm)
-    # (2) sanity min_ram (>=64), min_disk (>= size)
-    if img.min_ram < 64:
-        print(f'WARNING: Image "{imgnm}": min_ram == {img.min_ram} MiB < 64 MiB', file=sys.stderr)
+    # (2) sanity min_ram (>=32), min_disk (>= size)
+    if img.min_ram < 32:
+        print(f'WARNING: Image "{imgnm}": min_ram == {img.min_ram} MiB < 32 MiB', file=sys.stderr)
         warnings += 1
     if not img.min_ram:
         print(f'ERROR: Image "{imgnm}": min_ram == 0', file=sys.stderr)
@@ -304,6 +330,8 @@ def validate_imageMD(img, outd_list):
 
     if not errors and verbose:
         print(f'Image "{imgnm}": All good ({warnings} warnings)')
+    elif verbose:
+        print(f'Image "{imgnm}": {errors} errors and {warnings} warnings')
     return errors
 
 
@@ -313,7 +341,7 @@ def report_stdimage_coverage(imgs):
     for inm in mand_images:
         if inm not in imgs:
             err += 1
-            print(f'WARNING: Mandatory image "{inm}" is missing', file=sys.stderr)
+            print(f'ERROR: Mandatory image "{inm}" is missing', file=sys.stderr)
     for inm in (*rec1_images, *rec2_images):
         if inm not in imgs:
             print(f'INFO: Recommended image "{inm}" is missing', file=sys.stderr)