From 72e2f0fa030baa5f5b5aee1285c2c4bfe006d4a2 Mon Sep 17 00:00:00 2001 From: Arthur Lu Date: Sun, 20 Nov 2022 13:43:42 -0800 Subject: [PATCH] comment appTestHelpers.js Signed-off-by: Arthur Lu --- source/assets/scripts/appTestHelpers.js | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/source/assets/scripts/appTestHelpers.js b/source/assets/scripts/appTestHelpers.js index 434d09f..82ade7a 100644 --- a/source/assets/scripts/appTestHelpers.js +++ b/source/assets/scripts/appTestHelpers.js @@ -1,5 +1,10 @@ import {strict as assert} from "node:assert"; +/** + * Fills out a create or update review form + * @param {Object} page the page object which contains the create or update form + * @param {Object} review review data to input into the form + */ export async function setReviewForm(page, review) { // Set text fields @@ -28,6 +33,12 @@ export async function setReviewForm(page, review) { await rating_select.click({delay: 100}); } +/** + * Tests a page or shadowDOM for correct element text, src, or alt values + * @param {Object} root page or shodowDOM to test + * @param {string} prefix prefix character for element IDs + * @param {Object} expected values for eahc element + */ export async function checkCorrectness(root, prefix, expected){ // Get the review image and check src and alt let img = await root.$(`#${prefix}-mealImg`);