mirror of
https://github.com/nasa/openmct.git
synced 2024-12-24 07:16:39 +00:00
bd11b85b6e
* moving rename methods to appActions * importing back into original test * reverting * add the ability to change the name in the browse bar * add test to verify entries are not being lost * addding aria labels for tests * when an object is changed, store the whole new object, not just the name * typo!
720 lines
27 KiB
JavaScript
720 lines
27 KiB
JavaScript
/*****************************************************************************
|
|
* 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.
|
|
*****************************************************************************/
|
|
|
|
/**
|
|
* The fixtures in this file are to be used to consolidate common actions performed by the
|
|
* various test suites. The goal is only to avoid duplication of code across test suites and not to abstract
|
|
* away the underlying functionality of the application. For more about the App Action pattern, see /e2e/README.md)
|
|
*
|
|
* For example, if two functions are nearly identical in
|
|
* timer.e2e.spec.js and notebook.e2e.spec.js, that function should be generalized and moved into this file.
|
|
*/
|
|
|
|
/**
|
|
* Defines parameters to be used in the creation of a domain object.
|
|
* @typedef {Object} CreateObjectOptions
|
|
* @property {string} type the type of domain object to create (e.g.: "Sine Wave Generator").
|
|
* @property {string} [name] the desired name of the created domain object.
|
|
* @property {string | import('../src/api/objects/ObjectAPI').Identifier} [parent] the Identifier or uuid of the parent object.
|
|
*/
|
|
|
|
/**
|
|
* Contains information about the newly created domain object.
|
|
* @typedef {Object} CreatedObjectInfo
|
|
* @property {string} name the name of the created object
|
|
* @property {string} uuid the uuid of the created object
|
|
* @property {string} url the relative url to the object (for use with `page.goto()`)
|
|
*/
|
|
|
|
/**
|
|
* Defines parameters to be used in the creation of a notification.
|
|
* @typedef {Object} CreateNotificationOptions
|
|
* @property {string} message the message
|
|
* @property {'info' | 'alert' | 'error'} severity the severity
|
|
* @property {import('../src/api/notifications/NotificationAPI').NotificationOptions} [notificationOptions] additional options
|
|
*/
|
|
|
|
import { expect } from '@playwright/test';
|
|
import { Buffer } from 'buffer';
|
|
import { v4 as genUuid } from 'uuid';
|
|
|
|
/**
|
|
* This common function creates a domain object with the default options. It is the preferred way of creating objects
|
|
* in the e2e suite when uninterested in properties of the objects themselves.
|
|
*
|
|
* @param {import('@playwright/test').Page} page - The Playwright page object.
|
|
* @param {Object} options - Options for creating the domain object.
|
|
* @param {string} options.type - The type of domain object to create (e.g., "Sine Wave Generator").
|
|
* @param {string} [options.name] - The desired name of the created domain object.
|
|
* @param {string | import('../src/api/objects/ObjectAPI').Identifier} [options.parent='mine'] - The Identifier or uuid of the parent object. Defaults to 'mine' folder
|
|
* @returns {Promise<CreatedObjectInfo>} An object containing information about the newly created domain object.
|
|
*/
|
|
async function createDomainObjectWithDefaults(page, { type, name, parent = 'mine' }) {
|
|
if (!name) {
|
|
name = `${type}:${genUuid()}`;
|
|
}
|
|
|
|
const parentUrl = await getHashUrlToDomainObject(page, parent);
|
|
|
|
// Navigate to the parent object. This is necessary to create the object
|
|
// in the correct location, such as a folder, layout, or plot.
|
|
await page.goto(parentUrl);
|
|
|
|
// Click the Create button
|
|
await page.getByRole('button', { name: 'Create', exact: true }).click();
|
|
|
|
// Click the object specified by 'type'-- case insensitive
|
|
await page.getByRole('menuitem', { name: new RegExp(`^${type}$`, 'i') }).click();
|
|
|
|
// Fill in the name of the object
|
|
await page.getByLabel('Title', { exact: true }).fill('');
|
|
await page.getByLabel('Title', { exact: true }).fill(name);
|
|
|
|
if (page.testNotes) {
|
|
// Fill the "Notes" section with information about the
|
|
// currently running test and its project.
|
|
// eslint-disable-next-line playwright/no-raw-locators
|
|
await page.locator('#notes-textarea').fill(page.testNotes);
|
|
}
|
|
|
|
await page.getByRole('button', { name: 'Save' }).click();
|
|
|
|
// Wait until the URL is updated
|
|
await page.waitForURL(`**/${parent}/*`);
|
|
const uuid = await getFocusedObjectUuid(page);
|
|
const objectUrl = await getHashUrlToDomainObject(page, uuid);
|
|
|
|
if (await _isInEditMode(page, uuid)) {
|
|
// Save (exit edit mode)
|
|
await page.getByRole('button', { name: 'Save' }).click();
|
|
await page.getByRole('listitem', { name: 'Save and Finish Editing' }).click();
|
|
}
|
|
|
|
return {
|
|
name,
|
|
uuid,
|
|
url: objectUrl
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Generate a notification with the given options.
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {CreateNotificationOptions} createNotificationOptions
|
|
*/
|
|
async function createNotification(page, createNotificationOptions) {
|
|
await page.evaluate((_createNotificationOptions) => {
|
|
const { message, severity, options } = _createNotificationOptions;
|
|
const notificationApi = window.openmct.notifications;
|
|
if (severity === 'info') {
|
|
notificationApi.info(message, options);
|
|
} else if (severity === 'alert') {
|
|
notificationApi.alert(message, options);
|
|
} else {
|
|
notificationApi.error(message, options);
|
|
}
|
|
}, createNotificationOptions);
|
|
}
|
|
|
|
/**
|
|
* Create a Plan object from JSON with the provided options. Must be used with a json based plan.
|
|
* Please check appActions.e2e.spec.js for an example of how to use this function.
|
|
*
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {string} name
|
|
* @param {Object} json
|
|
* @param {string | import('../src/api/objects/ObjectAPI').Identifier} [parent] the uuid or identifier of the parent object. Defaults to 'mine'
|
|
* @returns {Promise<CreatedObjectInfo>} An object containing information about the newly created domain object.
|
|
*/
|
|
async function createPlanFromJSON(page, { name, json, parent = 'mine' }) {
|
|
const parentUrl = await getHashUrlToDomainObject(page, parent);
|
|
|
|
// Navigate to the parent object. This is necessary to create the object
|
|
// in the correct location, such as a folder, layout, or plot.
|
|
await page.goto(`${parentUrl}`);
|
|
|
|
await page.getByRole('button', { name: 'Create' }).click();
|
|
|
|
await page.getByRole('menuitem', { name: 'Plan' }).click();
|
|
|
|
// Fill in the name of the object or generate a random one
|
|
if (!name) {
|
|
name = `Plan:${genUuid()}`;
|
|
}
|
|
await page.getByLabel('Title', { exact: true }).fill('');
|
|
await page.getByLabel('Title', { exact: true }).fill(name);
|
|
|
|
// Upload buffer from memory
|
|
await page.getByLabel('Select File...').setInputFiles({
|
|
name: 'plan.txt',
|
|
mimeType: 'text/plain',
|
|
buffer: Buffer.from(JSON.stringify(json))
|
|
});
|
|
|
|
await page.getByLabel('Save').click();
|
|
|
|
// Wait until the URL is updated
|
|
await page.waitForURL(`**/${parent}/*`);
|
|
const uuid = await getFocusedObjectUuid(page);
|
|
const objectUrl = await getHashUrlToDomainObject(page, uuid);
|
|
|
|
return {
|
|
uuid,
|
|
name,
|
|
url: objectUrl
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Create a standardized Telemetry Object (Sine Wave Generator) for use in visual tests
|
|
* and tests against plotting telemetry (e.g. logPlot tests).
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {string | import('../src/api/objects/ObjectAPI').Identifier} [parent] the uuid or identifier of the parent object. Defaults to 'mine'
|
|
* @returns {Promise<CreatedObjectInfo>} An object containing information about the telemetry object.
|
|
*/
|
|
async function createExampleTelemetryObject(page, parent = 'mine') {
|
|
const parentUrl = await getHashUrlToDomainObject(page, parent);
|
|
|
|
await page.goto(`${parentUrl}`);
|
|
|
|
await page.getByRole('button', { name: 'Create' }).click();
|
|
|
|
await page.getByRole('menuitem', { name: 'Sine Wave Generator' }).click();
|
|
|
|
const name = 'VIPER Rover Heading';
|
|
await page.getByLabel('Title', { exact: true }).fill(name);
|
|
|
|
// Fill out the fields with default values
|
|
await page.getByRole('spinbutton', { name: 'Period' }).fill('10');
|
|
await page.getByRole('spinbutton', { name: 'Amplitude' }).fill('1');
|
|
await page.getByRole('spinbutton', { name: 'Offset' }).fill('0');
|
|
await page.getByRole('spinbutton', { name: 'Data Rate (hz)' }).fill('1');
|
|
await page.getByRole('spinbutton', { name: 'Phase (radians)' }).fill('0');
|
|
await page.getByRole('spinbutton', { name: 'Randomness' }).fill('0');
|
|
await page.getByRole('spinbutton', { name: 'Loading Delay (ms)' }).fill('0');
|
|
|
|
await page.getByRole('button', { name: 'Save' }).click();
|
|
|
|
// Wait until the URL is updated
|
|
await page.waitForURL(`**/${parent}/*`);
|
|
|
|
const uuid = await getFocusedObjectUuid(page);
|
|
const url = await getHashUrlToDomainObject(page, uuid);
|
|
|
|
return {
|
|
name,
|
|
uuid,
|
|
url
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Create a Stable State Telemetry Object (State Generator) for use in visual tests
|
|
* and tests against plotting telemetry (e.g. logPlot tests). This will change state every 2 seconds.
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {string | import('../src/api/objects/ObjectAPI').Identifier} [parent] the uuid or identifier of the parent object. Defaults to 'mine'
|
|
* @returns {Promise<CreatedObjectInfo>} An object containing information about the telemetry object.
|
|
*/
|
|
async function createStableStateTelemetry(page, parent = 'mine') {
|
|
const parentUrl = await getHashUrlToDomainObject(page, parent);
|
|
|
|
await page.goto(`${parentUrl}`);
|
|
const createdObject = await createDomainObjectWithDefaults(page, {
|
|
type: 'State Generator',
|
|
name: 'Stable State Generator'
|
|
});
|
|
// edit the state generator to have a 1 second update rate
|
|
await page.getByLabel('More actions').click();
|
|
await page.getByRole('menuitem', { name: 'Edit Properties...' }).click();
|
|
await page.getByLabel('State Duration (seconds)', { exact: true }).fill('2');
|
|
await page.getByLabel('Save').click();
|
|
// Wait until the URL is updated
|
|
const uuid = await getFocusedObjectUuid(page);
|
|
const url = await getHashUrlToDomainObject(page, uuid);
|
|
|
|
return {
|
|
name: createdObject.name,
|
|
uuid,
|
|
url
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Navigates directly to a given object url, in fixed time mode, with the given start and end bounds. Note: does not set
|
|
* default view type.
|
|
*
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {string} url The url to the domainObject
|
|
* @param {string | number} start The starting time bound in milliseconds since epoch
|
|
* @param {string | number} end The ending time bound in milliseconds since epoch
|
|
*/
|
|
async function navigateToObjectWithFixedTimeBounds(page, url, start, end) {
|
|
await page.goto(
|
|
`${url}?tc.mode=fixed&tc.timeSystem=utc&tc.startBound=${start}&tc.endBound=${end}`
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Navigates directly to a given object url, in real-time mode. Note: does not set
|
|
* default view type.
|
|
*
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {string} url The url to the domainObject
|
|
* @param {string | number} start The start offset in milliseconds
|
|
* @param {string | number} end The end offset in milliseconds
|
|
*/
|
|
async function navigateToObjectWithRealTime(page, url, start = '1800000', end = '30000') {
|
|
await page.goto(
|
|
`${url}?tc.mode=local&tc.startDelta=${start}&tc.endDelta=${end}&tc.timeSystem=utc`
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Expands the entire object tree (every expandable tree item). Can be used to
|
|
* ensure that the tree is fully expanded before performing actions on objects.
|
|
* Can be applied to either the main tree or the create modal tree.
|
|
*
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {"Main Tree" | "Create Modal Tree"} [treeName="Main Tree"]
|
|
*/
|
|
async function expandEntireTree(page, treeName = 'Main Tree') {
|
|
const treeLocator = page.getByRole('tree', {
|
|
name: treeName
|
|
});
|
|
const collapsedTreeItems = treeLocator
|
|
.getByRole('treeitem', {
|
|
expanded: false
|
|
})
|
|
.getByLabel(/Expand/);
|
|
|
|
while ((await collapsedTreeItems.count()) > 0) {
|
|
//eslint-disable-next-line playwright/no-nth-methods
|
|
await collapsedTreeItems.nth(0).click();
|
|
|
|
// FIXME: Replace hard wait with something event-driven.
|
|
// Without the wait, this fails periodically due to a race condition
|
|
// with Vue rendering (loop exits prematurely).
|
|
// eslint-disable-next-line playwright/no-wait-for-timeout
|
|
await page.waitForTimeout(200);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets the UUID of the currently focused object by parsing the current URL
|
|
* and returning the last UUID in the path.
|
|
* @param {import('@playwright/test').Page} page
|
|
* @returns {Promise<string>} the uuid of the focused object
|
|
*/
|
|
async function getFocusedObjectUuid(page) {
|
|
const UUIDv4Regexp = /[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}/gi;
|
|
const focusedObjectUuid = await page.evaluate((regexp) => {
|
|
return window.location.href.split('?')[0].match(regexp).at(-1);
|
|
}, UUIDv4Regexp);
|
|
|
|
return focusedObjectUuid;
|
|
}
|
|
|
|
/**
|
|
* Returns the hashUrl to the domainObject given its uuid.
|
|
* Useful for directly navigating to the given domainObject.
|
|
*
|
|
* URLs returned will be of the form `'./browse/#/mine/<uuid0>/<uuid1>/...'`
|
|
*
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {string | import('../src/api/objects/ObjectAPI').Identifier} identifier the uuid or identifier of the object to get the url for
|
|
* @returns {Promise<string>} the url of the object
|
|
*/
|
|
async function getHashUrlToDomainObject(page, identifier) {
|
|
await page.waitForLoadState('domcontentloaded');
|
|
const hashUrl = await page.evaluate(async (objectIdentifier) => {
|
|
const path = await window.openmct.objects.getOriginalPath(objectIdentifier);
|
|
let url =
|
|
'./#/browse/' +
|
|
[...path]
|
|
.reverse()
|
|
.map((object) => window.openmct.objects.makeKeyString(object.identifier))
|
|
.join('/');
|
|
|
|
// Drop the vestigial '/ROOT' if it exists
|
|
if (url.includes('/ROOT')) {
|
|
url = url.split('/ROOT').join('');
|
|
}
|
|
|
|
return url;
|
|
}, identifier);
|
|
|
|
return hashUrl;
|
|
}
|
|
|
|
/**
|
|
* Utilizes the OpenMCT API to detect if the UI is in Edit mode.
|
|
* @private
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {string | import('../src/api/objects/ObjectAPI').Identifier} identifier
|
|
* @return {Promise<boolean>} true if the Open MCT is in Edit Mode
|
|
*/
|
|
async function _isInEditMode(page, identifier) {
|
|
// eslint-disable-next-line no-return-await
|
|
return await page.evaluate(() => window.openmct.editor.isEditing());
|
|
}
|
|
|
|
/**
|
|
* Set the time conductor mode to either fixed timespan or realtime mode.
|
|
* @private
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {boolean} [isFixedTimespan=true] true for fixed timespan mode, false for realtime mode; default is true
|
|
*/
|
|
async function _setTimeConductorMode(page, isFixedTimespan = true) {
|
|
// Click 'mode' button
|
|
await page.getByRole('button', { name: 'Time Conductor Mode', exact: true }).click();
|
|
await page.getByRole('button', { name: 'Time Conductor Mode Menu' }).click();
|
|
// Switch time conductor mode. Note, need to wait here for URL to update as the router is debounced.
|
|
if (isFixedTimespan) {
|
|
await page.getByRole('menuitem', { name: /Fixed Timespan/ }).click();
|
|
await page.waitForURL(/tc\.mode=fixed/);
|
|
} else {
|
|
await page.getByRole('menuitem', { name: /Real-Time/ }).click();
|
|
await page.waitForURL(/tc\.mode=local/);
|
|
}
|
|
//dismiss the time conductor popup
|
|
await page.getByLabel('Discard changes and close time popup').click();
|
|
}
|
|
|
|
/**
|
|
* Set the time conductor to fixed timespan mode
|
|
* @param {import('@playwright/test').Page} page
|
|
*/
|
|
async function setFixedTimeMode(page) {
|
|
await _setTimeConductorMode(page, true);
|
|
}
|
|
|
|
/**
|
|
* Set the time conductor to realtime mode
|
|
* @param {import('@playwright/test').Page} page
|
|
*/
|
|
async function setRealTimeMode(page) {
|
|
await _setTimeConductorMode(page, false);
|
|
}
|
|
|
|
/**
|
|
* @typedef {Object} OffsetValues
|
|
* @property {string | undefined} startHours
|
|
* @property {string | undefined} startMins
|
|
* @property {string | undefined} startSecs
|
|
* @property {string | undefined} endHours
|
|
* @property {string | undefined} endMins
|
|
* @property {string | undefined} endSecs
|
|
*/
|
|
|
|
/**
|
|
* Set the values (hours, mins, secs) for the TimeConductor offsets when in realtime mode
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {OffsetValues} offset - Object containing offset values
|
|
* @param {boolean} [offset.submitChanges=true] - If true, submit the offset changes; otherwise, discard them
|
|
*/
|
|
async function setTimeConductorOffset(
|
|
page,
|
|
{ startHours, startMins, startSecs, endHours, endMins, endSecs, submitChanges = true }
|
|
) {
|
|
if (startHours) {
|
|
await page.getByLabel('Start offset hours').fill(startHours);
|
|
}
|
|
|
|
if (startMins) {
|
|
await page.getByLabel('Start offset minutes').fill(startMins);
|
|
}
|
|
|
|
if (startSecs) {
|
|
await page.getByLabel('Start offset seconds').fill(startSecs);
|
|
}
|
|
|
|
if (endHours) {
|
|
await page.getByLabel('End offset hours').fill(endHours);
|
|
}
|
|
|
|
if (endMins) {
|
|
await page.getByLabel('End offset minutes').fill(endMins);
|
|
}
|
|
|
|
if (endSecs) {
|
|
await page.getByLabel('End offset seconds').fill(endSecs);
|
|
}
|
|
|
|
// Click the check button
|
|
if (submitChanges) {
|
|
await page.getByLabel('Submit time offsets').click();
|
|
} else {
|
|
await page.getByLabel('Discard changes and close time popup').click();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set the values (hours, mins, secs) for the start time offset when in realtime mode
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {OffsetValues} offset
|
|
* @param {boolean} [submit=true] If true, submit the offset changes; otherwise, discard them
|
|
*/
|
|
async function setStartOffset(page, { submitChanges = true, ...offset }) {
|
|
// Click 'mode' button
|
|
await page.getByRole('button', { name: 'Time Conductor Mode', exact: true }).click();
|
|
await setTimeConductorOffset(page, { submitChanges, ...offset });
|
|
}
|
|
|
|
/**
|
|
* Set the values (hours, mins, secs) for the end time offset when in realtime mode
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {OffsetValues} offset
|
|
* @param {boolean} [submit=true] If true, submit the offset changes; otherwise, discard them
|
|
*/
|
|
async function setEndOffset(page, { submitChanges = true, ...offset }) {
|
|
// Click 'mode' button
|
|
await page.getByRole('button', { name: 'Time Conductor Mode', exact: true }).click();
|
|
await setTimeConductorOffset(page, { submitChanges, ...offset });
|
|
}
|
|
|
|
/**
|
|
* Set the time conductor bounds in fixed time mode
|
|
*
|
|
* NOTE: Unless explicitly testing the Time Conductor itself, it is advised to instead
|
|
* navigate directly to the object with the desired time bounds using `navigateToObjectWithFixedTimeBounds()`.
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {Object} bounds - The time conductor bounds
|
|
* @param {string} [bounds.startDate] - The start date in YYYY-MM-DD format
|
|
* @param {string} [bounds.startTime] - The start time in HH:mm:ss format
|
|
* @param {string} [bounds.endDate] - The end date in YYYY-MM-DD format
|
|
* @param {string} [bounds.endTime] - The end time in HH:mm:ss format
|
|
* @param {boolean} [bounds.submitChanges=true] - If true, submit the changes; otherwise, discard them.
|
|
*/
|
|
async function setTimeConductorBounds(page, { submitChanges = true, ...bounds }) {
|
|
const { startDate, endDate, startTime, endTime } = bounds;
|
|
|
|
// Open the time conductor popup
|
|
await page.getByRole('button', { name: 'Time Conductor Mode', exact: true }).click();
|
|
|
|
// FIXME: https://github.com/nasa/openmct/pull/7818
|
|
// eslint-disable-next-line playwright/no-wait-for-timeout
|
|
await page.waitForTimeout(500);
|
|
|
|
if (startDate) {
|
|
await page.getByLabel('Start date').fill(startDate);
|
|
}
|
|
|
|
if (startTime) {
|
|
await page.getByLabel('Start time').fill(startTime);
|
|
}
|
|
|
|
if (endDate) {
|
|
await page.getByLabel('End date').fill(endDate);
|
|
}
|
|
|
|
if (endTime) {
|
|
await page.getByLabel('End time').fill(endTime);
|
|
}
|
|
|
|
if (submitChanges) {
|
|
await page.getByLabel('Submit time bounds').click();
|
|
} else {
|
|
await page.getByLabel('Discard changes and close time popup').click();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set the bounds of the visible conductor in fixed time mode.
|
|
* Requires that page already has an independent time conductor in view.
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {string} start - The start date in 'YYYY-MM-DD HH:mm:ss.SSSZ' format
|
|
* @param {string} end - The end date in 'YYYY-MM-DD HH:mm:ss.SSSZ' format
|
|
*/
|
|
async function setFixedIndependentTimeConductorBounds(page, { start, end }) {
|
|
// Activate Independent Time Conductor
|
|
await page.getByLabel('Enable Independent Time Conductor').click();
|
|
|
|
// Bring up the time conductor popup
|
|
await page.getByLabel('Independent Time Conductor Settings').click();
|
|
await expect(page.getByLabel('Time Conductor Options')).toBeInViewport();
|
|
await _setTimeBounds(page, start, end);
|
|
|
|
await page.keyboard.press('Enter');
|
|
}
|
|
|
|
/**
|
|
* Set the bounds of the visible conductor in fixed time mode
|
|
* @private
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {string} start - The start date in 'YYYY-MM-DD HH:mm:ss.SSSZ' format
|
|
* @param {string} end - The end date in 'YYYY-MM-DD HH:mm:ss.SSSZ' format
|
|
*/
|
|
async function _setTimeBounds(page, startDate, endDate) {
|
|
if (startDate) {
|
|
// Fill start time
|
|
await page
|
|
.getByRole('textbox', { name: 'Start date' })
|
|
.fill(startDate.toString().substring(0, 10));
|
|
await page
|
|
.getByRole('textbox', { name: 'Start time' })
|
|
.fill(startDate.toString().substring(11, 19));
|
|
}
|
|
|
|
if (endDate) {
|
|
// Fill end time
|
|
await page.getByRole('textbox', { name: 'End date' }).fill(endDate.toString().substring(0, 10));
|
|
await page
|
|
.getByRole('textbox', { name: 'End time' })
|
|
.fill(endDate.toString().substring(11, 19));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Waits and asserts that all plot series data on the page
|
|
* is loaded and drawn.
|
|
*
|
|
* In lieu of a better way to detect when a plot is done rendering,
|
|
* we [attach a class to the '.gl-plot' element](https://github.com/nasa/openmct/blob/5924d7ea95a0c2d4141c602a3c7d0665cb91095f/src/plugins/plot/MctPlot.vue#L27)
|
|
* once all pending series data has been loaded. The following appAction retrieves
|
|
* all plots on the page and waits up to the default timeout for the class to be
|
|
* attached to each plot.
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {number} [timeout] Provide a custom timeout in milliseconds to override the default timeout
|
|
*/
|
|
async function waitForPlotsToRender(page, { timeout } = {}) {
|
|
//eslint-disable-next-line playwright/no-raw-locators
|
|
const plotLocator = page.locator('.gl-plot');
|
|
for (const plot of await plotLocator.all()) {
|
|
await expect(plot).toHaveClass(/js-series-data-loaded/, { timeout });
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @typedef {Object} PlotPixel
|
|
* @property {number} r The value of the red channel (0-255)
|
|
* @property {number} g The value of the green channel (0-255)
|
|
* @property {number} b The value of the blue channel (0-255)
|
|
* @property {number} a The value of the alpha channel (0-255)
|
|
* @property {string} strValue The rgba string value of the pixel
|
|
*/
|
|
|
|
/**
|
|
* Wait for all plots to render and then retrieve and return an array
|
|
* of canvas plot pixel data (RGBA values).
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {string} canvasSelector The selector for the canvas element
|
|
* @return {Promise<PlotPixel[]>}
|
|
*/
|
|
async function getCanvasPixels(page, canvasSelector) {
|
|
const canvasHandle = await page.evaluateHandle(
|
|
(canvas) => document.querySelector(canvas),
|
|
canvasSelector
|
|
);
|
|
const canvasContextHandle = await page.evaluateHandle(
|
|
(canvas) => canvas.getContext('2d'),
|
|
canvasHandle
|
|
);
|
|
|
|
await waitForPlotsToRender(page);
|
|
return page.evaluate(
|
|
([canvas, ctx]) => {
|
|
// The document canvas is where the plot points and lines are drawn.
|
|
// The only way to access the canvas is using document (using page.evaluate)
|
|
/** @type {ImageData} */
|
|
const data = ctx.getImageData(0, 0, canvas.width, canvas.height).data;
|
|
/** @type {number[]} */
|
|
const imageDataValues = Object.values(data);
|
|
/** @type {PlotPixel[]} */
|
|
const plotPixels = [];
|
|
// Each pixel consists of four values within the ImageData.data array. The for loop iterates by multiples of four.
|
|
// The values associated with each pixel are R (red), G (green), B (blue), and A (alpha), in that order.
|
|
for (let i = 0; i < imageDataValues.length; ) {
|
|
if (imageDataValues[i] > 0) {
|
|
plotPixels.push({
|
|
r: imageDataValues[i],
|
|
g: imageDataValues[i + 1],
|
|
b: imageDataValues[i + 2],
|
|
a: imageDataValues[i + 3],
|
|
strValue: `rgb(${imageDataValues[i]}, ${imageDataValues[i + 1]}, ${
|
|
imageDataValues[i + 2]
|
|
}, ${imageDataValues[i + 3]})`
|
|
});
|
|
}
|
|
|
|
i = i + 4;
|
|
}
|
|
|
|
return plotPixels;
|
|
},
|
|
[canvasHandle, canvasContextHandle]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Search for telemetry and link it to an object. objectName should come from the domainObject.name function.
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {string} parameterName
|
|
* @param {string} objectName
|
|
*/
|
|
async function linkParameterToObject(page, parameterName, objectName) {
|
|
await page.getByRole('searchbox', { name: 'Search Input' }).click();
|
|
await page.getByRole('searchbox', { name: 'Search Input' }).fill(parameterName);
|
|
await page.getByLabel('Object Results').getByText(parameterName).click();
|
|
await page.getByLabel('More actions').click();
|
|
await page.getByLabel('Create Link').click();
|
|
await page.getByLabel('Modal Overlay').getByLabel('Search Input').click();
|
|
await page.getByLabel('Modal Overlay').getByLabel('Search Input').fill(objectName);
|
|
await page.getByLabel('Modal Overlay').getByLabel(`Navigate to ${objectName}`).click();
|
|
await page.getByLabel('Save').click();
|
|
}
|
|
|
|
/**
|
|
* Rename the currently viewed `domainObject` from the browse bar.
|
|
*
|
|
* @param {import('@playwright/test').Page} page
|
|
* @param {string} newName
|
|
*/
|
|
async function renameCurrentObjectFromBrowseBar(page, newName) {
|
|
const nameInput = page.getByLabel('Browse bar object name');
|
|
await nameInput.click();
|
|
await nameInput.fill('');
|
|
await nameInput.fill(newName);
|
|
// Click the browse bar container to save changes
|
|
await page.getByLabel('Browse bar', { exact: true }).click();
|
|
}
|
|
|
|
export {
|
|
createDomainObjectWithDefaults,
|
|
createExampleTelemetryObject,
|
|
createNotification,
|
|
createPlanFromJSON,
|
|
createStableStateTelemetry,
|
|
expandEntireTree,
|
|
getCanvasPixels,
|
|
linkParameterToObject,
|
|
navigateToObjectWithFixedTimeBounds,
|
|
navigateToObjectWithRealTime,
|
|
renameCurrentObjectFromBrowseBar,
|
|
setEndOffset,
|
|
setFixedIndependentTimeConductorBounds,
|
|
setFixedTimeMode,
|
|
setRealTimeMode,
|
|
setStartOffset,
|
|
setTimeConductorBounds,
|
|
waitForPlotsToRender
|
|
};
|