LGA-3267: Add Ruff Format to the pipeline (#25)

Author: BenMillar-MOJ

.github/workflows/static-analysis.yml

@@ -34,11 +34,16 @@ jobs:
     name: Ruff
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: chartboost/ruff-action@v1
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Lint
+        uses: chartboost/ruff-action@v1
         with:
           args: check --output-format=github
-          src: './src'
+      - name: Format
+        uses: chartboost/ruff-action@v1
+        with:
+          args: format --check
 
   sonarcloud:
     name: Sonar cloud

.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
         files: requirements-(base|production).in
         args: [requirements/source/requirements-production.in, "--output-file", requirements/generated/requirements-production.txt]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.5.4
+    rev: v0.6.2
     hooks:
       - id: ruff
         args: [ --fix ]

app/__init__.py

@@ -133,9 +133,7 @@ def create_app(config_class=Config):
     )
     # Concat all headscripts seperately so they can be loaded into the DOM head.
     headscripts = Bundle(
-        "src/js/headscripts/*.js",
-        filters="jsmin",
-        output="dist/js/headscripts.min.js"
+        "src/js/headscripts/*.js", filters="jsmin", output="dist/js/headscripts.min.js"
     )
     if "css" not in assets:
         assets.register("css", css)

app/main/__init__.py

@@ -3,4 +3,4 @@
 bp = Blueprint("main", __name__, template_folder="../templates/main")
 
 from app.main import routes  # noqa: E402,F401
-from app.main import filters
+from app.main import filters  # noqa: E402,F401

app/main/filters.py

@@ -4,7 +4,7 @@
 
 @bp.app_template_filter("dict")
 def str_to_dict(s):
-    """ Uses the JSON module to parse a string into a dict.
+    """Uses the JSON module to parse a string into a dict.
     This can be invoked in Jinja templates using:
     {{ '{"spam": "eggs"}' | dict }}
 
@@ -16,7 +16,7 @@ def str_to_dict(s):
 
 @bp.app_template_filter("get_item")
 def get_item_from_dict(d, s):
-    """ Gets an item from a dict safely returning None if it is not present
+    """Gets an item from a dict safely returning None if it is not present
     This can be invoked in Jinja templates using:
     {{ '{"spam": "eggs"}' | dict | get_item("spam") }}
 

app/main/gtm.py

@@ -33,5 +33,7 @@ def detect_gtm_anon_id():
     def remember_gtm_anon_id(response):
         session["gtm_anon_id"] = str(uuid.uuid4())
         expiration_date = datetime.now(UTC) + timedelta(days=30)
-        response.set_cookie("gtm_anon_id", session.get("gtm_anon_id"), expires=expiration_date)
+        response.set_cookie(
+            "gtm_anon_id", session.get("gtm_anon_id"), expires=expiration_date
+        )
         return response

requirements/generated/requirements-development.txt

@@ -124,7 +124,7 @@ requests==2.32.3
     #   pytest-base-url
 rich==13.7.1
     # via flask-limiter
-ruff==0.5.4
+ruff==0.6.2
     # via -r requirements/source/requirements-development.in
 sentry-sdk[flask]==2.10.0
     # via -r requirements/source/requirements-base.in

tests/functional_tests/conftest.py

@@ -3,13 +3,15 @@
 from app import create_app
 from flask import url_for
 
+
 class TestConfig(Config):
     TESTING = True
     DEBUG = True
     SERVER_NAME = "localhost"
     RATELIMIT_ENABLED = False
     SECRET_KEY = "TEST_KEY"
 
+
 @pytest.fixture(scope="session")
 def app():
     app = create_app(TestConfig)
@@ -28,4 +30,4 @@ def runner(app):
 
 @pytest.fixture(scope="function", autouse=True)
 def startup(app, page):
-    page.goto(url_for('main.index', _external=True))
+    page.goto(url_for("main.index", _external=True))

tests/functional_tests/test_accessibility.py

@@ -8,12 +8,13 @@
 
 ACCESSIBILITY_STANDARDS = ["wcag2a", "wcag2aa"]
 
+
 def check_accessibility(page: Page):
-    '''
+    """
     Inserts axe core python into a page at the yield step
     to run accessibility based testing. Axe will run on
     the page defined in the function.
-    '''
+    """
     if page.title() != "localhost":
         directory = "tests/functional_tests/accessibility_output"
         if not os.path.exists(directory):
@@ -24,16 +25,16 @@ def check_accessibility(page: Page):
 
         wcag_violations = []
 
-        for violation in results['violations']:
+        for violation in results["violations"]:
             if set(violation["tags"]) & set(ACCESSIBILITY_STANDARDS):
                 wcag_violations.append(violation)
-        
+
         if len(wcag_violations) == 0:
             assert "No WCAG accessibility issues found"
         else:
             # Cleans the URL to remove any invalid characters and replace with _
             invalid_filename_chars = r'[\/:*?"<>|]'
-            sanitized_title = re.sub(invalid_filename_chars, '_', page.title())
+            sanitized_title = re.sub(invalid_filename_chars, "_", page.title())
 
             max_title_len = 30
             file_name = f"axe_results_{sanitized_title[:max_title_len]}.json"
@@ -44,17 +45,18 @@ def check_accessibility(page: Page):
 
 @pytest.mark.usefixtures("live_server")
 def test_all_page_accessibility(app, page: Page):
-    ignored_routes = ['static', '/']
+    ignored_routes = ["static", "/"]
     routes = app.view_functions
     for route in routes:
         if route not in ignored_routes:
             full_url = url_for(route, _external=True)
             page.goto(full_url)
             check_accessibility(page)
 
+
 def test_accessibility_folder():
-    path = 'tests/functional_tests/accessibility_output'
+    path = "tests/functional_tests/accessibility_output"
     if not any(os.scandir(path)):
         assert True
     else:
-        assert not 'WCAG accessibility issues found'
+        assert not "WCAG accessibility issues found"

tests/functional_tests/test_example.py

@@ -1,6 +1,7 @@
 from playwright.sync_api import Page
 import pytest
 
+
 @pytest.mark.usefixtures("live_server")
 def test_base_accessibility(page: Page):
-    pass
+    pass

tests/unit_tests/test_example.py

@@ -1,4 +1,4 @@
 def test_coverage():
     # Test Pytest coverage
     assert 1 + 1 == 2
-    pass
+    pass