passbolt-styleguide/src/react-extension/components/ResourceDetails/DisplayResourceDetails/DisplayResourceDetailsComment.test.page.js

Passbolt styleguide contains common styling assets used by the different sites, plugin, etc.

/**
 * Passbolt ~ Open source password manager for teams
 * Copyright (c) 2020 Passbolt SA (https://www.passbolt.com)
 *
 * Licensed under GNU Affero General Public License version 3 of the or any later version.
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) 2020 Passbolt SA (https://www.passbolt.com)
 * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
 * @link          https://www.passbolt.com Passbolt(tm)
 * @since         2.11.0
 */

import { fireEvent, render, waitFor } from "@testing-library/react";
import AppContext from "../../../../shared/context/AppContext/AppContext";
import React from "react";
import DisplayResourceDetailsComment from "./DisplayResourceDetailsComment";
import AddResourceCommentPageObject from "../../ResourceComment/AddResourceComment/AddResourceComment.test.page.object";
import DisplayResourceCommentListPageObject from "../../ResourceComment/DisplayResourceCommentList/DisplayResourceCommentList.test.page.object";
import ConfirmResourceCommentDeletionPageObject from "../../ResourceComment/ConfirmResourceCommentDeletion/ConfirmResourceCommentDeletion.test.page.object";
import PropTypes from "prop-types";
import ManageDialogs from "../../Common/Dialog/ManageDialogs/ManageDialogs";
import DialogContextProvider from "../../../contexts/DialogContext";
import MockTranslationProvider from "../../../test/mock/components/Internationalisation/MockTranslationProvider";
import userEvent from "@testing-library/user-event";

/**
 * The PasswordSidebarCommentSection component represented as a page
 */
export default class PasswordSidebarCommentSectionPage {
  /**
   * Default constructor
   * @param appContext An app context
   * @param props Props to attach
   */
  constructor(appContext, props) {
    this._page = render(
      <MockTranslationProvider>
        <AppContextProvider context={appContext}>
          <DialogContextProvider>
            <ManageDialogs />
            <DisplayResourceDetailsComment {...props} />
          </DialogContextProvider>
        </AppContextProvider>
      </MockTranslationProvider>,
    );
    this.setupPageObjects();
  }

  /**
   * Set up the objects of the page
   */
  setupPageObjects() {
    this._addComment = new AddResourceCommentPageObject(this._page.container);
    this._displayCommentList = new DisplayResourceCommentListPageObject(this._page.container);
    this._titleHeader = new TitleHeaderPageObject(this._page.container);
    this._addIcon = new AddIconPageObject(this._page.container);
    this._confirmDeleteComment = new ConfirmResourceCommentDeletionPageObject(this._page.container);
  }

  /**
   * Return the page object of the title header
   * @returns {{select: select}}
   */
  get title() {
    return this._titleHeader;
  }

  /**
   * Return the page object of add icon element
   */
  get addIcon() {
    return this._addIcon;
  }

  /**
   * Returns the page object of add comment component
   */
  get addComment() {
    return this._addComment;
  }

  /**
   * Returns the page object of display comments
   */
  get displayCommentList() {
    return this._displayCommentList;
  }

  /**
   * Returns the page object of the confirm comment deletion
   */
  get confirmDeleteComment() {
    return this._confirmDeleteComment;
  }
}

/**
 * Page object for the TitleHeader element
 */
class TitleHeaderPageObject {
  /**
   * Default constructor
   * @param container The container which includes the AddComment Component
   */
  constructor(container) {
    this._container = container;
  }

  /**
   * Returns the clickable area of the header
   */
  get hyperlink() {
    return this._container.querySelector(".accordion-header h4 button.link");
  }

  /** Click on the title */
  async click() {
    const leftClick = { button: 0 };
    fireEvent.click(this.hyperlink, leftClick);
    await waitFor(() => {});
  }
}

/**
 * Page object for the AddIcon element
 */
class AddIconPageObject {
  /**
   * Default constructor
   * @param container The container which includes the AddComment Component
   */
  constructor(container) {
    this._container = container;
    this.user = userEvent.setup();
  }

  /**
   * Returns the icon element
   */
  get icon() {
    return this._container.querySelector(".section-action");
  }

  /**
   * Returns true if the page object exists in the DOM
   * @returns {boolean}
   */
  exists() {
    return this.icon !== null;
  }

  /**
   * Click on the page object
   */
  async click() {
    this.icon.focus();
    await this.user.click(this.icon);
  }
}

/**
 * Custom application provider (used to force the re-rendering when context changes )
 */
class AppContextProvider extends React.Component {
  /**
   * Default constructor
   * @param props Props component
   */
  constructor(props) {
    super(props);
    this.state = props.context;
  }

  componentDidMount() {
    this.setState({ setContext: this.setState.bind(this) });
  }

  /**
   * Render the component
   */
  render() {
    return <AppContext.Provider value={this.state}>{this.props.children}</AppContext.Provider>;
  }
}

AppContextProvider.propTypes = {
  context: PropTypes.object,
  children: PropTypes.any,
};