Merge pull request #2378 from kurtmckee/tox

Add tox for cross-platform, parallel test suite execution

Author: staticdev

.github/workflows/lint.yml

@@ -33,4 +33,4 @@ jobs:
         run: uv sync --all-extras --frozen
 
       - name: Lint
-        run: ./scripts/lint.sh
+        run: uv run --with tox-uv tox -e lint

.github/workflows/test.yml

@@ -38,8 +38,7 @@ jobs:
         run: uv sync --all-extras --frozen
 
       - name: Test
-        shell: bash
-        run: ./scripts/test.sh
+        run: uv run --with tox-uv tox -e py,coverage_report-ci
 
       - name: Report Coverage
         if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.11'

pyproject.toml

@@ -76,6 +76,7 @@ tests = ["tests", "*/tests"]
 
 [tool.coverage.run]
 branch = true
+parallel = true
 source = ["isort", "tests"]
 omit = [
     "isort/_vendored/*",
@@ -141,6 +142,8 @@ dev = [
     "ruff>=0.9.6",
     "stdlibs>=2024.10.21.16",
     "toml>=0.10.2",
+    "tox>=4.24.1",
+    "tox-uv>=1.25.0",
     "types-colorama>=0.4.2",
     "types-setuptools>=70.0.0.20240523",
     "types-toml>=0.1.3",

scripts/lint.sh

@@ -0,0 +1,65 @@
+[tox]
+env_list =
+    coverage_erase
+    # When updating the list of Python versions to test,
+    # use search-and-replace to ensure that intra-environment
+    # dependencies are maintained for parallel execution.
+    py{3.13, 3.12, 3.11, 3.10, 3.9}
+    coverage_report
+    mypy
+
+
+[testenv:coverage_erase]
+description = Erase coverage files
+dependency_groups =
+    dev
+commands =
+    coverage erase
+
+
+[testenv]
+runner = uv-venv-lock-runner
+dependency_groups =
+    dev
+depends =
+    py{3.13, 3.12, 3.11, 3.10, 3.9}: coverage_erase
+commands =
+    coverage run -m pytest tests/unit/ -s --ignore=tests/unit/test_deprecated_finders.py
+
+
+[testenv:coverage_report{,-ci}]
+description = Create a coverage report
+depends =
+    py{3.13, 3.12, 3.11, 3.10, 3.9}
+dependency_groups =
+    dev
+commands_pre =
+    # `coverage combine` will fail if run twice in a row.
+    # The '-' ignores failures.
+    - coverage combine
+ # Only write an HTML reports when NOT running in CI.
+    # Also, ignore the exit code if coverage falls below the fail_under value.
+    !ci: - coverage html
+commands =
+    coverage report
+commands_post =
+    # Only write an XML report when running in CI.
+    ci: coverage xml
+
+
+[testenv:lint]
+description = Lint the project
+skip_install = true
+dependency_groups =
+    dev
+commands =
+    cruft check
+    mypy -p isort -p tests
+    black --target-version py39 --check .
+    isort --profile hug --check --diff isort/ tests/
+    isort --profile hug --check --diff example_isort_formatting_plugin/
+    isort --profile hug --check --diff example_isort_sorting_plugin/
+    isort --profile hug --check --diff example_shared_isort_profile/
+    flake8 isort/ tests/
+    ruff check
+    bandit -r isort/ -x isort/_vendored