general: update ci files to up to date versions

.ci/run

@@ -37,4 +37,4 @@ if ! command -v python3 &> /dev/null; then
 fi
 
 "$PY_BIN" -m pip install --user tox
-"$PY_BIN" -m tox
+"$PY_BIN" -m tox "$@"

.github/workflows/main.yml

@@ -10,7 +10,13 @@ on:
   pull_request: # needed to trigger on others' PRs
   # Note that people who fork it need to go to "Actions" tab on their fork and click "I understand my workflows, go ahead and enable them".
   workflow_dispatch: # needed to trigger workflows manually
-  # todo cron?
+    # todo cron?
+    inputs:
+      debug_enabled:
+        type: boolean
+        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
+        required: false
+        default: false
 
 
 jobs:
@@ -40,8 +46,8 @@ jobs:
         submodules: recursive
         fetch-depth: 0  # nicer to have all git history when debugging/for tests
 
-    # uncomment for SSH debugging
-    # - uses: mxschmitt/action-tmate@v3
+    - uses: mxschmitt/action-tmate@v3
+      if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
 
     # explicit bash command is necessary for Windows CI runner, otherwise it thinks it's cmd...
     - run: bash .ci/run

conftest.py

@@ -0,0 +1,38 @@
+# this is a hack to monkey patch pytest so it handles tests inside namespace packages without __init__.py properly
+# without it, pytest can't discover the package root for some reason
+# also see https://github.com/karlicoss/pytest_namespace_pkgs for more
+
+import pathlib
+from typing import Optional
+
+import _pytest.main
+import _pytest.pathlib
+
+# we consider all dirs in repo/ to be namespace packages
+root_dir = pathlib.Path(__file__).absolute().parent.resolve() / 'src'
+assert root_dir.exists(), root_dir
+
+# TODO assert it contains package name?? maybe get it via setuptools..
+
+namespace_pkg_dirs = [str(d) for d in root_dir.iterdir() if d.is_dir()]
+
+# resolve_package_path is called from _pytest.pathlib.import_path
+# takes a full abs path to the test file and needs to return the path to the 'root' package on the filesystem
+resolve_pkg_path_orig = _pytest.pathlib.resolve_package_path
+def resolve_package_path(path: pathlib.Path) -> Optional[pathlib.Path]:
+    result = path  # search from the test file upwards
+    for parent in result.parents:
+        if str(parent) in namespace_pkg_dirs:
+            return parent
+    raise RuntimeError("Couldn't determine path for ", path)
+_pytest.pathlib.resolve_package_path = resolve_package_path
+
+
+# without patching, the orig function returns just a package name for some reason
+# (I think it's used as a sort of fallback)
+# so we need to point it at the absolute path properly
+# not sure what are the consequences.. maybe it wouldn't be able to run against installed packages? not sure..
+search_pypath_orig = _pytest.main.search_pypath
+def search_pypath(module_name: str) -> str:
+    return str(root_dir)
+_pytest.main.search_pypath = search_pypath

tox.ini

@@ -7,6 +7,8 @@ envlist = tests,pylint,mypy
 toxworkdir={env:TOXWORKDIR_BASE:}{toxinidir}/.tox
 
 [testenv]
+# TODO how to get package name from setuptools?
+package_name = "cachew"
 passenv =
     CI
     CI_*
@@ -18,32 +20,33 @@ passenv =
 
 [testenv:tests]
 commands =
-    pip install -e .[testing]
+    {envpython} -m pip install -e .[testing]
     # posargs allow test filtering, e.g. tox ... -- -k test_name
-    python -m pytest src {posargs}
+    {envpython} -m pytest \
+        --pyargs {[testenv]package_name} \
+        {posargs}
 
 
 [testenv:mypy]
 commands =
-    pip install -e .[testing]
-    python -m mypy --install-types --non-interactive \
-                   -p cachew                         \
-                   # txt report is a bit more convenient to view on CI
-                   --txt-report  .coverage.mypy      \
-                   --html-report .coverage.mypy      \
-                   {posargs}
+    {envpython} -m pip install -e .[testing]
+    {envpython} -m mypy --install-types --non-interactive \
+        -p {[testenv]package_name}       \
+        # txt report is a bit more convenient to view on CI
+        --txt-report  .coverage.mypy     \
+        --html-report .coverage.mypy     \
+        {posargs}
 
 
 # todo get rid of pylint? it has limited value...
 [testenv:pylint]
 commands =
-    pip install -e .[testing]
-    python -m pylint src/cachew {posargs}
+    {envpython} -m pip install -e .[testing]
+    {envpython} -m pylint src/cachew {posargs}
 
 
 # todo not sure if really need bandit at all?
 [testenv:bandit]
 commands =
-    pip install -e .[testing]
-    python -m bandit -c .bandit.yml -r src/cachew
-
+    {envpython} -m pip install -e .[testing]
+    {envpython} -m bandit -c .bandit.yml -r src/cachew