passbolt-styleguide/test/matchers/toThrowEntityValidationError.js

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

/**
 * Passbolt ~ Open source password manager for teams
 * Copyright (c) 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) Passbolt SA (https://www.passbolt.com)
 * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
 * @link          https://www.passbolt.com Passbolt(tm)
 * @since         4.8.0
 */
const getPropertyValueByPath = (obj, path) => path
  .split('.')
  .reduce((accumulator, key) => accumulator?.[key], obj);

exports.toThrowEntityValidationError = async function(received, propertyPath, validationRule, dto) {
  const {printExpected, printReceived, matcherHint} = this.utils;
  let errorDetails;

  try {
    await received();
  } catch (error) {
    errorDetails = error.details;
  }

  let expectedPropertyMessage = propertyPath;
  if (validationRule) {
    expectedPropertyMessage += `:${validationRule}`;
  }

  let passMessage =
    `${matcherHint('.not.toThrowEntityValidationErrorOnProperty')
    }\n\n` +
    `Expected validation to not fail on property & optionally validation rule: ` +
    `  ${printExpected(expectedPropertyMessage)}\n` +
    `Received:\n` +
    `  ${printReceived(errorDetails)}`;

  let failMessage =
    `${matcherHint('.toThrowEntityValidationErrorOnProperty')
    }\n\n` +
    `Expected validation to fail on properties:\n` +
    `  ${printExpected(expectedPropertyMessage)}\n` +
    `Received:\n` +
    `  ${printReceived(errorDetails)}`;

  if (dto) {
    passMessage += `\nDTO:\n` +
    `  ${printReceived(dto)}\n`;
    failMessage += `\nDTO:\n` +
    `  ${printReceived(dto)}\n`;
  }

  const pass = Boolean(errorDetails)
    && Boolean(getPropertyValueByPath(errorDetails, propertyPath))
    && (!validationRule || validationRule in getPropertyValueByPath(errorDetails, propertyPath));

  return {pass: pass, message: () => (pass ? passMessage : failMessage)};
};