CI: uv+ruff (#109)

Author: mmetc

.dockerignore

@@ -0,0 +1,11 @@
+# We include .git in the build context because excluding it would break the
+# "make release" target, which uses git to retrieve the build version and tag.
+#.git
+
+crowdsec-blocklist-mirror
+crowdsec-blocklist-mirror-*
+crowdsec-blocklist-mirror.tgz
+docs/
+debian/
+rpm/
+test/

.github/workflows/tests.yml

@@ -38,22 +38,21 @@ jobs:
       env:
         RICHGO_FORCE_COLOR: 1
 
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        version: 0.5.24
+        enable-cache: true
+        cache-dependency-glob: "test/uv.lock"
+
     - name: "Setup Python"
       uses: actions/setup-python@v5
       with:
-        python-version: "3.12"
-        cache: 'pipenv'
+        python-version-file: "test/.python-version"
 
-    - name: "Install python dependencies"
-      env:
-        PIP_BREAK_SYSTEM_PACKAGES: 1
-        PIP_IGNORE_INSTALLED: 1
-      run: |
-        python -m pip install --upgrade pipenv
-        pipenv install --deploy
-        # some tests need root, so we have to install pytest twice
-        sudo python3 -m pip install --upgrade pipenv
-        sudo pipenv install --deploy
+    - name: Install the project
+      working-directory: ./test
+      run: uv sync --all-extras --dev
 
     - name: Install functional test dependencies
       run: |
@@ -66,18 +65,26 @@ jobs:
         CROWDSEC_TEST_NETWORK: net-test
         CROWDSEC_TEST_TIMEOUT: 60
         PYTEST_ADDOPTS: --durations=0 -vv --color=yes -m "not (deb or rpm)"
+      working-directory: ./test
       run: |
         # everything except for
         # - install (requires root, ignored by default)
         # - deb/rpm (on their own workflows)
-        pipenv run pytest
+        uv run pytest
         # these need root
-        sudo -E pipenv run pytest ./test/install/no_crowdsec
+        sudo -E $(which uv) run pytest ./tests/install/no_crowdsec
         # these need a running crowdsec
-        docker run -d --name crowdsec -e CI_TESTING=true -e DISABLE_ONLINE_API=true -ti crowdsecurity/crowdsec
+        docker run -d --name crowdsec -e CI_TESTING=true -e DISABLE_ONLINE_API=true -p 8080:8080 -ti crowdsecurity/crowdsec
         install -m 0755 /dev/stdin /usr/local/bin/cscli <<'EOT'
         #!/bin/sh
         docker exec crowdsec cscli "$@"
         EOT
         sleep 5
-        sudo -E pipenv run pytest ./test/install/with_crowdsec
+        sudo -E $(which uv) run pytest ./tests/install/with_crowdsec
+
+    - name: Lint
+      working-directory: ./test
+      run: |
+        uv run ruff check
+        uv run basedpyright
+

.github/workflows/tests_deb.yml

@@ -26,22 +26,21 @@ jobs:
       with:
         go-version-file: go.mod
 
-    - name: "Setup Python"
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        version: 0.5.24
+        enable-cache: true
+        cache-dependency-glob: "test/uv.lock"
+
+    - name: "Set up Python"
       uses: actions/setup-python@v5
       with:
-        python-version: "3.12"
-        cache: 'pipenv'
+        python-version-file: "test/.python-version"
 
-    - name: "Install python dependencies"
-      env:
-        PIP_BREAK_SYSTEM_PACKAGES: 1
-        PIP_IGNORE_INSTALLED: 1
-      run: |
-        python -m pip install --upgrade pipenv
-        pipenv install --deploy
-        # some tests need root, so we have to install pytest twice
-        sudo python3 -m pip install --upgrade pipenv
-        sudo pipenv install --deploy
+    - name: Install the project
+      run: uv sync --all-extras --dev
+      working-directory: ./test
 
     - name: Install functional test dependencies
       run: |
@@ -56,6 +55,7 @@ jobs:
         CROWDSEC_TEST_NETWORK: net-test
         CROWDSEC_TEST_TIMEOUT: 60
         PYTEST_ADDOPTS: --durations=0 -vv --color=yes
+      working-directory: ./test
       run: |
-        pipenv run pytest test/pkg/test_build_deb.py
-        sudo -E pipenv run pytest -m deb ./test/install/no_crowdsec
+        uv run pytest ./tests/pkg/test_build_deb.py
+        sudo -E $(which uv) run pytest -m deb ./tests/install/no_crowdsec

Pipfile

@@ -0,0 +1 @@
+3.12

Pipfile.lock

@@ -0,0 +1,80 @@
+[project]
+name = "cs-blocklist-mirror-tests"
+version = "0.1.0"
+description = "Tests for cs-blocklist-mirror"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "pexpect>=4.9.0",
+    "pytest>=8.3.5",
+    "pytest-cs>=0.7.21",
+    "pytest-dependency>=0.6.0",
+    "pytest-dotenv>=0.5.2",
+    "zxcvbn>=4.5.0",
+]
+
+[tool.uv.sources]
+pytest-cs = { git = "https://github.com/crowdsecurity/pytest-cs" }
+
+[dependency-groups]
+dev = [
+    "basedpyright>=1.28.4",
+    "ipdb>=0.13.13",
+    "ruff>=0.11.2",
+]
+
+[tool.ruff]
+
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+  "ALL"
+]
+
+ignore = [
+    "ANN",      # Missing type annotations
+    "ARG001",   # Unused function argument: `...`
+    "COM812",   # Trailing comma missing
+    "D100",     # Missing docstring in public module
+    "D103",     # Missing docstring in public function
+    "D104",     # Missing docstring in public package
+    "D202",
+    "D203",     # incorrect-blank-line-before-class
+    "D212",     # Multi-line docstring summary should start at the first line
+    "D400",     # First line should end with a period
+    "D415",     # First line should end with a period, question mark, or exclamation point
+     "ERA",
+    "FIX002",   # Line contains TODO, consider resolving the issue
+    "FIX003",   # Line contains XXX, consider resolving the issue
+    "I001",
+    "PLW1510",  # `subprocess.run` without explicit `check` argument
+    "S101",     # Use of 'assert' detected
+    "S603",     # `subprocess` call: check for execution of untrusted input
+    "S607",     # Starting a process with a partial executable path
+    "TD",
+    "PLR2004",  # Magic value used in comparison, consider replacing `...` with a constant variable
+    "PLR0913",  # Too many arguments in function definition (6 > 5)
+    "PTH107",   # `os.remove()` should be replaced by `Path.unlink()`
+    "PTH108",   # `os.unlink()` should be replaced by `Path.unlink()`
+    "PTH110",   # `os.path.exists()` should be replaced by `Path.exists()`
+    "PTH116",   # `os.stat()` should be replaced by `Path.stat()`, `Path.owner()`, or `Path.group()`
+    "PTH123",   # `open()` should be replaced by `Path.open()`
+    "PT022",    # No teardown in fixture `fw_cfg_factory`, use `return` instead of `yield`
+     "Q000",    # Single quotes found but double quotes preferred
+    "UP022",    # Prefer `capture_output` over sending `stdout` and `stderr` to `PIPE`
+]
+
+[tool.basedpyright]
+reportAny = "none"
+reportArgumentType = "none"
+reportAttributeAccessIssue = "none"
+reportMissingParameterType = "none"
+reportMissingTypeStubs = "none"
+reportOptionalMemberAccess = "none"
+reportUnknownArgumentType = "none"
+reportUnknownMemberType = "none"
+reportUnknownParameterType = "none"
+reportUnknownVariableType = "none"
+reportUnusedCallResult = "none"
+reportUnusedParameter = "none"

test/.python-version

@@ -1,7 +1,7 @@
 [pytest]
 addopts =
     --pdbcls=IPython.terminal.debugger:Pdb
-    --ignore=test/install
+    --ignore=tests/install
     --strict-markers
 markers:
     deb: mark tests related to deb packaging