Update Netbox snapshot, add pre-commit for ruff linting/formatting and use it in CI

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+94cfb2723f453c0cd7bffba112d1ee2a89fba996 # Run ruff format on all files
+5809b73d4aec68f180d25d2451288250fd6d25ef # Run ruff check on all files

.github/workflows/docker-compose-test.yml → .github/workflows/ci.yml

@@ -1,14 +1,44 @@
-name: Docker Compose Validation
+name: CI
 
 on:
-  pull_request:
   push:
     branches: [ main ]
+  pull_request:
+
+env:
+  UV_LOCKED: true  # Assert that the `uv.lock` will remain unchanged
 
 jobs:
+  precommit:
+    name: Run pre-commit
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v7
+        with:
+          # It is considered best practice to pin to a specific uv version.
+          version: "0.9.29"
+          python-version: '3.13'
+
+      - name: Install the project
+        run: uv sync
+
+      - name: Cache pre-commit hooks and environments
+        uses: actions/cache@v5
+        with:
+          path: ~/.cache/pre-commit
+          key: ${{ runner.os }}-pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+
+      - name: Run remaining pre-commit hooks
+        run: uv run pre-commit run --all-files
+
   validate-compose:
     name: Spin up and test health of services
     runs-on: ubuntu-latest
+    needs: precommit  # Only run if precommit checks pass
 
     steps:
       - name: Checkout repository
@@ -75,4 +105,4 @@ jobs:
 
       - name: Tear down Docker Compose
         if: always()
-        run: docker compose down -v
+        run: docker compose down -v

.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+# .pre-commit-config.yaml
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.0   # pin to a specific Ruff version
+    hooks:
+      # Ruff linting (includes some type-related rules if enabled in your config)
+      - id: ruff-check
+        args:
+          - --fix
+
+      # Ruff formatting
+      - id: ruff-format

docker/netbox/patch_federation.py

@@ -1,7 +1,7 @@
 import re
 from pathlib import Path
 
-NETBOX_ROOT = Path('/opt/netbox/netbox')
+NETBOX_ROOT = Path("/opt/netbox/netbox")
 
 resolve_reference = '''\
     @classmethod
@@ -10,7 +10,7 @@ def resolve_reference(cls, id: strawberry.ID) -> '{type_name}':
         return models.{model_name}.objects.get(pk=id)
 '''
 
-type_directives = f"directives=[Key(fields=key, resolvable=UNSET) for key in ['id']],"
+type_directives = "directives=[Key(fields=key, resolvable=UNSET) for key in ['id']],"
 
 
 def insert_import(text: str, import_stmt: str) -> str:
@@ -19,7 +19,7 @@ def insert_import(text: str, import_stmt: str) -> str:
 
 
 def patch_types():
-    file = NETBOX_ROOT / 'dcim/graphql/types.py'
+    file = NETBOX_ROOT / "dcim/graphql/types.py"
     text = file.open().read()
 
     text = insert_import(text, "from strawberry.federation.schema_directives import Key")
@@ -34,21 +34,21 @@ def patch_types():
         text = re.sub(regex_find_class, rf"\1{method}\n", text, count=1, flags=re.DOTALL)
 
         # Add directives to the class decorator
-        regex_find_decorator  = rf"(@strawberry_django.type\(\n\s+models\.{model_name},)"
+        regex_find_decorator = rf"(@strawberry_django.type\(\n\s+models\.{model_name},)"
         text = re.sub(regex_find_decorator, rf"\1 {type_directives}", text, count=1)
 
-    with file.open(mode='w') as f:
+    with file.open(mode="w") as f:
         f.write(text)
 
 
 def patch_subscription_query():
-    file = NETBOX_ROOT / 'extras/graphql/schema.py'
+    file = NETBOX_ROOT / "extras/graphql/schema.py"
     text = file.open().read()
 
     text = re.sub("subscription:", "nb_subscription:", text, count=1)
     text = re.sub("subscription_list:", "nb_subscription_list:", text, count=1)
 
-    with file.open(mode='w') as f:
+    with file.open(mode="w") as f:
         f.write(text)
 
 
@@ -60,5 +60,5 @@ def main():
     patch_subscription_query()
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()