alfresco-content-app/projects/aca-testing-shared/src/utilities/test-element.ts

/*!
 * Copyright © 2005-2024 Hyland Software, Inc. and its affiliates. All rights reserved.
 *
 * Alfresco Example Content Application
 *
 * This file is part of the Alfresco Example Content Application.
 * If the software was purchased under a paid Alfresco license, the terms of
 * the paid license agreement will prevail. Otherwise, the software is
 * provided under the following open source license terms:
 *
 * The Alfresco Example Content Application is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * The Alfresco Example Content Application is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 */

import { by, element, ElementFinder, $, browser } from 'protractor';
import { clearSendKeys, click } from './browser-actions';
import { waitUntilElementIsNotVisible, waitUntilElementIsPresent, waitUntilElementIsVisible } from './browser-visibility';

async function getText(elementFinder: ElementFinder): Promise<string> {
  const present = await waitUntilElementIsVisible(elementFinder);

  if (present) {
    let text = await elementFinder.getText();

    if (text === '') {
      // DO NOT REMOVE BUG sometime wrongly return empty text for cdk elements
      console.info(`Use backup get text script`);

      text = await browser.executeScript(`return arguments[0].textContent`, elementFinder);
      return text?.trim();
    }

    return text;
  } else {
    console.error(`Get Text ${elementFinder.locator().toString()} not present`);
    return '';
  }
}

/**
 * Provides a wrapper for the most common operations with the page elements.
 */
export class TestElement {
  constructor(public elementFinder: ElementFinder) {}

  /**
   * Create a new instance with the element located by the id
   *
   * @param id The id of the element
   * @returns test element wrapper
   */
  static byId(id: string): TestElement {
    return new TestElement(element(by.id(id)));
  }

  /**
   * Create a new instance with the element located by the CSS class name
   *
   * @param selector The CSS class name to lookup
   * @returns test element wrapper
   */
  static byCss(selector: string): TestElement {
    return new TestElement($(selector));
  }

  /**
   * Create a new instance with the element that contains specific text
   *
   * @param selector the CSS selector
   * @param text the text within the target element
   * @returns test element wrapper
   */
  static byText(selector: string, text: string): TestElement {
    return new TestElement(element(by.cssContainingText(selector, text)));
  }

  /**
   * Performs a click on this element
   */
  async click() {
    return click(this.elementFinder);
  }

  /**
   * Checks that an element is present on the DOM of a page and visible
   *
   * @param waitTimeout How long to wait for the condition to be true
   */
  async isVisible(waitTimeout?: number): Promise<boolean> {
    try {
      await waitUntilElementIsVisible(this.elementFinder, waitTimeout);
      return true;
    } catch {
      return false;
    }
  }

  /**
   * Waits until the element is present on the DOM of a page and visible
   *
   * @param waitTimeout How long to wait for the condition to be true
   */
  async waitVisible(waitTimeout?: number): Promise<any> {
    return waitUntilElementIsVisible(this.elementFinder, waitTimeout);
  }

  /**
   * Waits until the element is either invisible or not present on the DOM
   *
   * @param waitTimeout How long to wait for the condition to be true
   */
  async waitNotVisible(waitTimeout?: number): Promise<any> {
    return waitUntilElementIsNotVisible(this.elementFinder, waitTimeout);
  }

  /**
   * Checks that an element is present on the DOM of a page
   *
   * @param waitTimeout How long to wait for the condition to be true
   */
  async isPresent(waitTimeout?: number): Promise<boolean> {
    try {
      await waitUntilElementIsPresent(this.elementFinder, waitTimeout);
      return true;
    } catch {
      return false;
    }
  }

  /**
   * Get the visible (i.e. not hidden by CSS) innerText of this element, including sub-elements, without any leading or trailing whitespace.
   */
  async getText(): Promise<string> {
    return getText(this.elementFinder);
  }

  /**
   * Enter the text
   *
   * @param text the text to enter
   */
  async typeText(text: string): Promise<void> {
    await clearSendKeys(this.elementFinder, text);
  }
}