CM v2.2.0 release (#1227)

CM v2.2.0 release:
- fixed detection of a CM artifact using 'cm info .' when inside virtual
env entries.
- added "cmind.utils.debug_here" function to attach remote Python
debugger
     and tested with Visual Studio Code.
   - added test to avoid checking out CM repo that was not pulled
- added utils.safe_load_json to return empty dict if file doesn't exist
- added utils.compare_versions to check min version requirements for
automations and entries
- removed outdated convert_path
(mlcommons/ck#1219)
- added utils.check_if_true_yes_on
(mlcommons/ck#1216)
- check "min_cm_version" in CM automations and CM scripts (use _cm.yaml
or _cm.json)

cm/CHANGES.md

@@ -1,8 +1,13 @@
-## V2.1.2.1
+## V2.2.0
    - fixed detection of a CM artifact using 'cm info .' when inside virtual env entries.
    - added "cmind.utils.debug_here" function to attach remote Python debugger
      and tested with Visual Studio Code.
    - added test to avoid checking out CM repo that was not pulled
+   - added utils.safe_load_json to return empty dict if file doesn't exist
+   - added utils.compare_versions to check min version requirements for automations and entries
+   - removed outdated convert_path (https://github.com/mlcommons/ck/issues/1219)
+   - added utils.check_if_true_yes_on (https://github.com/mlcommons/ck/issues/1216)
+   - check "min_cm_version" in CM automations and CM scripts (use _cm.yaml or _cm.json)
 
 ## V2.1.2
    - added support for deps on other CM repos 

cm/cmind/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "2.1.2.1"
+__version__ = "2.2.0"
 
 from cmind.core import access
 from cmind.core import error

cm/cmind/core.py

@@ -584,6 +584,16 @@ def access(self, i, out = None):
 
             i['parsed_artifact'] = r['cm_object']
 
+        # Check min CM version requirement
+        min_cm_version = automation_meta.get('min_cm_version','').strip()
+        if min_cm_version != '':
+            from cmind import __version__ as current_cm_version
+            comparison = utils.compare_versions(current_cm_version, min_cm_version)
+            if comparison < 0:
+                return {'return':1, 'error':'CM automation requires CM version >= {} while current CM version is {} - please update using "pip install cmind -U"'.format(min_cm_version, current_cm_version)}
+
+
+
         # Call automation action
         action_addr=getattr(initialized_automation, action)
 

cm/cmind/utils.py

@@ -138,6 +138,37 @@ def save_json_or_yaml(file_name, meta, sort_keys=False, encoding = 'utf8'):
 
     return {'return':ERROR_UNKNOWN_FILE_EXTENSION, 'error':'unknown file extension'}
 
+###########################################################################
+def safe_load_json(path, file_name='', encoding='utf8'):
+    """
+    Load JSON file if exists, otherwise return empty dict
+
+    Args:    
+       (CM input dict):
+
+       file_name (str): file name
+       (encoding) (str): file encoding ('utf8' by default)
+
+    Returns:
+       (CM return dict):
+
+       * return (int): return code == 0 if no error and >0 if error
+       * (error) (str): error string if return>0
+
+       * meta (dict): meta from the file
+
+    """
+
+    path_to_file = os.path.join(path, file_name) if file_name == '' or path != file_name else path
+
+    meta = {}
+
+    r = load_json(path_to_file, check_if_exists=True, encoding=encoding)
+    if r['return'] == 0:
+        meta = r['meta']
+
+    return {'return':0, 'meta': meta}
+
 ###########################################################################
 def load_json(file_name, check_if_exists = False, encoding='utf8'):
     """
@@ -173,8 +204,7 @@ def load_json(file_name, check_if_exists = False, encoding='utf8'):
         except Exception as e:
             return {'return':4, 'error': format(e)}
 
-    return {'return':0,
-            'meta': meta}
+    return {'return':0, 'meta': meta}
 
 ###########################################################################
 def save_json(file_name, meta={}, indent=2, sort_keys=True, encoding = 'utf8'):
@@ -1679,3 +1709,76 @@ def breakpoint(self):
 
     # Go up outside this function to continue debugging (F11 in VS)
     return debugpy
+
+##############################################################################
+def compare_versions(version1, version2):
+    """
+    Compare versions
+
+    Args:    
+
+       version1 (str): version 1
+       version2 (str): version 2
+
+    Returns:
+       comparison (int):  1 - version 1 > version 2
+                          0 - version 1 == version 2
+                         -1 - version 1 < version 2
+    """
+
+    l_version1 = version1.split('.')
+    l_version2 = version2.split('.')
+
+    # 3.9.6 vs 3.9
+    # 3.9 vs 3.9.6
+
+    i_version1 = [int(v) if v.isdigit() else v for v in l_version1]
+    i_version2 = [int(v) if v.isdigit() else v for v in l_version2]
+
+    comparison = 0
+
+    for index in range(max(len(i_version1), len(i_version2))):
+        v1 = i_version1[index] if index < len(i_version1) else 0
+        v2 = i_version2[index] if index < len(i_version2) else 0
+
+        if v1 > v2:
+            comparison = 1
+            break
+        elif v1 < v2:
+            comparison = -1
+            break
+
+    return comparison
+
+##############################################################################
+def check_if_true_yes_on(env, key):
+    """
+    Universal check if str(env.get(key, '')).lower() in ['true', 'yes', 'on']:
+
+    Args:    
+
+       env (dict): dictionary
+       key (str): key
+
+    Returns:
+       True if str(env.get(key, '')).lower() in ['true', 'yes', 'on']:
+    """
+
+    return str(env.get(key, '')).lower() in ['true', 'yes', 'on']
+
+##############################################################################
+def check_if_none_false_no_off(env, key):
+    """
+    Universal check if str(env.get(key, '')).lower() in ['false', 'no', 'off']:
+
+    Args:    
+
+       env (dict): dictionary
+       key (str): key
+
+    Returns:
+       True if str(env.get(key, '')).lower() in ['false', 'no', 'off']:
+    """
+
+    return str(env.get(key, '')).lower() in ['none', 'false', 'no', 'off']
+

cm/setup.py

@@ -2,7 +2,7 @@
 import sys
 import re
 
-from setuptools import find_packages, setup, convert_path
+from setuptools import find_packages, setup
 
 try:
     from setuptools.command.install import install