Converting tests from selenium to playwright. Updating utils and documentation. Updating POMs

Author: adrianoaru-nhs

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
     )

docs/utility-guides/InvestigationDataset.md

@@ -16,6 +16,19 @@ The Investigation Dataset Utility provides methods to fill out the investigation
     - [Key Methods](#key-methods-1)
   - [InvestigationDatasetResults Class](#investigationdatasetresults-class)
   - [Example Usage](#example-usage)
+  - [Using the InvestigationDatasetCompletion class with your own values](#using-the-investigationdatasetcompletion-class-with-your-own-values)
+    - [Required Args](#required-args)
+    - [How to use this method](#how-to-use-this-method)
+    - [Example Usage](#example-usage-1)
+    - [Supported Fields](#supported-fields)
+      - [General Information](#general-information)
+      - [Drug Information](#drug-information)
+      - [Endoscopy Information](#endoscopy-information)
+      - [Failure Infoformation](#failure-infoformation)
+      - [Completion Proof Infoformation](#completion-proof-infoformation)
+      - [Polyp Information (Optional)](#polyp-information-optional)
+      - [Polyp Intervention (Optional)](#polyp-intervention-optional)
+      - [Polyp Histology (Optional)](#polyp-histology-optional)
 
 ## Using the Investigation Dataset Utility
 
@@ -144,4 +157,197 @@ after_investigation.progress_episode_based_on_result(result, younger)
 
 ---
 
+## Using the InvestigationDatasetCompletion class with your own values
+
+You can initialise the class and use its method as follows:
+
+```python
+from utils.investigation_dataset_completion import InvestigationDatasetCompletion
+
+completion_utility = InvestigationDatasetCompletion(page)
+completion_utility.complete_dataset_with_args(
+    general_information=...,
+    drug_information=...,
+    endoscopy_information=...,
+    failure_information=...,
+    completion_information=...,
+    polyp_1_information=...,
+    polyp_1_intervention=...,
+    polyp_1_histology=...
+)
+```
+
+### Required Args
+
+All fields are `dict` objects containing key-value pairs that match the expected form inputs.
+
+- `general_information` (required): Information about site, practitioner, and endoscopist.
+- `drug_information` (required): Drugs used during the procedure.
+- `endoscopy_information` (required): Field-value pairs describing procedure details.
+- `failure_information` (required): Reasons for dataset failure.
+- `completion_information` (optional): Completion proof values.
+- `polyp_1_information` (optional): Data for a polyp entry.
+- `polyp_1_intervention` (optional): Data for a polyp intervention.
+- `polyp_1_histology` (optional): Histology data for the polyp.
+
+### How to use this method
+
+Call the `complete_dataset_with_args()` method to populate and submit the investigation dataset form. The method performs the following:
+
+- Navigates to relevant form sections.
+- Inputs field values using select/input locators.
+- Handles optional sub-sections (e.g., polyps, interventions).
+- Handles conditional logic for field population.
+- Submits the form once complete.
+
+---
+
+### Example Usage
+
+```python
+completion_utility = InvestigationDatasetCompletion(page)
+
+completion_utility.complete_dataset_with_args(
+    general_information={
+        "site": -1,
+        "practitioner": -1,
+        "testing clinician": -1,
+        "aspirant endoscopist": None
+    },
+    drug_information = {
+        "drug_type1": DrugTypeOptions.MANNITOL,
+        "drug_dose1": "3",
+    },
+    endoscopy_information = {
+        "endoscope inserted": "yes",
+        "procedure type": "therapeutic",
+        "bowel preparation quality": BowelPreparationQualityOptions.GOOD,
+        "comfort during examination": ComfortOptions.NO_DISCOMFORT,
+        "comfort during recovery": ComfortOptions.NO_DISCOMFORT,
+        "endoscopist defined extent": EndoscopyLocationOptions.APPENDIX,
+        "scope imager used": YesNoOptions.YES,
+        "retroverted view": YesNoOptions.NO,
+        "start of intubation time": "09:00",
+        "start of extubation time": "09:30",
+        "end time of procedure": "10:00",
+        "scope id": "Autotest",
+        "insufflation": InsufflationOptions.AIR,
+        "outcome at time of procedure": OutcomeAtTimeOfProcedureOptions.LEAVE_DEPARTMENT,
+        "late outcome": LateOutcomeOptions.NO_COMPLICATIONS,
+    },
+    failure_information={
+        "failure reasons": FailureReasonsOptions.ADHESION
+    },
+    completion_information={
+        "completion proof": CompletionProofOptions.VIDEO_APPENDIX
+    },
+    polyp_1_information={
+        "location": EndoscopyLocationOptions.APPENDIX,
+        "classification": PolypClassificationOptions.IS,
+        "estimate of whole polyp size": "8",
+        "polyp access": PolypAccessOptions.EASY,
+        "left in situ": YesNoOptions.NO,
+    },
+    polyp_1_intervention={
+        "modality": PolypInterventionModalityOptions.POLYPECTOMY,
+        "device": PolypInterventionDeviceOptions.COLD_SNARE,
+        "excised": YesNoOptions.YES,
+        "retrieved": YesNoOptions.YES,
+    },
+    polyp_1_histology={
+        "date of receipt": datetime.today(),
+        "date of reporting": datetime.today(),
+        "pathology provider": -1,
+        "pathologist": -1,
+        "polyp type": PolypTypeOptions.SERRATED_LESION,
+        "serrated lesion sub type": SerratedLesionSubTypeOptions.MIXED_POLYP,
+        "polyp excision complete": PolypExcisionCompleteOptions.R1,
+        "polyp size": "10",
+        "polyp dysplasia": PolypDysplasiaOptions.NOT_REPORTED,
+        "polyp carcinoma": YesNoUncertainOptions.NO,
+    }
+)
+```
+
+---
+
+### Supported Fields
+
+#### General Information
+
+| Field                   | Type    | Description                          |
+|------------------------|---------|--------------------------------------|
+| site                   | `int`   | Index in the site dropdown           |
+| practitioner           | `int`   | Index in the practitioner dropdown   |
+| testing clinician      | `int`   | Index in the clinician dropdown      |
+| aspirant endoscopist   | `int or None` | Index or skip check if None   |
+
+#### Drug Information
+
+| Field        | Type  | Description                        |
+|--------------|-------|------------------------------------|
+| drug_type1   | str   | Drug name (e.g., Midazolam)        |
+| drug_dose1   | str   | Dose (e.g., "2mg")                 |
+
+#### Endoscopy Information
+
+Supports dynamic keys like:
+
+- `"endoscope inserted"`: `"yes"` or `"no"`
+- `"procedure type"`: `"diagnostic"` or `"therapeutic"`
+- `"bowel preparation quality"`: Option from dropdown
+- `"start of intubation time"`: `"09:00"`
+- `"scope id"`: Free text
+
+#### Failure Infoformation
+
+| Field              | Type  | Description                              |
+|-------------------|-------|------------------------------------------|
+| failure reasons    | str   | Reason text for dataset failure          |
+
+#### Completion Proof Infoformation
+
+| Field              | Type  | Description                              |
+|-------------------|-------|------------------------------------------|
+| completion proof   | str   | Value for the "Proof Parameters" field   |
+
+#### Polyp Information (Optional)
+
+| Field                        | Type  | Description                          |
+|-----------------------------|-------|--------------------------------------|
+| location                    | str   | Polyp location                       |
+| classification              | str   | Polyp classification                 |
+| estimate of whole polyp size| str   | Size in mm                           |
+| polyp access                | str   | Access difficulty                    |
+| left in situ                | str   | `"Yes"` or `"No"`                    |
+
+#### Polyp Intervention (Optional)
+
+| Field                                   | Type  | Description                     |
+|----------------------------------------|-------|---------------------------------|
+| modality                               | str   | E.g., `"Polypectomy"`           |
+| device                                 | str   | E.g., `"Cold snare"`            |
+| excised                                | str   | `"Yes"` or `"No"`               |
+| retrieved                              | str   | `"Yes"` or `"No"`               |
+| excision technique                     | str   | Optional technique detail       |
+| polyp appears fully resected endoscopically | str | Option from dropdown        |
+
+#### Polyp Histology (Optional)
+
+| Field                     | Type        | Description                         |
+|--------------------------|-------------|-------------------------------------|
+| date of receipt          | `datetime`  | Date of receipt                     |
+| date of reporting        | `datetime`  | Date of reporting                   |
+| pathology provider       | `int`       | Index for provider                  |
+| pathologist              | `int`       | Index for pathologist               |
+| polyp type               | `str`       | E.g., `"Serrated Lesion"`           |
+| serrated lesion sub type | `str`       | Subtype of serrated lesion          |
+| adenoma sub type         | `str`       | Subtype of adenoma                  |
+| polyp excision complete  | `str`       | Completion status                   |
+| polyp size               | `str`       | Size in mm                          |
+| polyp dysplasia          | `str`       | Dysplasia report                    |
+| polyp carcinoma          | `str`       | `"Yes"`, `"No"`, or `"Uncertain"`   |
+
+---
+
 For more details on each function's implementation, refer to the source code in `utils/investigation_dataset.py`.