Light refactor of visual tests (#5585)

e2e/helper/notebookUtils.js

@@ -20,9 +20,11 @@
  * at runtime from the About dialog for additional information.
  *****************************************************************************/
 
-const { createDomainObjectWithDefaults } = require('../appActions');
+const { selectInspectorTab, createDomainObjectWithDefaults } = require('../appActions');
 
 const NOTEBOOK_DROP_AREA = '.c-notebook__drag-area';
+const CUSTOM_NAME = 'CUSTOM_NAME';
+const path = require('path');
 
 /**
  * @param {import('@playwright/test').Page} page
@@ -62,8 +64,86 @@ async function commitEntry(page) {
   await page.locator('.c-ne__save-button > button').click();
 }
 
+/**
+ * @param {import('@playwright/test').Page} page
+ */
+async function startAndAddRestrictedNotebookObject(page) {
+  // eslint-disable-next-line no-undef
+  await page.addInitScript({ path: path.join(__dirname, 'addInitRestrictedNotebook.js') });
+  await page.goto('./', { waitUntil: 'domcontentloaded' });
+
+  return createDomainObjectWithDefaults(page, {
+    type: CUSTOM_NAME,
+    name: 'Restricted Test Notebook'
+  });
+}
+
+/**
+ * @param {import('@playwright/test').Page} page
+ */
+async function lockPage(page) {
+  const commitButton = page.locator('button:has-text("Commit Entries")');
+  await commitButton.click();
+
+  //Wait until Lock Banner is visible
+  await page.locator('text=Lock Page').click();
+}
+
+/**
+ * Creates a notebook object and adds an entry.
+ * @param {import('@playwright/test').Page} - page to load
+ * @param {number} [iterations = 1] - the number of entries to create
+ */
+async function createNotebookAndEntry(page, iterations = 1) {
+  const notebook = createDomainObjectWithDefaults(page, { type: 'Notebook' });
+
+  for (let iteration = 0; iteration < iterations; iteration++) {
+    await enterTextEntry(page, `Entry ${iteration}`);
+  }
+
+  return notebook;
+}
+
+/**
+ * Creates a notebook object, adds an entry, and adds a tag.
+ * @param {import('@playwright/test').Page} page
+ * @param {number} [iterations = 1] - the number of entries (and tags) to create
+ */
+async function createNotebookEntryAndTags(page, iterations = 1) {
+  const notebook = await createNotebookAndEntry(page, iterations);
+  await selectInspectorTab(page, 'Annotations');
+
+  for (let iteration = 0; iteration < iterations; iteration++) {
+    // Hover and click "Add Tag" button
+    // Hover is needed here to "slow down" the actions while running in headless mode
+    await page.locator(`[aria-label="Notebook Entry"] >> nth = ${iteration}`).click();
+    await page.hover(`button:has-text("Add Tag")`);
+    await page.locator(`button:has-text("Add Tag")`).click();
+
+    // Click inside the tag search input
+    await page.locator('[placeholder="Type to select tag"]').click();
+    // Select the "Driving" tag
+    await page.locator('[aria-label="Autocomplete Options"] >> text=Driving').click();
+
+    // Hover and click "Add Tag" button
+    // Hover is needed here to "slow down" the actions while running in headless mode
+    await page.hover(`button:has-text("Add Tag")`);
+    await page.locator(`button:has-text("Add Tag")`).click();
+    // Click inside the tag search input
+    await page.locator('[placeholder="Type to select tag"]').click();
+    // Select the "Science" tag
+    await page.locator('[aria-label="Autocomplete Options"] >> text=Science').click();
+  }
+
+  return notebook;
+}
+
 // eslint-disable-next-line no-undef
 module.exports = {
   enterTextEntry,
-  dragAndDropEmbed
+  dragAndDropEmbed,
+  startAndAddRestrictedNotebookObject,
+  lockPage,
+  createNotebookEntryAndTags,
+  createNotebookAndEntry
 };