AC - got ruff and mypy tests all passing

Author: andrew-cleveland

pages/bcss_home_page.py

@@ -28,35 +28,35 @@ def __init__(self, page: Page):
         )
         self.contacts_list = self.page.get_by_role("link", name="Contacts List")
 
-    def click_sub_menu_link(self):
+    def click_sub_menu_link(self) -> None:
         self.sub_menu_link.click()
 
-    def click_hide_sub_menu_link(self):
+    def click_hide_sub_menu_link(self) -> None:
         self.hide_sub_menu_link.click()
 
-    def click_select_org_link(self):
+    def click_select_org_link(self) -> None:
         self.select_org_link.click()
 
-    def click_back_button(self):
+    def click_back_button(self) -> None:
         self.back_button.click()
 
-    def click_release_notes_link(self):
+    def click_release_notes_link(self) -> None:
         self.release_notes_link.click()
 
-    def click_refresh_alerts_link(self):
+    def click_refresh_alerts_link(self) -> None:
         self.refresh_alerts_link.click()
 
-    def click_user_guide_link(self):
+    def click_user_guide_link(self) -> None:
         self.user_guide_link.click()
 
-    def click_help_link(self):
+    def click_help_link(self) -> None:
         self.help_link.click()
 
-    def click_screening_pracitioners_appointments(self):
+    def click_screening_pracitioners_appointments(self) -> None:
         self.screening_pracitioners_appointments.click()
 
-    def click_contacts_list(self):
+    def click_contacts_list(self) -> None:
         self.contacts_list.click()
 
-    def click_logout(self):
+    def click_logout(self) -> None:
         self.log_out.click()

pages/contacts_list.py

@@ -8,34 +8,28 @@ def __init__(self, page: Page):
 
         # Main Menu
         self.view_contacts = self.page.get_by_role("link", name="View Contacts")
-        self.edit_my_contact_details = self.page.get_by_role(
-            "link", name="Edit My Contact Details"
-        )
+        self.edit_my_contact_details = self.page.get_by_role("link", name="Edit My Contact Details")
         self.maintain_contacts = self.page.get_by_role("link", name="Maintain Contacts")
-        self.my_preference_settings = self.page.get_by_role(
-            "link", name="My Preference Settings"
-        )
-        self.extract_contact_details = self.page.get_by_role(
-            "link", name="Extract Contact Details"
-        )
+        self.my_preference_settings = self.page.get_by_role("link", name="My Preference Settings")
+        self.extract_contact_details = self.page.get_by_role("link", name="Extract Contact Details")
         self.resect_and_discard_accredited_endoscopists = self.page.get_by_role(
             "link", name="Resect and Discard Accredited Endoscopists"
         )
 
-    def click_view_contacts(self):
+    def click_view_contacts(self) -> None:
         self.view_contacts.click()
 
-    def click_edit_my_contact_details(self):
+    def click_edit_my_contact_details(self) -> None:
         self.edit_my_contact_details.click()
 
-    def click_maintain_contacts(self):
+    def click_maintain_contacts(self) -> None:
         self.maintain_contacts.click()
 
-    def click_my_preference_settings(self):
+    def click_my_preference_settings(self) -> None:
         self.my_preference_settings.click()
 
-    def click_extract_contact_details(self):
+    def click_extract_contact_details(self) -> None:
         self.extract_contact_details.click()
 
-    def click_resect_and_discard_accredited_endoscopists(self):
+    def click_resect_and_discard_accredited_endoscopists(self) -> None:
         self.resect_and_discard_accredited_endoscopists.click()

pages/login.py

@@ -1,5 +1,8 @@
+import logging
 from playwright.sync_api import Page
 
+logger = logging.getLogger(__name__)
+
 
 class BcssLoginPage:
 
@@ -10,7 +13,10 @@ def __init__(self, page: Page):
         self.password = page.get_by_role("textbox", name="Password")
         self.submit_button = page.get_by_role("button", name="submit")
 
-    def login(self, username, password):
+    def login(self, username: str | None, password: str | None) -> None:
+        if username is None or password is None:
+            logging.error("BCSS_USERNAME and BCSS_PASSWORD environmental variables must be set")
+            raise ValueError("BCSS_USERNAME and BCSS_PASSWORD environmental variables must be set")
         self.username.fill(username)
         self.password.fill(password)
         self.submit_button.click()

pages/screening_practitioner_appointments.py

@@ -23,10 +23,8 @@ def __init__(self, page: Page):
 
         # Main Menu
         self.view_appointments = self.page.get_by_role("link", name="View appointments")
-        self.patients_that_require_colonoscopy_assessment_appointments = (
-            self.page.get_by_role(
-                "link", name="Patients that Require Colonoscopy Assessment Appointments"
-            )
+        self.patients_that_require_colonoscopy_assessment_appointments = self.page.get_by_role(
+            "link", name="Patients that Require Colonoscopy Assessment Appointments"
         )
         self.patients_that_require_colonoscopy_assessment_appointments_bowl_scope = self.page.get_by_role(
             "link",
@@ -35,55 +33,53 @@ def __init__(self, page: Page):
         self.patients_that_require_surveillance_appointments = self.page.get_by_role(
             "link", name="Patients that Require Surveillance Appointments"
         )
-        self.patients_that_require_post_investigation_appointments = (
-            self.page.get_by_role(
-                "link", name="Patients that Require Post-Investigation Appointments"
-            )
+        self.patients_that_require_post_investigation_appointments = self.page.get_by_role(
+            "link", name="Patients that Require Post-Investigation Appointments"
         )
         self.set_availability = self.page.get_by_role("link", name="Set Availability")
 
     # Top menu interactions
-    def click_sub_menu_link(self):
+    def click_sub_menu_link(self) -> None:
         self.sub_menu_link.click()
 
-    def click_hide_sub_menu_link(self):
+    def click_hide_sub_menu_link(self) -> None:
         self.hide_sub_menu_link.click()
 
-    def click_select_org_link(self):
+    def click_select_org_link(self) -> None:
         self.select_org_link.click()
 
-    def click_back_button(self):
+    def click_back_button(self) -> None:
         self.back_button.click()
 
-    def click_release_notes_link(self):
+    def click_release_notes_link(self) -> None:
         self.release_notes_link.click()
 
-    def click_refresh_alerts_link(self):
+    def click_refresh_alerts_link(self) -> None:
         self.refresh_alerts_link.click()
 
-    def click_user_guide_link(self):
+    def click_user_guide_link(self) -> None:
         self.user_guide_link.click()
 
-    def click_help_link(self):
+    def click_help_link(self) -> None:
         self.help_link.click()
 
     # Main Menu interactions
-    def click_view_appointments(self):
+    def click_view_appointments(self) -> None:
         self.view_appointments.click()
 
-    def click_patients_that_require_colonoscopy_assessment_appointments(self):
+    def click_patients_that_require_colonoscopy_assessment_appointments(self) -> None:
         self.patients_that_require_colonoscopy_assessment_appointments.click()
 
     def click_patients_that_require_colonoscopy_assessment_appointments_bowl_scope(
         self,
-    ):
+    ) -> None:
         self.patients_that_require_colonoscopy_assessment_appointments_bowl_scope.click()
 
-    def click_patients_that_require_surveillance_appointments(self):
+    def click_patients_that_require_surveillance_appointments(self) -> None:
         self.patients_that_require_surveillance_appointments.click()
 
-    def click_patients_that_require_post_investigation_appointments(self):
+    def click_patients_that_require_post_investigation_appointments(self) -> None:
         self.patients_that_require_post_investigation_appointments.click()
 
-    def click_set_availability(self):
+    def click_set_availability(self) -> None:
         self.set_availability.click()

pyproject.toml

@@ -0,0 +1,21 @@
+[tool.black]
+line-length = 120
+
+[tool.ruff]
+line-length = 120
+
+target-version = "py312"
+
+lint.select = [
+    "E",  # pycodestyle
+    "W",  # pycodestyle
+    "F",  # pyflakes
+    "I",  # isort
+    "B",  # flake8-bugbear
+    "C90",  # mccabe cyclomatic complexity
+    "G",  # flake8-logging-format
+]
+lint.ignore = []
+exclude = [
+    "docs/adr/assets"
+]

requirements.txt

@@ -6,4 +6,4 @@ python-dotenv>=1.0.1
 pytest-retry>=1.6.3
 pytest-xdist>=3.6.1
 mypy>=1.14.1
-PyMuPDF>=1.24.13
+ruff>=0.9.6

run_tests.sh

@@ -1,4 +1,5 @@
 #!/bin/bash
 
+ruff --fix
 mypy tests/*.py pages/*.py utils/*.py --disallow-untyped-defs --explicit-package-bases
 pytest

tests/test_contacts_list.py

@@ -1,47 +1,46 @@
-from gc import get_count
-from os import environ
+import logging
 import random
 import re
+from os import environ
+
 import pytest
-import logging
+from dotenv import load_dotenv
 from playwright.sync_api import Page, expect
-from pages.login import BcssLoginPage
+
 from pages.bcss_home_page import BcssHomePage
 from pages.contacts_list import ContactsList
-from dotenv import load_dotenv
+from pages.login import BcssLoginPage
 
 load_dotenv()
 logger = logging.getLogger(__name__)
 expect.set_options(timeout=20_000)
 
 
 @pytest.fixture(scope="function", autouse=True)
-def before_each(page: Page):
+def before_each(page: Page) -> None:
     username = environ.get("BCSS_USERNAME")
     password = environ.get("BCSS_PASSWORD")
     login_page = BcssLoginPage(page)
     login_page.login(username, password)
 
 
-def get_to_screen(page: Page):
+def get_to_screen(page: Page) -> None:
     homepage = BcssHomePage(page)
-    expect(
-        page.get_by_role("link", name="Screening Practitioner Appointments")
-    ).to_be_visible()
+    expect(page.get_by_role("link", name="Screening Practitioner Appointments")).to_be_visible()
     homepage.click_contacts_list()
     page.screenshot(path="test-results/contacts_list/select_org_screen.png")
     expect(page.get_by_text("Contacts List")).to_be_visible()
 
 
-def test_view_contacts(page: Page):
+def test_view_contacts(page: Page) -> None:
     get_to_screen(page)
     contacts_list = ContactsList(page)
     contacts_list.click_view_contacts()
     page.screenshot(path="test-results/contacts_list/contacts_list.png")
     expect(page.get_by_text("View Contacts")).to_be_visible()
 
 
-def test_edit_my_contact_details(page: Page):
+def test_edit_my_contact_details(page: Page) -> None:
     get_to_screen(page)
     contacts_list = ContactsList(page)
     contacts_list.click_edit_my_contact_details()
@@ -55,7 +54,7 @@ def test_edit_my_contact_details(page: Page):
     expect(page.get_by_text("The action was performed successfully")).to_be_visible()
 
 
-def generate_phone_number():
+def generate_phone_number() -> str:
     # Generate 2 digits for first part
     first_part = "".join(str(random.randint(0, 9)) for _ in range(2))
     # Generate 2 digits for second part

tests/test_example.py

@@ -13,7 +13,7 @@
 
 @pytest.mark.example
 def test_basic_example(page: Page) -> None:
-    '''
+    """
     This test demonstrates how to quickly get started using Playwright Python.
 
     This example starts with @pytest.mark.example, which indicates this test has been tagged
@@ -27,7 +27,7 @@ def test_basic_example(page: Page) -> None:
     1) Navigates to this repository
     2) Asserts that the README contents rendered by GitHub contains the text "Playwright Python Blueprint"
     3) Asserts that the main section of the page contains the topic label "playwright-python"
-    '''
+    """
 
     # Navigate to page
     page.goto("https://github.com/nhs-england-tools/playwright-python-blueprint")

tests/test_homepage_links.py

@@ -1,16 +1,18 @@
 from os import environ
+
 import pytest
+from dotenv import load_dotenv
 from playwright.sync_api import Page, expect
-from pages.login import BcssLoginPage
+
 from pages.bcss_home_page import BcssHomePage
-from dotenv import load_dotenv
+from pages.login import BcssLoginPage
 
 load_dotenv()
 expect.set_options(timeout=30_000)
 
 
 @pytest.fixture(scope="function", autouse=True)
-def before_each(page: Page):
+def before_each(page: Page) -> None:
     # This will run before every other job and log in to the homepage.
     username = environ.get("BCSS_USERNAME")
     password = environ.get("BCSS_PASSWORD")
@@ -36,9 +38,7 @@ def test_homepage_select_org(page: Page) -> None:
     # check the select org link works
     homepage.click_select_org_link()
     page.screenshot(path="test-results/homepage/select_org_screen.png")
-    expect(page.locator("form[action*='/changeorg']")).to_contain_text(
-        "Choose an Organisation"
-    )
+    expect(page.locator("form[action*='/changeorg']")).to_contain_text("Choose an Organisation")
     # Check there is at least one entry in the organisation list
     table_locator = page.locator("table#organisations tr")
     row_count = table_locator.count()
@@ -65,9 +65,8 @@ def test_homepage_help(page: Page) -> None:
         homepage.click_help_link()
         help_page = popup_info.value
         help_page.screenshot(path="test-results/homepage/help_screen.png")
-        expect(
-            help_page.get_by_text("Bowel Cancer Screening System Help")
-        ).to_be_visible
+        help_page_element = help_page.get_by_text("Bowel Cancer Screening System Help")
+        expect(help_page_element).to_be_visible()
 
 
 def test_homepage_user_guide(page: Page) -> None: