openmct/e2e/tests/functional/plugins/timer/timer.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.
 *****************************************************************************/

const { test, expect } = require('../../../../pluginFixtures');
const {
  openObjectTreeContextMenu,
  createDomainObjectWithDefaults
} = require('../../../../appActions');
import { MISSION_TIME } from '../../../../constants';

test.describe('Timer', () => {
  let timer;

  test.beforeEach(async ({ page }) => {
    await page.goto('./', { waitUntil: 'domcontentloaded' });
    timer = await createDomainObjectWithDefaults(page, { type: 'timer' });
    await assertTimerElements(page, timer);
  });

  test('Can perform actions on the Timer', async ({ page }) => {
    test.info().annotations.push({
      type: 'issue',
      description: 'https://github.com/nasa/openmct/issues/4313'
    });

    const timerUrl = timer.url;

    await test.step('From the tree context menu', async () => {
      await triggerTimerContextMenuAction(page, timerUrl, 'Start');
      await triggerTimerContextMenuAction(page, timerUrl, 'Pause');
      await triggerTimerContextMenuAction(page, timerUrl, 'Restart at 0');
      await triggerTimerContextMenuAction(page, timerUrl, 'Stop');
    });

    await test.step('From the 3dot menu', async () => {
      await triggerTimer3dotMenuAction(page, 'Start');
      await triggerTimer3dotMenuAction(page, 'Pause');
      await triggerTimer3dotMenuAction(page, 'Restart at 0');
      await triggerTimer3dotMenuAction(page, 'Stop');
    });

    await test.step('From the object view', async () => {
      await triggerTimerViewAction(page, 'Start');
      await triggerTimerViewAction(page, 'Pause');
      await triggerTimerViewAction(page, 'Restart at 0');
    });
  });
});

test.describe('Timer with target date', () => {
  let timer;

  test.beforeEach(async ({ page }) => {
    await page.goto('./', { waitUntil: 'domcontentloaded' });
    timer = await createDomainObjectWithDefaults(page, { type: 'timer' });
    await assertTimerElements(page, timer);
  });

  // Override clock
  test.use({
    clockOptions: {
      now: MISSION_TIME,
      shouldAdvanceTime: true
    }
  });

  test('Can count down to a target date', async ({ page }) => {
    // Set the target date to 2024-11-24 03:30:00
    await page.getByTitle('More options').click();
    await page.getByRole('menuitem', { name: /Edit Properties.../ }).click();
    await page.getByPlaceholder('YYYY-MM-DD').fill('2024-11-24');
    await page.locator('input[name="hour"]').fill('3');
    await page.locator('input[name="min"]').fill('30');
    await page.locator('input[name="sec"]').fill('00');
    await page.getByLabel('Save').click();

    // Get the current timer seconds value
    const timerSecValue = (await page.locator('.c-timer__value').innerText()).split(':').at(-1);
    await expect(page.locator('.c-timer__direction')).toHaveClass(/icon-minus/);

    // Wait for the timer to count down and assert
    await expect
      .poll(async () => {
        const newTimerValue = (await page.locator('.c-timer__value').innerText()).split(':').at(-1);
        return Number(newTimerValue);
      })
      .toBeLessThan(Number(timerSecValue));
  });

  test('Can count up from a target date', async ({ page }) => {
    // Set the target date to 2020-11-23 03:30:00
    await page.getByTitle('More options').click();
    await page.getByRole('menuitem', { name: /Edit Properties.../ }).click();
    await page.getByPlaceholder('YYYY-MM-DD').fill('2020-11-23');
    await page.locator('input[name="hour"]').fill('3');
    await page.locator('input[name="min"]').fill('30');
    await page.locator('input[name="sec"]').fill('00');
    await page.getByLabel('Save').click();

    // Get the current timer seconds value
    const timerSecValue = (await page.locator('.c-timer__value').innerText()).split(':').at(-1);
    await expect(page.locator('.c-timer__direction')).toHaveClass(/icon-plus/);

    // Wait for the timer to count up and assert
    await expect
      .poll(async () => {
        const newTimerValue = (await page.locator('.c-timer__value').innerText()).split(':').at(-1);
        return Number(newTimerValue);
      })
      .toBeGreaterThan(Number(timerSecValue));
  });
});

/**
 * Actions that can be performed on a timer from context menus.
 * @typedef {'Start' | 'Stop' | 'Pause' | 'Restart at 0'} TimerAction
 */

/**
 * Actions that can be performed on a timer from the object view.
 * @typedef {'Start' | 'Pause' | 'Restart at 0'} TimerViewAction
 */

/**
 * Trigger a timer action from the tree context menu
 * @param {import('@playwright/test').Page} page
 * @param {TimerAction} action
 */
async function triggerTimerContextMenuAction(page, timerUrl, action) {
  const menuAction = `.c-menu ul li >> text="${action}"`;
  await openObjectTreeContextMenu(page, timerUrl);
  await page.locator(menuAction).click();
  assertTimerStateAfterAction(page, action);
}

/**
 * Trigger a timer action from the 3dot menu
 * @param {import('@playwright/test').Page} page
 * @param {TimerAction} action
 */
async function triggerTimer3dotMenuAction(page, action) {
  const menuAction = `.c-menu ul li >> text="${action}"`;
  const threeDotMenuButton = 'button[title="More options"]';
  let isActionAvailable = false;
  let iterations = 0;
  // Dismiss/open the 3dot menu until the action is available
  // or a maximum number of iterations is reached
  while (!isActionAvailable && iterations <= 20) {
    await page.click('.c-object-view');
    await page.click(threeDotMenuButton);
    isActionAvailable = await page.locator(menuAction).isVisible();
    iterations++;
  }

  await page.locator(menuAction).click();
  assertTimerStateAfterAction(page, action);
}

/**
 * Trigger a timer action from the object view
 * @param {import('@playwright/test').Page} page
 * @param {TimerViewAction} action
 */
async function triggerTimerViewAction(page, action) {
  await page.locator('.c-timer').hover({ trial: true });
  const buttonTitle = buttonTitleFromAction(action);
  await page.click(`button[title="${buttonTitle}"]`);
  assertTimerStateAfterAction(page, action);
}

/**
 * Takes in a TimerViewAction and returns the button title
 * @param {TimerViewAction} action
 */
function buttonTitleFromAction(action) {
  switch (action) {
    case 'Start':
      return 'Start';
    case 'Pause':
      return 'Pause';
    case 'Restart at 0':
      return 'Reset';
  }
}

/**
 * Verify the timer state after a timer action has been performed.
 * @param {import('@playwright/test').Page} page
 * @param {TimerAction} action
 */
async function assertTimerStateAfterAction(page, action) {
  const timerValue = page.locator('.c-timer__value');
  let timerStateClass;
  switch (action) {
    case 'Start':
    case 'Restart at 0':
      timerStateClass = 'is-started';
      expect(await timerValue.innerText()).toBe('0D 00:00:00');
      break;
    case 'Stop':
      timerStateClass = 'is-stopped';
      expect(await timerValue.innerText()).toBe('--:--:--');
      break;
    case 'Pause':
      timerStateClass = 'is-paused';
      break;
  }

  await expect.soft(page.locator('.c-timer')).toHaveClass(new RegExp(timerStateClass));
}

/**
 * Assert that all the major components of a timer are present in the DOM.
 * @param {import('@playwright/test').Page} page
 * @param {import('../../../../appActions').CreatedObjectInfo} timer
 */
async function assertTimerElements(page, timer) {
  const timerElement = page.locator('.c-timer');
  const resetButton = page.getByRole('button', { name: 'Reset' });
  const pausePlayButton = page
    .getByRole('button', { name: 'Pause' })
    .or(page.getByRole('button', { name: 'Start' }));
  const timerDirectionIcon = page.locator('.c-timer__direction');
  const timerValue = page.locator('.c-timer__value');

  expect(await page.locator('.l-browse-bar__object-name').innerText()).toBe(timer.name);
  expect(timerElement).toBeAttached();
  expect(resetButton).toBeAttached();
  expect(pausePlayButton).toBeAttached();
  expect(timerDirectionIcon).toBeAttached();
  expect(timerValue).toBeAttached();
}