Merge branch 'main' into feature/BCSS-20615-regression-test-subject-episodes-diagnosis-date

Signed-off-by: vidhya-chandra1 <[email protected]>

Author: vidhya-chandra1

.gitignore

@@ -18,5 +18,6 @@ test-results/
 axe-reports/
 .env
 local.env
+.test_last_runs.json
 
 # Please, add your custom content below!

buildBase.dockerfile

@@ -1,18 +1,37 @@
+# This dockerfile allows for the code from the project to be built into a Docker image,
+# for use in a CI/CD-style environment such as GitHub Actions or Jenkins.
+# Further reading on this: https://docs.docker.com/get-started/docker-concepts/the-basics/what-is-an-image/
+
 FROM python:3.13-slim
 
+# Create non-root OS user/group and configure environment
+RUN addgroup --system nonroot \
+  && adduser --system --home /home/nonroot nonroot --ingroup nonroot
+
 WORKDIR /test
 
+ENV HOME=/home/nonroot
+ENV PATH="$HOME/.local/bin:$PATH"
+
 # Install dependencies
 COPY ./requirements.txt ./requirements.txt
-RUN pip install --no-cache-dir -r requirements.txt
-RUN playwright install --with-deps
-RUN playwright install chrome
+RUN pip install --no-cache-dir -r requirements.txt && \
+  playwright install --with-deps && \
+  mkdir -p /tests/ && \
+  mkdir -p /utils/ && \
+  mkdir -p /pages/
 
-RUN mkdir -p /tests/
+# Copy project files
 COPY ./tests/ ./tests/
-RUN mkdir -p /utils/
 COPY ./utils/ ./utils/
+COPY ./pages/ ./pages/
+COPY ./conftest.py ./conftest.py
 COPY ./pytest.ini ./pytest.ini
 COPY ./run_tests.sh ./run_tests.sh
+COPY ./users.json ./users.json
+
+# Set permissions, make the script executable and switch OS user
+RUN chmod +x ./run_tests.sh \
+  && chown -R nonroot:nonroot /test
 
-RUN chmod +x ./run_tests.sh
+USER nonroot

conftest.py

@@ -6,9 +6,16 @@
 
 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
+from _pytest.config.argparsing import Parser
+from _pytest.fixtures import FixtureRequest
+
+# Environment Variable Handling
 
 LOCAL_ENV_PATH = Path(os.getcwd()) / "local.env"
 
@@ -35,3 +42,67 @@ 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__)
+
+
+# Command-Line Options for Pytest
+
+
+def pytest_addoption(parser: Parser) -> None:
+    """
+    Add custom command-line options to pytest.
+
+    Args:
+        parser (Parser): The pytest parser object used to define CLI options.
+
+    Adds:
+        --subjects-to-run-for (int):
+            The number of subjects to run the test setup for.
+            Default is 10.
+
+    Example:
+        pytest tests/test_setup.py::test_setup_subjects_as_a259 --subjects-to-run-for=5
+    """
+    parser.addoption(
+        "--subjects-to-run-for",
+        action="store",
+        default="10",
+        help="Number of subjects to run the test setup for (default: 10)",
+    )
+
+
+@pytest.fixture
+def subjects_to_run_for(request: FixtureRequest) -> int:
+    """
+    Fixture to retrieve the value of the '--subjects-to-run-for' CLI argument.
+
+    Args:
+        request (FixtureRequest): Provides access to the requesting test context.
+
+    Returns:
+        int: The number of subjects specified via the CLI or default (10).
+    """
+    return int(request.config.getoption("--subjects-to-run-for"))  # type: ignore

docs/utility-guides/DatasetField.md

@@ -83,5 +83,5 @@ The example below is using options that can be imported from `pages.datasets.inv
 
     # populate_select_locator_for_field_inside_div
     DatasetFieldUtil(page).populate_select_locator_for_field_inside_div(
-        "Classification", "divPolypNumber1Section", PolypClassificationOptions.LS
+        "Classification", "divPolypNumber1Section", PolypClassificationOptions.IS
     )