openmct/e2e/tests/visual-a11y/planning-view.visual.spec.js

/*****************************************************************************
 * Open MCT, Copyright (c) 2014-2024, 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.
 *****************************************************************************/

import percySnapshot from '@percy/playwright';
import fs from 'fs';

import { createPlanFromJSON } from '../../appActions.js';
import { scanForA11yViolations, test } from '../../avpFixtures.js';
import { VISUAL_FIXED_URL } from '../../constants.js';
import {
  createTimelistWithPlanAndSetActivityInProgress,
  getFirstActivity,
  setBoundsToSpanAllActivities,
  setDraftStatusForPlan
} from '../../helper/planningUtils.js';

const examplePlanSmall1 = JSON.parse(
  fs.readFileSync(new URL('../../test-data/examplePlans/ExamplePlan_Small1.json', import.meta.url))
);

const examplePlanSmall2 = JSON.parse(
  fs.readFileSync(new URL('../../test-data/examplePlans/ExamplePlan_Small2.json', import.meta.url))
);

const FIRST_ACTIVITY_SMALL_1 = getFirstActivity(examplePlanSmall1);
const FIRST_ACTIVITY_SMALL_2 = getFirstActivity(examplePlanSmall2);

test.describe('Visual - Timelist progress bar @clock @a11y', () => {
  test.beforeEach(async ({ page }) => {
    await page.clock.install({ time: FIRST_ACTIVITY_SMALL_1.end + 10000 });
    await page.clock.resume();
    await createTimelistWithPlanAndSetActivityInProgress(page, examplePlanSmall1);
    await page.getByLabel('Click to collapse items').click();
  });

  test('progress pie is full', async ({ page, theme }) => {
    // Progress pie is completely full and doesn't update if now is greater than the end time
    await percySnapshot(page, `Time List with Activity in Progress (theme: ${theme})`);
  });
});

test.describe('Visual - Plan View @a11y', () => {
  test.beforeEach(async ({ page }) => {
    // Set the clock to the end of the first activity in the plan
    // This is so we can see the "now" line in the plan view
    await page.clock.install({ time: FIRST_ACTIVITY_SMALL_2.end + 10000 });
    await page.clock.resume();

    await page.goto(VISUAL_FIXED_URL, { waitUntil: 'domcontentloaded' });
  });

  test('Plan View', async ({ page, theme }) => {
    const plan = await createPlanFromJSON(page, {
      name: 'Plan Visual Test',
      json: examplePlanSmall2
    });
    await setBoundsToSpanAllActivities(page, examplePlanSmall2, plan.url);
    await percySnapshot(page, `Plan View (theme: ${theme})`);
  });

  test('Resize Plan View @2p', async ({ browser, theme }) => {
    // need to set viewport to null to allow for resizing
    const newContext = await browser.newContext({
      viewport: null
    });
    const newPage = await newContext.newPage();

    await newPage.goto(VISUAL_FIXED_URL, { waitUntil: 'domcontentloaded' });
    const plan = await createPlanFromJSON(newPage, {
      name: 'Plan Visual Test',
      json: examplePlanSmall2
    });

    await setBoundsToSpanAllActivities(newPage, examplePlanSmall2, plan.url);
    // resize the window
    await newPage.setViewportSize({ width: 800, height: 600 });
    await percySnapshot(newPage, `Plan View resized (theme: ${theme})`);
  });

  test('Plan View w/ draft status', async ({ page, theme }) => {
    const plan = await createPlanFromJSON(page, {
      name: 'Plan Visual Test (Draft)',
      json: examplePlanSmall2
    });
    await page.goto(VISUAL_FIXED_URL, { waitUntil: 'domcontentloaded' });
    await setDraftStatusForPlan(page, plan);

    await setBoundsToSpanAllActivities(page, examplePlanSmall2, plan.url);
    await percySnapshot(page, `Plan View w/ draft status (theme: ${theme})`);
  });
});

test.afterEach(async ({ page }, testInfo) => {
  await scanForA11yViolations(page, testInfo.title);
});