Test running tests directly on action runner

To be able to test on different systems.

.github/workflows/test.yml

@@ -1,13 +1,92 @@
 ---
 name: Tests
+
 on:  # yamllint disable-line rule:truthy
   - push
   - pull_request
   - workflow_dispatch
+
+env:
+  SC_VER: "0.10.0"
+  ESH_VER: "0.3.2"
+
 jobs:
   Tests:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-24.04
+          - macos-13
+        python-version:
+          - "3.11"
     steps:
-      - uses: actions/checkout@v2
-      - name: Tests
-        run: make test
+      - uses: actions/checkout@v4
+
+      - name: Install dependencies on Linux
+        if: ${{ runner.os == 'Linux' }}
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y expect
+      - name: Install dependencies on macOS
+        if: ${{ runner.os == 'macOS' }}
+        run: |
+          brew install expect
+
+      - name: Prepare tools directory
+        run: |
+          mkdir "$RUNNER_TEMP/tools"
+          echo "$RUNNER_TEMP/tools" >> "$GITHUB_PATH"
+
+      - name: Install shellcheck
+        run: |
+          if [ "$RUNNER_OS" = "macOS" ]; then
+            OS=darwin
+          else
+            OS=linux
+          fi
+
+          if [ "$RUNNER_ARCH" = "ARM64" ]; then
+            ARCH=aarch64
+          else
+            ARCH=x86_64
+          fi
+
+          cd "$RUNNER_TEMP"
+
+          BASE_URL="https://github.com/koalaman/shellcheck/releases/download"
+          SC="v$SC_VER/shellcheck-v$SC_VER.$OS.$ARCH.tar.xz"
+          curl -L "$BASE_URL/$SC" | tar Jx shellcheck-v$SC_VER/shellcheck
+          mv shellcheck-v$SC_VER/shellcheck tools
+
+      - name: Install esh
+        run: |
+          cd "$RUNNER_TEMP/tools"
+
+          BASE_URL="https://github.com/jirutka/esh/raw/refs/tags"
+          curl -L -o esh "$BASE_URL/v$ESH_VER/esh"
+          chmod +x esh
+
+      - name: Add old yadm versions  # to test upgrades
+        run: |
+          for version in 1.12.0 2.5.0; do
+            git fetch origin $version:refs/tags/$version
+            git cat-file blob $version:yadm > "$RUNNER_TEMP/tools/yadm-$version"
+            chmod +x "$RUNNER_TEMP/tools/yadm-$version"
+          done
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -r test/requirements.txt
+
+      - name: Run tests
+        run: |
+          git config --global user.email test@yadm.io
+          git config --global user.name "Yadm Test"
+          pytest -v --color=yes

.gitignore

@@ -5,3 +5,4 @@
 .testyadm
 _site
 testenv
+__pycache__/

Makefile

@@ -1,5 +1,5 @@
 PYTESTS = $(wildcard test/test_*.py)
-IMAGE = docker.io/yadm/testbed:2023-07-12
+IMAGE = docker.io/yadm/testbed:2024-11-11
 OCI = docker
 
 .PHONY: all

pyproject.toml

@@ -7,6 +7,7 @@ markers = [
 
 [tool.pylint.design]
 max-args = 14
+max-positional-arguments = 10
 max-locals = 28
 max-attributes = 8
 max-statements = 65

test/Dockerfile

@@ -1,8 +1,7 @@
-FROM ubuntu:23.04
-MAINTAINER Tim Byrne <sultan@locehilios.com>
+FROM ubuntu:24.10
 
 # Shellcheck and esh versions
-ARG SC_VER=0.9.0
+ARG SC_VER=0.10.0
 ARG ESH_VER=0.3.2
 
 # Install prerequisites and configure UTF-8 locale
@@ -14,6 +13,7 @@ RUN \
     expect \
     git \
     gnupg \
+    j2cli \
     locales \
     lsb-release \
     make \
@@ -39,10 +39,9 @@ RUN cd /opt \
   && rm -f shellcheck-v$SC_VER.linux.x86_64.tar.xz \
   && ln -s /opt/shellcheck-v$SC_VER/shellcheck /usr/local/bin
 
-# Upgrade pip3 and install requirements
+# Install requirements
 COPY test/requirements.txt /tmp/requirements.txt
-RUN python3 -m pip install --break-system-packages --upgrade pip setuptools \
-  && python3 -m pip install --break-system-packages --upgrade -r /tmp/requirements.txt \
+RUN python3 -m pip install --break-system-packages -r /tmp/requirements.txt \
   && rm -f /tmp/requirements
 
 # Install esh

test/conftest.py

@@ -9,7 +9,6 @@ import pwd
 import shutil
 from subprocess import PIPE, Popen
 
-import py
 import pytest
 
 
@@ -26,37 +25,37 @@ def pytest_addoption(parser):
 @pytest.fixture(scope="session")
 def shellcheck_version():
     """Version of shellcheck supported"""
-    return "0.9.0"
+    return "0.10.0"
 
 
 @pytest.fixture(scope="session")
 def pylint_version():
     """Version of pylint supported"""
-    return "2.17.0"
+    return "3.3.1"
 
 
 @pytest.fixture(scope="session")
 def isort_version():
     """Version of isort supported"""
-    return "5.12.0"
+    return "5.13.2"
 
 
 @pytest.fixture(scope="session")
 def flake8_version():
     """Version of flake8 supported"""
-    return "6.0.0"
+    return "7.1.1"
 
 
 @pytest.fixture(scope="session")
 def black_version():
     """Version of black supported"""
-    return "23.1.0"
+    return "24.10.0"
 
 
 @pytest.fixture(scope="session")
 def yamllint_version():
     """Version of yamllint supported"""
-    return "1.30.0"
+    return "1.35.1"
 
 
 @pytest.fixture(scope="session")
@@ -246,7 +245,7 @@ class Runner:
         if not expect:
             return
         cmdline = " ".join([f'"{w}"' for w in self.command])
-        expect_script = f"set timeout 2\nspawn {cmdline}\n"
+        expect_script = f"set timeout 5\nspawn {cmdline}\n"
         for question, answer in expect:
             expect_script += "expect {\n" f'"{question}" {{send "{answer}\\r"}}\n' "timeout {close;exit 128}\n" "}\n"
         expect_script += "expect eof\n" "foreach {pid spawnid os_error_flag value} [wait] break\n" "exit $value"
@@ -575,17 +574,21 @@ def ds1(ds1_work_copy, paths, ds1_dset):
 def gnupg(tmpdir_factory, runner):
     """Location of GNUPGHOME"""
 
-    def register_gpg_password(password):
-        """Publish a new GPG mock password"""
-        py.path.local("/tmp/mock-password").write(password)
-
     home = tmpdir_factory.mktemp("gnupghome")
     home.chmod(0o700)
     conf = home.join("gpg.conf")
     conf.write("no-secmem-warning\n")
     conf.chmod(0o600)
     agentconf = home.join("gpg-agent.conf")
-    agentconf.write(f'pinentry-program {os.path.abspath("test/pinentry-mock")}\n' "max-cache-ttl 0\n")
+    agentconf.write(
+        f"""\
+pinentry-program {os.path.abspath("test/pinentry-mock")}
+max-cache-ttl 0
+browser-socket none
+extra-socket none
+disable-scdaemon
+"""
+    )
     agentconf.chmod(0o600)
     data = collections.namedtuple("GNUPG", ["home", "pw"])
     env = os.environ.copy()
@@ -594,4 +597,12 @@ def gnupg(tmpdir_factory, runner):
     # this pre-populates std files in the GNUPGHOME
     runner(["gpg", "-k"], env=env)
 
-    return data(home, register_gpg_password)
+    def register_gpg_password(password):
+        """Publish a new GPG mock password and flush cached passwords"""
+        home.join("mock-password").write(password)
+        runner(["gpgconf", "--reload", "gpg-agent"], env=env)
+
+    yield data(home, register_gpg_password)
+
+    runner(["gpgconf", "--kill", "gpg-agent"], env=env)
+    runner(["gpgconf", "--remove-socketdir", "gpg-agent"], env=env)

test/pinentry-mock

@@ -6,10 +6,9 @@
 echo "OK Pleased to meet you"
 while read -r line; do
   if [[ $line =~ GETPIN ]]; then
-    password="$(cat /tmp/mock-password 2>/dev/null)"
+    password="$(cat "$GNUPGHOME/mock-password" 2>/dev/null)"
     if [ -n "$password" ]; then
-      echo -n "D "
-      echo "$password"
+      echo "D $password"
       echo "OK";
     else
       echo "CANCEL";

test/requirements.txt

@@ -1,8 +1,8 @@
-black==23.1.0
+black==24.10.0
 envtpl
-flake8==6.0.0
-isort==5.12.0
+flake8==7.1.1
+isort==5.13.2
 j2cli
-pylint==2.17.0
-pytest==7.2.2
-yamllint==1.30.0
+pylint==3.3.1
+pytest==8.3.3
+yamllint==1.35.1

test/test_alt.py

@@ -1,4 +1,5 @@
 """Test alt"""
+
 import os
 import string
 

test/test_encryption.py

@@ -2,7 +2,6 @@
 
 import os
 import shlex
-import time
 
 import pytest
 
@@ -219,7 +218,6 @@ def test_symmetric_decrypt(runner, yadm_cmd, paths, decrypt_targets, gnupg, doli
 
     if bad_phrase:
         gnupg.pw("")
-        time.sleep(1)  # allow gpg-agent cache to expire
     else:
         gnupg.pw(PASSPHRASE)
 

test/test_help.py

@@ -1,4 +1,5 @@
 """Test help"""
+
 import pytest
 
 

test/test_list.py

@@ -20,7 +20,8 @@ def test_list(runner, yadm_cmd, paths, ds1, location):
         run_dir = paths.work
     elif location == "outside":
         run_dir = paths.work.join("..")
-    elif location == "subdir":
+    else:
+        assert location == "subdir"
         # first directory with tracked data
         run_dir = paths.work.join(ds1.tracked_dirs[0])
     with run_dir.as_cwd():

test/test_syntax.py

@@ -1,6 +1,7 @@
 """Syntax checks"""
 
 import os
+import shutil
 
 import pytest
 
@@ -77,7 +78,8 @@ def test_yamllint(pytestconfig, runner, yamllint_version):
 
 def test_man(runner):
     """Check for warnings from man"""
-    run = runner(command=["man.REAL", "--warnings", "./yadm.1"])
+    man = "man" if shutil.which("man.REAL") is None else "man.REAL"
+    run = runner(command=[man, "--warnings", "./yadm.1"])
     assert run.success
     assert run.err == ""
     assert "yadm - Yet Another Dotfiles Manager" in run.out

test/test_unit_choose_template_cmd.py

@@ -1,4 +1,5 @@
 """Unit tests: choose_template_cmd"""
+
 import pytest
 
 

test/test_unit_copy_perms.py

@@ -1,4 +1,5 @@
 """Unit tests: copy_perms"""
+
 import os
 
 import pytest

test/test_unit_exclude_encrypted.py

@@ -1,4 +1,5 @@
 """Unit tests: exclude_encrypted"""
+
 import pytest
 
 

test/test_unit_issue_legacy_path_warning.py

@@ -1,4 +1,5 @@
 """Unit tests: issue_legacy_path_warning"""
+
 import pytest
 
 

test/test_unit_private_dirs.py

@@ -1,4 +1,5 @@
 """Unit tests: private_dirs"""
+
 import pytest
 
 

test/test_unit_query_distro.py

@@ -1,4 +1,5 @@
 """Unit tests: query_distro"""
+
 import pytest
 
 

test/test_unit_query_distro_family.py

@@ -1,4 +1,5 @@
 """Unit tests: query_distro_family"""
+
 import pytest
 
 

test/test_unit_record_score.py

@@ -1,4 +1,5 @@
 """Unit tests: record_score"""
+
 import pytest
 
 INIT_VARS = """

test/test_unit_relative_path.py

@@ -1,4 +1,5 @@
 """Unit tests: relative_path"""
+
 import pytest
 
 

test/test_unit_remove_stale_links.py

@@ -1,4 +1,5 @@
 """Unit tests: remove_stale_links"""
+
 import os
 
 import pytest

test/test_unit_report_invalid_alts.py

@@ -1,4 +1,5 @@
 """Unit tests: report_invalid_alts"""
+
 import pytest
 
 

test/test_unit_score_file.py

@@ -1,4 +1,5 @@
 """Unit tests: score_file"""
+
 import pytest
 
 CONDITION = {

test/test_unit_set_local_alt_values.py

@@ -1,4 +1,5 @@
 """Unit tests: set_local_alt_values"""
+
 import pytest
 import utils
 

test/test_unit_set_yadm_dir.py

@@ -1,4 +1,5 @@
 """Unit tests: set_yadm_dirs"""
+
 import pytest
 
 

test/test_unit_template_esh.py

@@ -1,4 +1,5 @@
 """Unit tests: template_esh"""
+
 import os
 
 FILE_MODE = 0o754

test/test_unit_template_j2.py

@@ -1,4 +1,5 @@
 """Unit tests: template_j2cli & template_envtpl"""
+
 import os
 
 import pytest

test/test_unit_upgrade.py

@@ -1,4 +1,5 @@
 """Unit tests: upgrade"""
+
 import pytest
 
 
@@ -62,8 +63,7 @@ def test_upgrade(tmpdir, runner, yadm, condition):
             function git() {{
                 echo "$@"
                 if [[ "$*" = *"submodule status" ]]; then
-                    { 'echo " 1234567 mymodule (1.0)"'
-                        if condition == 'submodules' else ':' }
+                    {'echo " 1234567 mymodule (1.0)"' if condition == 'submodules' else ':'}
                 fi
                 if [[ "$*" = *ls-files* ]]; then
                     return {1 if condition == 'untracked' else 0}

test/test_upgrade.py

@@ -19,13 +19,15 @@ import pytest
     ],
 )
 @pytest.mark.parametrize("submodule", [False, True], ids=["no submodule", "with submodules"])
-def test_upgrade(tmpdir, runner, versions, submodule):
+def test_upgrade(tmpdir, runner, paths, versions, submodule):
     """Upgrade tests"""
     # pylint: disable=too-many-statements
     home = tmpdir.mkdir("HOME")
     env = {"HOME": str(home)}
     runner(["git", "config", "--global", "init.defaultBranch", "master"], env=env)
     runner(["git", "config", "--global", "protocol.file.allow", "always"], env=env)
+    runner(["git", "config", "--global", "user.email", "test@yadm.io"], env=env)
+    runner(["git", "config", "--global", "user.name", "Yadm Test"], env=env)
 
     if submodule:
         ext_repo = tmpdir.mkdir("ext_repo")
@@ -39,7 +41,7 @@ def test_upgrade(tmpdir, runner, versions, submodule):
     os.environ.pop("XDG_DATA_HOME", None)
 
     def run_version(version, *args, check_stderr=True):
-        yadm = f"yadm-{version}" if version else "/yadm/yadm"
+        yadm = f"yadm-{version}" if version else paths.pgm
         run = runner([yadm, *args], shell=True, cwd=str(home), env=env)
         assert run.success
         if check_stderr: