From 6ab93cfc86f1fdf714a9921fcefd8f0dc36d55d1 Mon Sep 17 00:00:00 2001
From: Alexandre Aubin <alex.aubin@mailoo.org>
Date: Fri, 20 Aug 2021 10:24:46 +0200
Subject: [PATCH] Add a test for i18n keys

---
 test/test_i18n_keys.py | 83 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 83 insertions(+)
 create mode 100644 test/test_i18n_keys.py

diff --git a/test/test_i18n_keys.py b/test/test_i18n_keys.py
new file mode 100644
index 00000000..930d478c
--- /dev/null
+++ b/test/test_i18n_keys.py
@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+
+import re
+import glob
+import json
+
+
+###############################################################################
+#   Find used keys in python code                                             #
+###############################################################################
+
+
+def find_expected_string_keys():
+
+    # Try to find :
+    #    m18n.g(   "foo"
+    #    MoulinetteError("foo"
+    p1 = re.compile(r"m18n\.g\(\s*[\"\'](\w+)[\"\']")
+    p2 = re.compile(r"MoulinetteError\([\'\"](\w+)[\'\"]")
+    p3 = re.compile(r"MoulinetteValidationError\([\'\"](\w+)[\'\"]")
+    p4 = re.compile(r"MoulinetteAuthenticationError\([\'\"](\w+)[\'\"]")
+
+    python_files = glob.glob("moulinette/*.py")
+    python_files.extend(glob.glob("moulinette/*/*.py"))
+
+    for python_file in python_files:
+        content = open(python_file).read()
+        for m in p1.findall(content):
+            if m.endswith("_"):
+                continue
+            yield m
+        for m in p2.findall(content):
+            if m.endswith("_"):
+                continue
+            yield m
+        for m in p3.findall(content):
+            if m.endswith("_"):
+                continue
+            yield m
+        for m in p4.findall(content):
+            if m.endswith("_"):
+                continue
+            yield m
+
+
+###############################################################################
+#   Load en locale json keys                                                  #
+###############################################################################
+
+
+def keys_defined_for_en():
+    return json.loads(open("locales/en.json").read()).keys()
+
+
+###############################################################################
+#   Compare keys used and keys defined                                        #
+###############################################################################
+
+
+expected_string_keys = set(find_expected_string_keys())
+keys_defined = set(keys_defined_for_en())
+
+
+def test_undefined_i18n_keys():
+    undefined_keys = expected_string_keys.difference(keys_defined)
+    undefined_keys = sorted(undefined_keys)
+
+    if undefined_keys:
+        raise Exception(
+            "Those i18n keys should be defined in en.json:\n"
+            "    - " + "\n    - ".join(undefined_keys)
+        )
+
+
+def test_unused_i18n_keys():
+
+    unused_keys = keys_defined.difference(expected_string_keys)
+    unused_keys = sorted(unused_keys)
+
+    if unused_keys:
+        raise Exception(
+            "Those i18n keys appears unused:\n" "    - " + "\n    - ".join(unused_keys)
+        )