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

/**
 * This test is dedicated to test styling of stacked plots
 */

import { createDomainObjectWithDefaults } from '../../../../appActions.js';
import {
  checkFontStyles,
  checkStyles,
  hexToRGB,
  setStyles
} from '../../../../helper/stylingUtils.js';
import { test } from '../../../../pluginFixtures.js';

const setBorderColor = '#ff00ff';
const setBackgroundColor = '#5b0f00';
const setTextColor = '#e6b8af';
const defaultTextColor = '#acacac'; // default text color
const NO_STYLE_RGBA = 'rgba(0, 0, 0, 0)'; //default background color value
const DEFAULT_PLOT_VIEW_BORDER_COLOR = '#acacac';
const setFontSize = '72px';
const setFontWeight = '700'; //bold for monospace bold
const setFontFamily = '"Andale Mono", sans-serif';

test.describe('Stacked Plot styling', () => {
  let stackedPlot;
  let overlayPlot1;
  let overlayPlot2;
  test.beforeEach(async ({ page }) => {
    await page.goto('./', { waitUntil: 'domcontentloaded' });

    // Create a Stacked Plot
    stackedPlot = await createDomainObjectWithDefaults(page, {
      type: 'Stacked Plot',
      name: 'StackedPlot1'
    });

    // create two overlay plots
    overlayPlot1 = await createDomainObjectWithDefaults(page, {
      type: 'Overlay Plot',
      name: 'Overlay Plot 1',
      parent: stackedPlot.uuid
    });

    overlayPlot2 = await createDomainObjectWithDefaults(page, {
      type: 'Overlay Plot',
      name: 'Overlay Plot 2',
      parent: stackedPlot.uuid
    });

    // Create two SWGs and attach them to the Stacked Plot
    await createDomainObjectWithDefaults(page, {
      type: 'Sine Wave Generator',
      name: 'Sine Wave Generator 1',
      parent: overlayPlot1.uuid
    });

    await createDomainObjectWithDefaults(page, {
      type: 'Sine Wave Generator',
      name: 'Sine Wave Generator 2',
      parent: overlayPlot2.uuid
    });
  });

  test('styling the overlay plot properly applies the styles to all containers', async ({
    page
  }) => {
    // Directly navigate to the stacked plot
    await page.goto(stackedPlot.url, { waitUntil: 'domcontentloaded' });

    await page.getByLabel('Edit Object').click();

    await page.getByRole('tab', { name: 'Styles' }).click();

    //Set styles on overall stacked plot
    await setStyles(
      page,
      setBorderColor,
      setBackgroundColor,
      setTextColor,
      page.getByRole('tab', { name: 'Styles' }) //Workaround for https://github.com/nasa/openmct/issues/7229
    );

    //Set Font Size to 72
    await page.getByLabel('Set Font Size').click();
    await page.getByRole('menuitem', { name: '72px' }).click();

    //Set Font Type to Monospace Bold. See setFontWeight and setFontFamily variables
    await page.getByLabel('Set Font Type').click();
    await page.getByRole('menuitem', { name: 'Monospace Bold' }).click();

    //Check styles of stacked plot
    await checkStyles(
      hexToRGB(setBorderColor),
      hexToRGB(setBackgroundColor),
      hexToRGB(setTextColor),
      page.getByLabel('Stacked Plot Style Target')
    );

    //Check font styles of stacked plot
    await checkFontStyles(
      setFontSize,
      setFontWeight,
      setFontFamily,
      page.getByLabel('Stacked Plot Style Target')
    );

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

    // Reload page
    await page.reload({ waitUntil: 'domcontentloaded' });

    //Verify styles are correct after reload
    await checkStyles(
      hexToRGB(setBorderColor),
      hexToRGB(setBackgroundColor),
      hexToRGB(setTextColor),
      page.getByLabel('Stacked Plot Style Target')
    );

    await checkFontStyles(
      setFontSize,
      setFontWeight,
      setFontFamily,
      page.getByLabel('Stacked Plot Style Target')
    );

    //Verify that stacked Plot Items inherit only text properties
    await checkStyles(
      NO_STYLE_RGBA,
      NO_STYLE_RGBA,
      hexToRGB(setTextColor),
      page.getByLabel('Stacked Plot Item Overlay Plot 1')
    );

    await checkStyles(
      NO_STYLE_RGBA,
      NO_STYLE_RGBA,
      hexToRGB(setTextColor),
      page.getByLabel('Stacked Plot Item Overlay Plot 2')
    );

    await checkFontStyles(
      setFontSize,
      setFontWeight,
      setFontFamily,
      page.getByLabel('Stacked Plot Item Overlay Plot 1')
    );
  });

  test('styling a child object of the flexible layout properly applies that style to only that child', async ({
    page
  }) => {
    test.info().annotations.push({
      type: 'issue',
      description: 'https://github.com/nasa/openmct/issues/7338'
    });
    await page.goto(stackedPlot.url, { waitUntil: 'domcontentloaded' });

    await page.getByLabel('Edit Object').click();

    await page.getByRole('tab', { name: 'Styles' }).click();

    //Check default styles for overlayPlot1 and overlayPlot2
    await checkStyles(
      NO_STYLE_RGBA,
      NO_STYLE_RGBA,
      hexToRGB(defaultTextColor),
      page.getByLabel('Stacked Plot Item Overlay Plot 1')
    );

    await checkStyles(
      NO_STYLE_RGBA,
      NO_STYLE_RGBA,
      hexToRGB(defaultTextColor),
      page.getByLabel('Stacked Plot Item Overlay Plot 2')
    );

    // Set styles using setStyles function on StackedPlot1 but not StackedPlot2
    await setStyles(
      page,
      setBorderColor,
      setBackgroundColor,
      setTextColor,
      page.getByLabel('Stacked Plot Item Overlay Plot 1')
    );

    //Set Font Styles on SWG1 but not SWG2
    await page.getByLabel('Stacked Plot Item Overlay Plot 1').click();
    //Set Font Size to 72
    await page.getByLabel('Set Font Size').click();
    await page.getByRole('menuitem', { name: '72px' }).click();

    //Set Font Type to Monospace Bold. See setFontWeight and setFontFamily variables
    await page.getByLabel('Set Font Type').click();
    await page.getByRole('menuitem', { name: 'Monospace Bold' }).click();

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

    // Check styles on StackedPlot1
    await checkStyles(
      hexToRGB(setBorderColor),
      hexToRGB(setBackgroundColor),
      hexToRGB(setTextColor),
      page.getByLabel('Plot Container Style Target').first()
    );

    // Check styles on StackedPlot2
    await checkStyles(
      hexToRGB(DEFAULT_PLOT_VIEW_BORDER_COLOR),
      NO_STYLE_RGBA,
      hexToRGB(defaultTextColor),
      page.getByLabel('Plot Container Style Target').nth(1)
    );

    // Reload page and verify that styles persist
    await page.reload({ waitUntil: 'domcontentloaded' });

    // Check styles on StackedPlot1
    await checkStyles(
      hexToRGB(setBorderColor),
      hexToRGB(setBackgroundColor),
      hexToRGB(setTextColor),
      page.getByLabel('Plot Container Style Target').first()
    );

    // Check styles on StackedPlot2
    await checkStyles(
      hexToRGB(DEFAULT_PLOT_VIEW_BORDER_COLOR),
      NO_STYLE_RGBA,
      hexToRGB(defaultTextColor),
      page.getByLabel('Plot Container Style Target').nth(1)
    );
  });
});