Merge pull request #56 from GitGuardian/agateau/enforce-precommits

Enforce precommits

Author: agateau-gg

.github/workflows/test-lint.yml

@@ -20,17 +20,25 @@ jobs:
         uses: actions/setup-python@v1
         with:
           python-version: 3.9
+
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install --upgrade pipenv==2022.10.4
-          pipenv install --dev --system --skip-lock
-      - name: Lint with flake8
-        run: |
-          pipenv run flake8
-      - name: Lint with black
-        run: |
-          pipenv run black .
+          python -m pip install --upgrade pipenv==2022.10.4 pre-commit
+          pipenv install --system --skip-lock
+
+      - uses: actions/cache@v3
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }}
+
+      - name: Install pre-commit hooks
+        run: pre-commit install --install-hooks
+
+      - name: Run pre-commit checks
+        run: pre-commit run --show-diff-on-failure --all-files
+        env:
+          GITGUARDIAN_API_KEY: ${{ secrets.GITGUARDIAN_API_KEY }}
 
   build:
     runs-on: ${{ matrix.os }}

Makefile

@@ -5,24 +5,16 @@ SHELL :=/bin/bash
 test ?= tests
 
 all:
-	echo "Usage :"
-	echo "      make test"           # Run tests
-	echo "      make coverage"           # Run tests and coverage
-	echo "      make black"          # Run black formatter on python code
-	echo "      make flake8"          # Run flake8 linter on python code
-	echo "      make isort"          # Run isort linter on python code
+	echo "Targets:"
+	echo "  test            Run tests"
+	echo "  coverage        Run tests with coverage"
+	echo "  lint            Run all linters"
 
 test:
 	pipenv run pytest --disable-pytest-warnings -vvv $(test)
 
 coverage:
 	pipenv run coverage run --source pygitguardian -m pytest --disable-pytest-warnings && pipenv run coverage report --fail-under=80
 
-black:
-	pipenv run black .
-
-flake8:
-	pipenv run flake8
-
-isort:
-	pipenv run isort **/*.py
+lint:
+	pre-commit run --all

changelog.d/20230425_100744_antonin.lacombe_implement_honeytoken_creation.md

@@ -1,4 +1,3 @@
-
 ### Added
 
 - Add `GGClient.create_honeytoken()` method.

changelog.d/20230505_162227_antonin.lacombe_update_honeytoken_id_type.md

@@ -1,4 +1,3 @@
-
 ### Changed
 
 - Add `gitguardian_url` and change id type of `honeytoken`'s model.

pygitguardian/client.py

@@ -252,7 +252,7 @@ def get(
     def post(
         self,
         endpoint: str,
-        data: Optional[Dict[str, str]] = None,
+        data: Optional[Dict[str, Any]] = None,
         version: str = DEFAULT_API_VERSION,
         extra_headers: Optional[Dict[str, str]] = None,
         **kwargs: Any,

pygitguardian/models.py

@@ -118,7 +118,7 @@ def rename_errors(self, data: Dict, many: bool, **kwargs: Any) -> Dict:
         return data
 
     @post_load
-    def make_detail_response(self, data: Dict[str, str], **kwargs: Any) -> "Detail":
+    def make_detail_response(self, data: Dict[str, Any], **kwargs: Any) -> "Detail":
         return Detail(**data)
 
 
@@ -132,7 +132,9 @@ class Detail(Base):
 
     SCHEMA = DetailSchema()
 
-    def __init__(self, detail: str, status_code: Optional[int] = None, **kwargs: Any) -> None:
+    def __init__(
+        self, detail: str, status_code: Optional[int] = None, **kwargs: Any
+    ) -> None:
         super().__init__(status_code=status_code)
         self.detail = detail
 

tests/test_client.py

@@ -672,8 +672,7 @@ def test_create_honeytoken(
         "name": "honeytoken A",
         "description": "honeytoken used in the repository AA",
         "created_at": "2019-08-22T14:15:22Z",
-        "gitguardian_url":
-            "https://dashboard.gitguardian.com/workspace/1/honeytokens/d45a123f-b15d-4fea-abf6-ff2a8479de5b",
+        "gitguardian_url": "https://dashboard.gitguardian.com/workspace/1/honeytokens/d45a123f-b15d-4fea-abf6-ff2a8479de5b",  # noqa: E501
         "status": "active",
         "triggered_at": "2019-08-22T14:15:22Z",
         "revoked_at": None,
@@ -683,18 +682,17 @@ def test_create_honeytoken(
         "revoker_id": None,
         "creator_api_token_id": None,
         "revoker_api_token_id": None,
-        "token": {
-            "access_token_id": "AAAA",
-            "secret_key": "BBB"
-        },
-        "tags": ["publicly_exposed"]
+        "token": {"access_token_id": "AAAA", "secret_key": "BBB"},
+        "tags": ["publicly_exposed"],
     }
 
     request_mock.return_value = mock_response
 
-    result = client.create_honeytoken(name="honeytoken A",
-                                      description="honeytoken used in the repository AA",
-                                      type_="AWS")
+    result = client.create_honeytoken(
+        name="honeytoken A",
+        description="honeytoken used in the repository AA",
+        type_="AWS",
+    )
 
     assert request_mock.called
     assert isinstance(result, HoneytokenResponse)
@@ -719,9 +717,11 @@ def test_create_honeytoken_error(
 
     request_mock.return_value = mock_response
 
-    result = client.create_honeytoken(name="honeytoken A",
-                                      description="honeytoken used in the repository AA",
-                                      type_="AWS")
+    result = client.create_honeytoken(
+        name="honeytoken A",
+        description="honeytoken used in the repository AA",
+        type_="AWS",
+    )
 
     assert request_mock.called
     assert isinstance(result, Detail)

tests/test_models.py

@@ -145,8 +145,7 @@ def test_document_handle_surrogates(self):
                     "name": "honeytoken A",
                     "description": "honeytoken used in the repository AA",
                     "created_at": "2019-08-22T14:15:22Z",
-                    "gitguardian_url":
-                    "https://dashboard.gitguardian.com/workspace/1/honeytokens/d45a123f-b15d-4fea-abf6-ff2a8479de5b",
+                    "gitguardian_url": "https://dashboard.gitguardian.com/workspace/1/honeytokens/d45a123f-b15d-4fea-abf6-ff2a8479de5b",  # noqa: E501
                     "status": "active",
                     "triggered_at": "2019-08-22T14:15:22Z",
                     "revoked_at": None,
@@ -156,11 +155,8 @@ def test_document_handle_surrogates(self):
                     "revoker_id": None,
                     "creator_api_token_id": None,
                     "revoker_api_token_id": None,
-                    "token": {
-                        "access_token_id": "AAAA",
-                        "secret_key": "BBB"
-                    },
-                    "tags": ["publicly_exposed"]
+                    "token": {"access_token_id": "AAAA", "secret_key": "BBB"},
+                    "tags": ["publicly_exposed"],
                 },
             ),
         ],