BCSS-20899: Align with playwright-python-blueprint (#101)

<!-- markdownlint-disable-next-line first-line-heading -->
## Description

<!-- Describe your changes in detail. -->
A change to the reporting in the playwright-python-blueprint was in
conflict with our conftest.py file, so this brings in that change and
aligns us back to the blueprint.

## Context

<!-- Why is this change required? What problem does it solve? -->
This change amends the reporting so it includes the description of the
test in the HTML, and ensures we don't fall behind the
playwright-python-blueprint.

## Type of changes

<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply. -->

- [x] Refactoring (non-breaking change)
- [x] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would change existing
functionality)
- [ ] Bug fix (non-breaking change which fixes an issue)

## Checklist

<!-- Go over all the following points, and put an `x` in all the boxes
that apply. -->

- [x] I am familiar with the [contributing
guidelines](https://github.com/nhs-england-tools/playwright-python-blueprint/blob/main/CONTRIBUTING.md)
- [x] I have followed the code style of the project
- [ ] I have added tests to cover my changes (where appropriate)
- [ ] I have updated the documentation accordingly
- [ ] This PR is a result of pair or mob programming

---

## Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others
privacy, we kindly ask you to NOT including [PII (Personal Identifiable
Information) / PID (Personal Identifiable
Data)](https://digital.nhs.uk/data-and-information/keeping-data-safe-and-benefitting-the-public)
or any other sensitive data in this PR (Pull Request) and the codebase
changes. We will remove any PR that do contain any sensitive
information. We really appreciate your cooperation in this matter.

- [x] I confirm that neither PII/PID nor sensitive data are included in
this PR and the codebase changes.

Author: davethepunkyone

conftest.py

@@ -6,10 +6,15 @@
 
 import pytest
 import os
+import typing
 from dotenv import load_dotenv
 from pathlib import Path
+from _pytest.python import Function
+from pytest_html.report_data import ReportData
 from utils.load_properties_file import PropertiesFile
 
+# Environment Variable Handling
+
 LOCAL_ENV_PATH = Path(os.getcwd()) / "local.env"
 
 
@@ -35,3 +40,27 @@ def smokescreen_properties() -> dict:
 @pytest.fixture
 def general_properties() -> dict:
     return PropertiesFile().get_general_properties()
+
+
+# HTML Report Customization
+
+
+def pytest_html_report_title(report: ReportData) -> None:
+    report.title = "BCSS Test Automation Report"
+
+
+def pytest_html_results_table_header(cells: list) -> None:
+    cells.insert(2, "<th>Description</th>")
+
+
+def pytest_html_results_table_row(report: object, cells: list) -> None:
+    description = getattr(report, "description", "N/A")
+    cells.insert(2, f"<td>{description}</td>")
+
+
+@pytest.hookimpl(hookwrapper=True)
+def pytest_runtest_makereport(item: Function) -> typing.Generator[None, None, None]:
+    outcome = yield
+    if outcome is not None:
+        report = outcome.get_result()
+        report.description = str(item.function.__doc__)