gitbot/qmk_firmware
0
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2025-07-18 05:32:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Ensure keyboard aliases do not point to themselves (#25500)

Browse Source
This commit is contained in:
Joel Challis 2025-07-17 13:36:04 +01:00 committed by GitHub
parent 507c948ed8
commit 865c29f4de
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
lib/python/qmk/cli/ci/validate_aliases.py
View File

@ -25,6 +25,21 @@ def _target_keyboard_exists(target):
return True return True
def _alias_not_self(alias):
"""Check if alias points to itself, either directly or within a circular reference
"""
aliases = keyboard_alias_definitions()
found = set()
while alias in aliases:
found.add(alias)
alias = aliases[alias].get('target', alias)
if alias in found:
return False
return True
@cli.subcommand('Validates the list of keyboard aliases.', hidden=True) @cli.subcommand('Validates the list of keyboard aliases.', hidden=True)
def ci_validate_aliases(cli): def ci_validate_aliases(cli):
aliases = keyboard_alias_definitions() aliases = keyboard_alias_definitions()
@ -32,7 +47,11 @@ def ci_validate_aliases(cli):
success = True success = True
for alias in aliases.keys(): for alias in aliases.keys():
target = aliases[alias].get('target', None) target = aliases[alias].get('target', None)
if not _target_keyboard_exists(target): if not _alias_not_self(alias):
cli.log.error(f'Keyboard alias {alias} should not point to itself')
success = False
elif not _target_keyboard_exists(target):
cli.log.error(f'Keyboard alias {alias} has a target that doesn\'t exist: {target}') cli.log.error(f'Keyboard alias {alias} has a target that doesn\'t exist: {target}')
success = False success = False