Merge pull request #12706 from keymanapp/chore/linux/rename-tests

chore(linux): rename test files

docs/linux/README.md

@@ -64,6 +64,10 @@ To just run the unit tests without integration tests, add the
 It's also possible to only run the tests for one of the subprojects. You
 can use `build.sh` in the subdirectory for that.
 
+Unit tests should be named after the file/class they are testing and
+follow the pattern `*.tests.<ext>` (e.g. `keymanutil.tests.c`) or
+for Python `*_tests.py`.
+
 ### ibus-keyman
 
 If you want to run the ibus-keyman tests with Wayland, you'll have to

docs/linux/keyman-config.md

@@ -200,7 +200,7 @@ LANGUAGE=de ./km-config
   "python.testing.unittestArgs": [
     "-v",
     "-s", "linux/keyman-config/tests",
-    "-p", "test_*.py"
+    "-p", "*_tests.py"
   ],
   "python.testing.unittestEnabled": true,
   ```

docs/settings/linux/launch.json

@@ -62,7 +62,7 @@
       "request": "launch",
       "name": "Launch ibus-keyman unit tests",
       "target": "./keymanutil_tests",
-      "cwd": "${workspaceFolder}/linux/build/x86_64/debug/src/test",
+      "cwd": "${workspaceFolder}/linux/build/x86_64/debug/src/tests",
       "valuesFormatting": "parseText",
       "internalConsoleOptions": "openOnSessionStart",
       "env": {

docs/settings/linux/settings.json

@@ -5,7 +5,7 @@
   "python.testing.unittestArgs": [
     "-v",
     "-s", "linux/keyman-config/tests",
-    "-p", "test_*.py"
+    "-p", "*_tests.py"
   ],
   "python.testing.unittestEnabled": true,
   "python.testing.pytestEnabled": false,

linux/.gitignore

@@ -31,7 +31,7 @@ debianpackage/
 *.tar.xz
 *.tar.gz
 *.dsc
-help/reference/
+docs/help/reference/
 
 # Cached/auto-compiled Python bytecode
 *.pyc

linux/ibus-keyman/src/test/meson.build

@@ -1,5 +1,5 @@
 keymanutil_sources = [
-  'keymanutil_tests.c',
+  'keymanutil.tests.c',
   util_files,
 ]
 
@@ -55,7 +55,7 @@ print_kmp_test = executable(
 bcp47_util_tests = executable(
   'bcp47-util-tests',
   sources: [
-    'bcp47util_tests.c',
+    'bcp47util.tests.c',
     '../bcp47util.c'
   ],
   dependencies: [ gtk, icu ],

linux/keyman-config/run-tests.sh

@@ -1,18 +1,18 @@
 #!/bin/bash
-PYTHONPATH=.:$PYTHONPATH
+PYTHONPATH=.:${PYTHONPATH}
 
 XDG_CONFIG_HOME=$(mktemp --directory)
 export XDG_CONFIG_HOME
 
-if [ -f /usr/libexec/ibus-memconf ]; then
+if [[ -f /usr/libexec/ibus-memconf ]]; then
   export GSETTINGS_BACKEND=keyfile
 fi
 
-if [ "$1" == "--coverage" ]; then
+if [[ "$1" == "--coverage" ]]; then
   coverage="-m coverage run --source=. --data-file=build/.coverage"
 fi
 
-if [ -n "$TEAMCITY_VERSION" ]; then
+if [[ -n "${TEAMCITY_VERSION}" ]]; then
   if ! pip3 list --format=columns | grep -q teamcity-messages; then
       pip3 install teamcity-messages
   fi
@@ -23,6 +23,6 @@ else
 fi
 
 # shellcheck disable=SC2086
-python3 ${coverage:-} -m ${test_module:-} discover ${extra_opts:-} -s tests -p test_*.py
+python3 ${coverage:-} -m "${test_module:-}" discover ${extra_opts:-} -s tests/ -p "*_tests.py"
 
-rm -rf "$XDG_CONFIG_HOME"
+rm -rf "${XDG_CONFIG_HOME}"