| 1 |
#!/usr/bin/python3 |
| 2 |
import os |
| 3 |
import re |
| 4 |
import sys |
| 5 |
import yaml |
| 6 |
import argparse |
| 7 |
|
| 8 |
override_dirs = ['/etc/kylin-config/industry'] |
| 9 |
output_file = '' |
| 10 |
|
| 11 |
# 每个问题类型声明一个列表存储对应的问题类型 |
| 12 |
# 键值类型改变 |
| 13 |
type_list = [] |
| 14 |
# 键值权限改变 |
| 15 |
permission_list = [] |
| 16 |
# 取值范围改变 |
| 17 |
range_list = [] |
| 18 |
# 版本不在应用支持范围 |
| 19 |
version_list = [] |
| 20 |
|
| 21 |
# 打印报告 |
| 22 |
def print_err(): |
| 23 |
with open(output_file, 'w') as file: |
| 24 |
if type_list: |
| 25 |
file.write('键值类型改变\n') |
| 26 |
file.write(' ' * 4 + '描述\n') |
| 27 |
file.write(' ' * 8 + '键值类型变化会导致应用读取数据是读不到数据或读到错误数据,导致应用运行结果异常\n') |
| 28 |
file.write(' ' * 4 + '如何修复\n') |
| 29 |
file.write(' ' * 8 + '联系应用调查原因,商讨修改方案\n') |
| 30 |
file.write(' ' * 4 + '问题上下文\n') |
| 31 |
for basic_file, override_file, path in type_list: |
| 32 |
file.write(' ' * 8 + f'应用文件:{basic_file} 目标文件:{override_file} 位置:{path}\n') |
| 33 |
if permission_list: |
| 34 |
file.write('键值权限改变\n') |
| 35 |
file.write(' ' * 4 + '描述\n') |
| 36 |
file.write(' ' * 8 + '键值权限改变可能会导致定制文件的内容无法覆盖应用文件的内容,导致定制内容不生效\n') |
| 37 |
file.write(' ' * 4 + '如何修复\n') |
| 38 |
file.write(' ' * 8 + '联系应用调查原因,商讨修改方案\n') |
| 39 |
file.write(' ' * 4 + '问题上下文\n') |
| 40 |
for basic_file, override_file, path in permission_list: |
| 41 |
file.write(' ' * 8 + f'应用文件:{basic_file} 目标文件:{override_file} 位置:{path}\n') |
| 42 |
if range_list: |
| 43 |
file.write('取值范围改变改变\n') |
| 44 |
file.write(' ' * 4 + '描述\n') |
| 45 |
file.write(' ' * 8 + '取值范围改变,可能会导致应用在读/写数据是读到/写入无意义的数据,导致应用运行出错或设置数据失败\n') |
| 46 |
file.write(' ' * 4 + '如何修复\n') |
| 47 |
file.write(' ' * 8 + '联系应用调查原因,商讨修改方案\n') |
| 48 |
file.write(' ' * 4 + '问题上下文\n') |
| 49 |
for basic_file, override_file, path in range_list: |
| 50 |
file.write(' ' * 8 + f'应用文件:{basic_file} 目标文件:{override_file} 位置:{path}\n') |
| 51 |
if version_list: |
| 52 |
file.write('版本不在应用规定范围\n') |
| 53 |
file.write(' ' * 4 + '描述\n') |
| 54 |
file.write(' ' * 8 + '如果版本不在应用指定支持的版本范围内无法确定配置应用读取的配置是否存在与该版本的配置内容中,可能会导致应用运行错误\n') |
| 55 |
file.write(' ' * 4 + '如何修复\n') |
| 56 |
file.write(' ' * 8 + '调查文件来源,如果可以删除建议删除,不能删除的话联系应用与定制包的负责人,商讨修改方案\n') |
| 57 |
file.write(' ' * 4 + '问题上下文\n') |
| 58 |
for basic_file, override_file, path in version_list: |
| 59 |
file.write(' ' * 8 + f'应用文件:{basic_file} 目标文件:{override_file} 位置:{path}\n') |
| 60 |
|
| 61 |
# 查询枚举类型数据的枚举定义 |
| 62 |
def _recursive_search(dictionary, key): |
| 63 |
if key in dictionary: |
| 64 |
return dictionary[key] |
| 65 |
else: |
| 66 |
for value in dictionary.values(): |
| 67 |
if isinstance(value, dict): |
| 68 |
result = _recursive_search(value, key) |
| 69 |
if result is not None: |
| 70 |
return result |
| 71 |
return None |
| 72 |
|
| 73 |
def _compare_versions(src, dest): |
| 74 |
src_nums = re.findall(r'\d+', src) |
| 75 |
dest_nums = re.findall(r'\d+', dest) |
| 76 |
lengh = len(src_nums) if len(src_nums) > len(dest_nums) else len(dest_nums) |
| 77 |
ret = -1 if len(src_nums) > len(dest_nums) else 1 if len(src_nums) < len(dest_nums) else 0 |
| 78 |
for i in range(0, lengh): |
| 79 |
if dest_nums[i] > src_nums[i]: |
| 80 |
return 1 |
| 81 |
if dest_nums[i] < src_nums[i]: |
| 82 |
return -1 |
| 83 |
return ret |
| 84 |
|
| 85 |
def _calculate_default_version(data:dict): |
| 86 |
versions = list(data.keys()) |
| 87 |
if '_default_version' in versions: |
| 88 |
return data.get('_default_version') |
| 89 |
default_version = '' |
| 90 |
for version in versions: |
| 91 |
if default_version == '': |
| 92 |
default_version = version |
| 93 |
continue |
| 94 |
if 1 == _compare_versions(default_version, version): |
| 95 |
default_version = version |
| 96 |
return default_version |
| 97 |
|
| 98 |
def check_value_type(basic_data:dict, override_data:dict, path:str, app, version, basic_file, override_file): |
| 99 |
basic_group = basic_data |
| 100 |
override_group = override_data |
| 101 |
for group in path.split('.'): |
| 102 |
basic_group = basic_group[group] |
| 103 |
override_group = override_group[group] |
| 104 |
result = [] |
| 105 |
for key, value in override_group.items(): |
| 106 |
if key in basic_group: |
| 107 |
if not isinstance(value, dict): |
| 108 |
continue |
| 109 |
basic_key_is_group = True if '_default' in next(iter(value.values())) else False |
| 110 |
override_key_is_group = True if '_default' in next(iter(value.values())) else False |
| 111 |
# 同名但是一个是组,一个是键 |
| 112 |
if basic_key_is_group != override_key_is_group: |
| 113 |
result.append((basic_file, override_file, f'{app}/{version}/{path}/{key}')) |
| 114 |
else: |
| 115 |
# 组 |
| 116 |
if basic_key_is_group and override_key_is_group: |
| 117 |
check_value_type(basic_data, override_data, f'{path}.{key}', app, version, basic_file, override_file) |
| 118 |
else: |
| 119 |
basic_key_type = basic_group[key]['_type'] |
| 120 |
override_key_type = override_group[key]['_type'] |
| 121 |
if basic_key_type != override_key_type: |
| 122 |
type_list.append((basic_file, override_file, f'{app}/{version}/{path}/{key}')) |
| 123 |
# 获取组的权限,未声明默认'public' |
| 124 |
basic_key_permission = basic_group.get('_permission', 'public') |
| 125 |
override_key_permission = override_group.get('_permission', 'public') |
| 126 |
# 读取键的权限,未声明则使用组权限 |
| 127 |
basic_key_permission = basic_group[key].get('_permission', basic_key_permission) |
| 128 |
override_key_permission = override_group[key].get('_permission', override_key_permission) |
| 129 |
if basic_key_permission != override_key_permission: |
| 130 |
permission_list.append((basic_file, override_file, f'{app}/{version}/{path}/{key}')) |
| 131 |
|
| 132 |
basic_key_range = basic_group[key].get('_range', '') |
| 133 |
override_key_range = override_group[key].get('_range', '') |
| 134 |
if basic_key_range and override_key_range: |
| 135 |
if basic_key_type == 'enum': |
| 136 |
basic_key_range = _recursive_search(basic_data, basic_key_range[1:]) |
| 137 |
override_key_range = _recursive_search(override_data, override_key_range[1:]) |
| 138 |
if basic_key_range != override_key_range: |
| 139 |
range_list.append((basic_file, override_file, f'{app}/{version}/{path}/{key}')) |
| 140 |
# elif basic_key_range == '' and override_key_range != '': |
| 141 |
# range_list.append((basic_file, override_file, f'{app}/{version}/{path}/{key}')) |
| 142 |
# elif basic_key_range != '' and override_key_range == '': |
| 143 |
# range_list.append((basic_file, override_file, f'{app}/{version}/{path}/{key}')) |
| 144 |
return result |
| 145 |
|
| 146 |
# 检查组配置文件 |
| 147 |
def check_group_config(basic_data, override_data, basic_file, override_file): |
| 148 |
for app, app_data in basic_data.items(): |
| 149 |
for version, version_data in app_data.items(): |
| 150 |
groups = set(override_data.keys()) |
| 151 |
for group in groups: |
| 152 |
if group in version_data: |
| 153 |
if not isinstance(version_data[group], dict): |
| 154 |
continue |
| 155 |
check_value_type(version_data, override_data, group, app, version, basic_file, override_file) |
| 156 |
|
| 157 |
# 检查应用配置文件 |
| 158 |
def check_app_config(basic_data, override_data, basic_file, override_file): |
| 159 |
version_err = [] |
| 160 |
for app, app_data in override_data.items(): |
| 161 |
if app in basic_data: |
| 162 |
# 读取应用支持版本号区间 |
| 163 |
min_version = '' |
| 164 |
max_version = '' |
| 165 |
if os.path.exists(f'/etc/kylin-config/compatibility/{app}-compatibility-settings.yaml'): |
| 166 |
with open(f'/etc/kylin-config/compatibility/{app}-compatibility-settings.yaml', 'r') as f: |
| 167 |
version_range = yaml.safe_load(f) |
| 168 |
min_version = version_range[app]['compatibility']['min_version'] |
| 169 |
max_version = version_range[app]['compatibility']['max_version'] |
| 170 |
versions = set(basic_data[app].keys()) | set(override_data[app].keys()) |
| 171 |
for version in versions: |
| 172 |
if (version == '_default_version'): |
| 173 |
continue |
| 174 |
if min_version and max_version: |
| 175 |
if -1 == _compare_versions(version, min_version) or 1 == _compare_versions(version, max_version): |
| 176 |
version_list.append((basic_file, override_file, f'{app}/{version}')) |
| 177 |
else: |
| 178 |
# 定制文件版本是否比应用文件版本高 待定? |
| 179 |
pass |
| 180 |
if version in basic_data[app] and version in override_data[app]: |
| 181 |
for group in override_data[app][version]: |
| 182 |
if not isinstance(override_data[app][version][group], dict): |
| 183 |
continue |
| 184 |
check_value_type(basic_data[app][version], override_data[app][version], group, app, version, basic_file, override_file) |
| 185 |
|
| 186 |
def check_one_app(basic_data, basic_file): |
| 187 |
for dir in override_dirs: |
| 188 |
for root, dirs, files in os.walk(dir): |
| 189 |
for file in files: |
| 190 |
override_file = f'{root}/{file}' |
| 191 |
with open(override_file, 'r') as f: |
| 192 |
override_data = yaml.safe_load(f) |
| 193 |
for value in override_data.values(): |
| 194 |
is_group_file = True if '_default' in next(iter(value.values())) else False |
| 195 |
if is_group_file: |
| 196 |
check_group_config(basic_data, override_data, basic_file, override_file) |
| 197 |
else: |
| 198 |
check_app_config(basic_data, override_data, basic_file, override_file) |
| 199 |
|
| 200 |
if __name__ == '__main__': |
| 201 |
parser = argparse.ArgumentParser(description='这是一个检测conf2模块的yaml文件中是否存在不兼容配置的程序') |
| 202 |
parser.add_argument('--output', '-o', type=str, required=True, |
| 203 |
help="检测结果文件输出路径") |
| 204 |
args = parser.parse_args() |
| 205 |
|
| 206 |
output_file = sys.argv[1] |
| 207 |
for root, dirs, files in os.walk('/etc/kylin-config/basic'): |
| 208 |
for file in files: |
| 209 |
basic_file = f'{root}/{file}' |
| 210 |
if(basic_file.endswith(".yaml")): |
| 211 |
with open(basic_file, 'r') as f: |
| 212 |
basic_data = yaml.safe_load(f) |
| 213 |
check_one_app(basic_data, basic_file) |
| 214 |
print_err() |