Cura/tests/TestShortcutKeys.py
2018-09-06 16:06:45 +02:00

114 lines
4.9 KiB
Python

import os
import re
import pytest
MSGCTXT = "msgctxt" # Scope of the text . Like : msgctxt "@action:inmenu menubar:help"
MSGID = "msgid" # The id tag, also English text version
MSGTR = "msgstr" # The translation tag
COLOR_WARNING = '\033[93m'
COLOR_ENDC = '\033[0m'
regex_patter = '(&[\w])' #"&[a-zA-Z0-9]" - Search char '&' and at least one character after it
# Directory where this python file resides
SCRIPT_DIR = os.path.dirname(os.path.realpath(__file__))
# Check default language shortcut keys, by default it is English
def test_default_shortcut_keys():
language_folder = "de_DE" # choose German language folder, because we only need to test English shortcut keys, the message id is English translation
translation_file_name = "cura.po"
cura_path = os.path.abspath(os.path.join(SCRIPT_DIR, ".."))
language_file_path = os.path.join(cura_path, "resources", "i18n", language_folder, translation_file_name)
not_valid_shortcut_keys = getDuplicatedShortcutKeys(language_file_path, False)
if len(not_valid_shortcut_keys) != 0:
temp = '%s' % ', '.join(map(str, not_valid_shortcut_keys))
print(COLOR_WARNING + "NOT VALID SHORTCUT KEYS: " + temp + COLOR_ENDC)
assert len(not_valid_shortcut_keys) == 0
# If the 'findShortcutKeysInTranslation' is False the function will search shortcut keys in message id
def getDuplicatedShortcutKeys(language_file_path: str, find_shortcut_keys_in_translation: bool):
last_translation_scope = ""
# {shortcut_key, {scope, [translation_text]}}
shortcut_keys = dict()
with open(language_file_path, 'r') as f:
for text in f:
if text.startswith(MSGCTXT):
last_translation_scope = text
elif text.startswith(MSGID) and find_shortcut_keys_in_translation or text.startswith(MSGTR) and not find_shortcut_keys_in_translation:
# if text has '&'symbol and at least one character (char or digit) after it
# ex '&acr mytest' -> this should return '&a'
# ex '& acr mytest' -> returns None
the_shortcut_key_word = re.search(regex_patter, text)
if the_shortcut_key_word is not None:
# take only char after '&' symbol
the_shortcut_key = the_shortcut_key_word.group(0)[1]
the_shortcut_key = the_shortcut_key.upper() # make all shortcut keys capital
# The shortcut key is not yet added
if the_shortcut_key not in shortcut_keys:
scope_translation = dict()
scope_translation[last_translation_scope] = []
scope_translation[last_translation_scope].append(text)
shortcut_keys[the_shortcut_key] = scope_translation
else:
# check if the shortcut key scope is already added or not
if last_translation_scope not in shortcut_keys[the_shortcut_key]:
scope_translation = dict()
scope_translation[last_translation_scope] = []
scope_translation[last_translation_scope].append(text)
shortcut_keys[the_shortcut_key].update(scope_translation)
# if the scope already exist then add the key
elif last_translation_scope in shortcut_keys[the_shortcut_key]:
shortcut_keys[the_shortcut_key][last_translation_scope].append(text)
last_translation_scope = ""
not_valid_shortcut_keys = []
# Validate all shortcut keys
for shortcut_key, scopes in shortcut_keys.items():
# check, whether the key exist in the same scope multiple times or not
for key, items in scopes.items():
# The shortcut keys should not be more than one time in the same scope
if len(items) > 1:
not_valid_shortcut_keys += items
return not_valid_shortcut_keys
@pytest.mark.parametrize("language_type", [("de_DE"),("es_ES"),("fi_FI"),("fr_FR"),("it_IT"),("ja_JP"),("ko_KR"),
("nl_NL"),("pl_PL"),("pt_BR"),("ru_RU"),("tr_TR")])
def test_shortcut_keys(language_type):
language_folder = language_type
translation_file_name = "cura.po"
plugin_file_path = os.path.dirname(os.path.abspath(__file__))
path_records = os.path.split(plugin_file_path)
global_path = path_records[:-1]
cura_path = os.path.join(*global_path)
language_file_path = os.path.join(cura_path, "resources", "i18n", language_folder, translation_file_name)
not_valid_shortcut_keys = getDuplicatedShortcutKeys(language_file_path, False)
if len(not_valid_shortcut_keys) != 0:
temp = "%s" % ", ".join(map(str, not_valid_shortcut_keys))
print(COLOR_WARNING + "NOT VALID SHORTCUT KEYS: " + temp + COLOR_ENDC)
assert len(not_valid_shortcut_keys) == 0