Log warning message for disabled runtime checks

Complete type hints for RuntimeConfig class and log
a warning message for each disabled runtime check

Author: schaefi

kiwi/runtime_config.py

@@ -17,7 +17,9 @@
 #
 import os
 import logging
-from typing import Literal
+from typing import (
+    Literal, List, Optional
+)
 import yaml
 
 # project
@@ -49,7 +51,7 @@ class RuntimeConfig:
 
     :param bool reread: reread runtime config
     """
-    def __init__(self, reread=False):
+    def __init__(self, reread: bool = False):
         global RUNTIME_CONFIG
 
         if RUNTIME_CONFIG is None or reread:
@@ -75,7 +77,7 @@ def __init__(self, reread=False):
                 with open(config_file, 'r') as config:
                     RUNTIME_CONFIG = yaml.safe_load(config) or {}
 
-    def get_credentials_verification_metadata_signing_key_file(self):
+    def get_credentials_verification_metadata_signing_key_file(self) -> str:
         """
         Return verification metadata signing key file, used for
         signature creation of rootfs verification metadata:
@@ -95,7 +97,7 @@ def get_credentials_verification_metadata_signing_key_file(self):
         )
         return signing_key_file if signing_key_file else ''
 
-    def get_obs_download_server_url(self):
+    def get_obs_download_server_url(self) -> str:
         """
         Return URL of buildservice download server in:
 
@@ -115,7 +117,7 @@ def get_obs_download_server_url(self):
         return obs_download_server_url if obs_download_server_url else \
             Defaults.get_obs_download_server_url()
 
-    def get_obs_api_server_url(self):
+    def get_obs_api_server_url(self) -> str:
         """
         Return URL of buildservice API server in:
 
@@ -135,7 +137,7 @@ def get_obs_api_server_url(self):
         return obs_api_server_url if obs_api_server_url else \
             Defaults.get_obs_api_server_url()
 
-    def get_obs_api_credentials(self):
+    def get_obs_api_credentials(self) -> List[str]:
         """
         Return OBS API credentials if configured:
 
@@ -148,10 +150,9 @@ def get_obs_api_credentials(self):
         :rtype: list
         """
         obs_users = self._get_attribute(element='obs', attribute='user') or []
-        if obs_users:
-            return obs_users
+        return obs_users
 
-    def is_obs_public(self):
+    def is_obs_public(self) -> bool:
         """
         Check if the buildservice configuration is public or private in:
 
@@ -170,7 +171,7 @@ def is_obs_public(self):
             obs_public = True
         return bool(obs_public)
 
-    def get_package_changes(self, default=True):
+    def get_package_changes(self, default: bool = True) -> bool:
         """
         Return boolean value to express if the image build and bundle
         should contain a .changes file. The .changes file contains
@@ -201,7 +202,7 @@ def get_package_changes(self, default=True):
                 bundle_package_changes = default
         return bool(bundle_package_changes)
 
-    def get_bundle_compression(self, default=True):
+    def get_bundle_compression(self, default: bool = True) -> bool:
         """
         Return boolean value to express if the image bundle should
         contain XZ compressed image results or not.
@@ -229,7 +230,7 @@ def get_bundle_compression(self, default=True):
             bundle_compress = default
         return bool(bundle_compress)
 
-    def get_xz_options(self):
+    def get_xz_options(self) -> Optional[List[str]]:
         """
         Return list of XZ compression options in:
 
@@ -250,7 +251,7 @@ def get_xz_options(self):
         xz_options = self._get_attribute(element='xz', attribute='options')
         return xz_options.split() if xz_options else None
 
-    def get_container_compression(self):
+    def get_container_compression(self) -> bool:
         """
         Return compression for container images
 
@@ -281,7 +282,7 @@ def get_container_compression(self):
             )
             return Defaults.get_container_compression()
 
-    def get_iso_tool_category(self):
+    def get_iso_tool_category(self) -> str:
         """
         Return tool category which should be used to build iso images
 
@@ -341,7 +342,7 @@ def get_iso_media_tag_tool(self) -> Literal['checkmedia', 'isomd5sum']:
             )
             return Defaults.get_iso_media_tag_tool()
 
-    def get_oci_archive_tool(self):
+    def get_oci_archive_tool(self) -> str:
         """
         Return OCI archive tool which should be used on creation of
         container archives for OCI compliant images, e.g docker
@@ -361,7 +362,7 @@ def get_oci_archive_tool(self):
         )
         return oci_archive_tool or Defaults.get_oci_archive_tool()
 
-    def get_mapper_tool(self):
+    def get_mapper_tool(self) -> str:
         """
         Return partition mapper tool
 
@@ -380,7 +381,7 @@ def get_mapper_tool(self):
         )
         return part_mapper_tool or Defaults.get_part_mapper_tool()
 
-    def get_max_size_constraint(self):
+    def get_max_size_constraint(self) -> Optional[int]:
         """
         Returns the maximum allowed size of the built image. The value is
         returned in bytes and it is specified in build_constraints element
@@ -401,7 +402,7 @@ def get_max_size_constraint(self):
         )
         return StringToSize.to_bytes(max_size) if max_size else None
 
-    def get_disabled_runtime_checks(self):
+    def get_disabled_runtime_checks(self) -> List[str]:
         """
         Returns disabled runtime checks. Checks can be disabled with:
 
@@ -413,10 +414,12 @@ def get_disabled_runtime_checks(self):
         """
         disabled_checks = self._get_attribute(
             element='runtime_checks', attribute='disable'
-        )
-        return disabled_checks or ''
+        ) or []
+        for check in disabled_checks:
+            log.warning(f'Runtime check: {check}: disabled')
+        return disabled_checks
 
-    def _get_attribute(self, element, attribute):
+    def _get_attribute(self, element: str, attribute: str):
         if RUNTIME_CONFIG:
             try:
                 if element in RUNTIME_CONFIG:
@@ -428,5 +431,5 @@ def _get_attribute(self, element, attribute):
                     f'{type(issue).__name__}: {issue}'
                 )
 
-    def _home_path(self):
-        return os.environ.get('HOME')
+    def _home_path(self) -> str:
+        return os.environ.get('HOME') or ''

kiwi/system/result.py

@@ -20,7 +20,7 @@
 import pickle
 import os
 from typing import (
-    Dict, NamedTuple, TypeVar, Any
+    Dict, NamedTuple, TypeVar, Any, Optional
 )
 
 # project
@@ -190,7 +190,7 @@ def load(filename: str) -> result_type:  # type: ignore
             )
 
     @staticmethod
-    def verify_image_size(size_limit: int, filename: str) -> None:
+    def verify_image_size(size_limit: Optional[int], filename: str) -> None:
         """
         Verifies the given image file does not exceed the size limit.
         Throws an exception if the limit is exceeded. If the size limit