Preliminary testing

Author: StanFromIreland

.github/workflows/run-tests.yml

@@ -0,0 +1,18 @@
+name: Run test suite
+on:
+  pull_request:
+  workflow_dispatch:
+  push:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - run: python -m unittest discover -s tests

build_status.py

@@ -21,16 +21,3 @@ def get_languages(http: PoolManager) -> Iterator[tuple[str, bool]]:
         language_code = code.lower().replace('_', '-')
         in_switcher = language.get('in_prod', config['defaults']['in_prod'])
         yield language_code, in_switcher
-
-
-def main() -> None:
-    languages = {
-        language: in_switcher for language, in_switcher in get_languages(PoolManager())
-    }
-    print(languages)
-    for code in ('en', 'pl', 'ar', 'zh-cn', 'id'):
-        print(f'{code}: {code in languages} {languages.get(code)}')
-
-
-if __name__ == '__main__':
-    main()

tests/support.py

@@ -0,0 +1,25 @@
+import sys
+import contextlib
+
+# -------------------------------- Imports ----------------------------------- #
+
+
+# Support functions borrowed from CPython's test.support
+@contextlib.contextmanager
+def import_scripts(dir='..'):
+    with DirsOnSysPath(dir) as cm:
+        yield cm
+
+
+class DirsOnSysPath(object):
+    def __init__(self, *paths):
+        self.original_value = sys.path[:]
+        self.original_object = sys.path
+        sys.path.extend(paths)
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, *ignore_exc):
+        sys.path = self.original_object
+        sys.path[:] = self.original_value

tests/test_build_status.py

@@ -0,0 +1,26 @@
+import unittest
+import support
+
+from urllib3 import PoolManager
+
+with support.import_scripts():
+    import build_status
+
+
+class testBuildStatus(unittest.TestCase):
+    def test_get_languages(self):
+        result = {
+            language: in_switcher
+            for language, in_switcher in build_status.get_languages(PoolManager())
+        }
+
+        self.assertIn('en', result)
+        self.assertIn('pl', result)
+        self.assertIn('zh-cn', result)
+
+        self.assertEqual(result.get('en'), True)
+        self.assertEqual(result.get('pl'), True)
+
+
+if __name__ == '__main__':
+    unittest.main()

tests/test_translators.py

@@ -0,0 +1,97 @@
+import unittest
+import support
+import tempfile
+import shutil
+
+from pathlib import Path
+from git import Repo
+
+with support.import_scripts():
+    import translators
+
+TRANSLATORS_BASIC = """
+John Cleese
+Graham Chapman
+Terry Jones
+Michael Palin
+Terry Gilliam
+"""
+
+TRANSLATORS_TITLE_AND_COMMENTS = """
+Translators
+John Cleese
+Graham Chapman
+Terry Jones
+# Also Translators
+Michael Palin
+Terry Gilliam
+"""
+
+TRANSLATORS_COMPLEX = """
+Translators
+John Cleese
+-----
+
+
+Graham Chapman
+Graham Chapman
+# I'm a line
+Terry Jones
+# # #
+-
+Michael Palin
+Terry Gilliam
+"""
+
+
+class testTranslators(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.tempdir = tempfile.mkdtemp()
+        cls.test_repo_path = Path(cls.tempdir) / 'python-docs-pl'
+        cls.test_repo = Repo.clone_from(
+            'https://github.com/python/python-docs-pl',
+            cls.test_repo_path,
+            branch='3.14',
+        )
+        cls.test_repo.git.checkout('d242ceee48cfa6d70dbc0bc75f5043d1e6c5efeb')
+
+    @classmethod
+    def tearDownClass(cls):
+        shutil.rmtree(cls.tempdir)
+
+    def test_yield_from_headers(self):
+        translators_list = set(translators.yield_from_headers(self.test_repo_path))
+        self.assertEqual(len(translators_list), 25)
+
+    def test_get_number_from_git_history(self):
+        # ["   183\tGitHub Action's commit-build job", "    84\tGitHub Action's update-chart job", "     6\tGitHub Action's update-readme job", "  1342\tGitHub Action's update-translation job", '   174\tMaciej Olko', '     3\tStan U.', '    20\tStan Ulbrych', '     1\tciarbin', '     5\tm-aciek']
+        self.assertEqual(
+            translators.get_number_from_git_history(self.test_repo_path), 9
+        )
+
+    def test_get_translators_from_file(self):
+        for i, file in enumerate(
+            (TRANSLATORS_BASIC, TRANSLATORS_TITLE_AND_COMMENTS, TRANSLATORS_COMPLEX)
+        ):
+            with self.subTest(i=i, file=file):
+                folder = Path(self.tempdir) / f'folder-{i}'
+                folder.mkdir()
+                (folder / 'TRANSLATORS').write_text(file)
+
+                result = translators.get_from_translators_file(folder)
+                self.assertEqual(len(result), 5)
+
+        # No TRANSLATORS file
+        result = translators.get_from_translators_file(Path(self.tempdir) / 'empty')
+        self.assertEqual(result, set())
+
+    def test_get_number(self):
+        (self.test_repo_path / 'TRANSLATORS').write_text(TRANSLATORS_COMPLEX)
+
+        result = translators.get_number(self.test_repo_path)
+        self.assertEqual(result, 25)
+
+
+if __name__ == '__main__':
+    unittest.main()

translators.py

@@ -1,7 +1,6 @@
 from collections.abc import Iterator
 from pathlib import Path
 from re import fullmatch
-from tempfile import TemporaryDirectory
 from typing import Literal
 
 from git import Repo
@@ -36,10 +35,10 @@ def yield_from_headers(path: Path) -> Iterator[str]:
                 yield translator
 
 
-def get_from_translators_file(path: Path) -> list[str]:
+def get_from_translators_file(path: Path) -> set[str]:
     if not (file := path.joinpath('TRANSLATORS')).exists():
-        return []
-    return list(
+        return set()
+    return set(
         line
         for line in file.read_text().splitlines()
         if line != 'Translators'
@@ -53,27 +52,3 @@ def get_link(clone_path: Path, repo: str, branch: str) -> str | Literal[False]:
         clone_path.joinpath('TRANSLATORS').exists()
         and f'https://github.com/{repo}/blob/{branch}/TRANSLATORS'
     )
-
-
-if __name__ == '__main__':
-    for lang, branch in (
-        ('es', '3.13'),
-        ('hu', '3.6'),
-        ('pl', '3.13'),
-        ('zh-tw', '3.13'),
-        ('id', '3.9'),
-        ('fr', '3.13'),
-        ('hu', '3.6'),
-    ):
-        with TemporaryDirectory() as directory:
-            Repo.clone_from(
-                f'https://github.com/python/python-docs-{lang}',
-                directory,
-                branch=branch,
-            )
-            from_headers = len(set(yield_from_headers(path := Path(directory))))
-            from_git_history = get_number_from_git_history(path)
-            from_translators_file = len(get_from_translators_file(path))
-            print(
-                f'{lang}: {from_headers=}, {from_git_history=}, {from_translators_file=}'
-            )