Enforce linting

Author: seanwiseman

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 100
+exclude = .git, .venv, .virtualenv, .tox, dist, doc, *egg, build, tools, templates, styles, static

.pylintrc

@@ -0,0 +1,15 @@
+[MESSAGES CONTROL]
+disable=
+    missing-docstring,
+    too-few-public-methods,
+    too-many-public-methods,
+    too-many-lines,
+    logging-fstring-interpolation,
+
+[SIMILARITIES]
+min-similarity-lines=5
+ignore-comments=yes
+ignore-docstrings=yes
+ignore-imports=yes
+
+max-args = 10

Makefile

@@ -1,4 +1,4 @@
-.PHONY: install install-dev start start-services stop-services delete-db
+.PHONY: install install-dev start start-services stop-services delete-db flake8 pylint lint
 
 install:
 	pip install -r requirements.txt
@@ -17,3 +17,11 @@ stop-services:
 
 delete-db: stop-services
 	docker volume rm coar-notify-inbox_mongodb_data
+
+flake8:
+	flake8
+
+pylint:
+	pylint --fail-under=10 db routers tasks tests validation app.py config.py
+
+lint: flake8 pylint

app.py

@@ -25,7 +25,8 @@
     allow_headers=["*"],
 )
 
-app.mount("/static", StaticFiles(directory=os.path.join(os.path.dirname(__file__), "static")), name="static")
+app.mount("/static",
+          StaticFiles(directory=os.path.join(os.path.dirname(__file__), "static")), name="static")
 app.include_router(inbox_router)
 
 

db/__init__.py

@@ -8,7 +8,5 @@ async def get_db():
     return client.notification_store
 
 
-async def get_collection(db, collection_name: str):
-    return db[collection_name]
-
-
+async def get_collection(database, collection_name: str):
+    return database[collection_name]

db/notifications.py

@@ -12,13 +12,13 @@
 
 
 async def _get_notifications_collection():
-    db = await get_db()
-    return await get_collection(db, NOTIFICATIONS_COLLECTION_NAME)
+    database = await get_db()
+    return await get_collection(database, NOTIFICATIONS_COLLECTION_NAME)
 
 
 async def _get_notification_states_collection():
-    db = await get_db()
-    return await get_collection(db, NOTIFICATION_STATES_COLLECTION_NAME)
+    database = await get_db()
+    return await get_collection(database, NOTIFICATION_STATES_COLLECTION_NAME)
 
 
 async def create_notification(notification: Notification) -> str:

mypy.ini

@@ -0,0 +1,2 @@
+[mypy]
+ignore_missing_imports = True

requirements.dev.txt

@@ -1,3 +1,5 @@
 httpx==0.24.1
+flake8==6.1.0
+pylint==2.17.5
 pytest==7.4.0
 pytest-asyncio==0.21.1

routers/inbox.py

@@ -51,7 +51,8 @@ async def read_inbox(request: Request) -> JSONResponse:
 
 
 @router.post("/")
-async def add_notification(request: Request, background_tasks: BackgroundTasks, payload: dict = Body(...)):
+async def add_notification(request: Request, background_tasks: BackgroundTasks,
+                           payload: dict = Body(...)):
     conforms, errors = validate_notification(payload)
 
     if not conforms:

tasks/webhooks.py

@@ -14,11 +14,13 @@ def send_notification_to_webhook(notification: Notification, webhook_url: str) -
         response = requests.post(
             url=webhook_url,
             headers={"content-type": "application/ld+json"},
-            json=json.dumps(notification, default=str)
+            json=json.dumps(notification, default=str),
+            timeout=(10, 10),
         )
 
         response.raise_for_status()
 
-        logger.info(f"Successfully sent notification to {webhook_url}. Status code: {response.status_code}")
+        logger.info(f"Successfully sent notification to {webhook_url}. "
+                    f"Status code: {response.status_code}")
     except requests.RequestException:
         logger.exception(f"Failed to send notification to {webhook_url}")

tests/app_test.py

@@ -1,6 +1,7 @@
-from fastapi.testclient import TestClient
 from unittest.mock import patch
 
+from fastapi.testclient import TestClient
+
 from app import app
 
 client = TestClient(app)

tests/conftest.py

@@ -102,11 +102,11 @@ def valid_offer_review_payload():
         },
         "id": "urn:uuid:0370c0fb-bb78-4a9b-87f5-bed307a509dd",
         "object": {
-            "id": "https://research-organisation.org/repository/preprint/201203/421/",
+            "id": "https://research.org/repository/preprint/201203/421/",
             "ietf:cite-as": "https://doi.org/10.5555/12345680",
             "type": "sorg:AboutPage",
             "url": {
-                "id": "https://research-organisation.org/repository/preprint/201203/421/content.pdf",
+                "id": "https://research.org/repository/preprint/201203/421/content.pdf",
                 "mediaType": "application/pdf",
                 "type": [
                     "Article",
@@ -115,8 +115,8 @@ def valid_offer_review_payload():
             }
         },
         "origin": {
-            "id": "https://research-organisation.org/repository",
-            "inbox": "https://research-organisation.org/inbox/",
+            "id": "https://research.org/repository",
+            "inbox": "https://research.org/inbox/",
             "type": "Service"
         },
         "target": {

tests/db/notifications_test.py

@@ -1,7 +1,14 @@
-import pytest
 from unittest.mock import AsyncMock, patch
+
+import pytest
+
 from db.models import Notification
-from db.notifications import create_notification, get_notification, get_notifications, delete_notification
+from db.notifications import (
+    create_notification,
+    get_notification,
+    get_notifications,
+    delete_notification,
+)
 
 
 @patch('db.notifications.get_db')
@@ -67,4 +74,4 @@ async def test_delete_notification(mock_get_collection, mock_get_db, notificatio
 
     mock_get_db.assert_called_once()
     mock_get_collection.assert_called_once()
-    mock_get_collection.return_value.delete_one.assert_called_once()
+    mock_get_collection.return_value.delete_one.assert_called_once()