feat: custom defined MIoT-Spec-V2 instance (#953)

test/check_rule_format.py

@@ -15,14 +15,13 @@ TRANS_RELATIVE_PATH: str = path.join(
 MIOT_I18N_RELATIVE_PATH: str = path.join(
     ROOT_PATH, '../custom_components/xiaomi_home/miot/i18n')
 SPEC_BOOL_TRANS_FILE = path.join(
-    ROOT_PATH,
-    '../custom_components/xiaomi_home/miot/specs/bool_trans.yaml')
+    ROOT_PATH, '../custom_components/xiaomi_home/miot/specs/bool_trans.yaml')
 SPEC_FILTER_FILE = path.join(
-    ROOT_PATH,
-    '../custom_components/xiaomi_home/miot/specs/spec_filter.yaml')
+    ROOT_PATH, '../custom_components/xiaomi_home/miot/specs/spec_filter.yaml')
+SPEC_ADD_FILE = path.join(
+    ROOT_PATH, '../custom_components/xiaomi_home/miot/specs/spec_add.json')
 SPEC_MODIFY_FILE = path.join(
-    ROOT_PATH,
-    '../custom_components/xiaomi_home/miot/specs/spec_modify.yaml')
+    ROOT_PATH, '../custom_components/xiaomi_home/miot/specs/spec_modify.yaml')
 
 
 def load_json_file(file_path: str) -> Optional[dict]:
@@ -30,7 +29,7 @@ def load_json_file(file_path: str) -> Optional[dict]:
         with open(file_path, 'r', encoding='utf-8') as file:
             return json.load(file)
     except FileNotFoundError:
-        _LOGGER.info('%s is not found.', file_path,)
+        _LOGGER.info('%s is not found.', file_path)
         return None
     except json.JSONDecodeError:
         _LOGGER.info('%s is not a valid JSON file.', file_path)
@@ -56,9 +55,12 @@ def load_yaml_file(file_path: str) -> Optional[dict]:
 
 def save_yaml_file(file_path: str, data: dict) -> None:
     with open(file_path, 'w', encoding='utf-8') as file:
-        yaml.safe_dump(
-            data, file, default_flow_style=False,
-            allow_unicode=True, indent=2, sort_keys=False)
+        yaml.safe_dump(data,
+                       file,
+                       default_flow_style=False,
+                       allow_unicode=True,
+                       indent=2,
+                       sort_keys=False)
 
 
 def dict_str_str(d: dict) -> bool:
@@ -132,13 +134,112 @@ def bool_trans(d: dict) -> bool:
     for key, trans in d['translate'].items():
         trans_keys: set[str] = set(trans.keys())
         if set(trans.keys()) != default_keys:
-            _LOGGER.info(
-                'bool trans inconsistent, %s, %s, %s',
-                key, default_keys, trans_keys)
+            _LOGGER.info('bool trans inconsistent, %s, %s, %s', key,
+                         default_keys, trans_keys)
             return False
     return True
 
 
+def spec_add(data: dict) -> bool:
+    """dict[str, list[dict[str, int| str | list]]]"""
+    if not isinstance(data, dict):
+        return False
+    for urn, content in data.items():
+        if not isinstance(urn, str) or not isinstance(content, (list, str)):
+            return False
+        if isinstance(content, str):
+            continue
+        for service in content:
+            if ('iid' not in service) or ('type' not in service) or (
+                    'description'
+                    not in service) or (('properties' not in service) and
+                                        ('actions' not in service) and
+                                        ('events' not in service)):
+                return False
+            type_strs: list[str] = service['type'].split(':')
+            if type_strs[1] != 'miot-spec-v2':
+                return False
+            if 'properties' in service:
+                if not isinstance(service['properties'], list):
+                    return False
+                for prop in service['properties']:
+                    if ('iid' not in prop) or ('type' not in prop) or (
+                            'description' not in prop) or (
+                                'format' not in prop) or ('access' not in prop):
+                        return False
+                    if not isinstance(prop['iid'], int) or not isinstance(
+                            prop['type'], str) or not isinstance(
+                                prop['description'], str) or not isinstance(
+                                    prop['format'], str) or not isinstance(
+                                        prop['access'], list):
+                        return False
+                    type_strs = prop['type'].split(':')
+                    if type_strs[1] != 'miot-spec-v2':
+                        return False
+                    for access in prop['access']:
+                        if access not in ['read', 'write', 'notify']:
+                            return False
+                    if 'value-range' in prop:
+                        if not isinstance(prop['value-range'], list):
+                            return False
+                        for value in prop['value-range']:
+                            if not isinstance(value, (int, float)):
+                                return False
+                    if 'value-list' in prop:
+                        if not isinstance(prop['value-list'], list):
+                            return False
+                        for item in prop['value-list']:
+                            if 'value' not in item or 'description' not in item:
+                                return False
+                            if not isinstance(item['value'],
+                                              int) or not isinstance(
+                                                  item['description'], str):
+                                return False
+            if 'actions' in service:
+                if not isinstance(service['actions'], list):
+                    return False
+                for action in service['actions']:
+                    if ('iid' not in action) or ('type' not in action) or (
+                            'description' not in action) or (
+                                'in' not in action) or ('out' not in action):
+                        return False
+                    if not isinstance(action['iid'], int) or not isinstance(
+                            action['type'], str) or not isinstance(
+                                action['description'], str) or not isinstance(
+                                    action['in'], list) or not isinstance(
+                                        action['out'], list):
+                        return False
+                    type_strs = action['type'].split(':')
+                    if type_strs[1] != 'miot-spec-v2':
+                        return False
+                    for param in action['in']:
+                        if not isinstance(param, int):
+                            return False
+                    for param in action['out']:
+                        if not isinstance(param, int):
+                            return False
+            if 'events' in service:
+                if not isinstance(service['events'], list):
+                    return False
+                for event in service['events']:
+                    if ('iid' not in event) or ('type' not in event) or (
+                            'description' not in event) or ('arguments'
+                                                            not in event):
+                        return False
+                    if not isinstance(event['iid'], int) or not isinstance(
+                            event['type'], str) or not isinstance(
+                                event['description'], str) or not isinstance(
+                                    event['arguments'], list):
+                        return False
+                    type_strs = event['type'].split(':')
+                    if type_strs[1] != 'miot-spec-v2':
+                        return False
+                    for param in event['arguments']:
+                        if not isinstance(param, int):
+                            return False
+    return True
+
+
 def spec_modify(data: dict) -> bool:
     """dict[str, str | dict[str, dict]]"""
     if not isinstance(data, dict):
@@ -159,25 +260,22 @@ def compare_dict_structure(dict1: dict, dict2: dict) -> bool:
         _LOGGER.info('invalid type')
         return False
     if dict1.keys() != dict2.keys():
-        _LOGGER.info(
-            'inconsistent key values, %s, %s', dict1.keys(), dict2.keys())
+        _LOGGER.info('inconsistent key values, %s, %s', dict1.keys(),
+                     dict2.keys())
         return False
     for key in dict1:
         if isinstance(dict1[key], dict) and isinstance(dict2[key], dict):
             if not compare_dict_structure(dict1[key], dict2[key]):
-                _LOGGER.info(
-                    'inconsistent key values, dict, %s', key)
+                _LOGGER.info('inconsistent key values, dict, %s', key)
                 return False
         elif isinstance(dict1[key], list) and isinstance(dict2[key], list):
             if not all(
                     isinstance(i, type(j))
                     for i, j in zip(dict1[key], dict2[key])):
-                _LOGGER.info(
-                    'inconsistent key values, list, %s', key)
+                _LOGGER.info('inconsistent key values, list, %s', key)
                 return False
         elif not isinstance(dict1[key], type(dict2[key])):
-            _LOGGER.info(
-                'inconsistent key values, type, %s', key)
+            _LOGGER.info('inconsistent key values, type, %s', key)
             return False
     return True
 
@@ -200,6 +298,12 @@ def sort_spec_filter(file_path: str):
     return filter_data
 
 
+def sort_spec_add(file_path: str):
+    filter_data = load_json_file(file_path=file_path)
+    assert isinstance(filter_data, dict), f'{file_path} format error'
+    return dict(sorted(filter_data.items()))
+
+
 def sort_spec_modify(file_path: str):
     filter_data = load_yaml_file(file_path=file_path)
     assert isinstance(filter_data, dict), f'{file_path} format error'
@@ -222,6 +326,14 @@ def test_spec_filter():
     assert spec_filter(data), f'{SPEC_FILTER_FILE} format error'
 
 
+@pytest.mark.github
+def test_spec_add():
+    data = load_json_file(SPEC_ADD_FILE)
+    assert isinstance(data, dict)
+    assert data, f'load {SPEC_ADD_FILE} failed'
+    assert spec_add(data), f'{SPEC_ADD_FILE} format error'
+
+
 @pytest.mark.github
 def test_spec_modify():
     data = load_yaml_file(SPEC_MODIFY_FILE)
@@ -255,7 +367,8 @@ def test_miot_lang_integrity():
     # pylint: disable=import-outside-toplevel
     from miot.const import INTEGRATION_LANGUAGES
     integration_lang_list: list[str] = [
-        f'{key}.json' for key in list(INTEGRATION_LANGUAGES.keys())]
+        f'{key}.json' for key in list(INTEGRATION_LANGUAGES.keys())
+    ]
     translations_names: set[str] = set(listdir(TRANS_RELATIVE_PATH))
     assert len(translations_names) == len(integration_lang_list)
     assert translations_names == set(integration_lang_list)
@@ -271,21 +384,18 @@ def test_miot_lang_integrity():
     default_dict = load_json_file(
         path.join(TRANS_RELATIVE_PATH, integration_lang_list[0]))
     for name in list(integration_lang_list)[1:]:
-        compare_dict = load_json_file(
-            path.join(TRANS_RELATIVE_PATH, name))
+        compare_dict = load_json_file(path.join(TRANS_RELATIVE_PATH, name))
         if not compare_dict_structure(default_dict, compare_dict):
-            _LOGGER.info(
-                'compare_dict_structure failed /translations, %s', name)
+            _LOGGER.info('compare_dict_structure failed /translations, %s',
+                         name)
             assert False
     # Check i18n files structure
     default_dict = load_json_file(
         path.join(MIOT_I18N_RELATIVE_PATH, integration_lang_list[0]))
     for name in list(integration_lang_list)[1:]:
-        compare_dict = load_json_file(
-            path.join(MIOT_I18N_RELATIVE_PATH, name))
+        compare_dict = load_json_file(path.join(MIOT_I18N_RELATIVE_PATH, name))
         if not compare_dict_structure(default_dict, compare_dict):
-            _LOGGER.info(
-                'compare_dict_structure failed /miot/i18n, %s', name)
+            _LOGGER.info('compare_dict_structure failed /miot/i18n, %s', name)
             assert False
 
 
@@ -303,12 +413,21 @@ def test_miot_data_sort():
                 f'{SPEC_BOOL_TRANS_FILE} not sorted, goto project root path'
                 ' and run the following command sorting, ',
                 'pytest -s -v -m update ./test/check_rule_format.py')
-    assert json.dumps(
-        load_yaml_file(file_path=SPEC_FILTER_FILE)) == json.dumps(
-            sort_spec_filter(file_path=SPEC_FILTER_FILE)), (
-                f'{SPEC_FILTER_FILE} not sorted, goto project root path'
-                ' and run the following command sorting, ',
-                'pytest -s -v -m update ./test/check_rule_format.py')
+    assert json.dumps(load_yaml_file(file_path=SPEC_FILTER_FILE)) == json.dumps(
+        sort_spec_filter(file_path=SPEC_FILTER_FILE)), (
+            f'{SPEC_FILTER_FILE} not sorted, goto project root path'
+            ' and run the following command sorting, ',
+            'pytest -s -v -m update ./test/check_rule_format.py')
+    assert json.dumps(load_json_file(file_path=SPEC_ADD_FILE)) == json.dumps(
+        sort_spec_add(file_path=SPEC_ADD_FILE)), (
+            f'{SPEC_ADD_FILE} not sorted, goto project root path'
+            ' and run the following command sorting, ',
+            'pytest -s -v -m update ./test/check_rule_format.py')
+    assert json.dumps(load_yaml_file(file_path=SPEC_MODIFY_FILE)) == json.dumps(
+        sort_spec_modify(file_path=SPEC_MODIFY_FILE)), (
+            f'{SPEC_MODIFY_FILE} not sorted, goto project root path'
+            ' and run the following command sorting, ',
+            'pytest -s -v -m update ./test/check_rule_format.py')
 
 
 @pytest.mark.update
@@ -319,6 +438,9 @@ def test_sort_spec_data():
     sort_data = sort_spec_filter(file_path=SPEC_FILTER_FILE)
     save_yaml_file(file_path=SPEC_FILTER_FILE, data=sort_data)
     _LOGGER.info('%s formatted.', SPEC_FILTER_FILE)
+    sort_data = sort_spec_add(file_path=SPEC_ADD_FILE)
+    save_json_file(file_path=SPEC_ADD_FILE, data=sort_data)
+    _LOGGER.info('%s formatted.', SPEC_ADD_FILE)
     sort_data = sort_spec_modify(file_path=SPEC_MODIFY_FILE)
     save_yaml_file(file_path=SPEC_MODIFY_FILE, data=sort_data)
     _LOGGER.info('%s formatted.', SPEC_MODIFY_FILE)