openmct/e2e/tests/functional/notification.e2e.spec.js

/*****************************************************************************
 * Open MCT, Copyright (c) 2014-2023, United States Government
 * as represented by the Administrator of the National Aeronautics and Space
 * Administration. All rights reserved.
 *
 * Open MCT is licensed under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0.
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 * Open MCT includes source code licensed under additional open source
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 * this source code distribution or the Licensing information page available
 * at runtime from the About dialog for additional information.
 *****************************************************************************/

/*
This test suite is dedicated to tests which verify Open MCT's Notification functionality
*/

const { createDomainObjectWithDefaults, createNotification } = require('../../appActions');
const { test, expect } = require('../../pluginFixtures');

const infoConfig = {
  severity: 'info',
  message: 'Info message'
};
const alertConfig = {
  severity: 'alert',
  message: 'Alert message'
};
const errorConfig = {
  severity: 'error',
  message: 'Error message'
};

test.describe('Notifications list', () => {
  /** @type {import('@playwright/test').Locator} */
  let notificationsList;

  test.beforeEach(async ({ page }) => {
    notificationsList = page.locator('div[role="dialog"]');
    // Go to baseURL
    await page.goto('./', { waitUntil: 'domcontentloaded' });
  });

  test('Notifications can be dismissed individually from the list', async ({ page }) => {
    test.info().annotations.push({
      type: 'issue',
      description: 'https://github.com/nasa/openmct/issues/6820'
    });

    // Create an alert notification with the message "Alert message"
    await createNotification(page, alertConfig);

    // Create an alert notification with the message "Alert message"
    await createNotification(page, alertConfig);

    // Create an error notification with the message "Error message"
    await createNotification(page, errorConfig);

    // Create an alert notification with the message "Alert message"
    await createNotification(page, alertConfig);

    // Create an alert notification with the message "Alert message"
    await createNotification(page, alertConfig);

    // Verify that there is a button with aria-label "Review 2 Notifications"
    expect(await page.locator('button[aria-label="Review 5 Notifications"]').count()).toBe(1);

    // Click on button with aria-label "Review 1 Notification"
    await page.click('button[aria-label="Review 5 Notifications"]');

    // Notifications list dialog is open
    await expect(notificationsList).toBeVisible();
    expect(await notificationsList.locator('div[role="listitem"]').count()).toBe(5);

    // Verify there is still a notification (listitem) with the text "Alert message"
    expect(await notificationsList.locator('div[role="listitem"]').nth(2).innerText()).toContain(
      'Error message'
    );

    // Click on button with aria-label="Dismiss notification of Alert message"
    await page.click('button[aria-label="Dismiss notification of Error message"]');
    expect(await notificationsList.locator('div[role="listitem"]').count()).toBe(4);
  });

  test('When last notification dismissed, list closes automatically', async ({ page }) => {
    test.info().annotations.push({
      type: 'issue',
      description: 'https://github.com/nasa/openmct/issues/6820'
    });

    // Go to baseURL
    await page.goto('./', { waitUntil: 'domcontentloaded' });

    // Create an error notification with the message "Error message"
    await createNotification(page, errorConfig);

    // Create an alert notification with the message "Alert message"
    await createNotification(page, alertConfig);

    // Verify that there is a button with aria-label "Review 2 Notifications"
    expect(await page.locator('button[aria-label="Review 2 Notifications"]').count()).toBe(1);

    // Click on button with aria-label "Review 2 Notifications"
    await page.click('button[aria-label="Review 2 Notifications"]');

    // Notifications list dialog is open
    await expect(notificationsList).toBeVisible();

    // Click on button with aria-label="Dismiss notification of Error message"
    await page.getByRole('button', { name: 'Dismiss notification of Error message' }).click();

    // Verify there is no a notification (listitem) with the text "Error message" since it was dismissed
    // expect(await page.getByRole('dialog').getByRole('listitem')).not.toContain('Error message');

    // Verify there is still a notification (listitem) with the text "Alert message"
    // expect(await page.getByRole('dialog').getByRole('listitem')).toContain('Alert message');

    // Click on button with aria-label="Dismiss notification of Alert message"
    await page.getByRole('button', { name: 'Dismiss notification of Alert message' }).click();

    // Verify that there is no dialog since the notification overlay was closed automatically after all notifications were dismissed
    await expect(notificationsList).toBeHidden();
  });
});

test.describe('Notification Overlay', () => {
  test('Closing notification list after notification banner disappeared does not cause it to open automatically', async ({
    page
  }) => {
    test.info().annotations.push({
      type: 'issue',
      description: 'https://github.com/nasa/openmct/issues/6130'
    });

    // Go to baseURL
    await page.goto('./', { waitUntil: 'domcontentloaded' });

    // Create a new Display Layout object
    await createDomainObjectWithDefaults(page, { type: 'Display Layout' });

    // Click on the button "Review 1 Notification"
    await page.click('button[aria-label="Review 1 Notification"]');

    // Verify that Notification List is open
    expect(await page.locator('div[role="dialog"]').isVisible()).toBe(true);

    // Wait until there is no Notification Banner
    await page.waitForSelector('div[role="alert"]', { state: 'detached' });

    // Click on the "Close" button of the Notification List
    await page.click('button[aria-label="Close"]');

    // On the Display Layout object, click on the "Edit" button
    await page.click('button[title="Edit"]');

    // Click on the "Save" button
    await page.click('button[title="Save"]');

    await page.getByRole('listitem', { name: 'Save and Finish Editing' }).click();

    // Verify that Notification List is NOT open
    expect(await page.locator('div[role="dialog"]').isVisible()).toBe(false);
  });
});