Merge pull request #1118 from GitGuardian/gg-hh/832/replace_snapshottest

chore: replace snapshottest with syrupy and support py3.12

Author: agateau-gg

.gitguardian.yaml

@@ -34,3 +34,4 @@ secret:
     - .env
     - 'tests/unit/cassettes/*'
     - 'tests/unit/**/snapshots/*'
+    - 'tests/unit/verticals/secret/output/__snapshots__/*'

.github/workflows/ci.yml

@@ -79,7 +79,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-22.04, macos-13, windows-2022]
-        python-version: ['3.9', '3.10', '3.11']
+        python-version: ['3.9', '3.10', '3.11', '3.12']
     steps:
       - uses: actions/checkout@v4
         with:

.pre-commit-config.yaml

@@ -16,7 +16,7 @@ repos:
     rev: v5.0.0
     hooks:
       - id: trailing-whitespace
-        exclude: \.importlinter|tests/unit/verticals/secret/output/snapshots/.*|tests/unit/core/scan/test_commit_utils.py
+        exclude: \.importlinter|tests/unit/verticals/secret(/output)?/__snapshots__/.*|tests/unit/core/scan/test_commit_utils.py
       - id: check-json
       - id: check-added-large-files
       - id: check-yaml

pdm.lock

@@ -27,6 +27,7 @@ classifiers = [
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.9",
     "Operating System :: OS Independent",
     "Topic :: Security",
@@ -123,7 +124,7 @@ tests = [
     "pytest-xdist",
     "pytest-voluptuous",
     "seed-isort-config",
-    "snapshottest",
+    "syrupy",
     "import-linter",
     "jsonschema",
     "vcrpy>=5.1.0",

pyproject.toml

@@ -4,7 +4,6 @@
 
 import pytest
 from pygitguardian.models import Match, PolicyBreak
-from snapshottest import Snapshot
 
 from ggshield.core.filter import censor_match, censor_string, get_ignore_sha
 from tests.unit.conftest import (
@@ -69,7 +68,6 @@ def test_get_ignore_sha(
     policy_breaks: List[PolicyBreak],
     duplicates: bool,
     expected_shas: Set[str],
-    snapshot: Snapshot,
 ) -> None:
     copy_policy_breaks = copy.deepcopy(policy_breaks)
     if duplicates:

tests/unit/cmd/snapshots/__init__.py

@@ -0,0 +1,44 @@
+# serializer version: 1
+# name: test_handle_scan_error[single file exception]
+  '''
+  Error: Scanning failed. Results may be incomplete.
+  Error: Add the following files to your ignored_paths:
+  Error: - /home/user/too/long/file/name: filename:: [ErrorDetail(string='Ensure this field has no more than 256 characters.', code='max_length')]
+  
+  '''
+# ---
+# name: test_handle_scan_error[source not found]
+  '''
+  Error: The provided source was not found in GitGuardian.
+  
+  '''
+# ---
+# name: test_handle_scan_error[too many documents]
+  '''
+  Error: Scanning failed. Results may be incomplete.
+  Error: The following chunk is affected:
+  - /example
+  - /example
+  - /example
+  - /example
+  - /example
+  - /example
+  - /example
+  - /example
+  - /example
+  - /example
+  - /example
+  - /example
+  - /example
+  - /example
+  - /example
+  - /example
+  - /example
+  - /example
+  - /example
+  - /example
+  - /example
+  Error: 400:Too many documents to scan
+  
+  '''
+# ---