Add pre-commit with GiHub Action (#56)

* Update pyproject.toml

* add pre-commit

* Create .pre-commit-config.yaml

* Comment out ruff

* Update .pre-commit-config.yaml

* General formatting

* Create format-and-fail.yml

* Update ci.yml

* Add pre-commit to dev dependencies

* Update pyproject.toml

app/tests/conftest.py

@@ -1,12 +1,14 @@
 import os
 from typing import AsyncGenerator
-from fastapi.testclient import TestClient
-import pytest
 from unittest.mock import patch
+
+import pytest
 import pytest_asyncio
-from sqlalchemy.ext.asyncio import AsyncSession, AsyncEngine
-from app.web.config import ALLOW_ANY_EMAIL
+from fastapi.testclient import TestClient
+from sqlalchemy.ext.asyncio import AsyncEngine, AsyncSession
+
 from app.shared.settings import Settings
+from app.web.config import ALLOW_ANY_EMAIL
 from app.web.db.user_state import UserState
 
 
@@ -65,10 +67,11 @@ def db_session(test_db):
 
 @pytest_asyncio.fixture()
 async def async_test_db(get_settings: Settings):
+    import asyncio
+
     from app.shared.db import models
     from app.shared.db.database import make_async_engine
     from app.web.db.crud import get_user_group_names
-    import asyncio
 
     get_user_group_names.cache_clear()
     engine = await make_async_engine(get_settings.ASYNC_DATABASE_PATH)
@@ -108,8 +111,8 @@ async def async_db_session(async_test_db: AsyncEngine) -> AsyncGenerator[AsyncSe
 
 @pytest.fixture()
 def app(db_session):
-    from app.web.main import app_factory
     from app.web.db import crud
+    from app.web.main import app_factory
     app = app_factory()
     crud.upsert_user_groups(db_session)
     return app
@@ -123,7 +126,11 @@ def client(app):
 
 @pytest.fixture()
 def app_with_auth(app, db_session):
-    from app.web.security import get_token_or_user_auth, get_user_auth, get_user_state
+    from app.web.security import (
+        get_token_or_user_auth,
+        get_user_auth,
+        get_user_state,
+    )
     app.dependency_overrides[get_token_or_user_auth] = lambda: "rick@example.com"
     app.dependency_overrides[get_user_auth] = lambda: "morty@example.com"
     app.dependency_overrides[get_user_state] = lambda: UserState(db_session, "MORTY@example.com")
@@ -138,7 +145,7 @@ def client_with_auth(app_with_auth):
 
 @pytest.fixture()
 def app_with_token(app):
-    from app.web.security import token_api_key_auth, get_token_or_user_auth
+    from app.web.security import get_token_or_user_auth, token_api_key_auth
     app.dependency_overrides[token_api_key_auth] = lambda: ALLOW_ANY_EMAIL
     app.dependency_overrides[get_token_or_user_auth] = lambda: ALLOW_ANY_EMAIL
     return app

app/tests/fake_service_account.json

@@ -1,3 +1,3 @@
 {
-	"client_email": "fake_service_account@fake_service_account.iam.gserviceaccount.com"
-}
+  "client_email": "fake_service_account@fake_service_account.iam.gserviceaccount.com"
+}

app/tests/orchestration.test.yaml

@@ -15,7 +15,7 @@ configurations:
   gsheet_feeder:
     service_account: "app/tests/fake_service_account.json"
   cli_feeder:
-    urls: 
+    urls:
       - "url1"
   hash_enricher:
     algorithm: "SHA-256"

app/tests/shared/db/test_models.py

@@ -3,4 +3,4 @@ def test_generate_uuid():
 
 	assert generate_uuid() != generate_uuid()
 	assert len(generate_uuid()) == 36
-	assert generate_uuid().count("-") == 4
+	assert generate_uuid().count("-") == 4

app/tests/shared/db/test_worker_crud.py

@@ -1,10 +1,9 @@
-from app.shared.db import models
-from app.shared.db import worker_crud, models
 from datetime import datetime
 
-
+from app.shared.db import models, worker_crud
 from app.tests.web.db.test_crud import test_data
 
+
 def test_update_sheet_last_url_archived_at(db_session):
 
     # Create test sheet
@@ -19,7 +18,7 @@ def test_update_sheet_last_url_archived_at(db_session):
     db_session.refresh(test_sheet)
     assert isinstance(test_sheet.last_url_archived_at, datetime)
     assert test_sheet.last_url_archived_at > before
-    
+
     # Test non-existent sheet
     assert worker_crud.update_sheet_last_url_archived_at(db_session, "non-existent-sheet") is False
 
@@ -73,8 +72,8 @@ def test_create_tag(db_session):
 
 
 def test_create_task(db_session):
-    from app.shared.db import worker_crud
     from app.shared import schemas
+    from app.shared.db import worker_crud
 
     task = schemas.ArchiveCreate(
         id="archive-id-456-101",
@@ -114,4 +113,4 @@ def test_create_task(db_session):
     assert nt.group_id == "spaceship"
     assert len(nt.tags) == 0
     assert len(nt.urls) == 0
-    assert nt.created_at is not None
+    assert nt.created_at is not None

app/tests/shared/test_business_logic.py

@@ -1,7 +1,12 @@
 from datetime import datetime, timedelta
 from unittest.mock import MagicMock, patch
+
 import pytest
-from app.shared.business_logic import get_store_archive_until, get_store_archive_until_or_never
+
+from app.shared.business_logic import (
+    get_store_archive_until,
+    get_store_archive_until_or_never,
+)
 
 
 class Test_get_store_archive_until:

app/tests/shared/utils/test_misc.py

@@ -11,7 +11,7 @@ def test_fnv1a_hash_mod():
 
     # Test different modulos
     hash1 = fnv1a_hash_mod("test", 5)
-    hash2 = fnv1a_hash_mod("test", 10) 
+    hash2 = fnv1a_hash_mod("test", 10)
     assert 0 <= hash1 < 5
     assert 0 <= hash2 < 10
 
@@ -28,4 +28,4 @@ def test_fnv1a_hash_mod():
     assert 0 <= fnv1a_hash_mod("测试", 10) < 10
 
     # Test modulo = 1 edge case
-    assert fnv1a_hash_mod("test", 1) == 0
+    assert fnv1a_hash_mod("test", 1) == 0

app/tests/user-groups.test.broken.yaml

@@ -3,4 +3,4 @@ This is just an invalid yaml for testing
 
 still broken: True
   - one
-  - two
+  - two

app/tests/user-groups.test.yaml

@@ -84,4 +84,4 @@ groups:
       # max_archive_lifespan_months: 12
       max_monthly_urls: 1
       # max_monthly_mbs: 50
-      priority: "low"
+      priority: "low"

app/tests/web/db/test_crud.py

@@ -3,10 +3,12 @@ from unittest.mock import patch
 
 import pytest
 import yaml
+
 from app.shared.db import models
 from app.shared.settings import Settings
-
 from app.web.db import crud
+
+
 authors = ["rick@example.com", "morty@example.com", "jerry@example.com"]
 
 
@@ -373,6 +375,7 @@ async def test_get_sheets_by_id_hash(async_db_session):
 @pytest.mark.asyncio
 async def test_delete_stale_sheets(async_db_session):
     from datetime import datetime, timedelta
+
     from sqlalchemy.sql import select
 
     now = datetime.now()
@@ -435,4 +438,4 @@ async def test_delete_stale_sheets(async_db_session):
 
     # Running again should not delete anything
     deleted = await crud.delete_stale_sheets(async_db_session, 7)
-    assert len(deleted) == 0
+    assert len(deleted) == 0

app/tests/web/db/test_user_state.py

@@ -1,5 +1,6 @@
 
 from unittest.mock import MagicMock, PropertyMock, patch
+
 import pytest
 
 from app.shared.db import models

app/tests/web/endpoints/test_default.py

@@ -1,10 +1,12 @@
 from unittest.mock import MagicMock
-from fastapi.testclient import TestClient
+
 import pytest
+from fastapi.testclient import TestClient
+
 from app.shared.schemas import Usage, UsageResponse
 from app.shared.user_groups import GroupInfo
-from app.web.config import VERSION
 from app.tests.web.db.test_crud import test_data
+from app.web.config import VERSION
 
 
 def test_endpoint_home(client_with_auth):

app/tests/web/endpoints/test_interoperability.py

@@ -1,5 +1,5 @@
-from datetime import datetime
 import json
+from datetime import datetime
 from unittest.mock import MagicMock, patch
 
 from app.shared.db import models

app/tests/web/endpoints/test_sheet.py

@@ -1,5 +1,5 @@
-from datetime import datetime
 import json
+from datetime import datetime
 from unittest.mock import MagicMock, patch
 
 from fastapi.testclient import TestClient
@@ -45,8 +45,8 @@ def test_create_sheet_endpoint(app_with_auth, db_session):
     assert response.json() == {"detail": "User does not have access to this group."}
 
     # switch to jerry who's got less quota/permissions
-    from app.web.security import get_user_state
     from app.web.db.user_state import UserState
+    from app.web.security import get_user_state
     app_with_auth.dependency_overrides[get_user_state] = lambda: UserState(db_session, "jerry@example.com")
     client_jerry = TestClient(app_with_auth)
 

app/tests/web/test_main.py

@@ -1,10 +1,10 @@
 import os
-from unittest.mock import patch
-from fastapi.testclient import TestClient
-
 import shutil
+from unittest.mock import patch
 
 import pytest
+from fastapi.testclient import TestClient
+
 
 def test_lifespan(app):
     with TestClient(app) as client:
@@ -25,7 +25,7 @@ def test_logging_middleware(m1, client_with_auth):
         client_with_auth.delete("/url/123")
     # creates one empty and one from above
     assert len(EXCEPTION_COUNTER.collect()[0].samples) == 2
-    
+
 
 def test_serve_local_archive_logic(get_settings):
     # create a test file first
@@ -38,7 +38,7 @@ def test_serve_local_archive_logic(get_settings):
         get_settings.SERVE_LOCAL_ARCHIVE = "/app/local_archive_test"
         from app.web.main import app_factory
         app = app_factory(get_settings)
-        
+
         # test
         client = TestClient(app)
         r = client.get("/app/local_archive_test/temp.txt")

app/tests/web/test_security.py

@@ -1,8 +1,8 @@
 from unittest.mock import Mock, patch
 
+import pytest
 from fastapi import HTTPException
 from fastapi.security import HTTPAuthorizationCredentials
-import pytest
 
 from app.web.config import ALLOW_ANY_EMAIL
 
@@ -108,8 +108,8 @@ async def test_authenticate_user_exception():
 
 
 def test_get_user_state():
-    from app.web.security import get_user_state
     from app.web.db.user_state import UserState
+    from app.web.security import get_user_state
 
     mock_session = Mock()
     test_email = "test@example.com"

app/tests/worker/test_worker_main.py

@@ -1,13 +1,12 @@
 from datetime import datetime
-
 from unittest.mock import patch
 
 import pytest
-
-from app.shared.db import models
-from app.shared import schemas
 from auto_archiver.core import Media, Metadata
 
+from app.shared import schemas
+from app.shared.db import models
+
 
 class Test_create_archive_task():
     URL = "https://example-live.com"