Compare commits

..

2 Commits

Author SHA1 Message Date
e9358c0552 Merge branch 'master' into vue-3 2022-11-03 12:15:10 -07:00
6414a6f556 WIP 2022-11-03 12:09:43 -07:00
249 changed files with 2517 additions and 10002 deletions

View File

@ -2,7 +2,7 @@ version: 2.1
executors: executors:
pw-focal-development: pw-focal-development:
docker: docker:
- image: mcr.microsoft.com/playwright:v1.29.0-focal - image: mcr.microsoft.com/playwright:v1.25.2-focal
environment: environment:
NODE_ENV: development # Needed to ensure 'dist' folder created and devDependencies installed NODE_ENV: development # Needed to ensure 'dist' folder created and devDependencies installed
PERCY_POSTINSTALL_BROWSER: 'true' # Needed to store the percy browser in cache deps PERCY_POSTINSTALL_BROWSER: 'true' # Needed to store the percy browser in cache deps

View File

@ -13,18 +13,14 @@ updates:
- "pr:daveit" - "pr:daveit"
- "pr:platform" - "pr:platform"
ignore: ignore:
#We have to source the playwright container which is not detected by Dependabot - dependency-name: "@playwright/test" #We have to source the playwright container which is not detected by Dependabot
- dependency-name: "@playwright/test" - dependency-name: "playwright-core" #We have to source the playwright container which is not detected by Dependabot
- dependency-name: "playwright-core" - dependency-name: "@babel/eslint-parser" #Lots of noise in these type patch releases.
#Lots of noise in these type patch releases.
- dependency-name: "@babel/eslint-parser"
update-types: ["version-update:semver-patch"] update-types: ["version-update:semver-patch"]
- dependency-name: "eslint-plugin-vue" - dependency-name: "eslint-plugin-vue" #Lots of noise in these type patch releases.
update-types: ["version-update:semver-patch"] update-types: ["version-update:semver-patch"]
- dependency-name: "babel-loader" - dependency-name: "babel-loader"
update-types: ["version-update:semver-patch"] update-types: ["version-update:semver-patch"]
- dependency-name: "sinon"
update-types: ["version-update:semver-patch"]
- package-ecosystem: "github-actions" - package-ecosystem: "github-actions"
directory: "/" directory: "/"
schedule: schedule:

View File

@ -23,7 +23,7 @@ jobs:
- uses: actions/setup-node@v3 - uses: actions/setup-node@v3
with: with:
node-version: '16' node-version: '16'
- run: npx playwright@1.29.0 install - run: npx playwright@1.25.2 install
- run: npm install - run: npm install
- run: sh src/plugins/persistence/couch/replace-localstorage-with-couchdb-indexhtml.sh - run: sh src/plugins/persistence/couch/replace-localstorage-with-couchdb-indexhtml.sh
- run: npm run test:e2e:couchdb - run: npm run test:e2e:couchdb

View File

@ -30,7 +30,7 @@ jobs:
- uses: actions/setup-node@v3 - uses: actions/setup-node@v3
with: with:
node-version: '16' node-version: '16'
- run: npx playwright@1.29.0 install - run: npx playwright@1.25.2 install
- run: npx playwright install chrome-beta - run: npx playwright install chrome-beta
- run: npm install - run: npm install
- run: npm run test:e2e:full - run: npm run test:e2e:full

View File

@ -16,11 +16,7 @@ jobs:
with: with:
node-version: 16 node-version: 16
- run: npm install - run: npm install
- run: | - run: npm test
echo "//registry.npmjs.org/:_authToken=$NODE_AUTH_TOKEN" >> ~/.npmrc
npm whoami
npm publish --access=public --tag unstable openmct
# - run: npm test
publish-npm-prerelease: publish-npm-prerelease:
needs: build needs: build
@ -32,6 +28,6 @@ jobs:
node-version: 16 node-version: 16
registry-url: https://registry.npmjs.org/ registry-url: https://registry.npmjs.org/
- run: npm install - run: npm install
- run: npm publish --access=public --tag unstable - run: npm publish --access public --tag unstable
env: env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

View File

@ -22,9 +22,3 @@
!index.html !index.html
!openmct.js !openmct.js
!SECURITY.md !SECURITY.md
# Add e2e tests to npm package
!/e2e/**/*
# ... except our test-data folder files.
/e2e/test-data/*.json

View File

@ -1,174 +0,0 @@
/* global __dirname module */
/*
This is the OpenMCT common webpack file. It is imported by the other three webpack configurations:
- webpack.prod.js - the production configuration for OpenMCT (default)
- webpack.dev.js - the development configuration for OpenMCT
- webpack.coverage.js - imports webpack.dev.js and adds code coverage
There are separate npm scripts to use these configurations, though simply running `npm install`
will use the default production configuration.
*/
const path = require("path");
const packageDefinition = require("../package.json");
const CopyWebpackPlugin = require("copy-webpack-plugin");
const webpack = require("webpack");
const MiniCssExtractPlugin = require("mini-css-extract-plugin");
const { VueLoaderPlugin } = require("vue-loader");
const projectRootDir = path.resolve(__dirname, "..");
let gitRevision = "error-retrieving-revision";
let gitBranch = "error-retrieving-branch";
try {
gitRevision = require("child_process")
.execSync("git rev-parse HEAD")
.toString()
.trim();
gitBranch = require("child_process")
.execSync("git rev-parse --abbrev-ref HEAD")
.toString()
.trim();
} catch (err) {
console.warn(err);
}
/** @type {import('webpack').Configuration} */
const config = {
context: projectRootDir,
entry: {
openmct: "./openmct.js",
generatorWorker: "./example/generator/generatorWorker.js",
couchDBChangesFeed:
"./src/plugins/persistence/couch/CouchChangesFeed.js",
inMemorySearchWorker: "./src/api/objects/InMemorySearchWorker.js",
espressoTheme: "./src/plugins/themes/espresso-theme.scss",
snowTheme: "./src/plugins/themes/snow-theme.scss"
},
output: {
globalObject: "this",
filename: "[name].js",
path: path.resolve(projectRootDir, "dist"),
library: "openmct",
libraryTarget: "umd",
publicPath: "",
hashFunction: "xxhash64",
clean: true
},
resolve: {
alias: {
"@": path.join(projectRootDir, "src"),
legacyRegistry: path.join(projectRootDir, "src/legacyRegistry"),
saveAs: "file-saver/src/FileSaver.js",
csv: "comma-separated-values",
EventEmitter: "eventemitter3",
bourbon: "bourbon.scss",
"plotly-basic": "plotly.js-basic-dist",
"plotly-gl2d": "plotly.js-gl2d-dist",
"d3-scale": path.join(
projectRootDir,
"node_modules/d3-scale/dist/d3-scale.min.js"
),
printj: path.join(
projectRootDir,
"node_modules/printj/dist/printj.min.js"
),
styles: path.join(projectRootDir, "src/styles"),
MCT: path.join(projectRootDir, "src/MCT"),
testUtils: path.join(projectRootDir, "src/utils/testUtils.js"),
objectUtils: path.join(
projectRootDir,
"src/api/objects/object-utils.js"
),
"kdbush": path.join(projectRootDir, "node_modules/kdbush/kdbush.min.js"),
utils: path.join(projectRootDir, "src/utils")
}
},
plugins: [
new webpack.DefinePlugin({
__OPENMCT_VERSION__: `'${packageDefinition.version}'`,
__OPENMCT_BUILD_DATE__: `'${new Date()}'`,
__OPENMCT_REVISION__: `'${gitRevision}'`,
__OPENMCT_BUILD_BRANCH__: `'${gitBranch}'`,
}),
new VueLoaderPlugin(),
new CopyWebpackPlugin({
patterns: [
{
from: "src/images/favicons",
to: "favicons"
},
{
from: "./index.html",
transform: function (content) {
return content.toString().replace(/dist\//g, "");
}
},
{
from: "src/plugins/imagery/layers",
to: "imagery"
}
]
}),
new MiniCssExtractPlugin({
filename: "[name].css",
chunkFilename: "[name].css"
})
],
module: {
rules: [
{
test: /\.(sc|sa|c)ss$/,
use: [
MiniCssExtractPlugin.loader,
{
loader: "css-loader"
},
{
loader: "resolve-url-loader"
},
{
loader: "sass-loader",
options: { sourceMap: true }
}
]
},
{
test: /\.vue$/,
use: "vue-loader"
},
{
test: /\.html$/,
type: "asset/source"
},
{
test: /\.(jpg|jpeg|png|svg)$/,
type: "asset/resource",
generator: {
filename: "images/[name][ext]"
}
},
{
test: /\.ico$/,
type: "asset/resource",
generator: {
filename: "icons/[name][ext]"
}
},
{
test: /\.(woff|woff2?|eot|ttf)$/,
type: "asset/resource",
generator: {
filename: "fonts/[name][ext]"
}
}
]
},
performance: {
// We should eventually consider chunking to decrease
// these values
maxEntrypointSize: 27000000,
maxAssetSize: 27000000
}
};
module.exports = config;

View File

@ -1,27 +0,0 @@
/* global __dirname module */
/*
This configuration should be used for production installs.
It is the default webpack configuration.
*/
const path = require("path");
const webpack = require("webpack");
const { merge } = require("webpack-merge");
const common = require("./webpack.common");
const projectRootDir = path.resolve(__dirname, "..");
module.exports = merge(common, {
mode: "production",
resolve: {
alias: {
vue: path.join(projectRootDir, "node_modules/vue/dist/vue.min.js")
}
},
plugins: [
new webpack.DefinePlugin({
__OPENMCT_ROOT_RELATIVE__: '""'
})
],
devtool: "source-map"
});

View File

@ -10,7 +10,7 @@ accept changes from external contributors.
The short version: The short version:
1. Write your contribution or describe your idea in the form of a [GitHub issue](https://github.com/nasa/openmct/issues/new/choose) or [start a GitHub discussion](https://github.com/nasa/openmct/discussions). 1. Write your contribution or describe your idea in the form of an [GitHub issue](https://github.com/nasa/openmct/issues/new/choose) or [Starting a GitHub Discussion](https://github.com/nasa/openmct/discussions)
2. Make sure your contribution meets code, test, and commit message 2. Make sure your contribution meets code, test, and commit message
standards as described below. standards as described below.
3. Submit a pull request from a topic branch back to `master`. Include a check 3. Submit a pull request from a topic branch back to `master`. Include a check

View File

@ -6,8 +6,10 @@ Please visit our [Official Site](https://nasa.github.io/openmct/) and [Getting S
Once you've created something amazing with Open MCT, showcase your work in our GitHub Discussions [Show and Tell](https://github.com/nasa/openmct/discussions/categories/show-and-tell) section. We love seeing unique and wonderful implementations of Open MCT! Once you've created something amazing with Open MCT, showcase your work in our GitHub Discussions [Show and Tell](https://github.com/nasa/openmct/discussions/categories/show-and-tell) section. We love seeing unique and wonderful implementations of Open MCT!
![Screen Shot 2022-11-23 at 9 51 36 AM](https://user-images.githubusercontent.com/4215777/203617422-4d912bfc-766f-4074-8324-409d9bbe7c05.png) ## See Open MCT in Action
Try Open MCT now with our [live demo](https://openmct-demo.herokuapp.com/).
![Demo](https://nasa.github.io/openmct/static/res/images/Open-MCT.Browse.Layout.Mars-Weather-1.jpg)
## Building and Running Open MCT Locally ## Building and Running Open MCT Locally

View File

@ -8,7 +8,7 @@ This document is designed to capture on the What, Why, and How's of writing and
1. [Getting Started](#getting-started) 1. [Getting Started](#getting-started)
2. [Types of Testing](#types-of-e2e-testing) 2. [Types of Testing](#types-of-e2e-testing)
3. [Architecture](#test-architecture-and-ci) 3. [Architecture](#architecture)
## Getting Started ## Getting Started
@ -276,36 +276,14 @@ Skipping based on browser version (Rarely used): <https://github.com/microsoft/p
- Leverage `await page.goto('./', { waitUntil: 'networkidle' });` - Leverage `await page.goto('./', { waitUntil: 'networkidle' });`
- Avoid repeated setup to test to test a single assertion. Write longer tests with multiple soft assertions. - Avoid repeated setup to test to test a single assertion. Write longer tests with multiple soft assertions.
### How to write a great test (WIP) ### How to write a great test (TODO)
- Use our [App Actions](./appActions.js) for performing common actions whenever applicable.
- If you create an object outside of using the `createDomainObjectWithDefaults` App Action, make sure to fill in the 'Notes' section of your object with `page.testNotes`:
```js
// Fill the "Notes" section with information about the
// currently running test and its project.
const { testNotes } = page;
const notesInput = page.locator('form[name="mctForm"] #notes-textarea');
await notesInput.fill(testNotes);
```
#### How to write a great visual test (TODO) #### How to write a great visual test (TODO)
#### How to write a great network test
- Where possible, it is best to mock out third-party network activity to ensure we are testing application behavior of Open MCT.
- It is best to be as specific as possible about the expected network request/response structures in creating your mocks.
- Make sure to only mock requests which are relevant to the specific behavior being tested.
- Where possible, network requests and responses should be treated in an order-agnostic manner, as the order in which certain requests/responses happen is dynamic and subject to change.
Some examples of mocking network responses in regards to CouchDB can be found in our [couchdb.e2e.spec.js](./tests/functional/couchdb.e2e.spec.js) test file.
### Best Practices ### Best Practices
For now, our best practices exist as self-tested, living documentation in our [exampleTemplate.e2e.spec.js](./tests/framework/exampleTemplate.e2e.spec.js) file. For now, our best practices exist as self-tested, living documentation in our [exampleTemplate.e2e.spec.js](./tests/framework/exampleTemplate.e2e.spec.js) file.
For best practices with regards to mocking network responses, see our [couchdb.e2e.spec.js](./tests/functional/couchdb.e2e.spec.js) file.
### Tips & Tricks (TODO) ### Tips & Tricks (TODO)
The following contains a list of tips and tricks which don't exactly fit into a FAQ or Best Practices doc. The following contains a list of tips and tricks which don't exactly fit into a FAQ or Best Practices doc.
@ -400,23 +378,3 @@ A single e2e test in Open MCT is extended to run:
- Tests won't start because 'Error: <http://localhost:8080/># is already used...' - Tests won't start because 'Error: <http://localhost:8080/># is already used...'
This error will appear when running the tests locally. Sometimes, the webserver is left in an orphaned state and needs to be cleaned up. To clear up the orphaned webserver, execute the following from your Terminal: This error will appear when running the tests locally. Sometimes, the webserver is left in an orphaned state and needs to be cleaned up. To clear up the orphaned webserver, execute the following from your Terminal:
```lsof -n -i4TCP:8080 | awk '{print$2}' | tail -1 | xargs kill -9``` ```lsof -n -i4TCP:8080 | awk '{print$2}' | tail -1 | xargs kill -9```
### Upgrading Playwright
In order to upgrade from one version of Playwright to another, the version should be updated in several places in both `openmct` and `openmct-yamcs` repos. An easy way to identify these locations is to search for the current version in all files and find/replace.
For reference, all of the locations where the version should be updated are listed below:
#### **In `openmct`:**
- `package.json`
- Both packages `@playwright/test` and `playwright-core` should be updated to the same target version.
- `.circleci/config.yml`
- `.github/workflows/e2e-couchdb.yml`
- `.github/workflows/e2e-pr.yml`
#### **In `openmct-yamcs`:**
- `package.json`
- `@playwright/test` should be updated to the target version.
- `.github/workflows/yamcs-quickstart-e2e.yml`

View File

@ -45,16 +45,7 @@
* @property {string} url the relative url to the object (for use with `page.goto()`) * @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
*/
const Buffer = require('buffer').Buffer; const Buffer = require('buffer').Buffer;
const genUuid = require('uuid').v4;
/** /**
* This common function creates a domain object with the default options. It is the preferred way of creating objects * This common function creates a domain object with the default options. It is the preferred way of creating objects
@ -65,10 +56,6 @@ const genUuid = require('uuid').v4;
* @returns {Promise<CreatedObjectInfo>} An object containing information about the newly created domain object. * @returns {Promise<CreatedObjectInfo>} An object containing information about the newly created domain object.
*/ */
async function createDomainObjectWithDefaults(page, { type, name, parent = 'mine' }) { async function createDomainObjectWithDefaults(page, { type, name, parent = 'mine' }) {
if (!name) {
name = `${type}:${genUuid()}`;
}
const parentUrl = await getHashUrlToDomainObject(page, parent); const parentUrl = await getHashUrlToDomainObject(page, parent);
// Navigate to the parent object. This is necessary to create the object // Navigate to the parent object. This is necessary to create the object
@ -80,18 +67,13 @@ async function createDomainObjectWithDefaults(page, { type, name, parent = 'mine
await page.click('button:has-text("Create")'); await page.click('button:has-text("Create")');
// Click the object specified by 'type' // Click the object specified by 'type'
await page.click(`li[role='menuitem']:text("${type}")`); await page.click(`li:text("${type}")`);
// Modify the name input field of the domain object to accept 'name' // Modify the name input field of the domain object to accept 'name'
if (name) {
const nameInput = page.locator('form[name="mctForm"] .first input[type="text"]'); const nameInput = page.locator('form[name="mctForm"] .first input[type="text"]');
await nameInput.fill(""); await nameInput.fill("");
await nameInput.fill(name); await nameInput.fill(name);
if (page.testNotes) {
// Fill the "Notes" section with information about the
// currently running test and its project.
const notesInput = page.locator('form[name="mctForm"] #notes-textarea');
await notesInput.fill(page.testNotes);
} }
// Click OK button and wait for Navigate event // Click OK button and wait for Navigate event
@ -114,39 +96,18 @@ async function createDomainObjectWithDefaults(page, { type, name, parent = 'mine
} }
return { return {
name, name: name || `Unnamed ${type}`,
uuid, uuid: uuid,
url: objectUrl 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);
}
/** /**
* @param {import('@playwright/test').Page} page * @param {import('@playwright/test').Page} page
* @param {string} name * @param {string} name
*/ */
async function expandTreePaneItemByName(page, name) { async function expandTreePaneItemByName(page, name) {
const treePane = page.getByRole('tree', { const treePane = page.locator('#tree-pane');
name: 'Main Tree'
});
const treeItem = treePane.locator(`role=treeitem[expanded=false][name=/${name}/]`); const treeItem = treePane.locator(`role=treeitem[expanded=false][name=/${name}/]`);
const expandTriangle = treeItem.locator('.c-disclosure-triangle'); const expandTriangle = treeItem.locator('.c-disclosure-triangle');
await expandTriangle.click(); await expandTriangle.click();
@ -220,24 +181,6 @@ async function openObjectTreeContextMenu(page, url) {
}); });
} }
/**
* Expands the entire object tree (every expandable tree item).
* @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
}).locator('span.c-disclosure-triangle.is-enabled');
while (await collapsedTreeItems.count() > 0) {
await collapsedTreeItems.nth(0).click();
}
}
/** /**
* Gets the UUID of the currently focused object by parsing the current URL * Gets the UUID of the currently focused object by parsing the current URL
* and returning the last UUID in the path. * and returning the last UUID in the path.
@ -380,9 +323,7 @@ async function setEndOffset(page, offset) {
// eslint-disable-next-line no-undef // eslint-disable-next-line no-undef
module.exports = { module.exports = {
createDomainObjectWithDefaults, createDomainObjectWithDefaults,
createNotification,
expandTreePaneItemByName, expandTreePaneItemByName,
expandEntireTree,
createPlanFromJSON, createPlanFromJSON,
openObjectTreeContextMenu, openObjectTreeContextMenu,
getHashUrlToDomainObject, getHashUrlToDomainObject,

View File

@ -1,27 +0,0 @@
/*****************************************************************************
* 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 should be used to install the Example User
document.addEventListener('DOMContentLoaded', () => {
const openmct = window.openmct;
openmct.install(openmct.plugins.example.ExampleUser());
});

View File

@ -1,76 +0,0 @@
class DomainObjectViewProvider {
constructor(openmct) {
this.key = 'doViewProvider';
this.name = 'Domain Object View Provider';
this.openmct = openmct;
}
canView(domainObject) {
return domainObject.type === 'imageFileInput'
|| domainObject.type === 'jsonFileInput';
}
view(domainObject, objectPath) {
let content;
return {
show: function (element) {
const body = domainObject.selectFile.body;
const type = typeof body;
content = document.createElement('div');
content.id = 'file-input-type';
content.textContent = JSON.stringify(type);
element.appendChild(content);
},
destroy: function (element) {
element.removeChild(content);
content = undefined;
}
};
}
}
document.addEventListener('DOMContentLoaded', () => {
const openmct = window.openmct;
openmct.types.addType('jsonFileInput', {
key: 'jsonFileInput',
name: "JSON File Input Object",
creatable: true,
form: [
{
name: 'Upload File',
key: 'selectFile',
control: 'file-input',
required: true,
text: 'Select File...',
type: 'application/json',
property: [
"selectFile"
]
}
]
});
openmct.types.addType('imageFileInput', {
key: 'imageFileInput',
name: "Image File Input Object",
creatable: true,
form: [
{
name: 'Upload File',
key: 'selectFile',
control: 'file-input',
required: true,
text: 'Select File...',
type: 'image/*',
property: [
"selectFile"
]
}
]
});
openmct.objectViews.addProvider(new DomainObjectViewProvider(openmct));
});

View File

@ -1,27 +0,0 @@
/*****************************************************************************
* 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 should be used to install the Operator Status
document.addEventListener('DOMContentLoaded', () => {
const openmct = window.openmct;
openmct.install(openmct.plugins.OperatorStatus());
});

View File

@ -20,8 +20,6 @@
* at runtime from the About dialog for additional information. * at runtime from the About dialog for additional information.
*****************************************************************************/ *****************************************************************************/
const { createDomainObjectWithDefaults } = require('../appActions');
const NOTEBOOK_DROP_AREA = '.c-notebook__drag-area'; const NOTEBOOK_DROP_AREA = '.c-notebook__drag-area';
/** /**
@ -40,17 +38,24 @@ async function enterTextEntry(page, text) {
/** /**
* @param {import('@playwright/test').Page} page * @param {import('@playwright/test').Page} page
*/ */
async function dragAndDropEmbed(page, notebookObject) { async function dragAndDropEmbed(page, myItemsFolderName) {
// Create example telemetry object // Click button:has-text("Create")
const swg = await createDomainObjectWithDefaults(page, { await page.locator('button:has-text("Create")').click();
type: "Sine Wave Generator" // Click li:has-text("Sine Wave Generator")
}); await page.locator('li:has-text("Sine Wave Generator")').click();
// Navigate to notebook // Click form[name="mctForm"] >> text=My Items
await page.goto(notebookObject.url); await page.locator(`form[name="mctForm"] >> text=${myItemsFolderName}`).click();
// Expand the tree to reveal the notebook // Click text=OK
await page.click('button[title="Show selected item in tree"]'); await page.locator('text=OK').click();
// Drag and drop the SWG into the notebook // Click text=Open MCT My Items >> span >> nth=3
await page.dragAndDrop(`text=${swg.name}`, NOTEBOOK_DROP_AREA); await page.locator(`text=Open MCT ${myItemsFolderName} >> span`).nth(3).click();
// Click text=Unnamed CUSTOM_NAME
await Promise.all([
page.waitForNavigation(),
page.locator('text=Unnamed CUSTOM_NAME').click()
]);
await page.dragAndDrop('text=UNNAMED SINE WAVE GENERATOR', NOTEBOOK_DROP_AREA);
} }
// eslint-disable-next-line no-undef // eslint-disable-next-line no-undef

View File

@ -126,21 +126,13 @@ exports.test = test.extend({
// This should follow in the Project's configuration. Can be set to 'snow' in playwright config.js // This should follow in the Project's configuration. Can be set to 'snow' in playwright config.js
theme: [theme, { option: true }], theme: [theme, { option: true }],
// eslint-disable-next-line no-shadow // eslint-disable-next-line no-shadow
page: async ({ page, theme }, use, testInfo) => { page: async ({ page, theme }, use) => {
// eslint-disable-next-line playwright/no-conditional-in-test // eslint-disable-next-line playwright/no-conditional-in-test
if (theme === 'snow') { if (theme === 'snow') {
//inject snow theme //inject snow theme
await page.addInitScript({ path: path.join(__dirname, './helper', './useSnowTheme.js') }); await page.addInitScript({ path: path.join(__dirname, './helper', './useSnowTheme.js') });
} }
// Attach info about the currently running test and its project.
// This will be used by appActions to fill in the created
// domain object's notes.
page.testNotes = [
`${testInfo.titlePath.join('\n')}`,
`${testInfo.project.name}`
].join('\n');
await use(page); await use(page);
}, },
myItemsFolderName: [myItemsFolderName, { option: true }], myItemsFolderName: [myItemsFolderName, { option: true }],
@ -148,5 +140,22 @@ exports.test = test.extend({
openmctConfig: async ({ myItemsFolderName }, use) => { openmctConfig: async ({ myItemsFolderName }, use) => {
await use({ myItemsFolderName }); await use({ myItemsFolderName });
} }
// objectCreateOptions: [objectCreateOptions, {option: true}],
// eslint-disable-next-line no-shadow
// domainObject: [async ({ page, objectCreateOptions }, use) => {
// // FIXME: This is a false-positive caused by a bug in the eslint-plugin-playwright rule.
// // eslint-disable-next-line playwright/no-conditional-in-test
// if (objectCreateOptions === null) {
// await use(page);
// return;
// }
// //Go to baseURL
// await page.goto('./', { waitUntil: 'networkidle' });
// const uuid = await getOrCreateDomainObject(page, objectCreateOptions);
// await use({ uuid });
// }, { auto: true }]
}); });
exports.expect = expect; exports.expect = expect;

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

View File

@ -20,8 +20,8 @@
* at runtime from the About dialog for additional information. * at runtime from the About dialog for additional information.
*****************************************************************************/ *****************************************************************************/
const { test, expect } = require('../../pluginFixtures.js'); const { test, expect } = require('../../baseFixtures.js');
const { createDomainObjectWithDefaults, createNotification, expandEntireTree } = require('../../appActions.js'); const { createDomainObjectWithDefaults } = require('../../appActions.js');
test.describe('AppActions', () => { test.describe('AppActions', () => {
test('createDomainObjectsWithDefaults', async ({ page }) => { test('createDomainObjectsWithDefaults', async ({ page }) => {
@ -49,12 +49,12 @@ test.describe('AppActions', () => {
parent: e2eFolder.uuid parent: e2eFolder.uuid
}); });
await page.goto(timer1.url); await page.goto(timer1.url, { waitUntil: 'networkidle' });
await expect(page.locator('.l-browse-bar__object-name')).toHaveText(timer1.name); await expect(page.locator('.l-browse-bar__object-name')).toHaveText('Timer Foo');
await page.goto(timer2.url); await page.goto(timer2.url, { waitUntil: 'networkidle' });
await expect(page.locator('.l-browse-bar__object-name')).toHaveText(timer2.name); await expect(page.locator('.l-browse-bar__object-name')).toHaveText('Timer Bar');
await page.goto(timer3.url); await page.goto(timer3.url, { waitUntil: 'networkidle' });
await expect(page.locator('.l-browse-bar__object-name')).toHaveText(timer3.name); await expect(page.locator('.l-browse-bar__object-name')).toHaveText('Timer Baz');
}); });
await test.step('Create multiple nested objects in a row', async () => { await test.step('Create multiple nested objects in a row', async () => {
@ -73,93 +73,16 @@ test.describe('AppActions', () => {
name: 'Folder Baz', name: 'Folder Baz',
parent: folder2.uuid parent: folder2.uuid
}); });
await page.goto(folder1.url); await page.goto(folder1.url, { waitUntil: 'networkidle' });
await expect(page.locator('.l-browse-bar__object-name')).toHaveText(folder1.name); await expect(page.locator('.l-browse-bar__object-name')).toHaveText('Folder Foo');
await page.goto(folder2.url); await page.goto(folder2.url, { waitUntil: 'networkidle' });
await expect(page.locator('.l-browse-bar__object-name')).toHaveText(folder2.name); await expect(page.locator('.l-browse-bar__object-name')).toHaveText('Folder Bar');
await page.goto(folder3.url); await page.goto(folder3.url, { waitUntil: 'networkidle' });
await expect(page.locator('.l-browse-bar__object-name')).toHaveText(folder3.name); await expect(page.locator('.l-browse-bar__object-name')).toHaveText('Folder Baz');
expect(folder1.url).toBe(`${e2eFolder.url}/${folder1.uuid}`); expect(folder1.url).toBe(`${e2eFolder.url}/${folder1.uuid}`);
expect(folder2.url).toBe(`${e2eFolder.url}/${folder1.uuid}/${folder2.uuid}`); expect(folder2.url).toBe(`${e2eFolder.url}/${folder1.uuid}/${folder2.uuid}`);
expect(folder3.url).toBe(`${e2eFolder.url}/${folder1.uuid}/${folder2.uuid}/${folder3.uuid}`); expect(folder3.url).toBe(`${e2eFolder.url}/${folder1.uuid}/${folder2.uuid}/${folder3.uuid}`);
}); });
}); });
test("createNotification", async ({ page }) => {
await page.goto('./', { waitUntil: 'networkidle' });
await createNotification(page, {
message: 'Test info notification',
severity: 'info'
});
await expect(page.locator('.c-message-banner__message')).toHaveText('Test info notification');
await expect(page.locator('.c-message-banner')).toHaveClass(/info/);
await page.locator('[aria-label="Dismiss"]').click();
await createNotification(page, {
message: 'Test alert notification',
severity: 'alert'
});
await expect(page.locator('.c-message-banner__message')).toHaveText('Test alert notification');
await expect(page.locator('.c-message-banner')).toHaveClass(/alert/);
await page.locator('[aria-label="Dismiss"]').click();
await createNotification(page, {
message: 'Test error notification',
severity: 'error'
});
await expect(page.locator('.c-message-banner__message')).toHaveText('Test error notification');
await expect(page.locator('.c-message-banner')).toHaveClass(/error/);
await page.locator('[aria-label="Dismiss"]').click();
});
test('expandEntireTree', async ({ page }) => {
await page.goto('./', { waitUntil: 'networkidle' });
const rootFolder = await createDomainObjectWithDefaults(page, {
type: 'Folder'
});
const folder1 = await createDomainObjectWithDefaults(page, {
type: 'Folder',
parent: rootFolder.uuid
});
await createDomainObjectWithDefaults(page, {
type: 'Clock',
parent: folder1.uuid
});
const folder2 = await createDomainObjectWithDefaults(page, {
type: 'Folder',
parent: folder1.uuid
});
await createDomainObjectWithDefaults(page, {
type: 'Folder',
parent: folder1.uuid
});
await createDomainObjectWithDefaults(page, {
type: 'Display Layout',
parent: folder2.uuid
});
await createDomainObjectWithDefaults(page, {
type: 'Folder',
parent: folder2.uuid
});
await page.goto('./#/browse/mine');
await expandEntireTree(page);
const treePane = page.getByRole('tree', {
name: "Main Tree"
});
const treePaneCollapsedItems = treePane.getByRole('treeitem', { expanded: false });
expect(await treePaneCollapsedItems.count()).toBe(0);
await page.goto('./#/browse/mine');
//Click the Create button
await page.click('button:has-text("Create")');
// Click the object specified by 'type'
await page.click(`li[role='menuitem']:text("Clock")`);
await expandEntireTree(page, "Create Modal Tree");
const locatorTree = page.getByRole("tree", {
name: "Create Modal Tree"
});
const locatorTreeCollapsedItems = locatorTree.locator('role=treeitem[expanded=false]');
expect(await locatorTreeCollapsedItems.count()).toBe(0);
});
}); });

View File

@ -45,7 +45,7 @@
*/ */
// Structure: Some standard Imports. Please update the required pathing. // Structure: Some standard Imports. Please update the required pathing.
const { test, expect } = require('../../pluginFixtures'); const { test, expect } = require('../../baseFixtures');
const { createDomainObjectWithDefaults } = require('../../appActions'); const { createDomainObjectWithDefaults } = require('../../appActions');
/** /**
@ -144,5 +144,5 @@ async function renameTimerFrom3DotMenu(page, timerUrl, newNameForTimer) {
await page.locator('text=Properties Title Notes >> input[type="text"]').fill(newNameForTimer); await page.locator('text=Properties Title Notes >> input[type="text"]').fill(newNameForTimer);
// Click Ok button to Save // Click Ok button to Save
await page.locator('button:has-text("OK")').click(); await page.locator('text=OK').click();
} }

View File

@ -43,14 +43,14 @@ test('Generate Visual Test Data @localStorage', async ({ page, context }) => {
await page.locator('button:has-text("Create")').click(); await page.locator('button:has-text("Create")').click();
// add sine wave generator with defaults // add sine wave generator with defaults
await page.locator('li[role="menuitem"]:has-text("Sine Wave Generator")').click(); await page.locator('li:has-text("Sine Wave Generator")').click();
//Add a 5000 ms Delay //Add a 5000 ms Delay
await page.locator('[aria-label="Loading Delay \\(ms\\)"]').fill('5000'); await page.locator('[aria-label="Loading Delay \\(ms\\)"]').fill('5000');
await Promise.all([ await Promise.all([
page.waitForNavigation(), page.waitForNavigation(),
page.locator('button:has-text("OK")').click(), page.locator('text=OK').click(),
//Wait for Save Banner to appear //Wait for Save Banner to appear
page.waitForSelector('.c-message-banner__message') page.waitForSelector('.c-message-banner__message')
]); ]);
@ -58,7 +58,7 @@ test('Generate Visual Test Data @localStorage', async ({ page, context }) => {
// focus the overlay plot // focus the overlay plot
await page.goto(overlayPlot.url); await page.goto(overlayPlot.url);
await expect(page.locator('.l-browse-bar__object-name')).toContainText(overlayPlot.name); await expect(page.locator('.l-browse-bar__object-name')).toContainText('Unnamed Overlay Plot');
//Save localStorage for future test execution //Save localStorage for future test execution
await context.storageState({ path: './e2e/test-data/VisualTestData_storage.json' }); await context.storageState({ path: './e2e/test-data/VisualTestData_storage.json' });
}); });

View File

@ -25,9 +25,9 @@
* *
*/ */
const { test, expect } = require('../../pluginFixtures'); const { test, expect } = require('../../baseFixtures');
test.describe("CouchDB Status Indicator with mocked responses @couchdb", () => { test.describe("CouchDB Status Indicator @couchdb", () => {
test.use({ failOnConsoleError: false }); test.use({ failOnConsoleError: false });
//TODO BeforeAll Verify CouchDB Connectivity with APIContext //TODO BeforeAll Verify CouchDB Connectivity with APIContext
test('Shows green if connected', async ({ page }) => { test('Shows green if connected', async ({ page }) => {
@ -71,41 +71,38 @@ test.describe("CouchDB Status Indicator with mocked responses @couchdb", () => {
}); });
}); });
test.describe("CouchDB initialization with mocked responses @couchdb", () => { test.describe("CouchDB initialization @couchdb", () => {
test.use({ failOnConsoleError: false }); test.use({ failOnConsoleError: false });
test("'My Items' folder is created if it doesn't exist", async ({ page }) => { test("'My Items' folder is created if it doesn't exist", async ({ page }) => {
const mockedMissingObjectResponsefromCouchDB = { // Store any relevant PUT requests that happen on the page
const createMineFolderRequests = [];
page.on('request', req => {
// eslint-disable-next-line playwright/no-conditional-in-test
if (req.method() === 'PUT' && req.url().endsWith('openmct/mine')) {
createMineFolderRequests.push(req);
}
});
// Override the first request to GET openmct/mine to return a 404
await page.route('**/openmct/mine', route => {
route.fulfill({
status: 404, status: 404,
contentType: 'application/json', contentType: 'application/json',
body: JSON.stringify({}) body: JSON.stringify({})
}; });
// Override the first request to GET openmct/mine to return a 404.
// This simulates the case of starting Open MCT with a fresh database
// and no "My Items" folder created yet.
await page.route('**/mine', route => {
route.fulfill(mockedMissingObjectResponsefromCouchDB);
}, { times: 1 }); }, { times: 1 });
// Set up promise to verify that a PUT request to create "My Items" // Go to baseURL
// folder was made.
const putMineFolderRequest = page.waitForRequest(req =>
req.url().endsWith('/mine')
&& req.method() === 'PUT');
// Set up promise to verify that a GET request to retrieve "My Items"
// folder was made.
const getMineFolderRequest = page.waitForRequest(req =>
req.url().endsWith('/mine')
&& req.method() === 'GET');
// Go to baseURL.
await page.goto('./', { waitUntil: 'networkidle' }); await page.goto('./', { waitUntil: 'networkidle' });
// Wait for both requests to resolve. // Verify that error banner is displayed
await Promise.all([ const bannerMessage = await page.locator('.c-message-banner__message').innerText();
putMineFolderRequest, expect(bannerMessage).toEqual('Failed to retrieve object mine');
getMineFolderRequest
]); // Verify that a PUT request to create "My Items" folder was made
await expect.poll(() => createMineFolderRequests.length, {
message: 'Verify that PUT request to create "mine" folder was made',
timeout: 1000
}).toBeGreaterThanOrEqual(1);
}); });
}); });

View File

@ -24,7 +24,7 @@
This test suite is dedicated to tests which verify the basic operations surrounding the example event generator. This test suite is dedicated to tests which verify the basic operations surrounding the example event generator.
*/ */
const { test, expect } = require('../../../pluginFixtures'); const { test, expect } = require('../../../baseFixtures');
const { createDomainObjectWithDefaults } = require('../../../appActions'); const { createDomainObjectWithDefaults } = require('../../../appActions');
test.describe('Example Event Generator CRUD Operations', () => { test.describe('Example Event Generator CRUD Operations', () => {

View File

@ -96,7 +96,7 @@ test.describe('Sine Wave Generator', () => {
//Click text=OK //Click text=OK
await Promise.all([ await Promise.all([
page.waitForNavigation(), page.waitForNavigation(),
page.click('button:has-text("OK")') page.click('text=OK')
]); ]);
// Verify that the Sine Wave Generator is displayed and correct // Verify that the Sine Wave Generator is displayed and correct

View File

@ -24,14 +24,10 @@
This test suite is dedicated to tests which verify form functionality in isolation This test suite is dedicated to tests which verify form functionality in isolation
*/ */
const { test, expect } = require('../../pluginFixtures'); const { test, expect } = require('../../baseFixtures');
const { createDomainObjectWithDefaults } = require('../../appActions');
const genUuid = require('uuid').v4;
const path = require('path'); const path = require('path');
const TEST_FOLDER = 'test folder'; const TEST_FOLDER = 'test folder';
const jsonFilePath = 'e2e/test-data/ExampleLayouts.json';
const imageFilePath = 'e2e/test-data/rick.jpg';
test.describe('Form Validation Behavior', () => { test.describe('Form Validation Behavior', () => {
test('Required Field indicators appear if title is empty and can be corrected', async ({ page }) => { test('Required Field indicators appear if title is empty and can be corrected', async ({ page }) => {
@ -47,7 +43,7 @@ test.describe('Form Validation Behavior', () => {
await page.press('text=Properties Title Notes >> input[type="text"]', 'Tab'); await page.press('text=Properties Title Notes >> input[type="text"]', 'Tab');
//Required Field Form Validation //Required Field Form Validation
await expect(page.locator('button:has-text("OK")')).toBeDisabled(); await expect(page.locator('text=OK')).toBeDisabled();
await expect(page.locator('.c-form-row__state-indicator').first()).toHaveClass(/invalid/); await expect(page.locator('.c-form-row__state-indicator').first()).toHaveClass(/invalid/);
//Correct Form Validation for missing title and trigger validation with 'Tab' //Correct Form Validation for missing title and trigger validation with 'Tab'
@ -56,13 +52,13 @@ test.describe('Form Validation Behavior', () => {
await page.press('text=Properties Title Notes >> input[type="text"]', 'Tab'); await page.press('text=Properties Title Notes >> input[type="text"]', 'Tab');
//Required Field Form Validation is corrected //Required Field Form Validation is corrected
await expect(page.locator('button:has-text("OK")')).toBeEnabled(); await expect(page.locator('text=OK')).toBeEnabled();
await expect(page.locator('.c-form-row__state-indicator').first()).not.toHaveClass(/invalid/); await expect(page.locator('.c-form-row__state-indicator').first()).not.toHaveClass(/invalid/);
//Finish Creating Domain Object //Finish Creating Domain Object
await Promise.all([ await Promise.all([
page.waitForNavigation(), page.waitForNavigation(),
page.click('button:has-text("OK")') page.click('text=OK')
]); ]);
//Verify that the Domain Object has been created with the corrected title property //Verify that the Domain Object has been created with the corrected title property
@ -70,41 +66,6 @@ test.describe('Form Validation Behavior', () => {
}); });
}); });
test.describe('Form File Input Behavior', () => {
test.beforeEach(async ({ page }) => {
// eslint-disable-next-line no-undef
await page.addInitScript({ path: path.join(__dirname, '../../helper', 'addInitFileInputObject.js') });
});
test('Can select a JSON file type', async ({ page }) => {
await page.goto('./', { waitUntil: 'networkidle' });
await page.getByRole('button', { name: ' Create ' }).click();
await page.getByRole('menuitem', { name: 'JSON File Input Object' }).click();
await page.setInputFiles('#fileElem', jsonFilePath);
await page.getByRole('button', { name: 'Save' }).click();
const type = await page.locator('#file-input-type').textContent();
await expect(type).toBe(`"string"`);
});
test('Can select an image file type', async ({ page }) => {
await page.goto('./', { waitUntil: 'networkidle' });
await page.getByRole('button', { name: ' Create ' }).click();
await page.getByRole('menuitem', { name: 'Image File Input Object' }).click();
await page.setInputFiles('#fileElem', imageFilePath);
await page.getByRole('button', { name: 'Save' }).click();
const type = await page.locator('#file-input-type').textContent();
await expect(type).toBe(`"object"`);
});
});
test.describe('Persistence operations @addInit', () => { test.describe('Persistence operations @addInit', () => {
// add non persistable root item // add non persistable root item
test.beforeEach(async ({ page }) => { test.beforeEach(async ({ page }) => {
@ -130,146 +91,6 @@ test.describe('Persistence operations @addInit', () => {
}); });
}); });
test.describe('Persistence operations @couchdb', () => {
test.use({ failOnConsoleError: false });
test('Editing object properties should generate a single persistence operation', async ({ page }) => {
test.info().annotations.push({
type: 'issue',
description: 'https://github.com/nasa/openmct/issues/5616'
});
await page.goto('./', { waitUntil: 'networkidle' });
// Create a new 'Clock' object with default settings
const clock = await createDomainObjectWithDefaults(page, {
type: 'Clock'
});
// Count all persistence operations (PUT requests) for this specific object
let putRequestCount = 0;
page.on('request', req => {
if (req.method() === 'PUT' && req.url().endsWith(clock.uuid)) {
putRequestCount += 1;
}
});
// Open the edit form for the clock object
await page.click('button[title="More options"]');
await page.click('li[title="Edit properties of this object."]');
// Modify the display format from default 12hr -> 24hr and click 'Save'
await page.locator('select[aria-label="12 or 24 hour clock"]').selectOption({ value: 'clock24' });
await page.click('button[aria-label="Save"]');
await expect.poll(() => putRequestCount, {
message: 'Verify a single PUT request was made to persist the object',
timeout: 1000
}).toEqual(1);
});
test('Can create an object after a conflict error @couchdb @2p', async ({ page }) => {
test.info().annotations.push({
type: 'issue',
description: 'https://github.com/nasa/openmct/issues/5982'
});
const page2 = await page.context().newPage();
// Both pages: Go to baseURL
await Promise.all([
page.goto('./', { waitUntil: 'networkidle' }),
page2.goto('./', { waitUntil: 'networkidle' })
]);
// Both pages: Click the Create button
await Promise.all([
page.click('button:has-text("Create")'),
page2.click('button:has-text("Create")')
]);
// Both pages: Click "Clock" in the Create menu
await Promise.all([
page.click(`li[role='menuitem']:text("Clock")`),
page2.click(`li[role='menuitem']:text("Clock")`)
]);
// Generate unique names for both objects
const nameInput = page.locator('form[name="mctForm"] .first input[type="text"]');
const nameInput2 = page2.locator('form[name="mctForm"] .first input[type="text"]');
// Both pages: Fill in the 'Name' form field.
await Promise.all([
nameInput.fill(""),
nameInput.fill(`Clock:${genUuid()}`),
nameInput2.fill(""),
nameInput2.fill(`Clock:${genUuid()}`)
]);
// Both pages: Fill the "Notes" section with information about the
// currently running test and its project.
const testNotes = page.testNotes;
const notesInput = page.locator('form[name="mctForm"] #notes-textarea');
const notesInput2 = page2.locator('form[name="mctForm"] #notes-textarea');
await Promise.all([
notesInput.fill(testNotes),
notesInput2.fill(testNotes)
]);
// Page 2: Click "OK" to create the domain object and wait for navigation.
// This will update the composition of the parent folder, setting the
// conditions for a conflict error from the first page.
await Promise.all([
page2.waitForLoadState(),
page2.click('[aria-label="Save"]'),
// Wait for Save Banner to appear
page2.waitForSelector('.c-message-banner__message')
]);
// Close Page 2, we're done with it.
await page2.close();
// Page 1: Click "OK" to create the domain object and wait for navigation.
// This will trigger a conflict error upon attempting to update
// the composition of the parent folder.
await Promise.all([
page.waitForLoadState(),
page.click('[aria-label="Save"]'),
// Wait for Save Banner to appear
page.waitForSelector('.c-message-banner__message')
]);
// Page 1: Verify that the conflict has occurred and an error notification is displayed.
await expect(page.locator('.c-message-banner__message', {
hasText: "Conflict detected while saving mine"
})).toBeVisible();
// Page 1: Start logging console errors from this point on
let errors = [];
page.on('console', (msg) => {
if (msg.type() === 'error') {
errors.push(msg.text());
}
});
// Page 1: Try to create a clock with the page that received the conflict.
const clockAfterConflict = await createDomainObjectWithDefaults(page, {
type: 'Clock'
});
// Page 1: Wait for save progress dialog to appear/disappear
await page.locator('.c-message-banner__message', {
hasText: 'Do not navigate away from this page or close this browser tab while this message is displayed.',
state: 'visible'
}).waitFor({ state: 'hidden' });
// Page 1: Navigate to 'My Items' and verify that the second clock was created
await page.goto('./#/browse/mine');
await expect(page.locator(`.c-grid-item__name[title="${clockAfterConflict.name}"]`)).toBeVisible();
// Verify no console errors occurred
expect(errors).toHaveLength(0);
});
});
test.describe('Form Correctness by Object Type', () => { test.describe('Form Correctness by Object Type', () => {
test.fixme('Verify correct behavior of number object (SWG)', async ({page}) => {}); test.fixme('Verify correct behavior of number object (SWG)', async ({page}) => {});
test.fixme('Verify correct behavior of number object Timer', async ({page}) => {}); test.fixme('Verify correct behavior of number object Timer', async ({page}) => {});

View File

@ -43,80 +43,48 @@ test.describe('Move & link item tests', () => {
name: 'Child Folder', name: 'Child Folder',
parent: parentFolder.uuid parent: parentFolder.uuid
}); });
const grandchildFolder = await createDomainObjectWithDefaults(page, { await createDomainObjectWithDefaults(page, {
type: 'Folder', type: 'Folder',
name: 'Grandchild Folder', name: 'Grandchild Folder',
parent: childFolder.uuid parent: childFolder.uuid
}); });
// Attempt to move parent to its own grandparent // Attempt to move parent to its own grandparent
await page.locator('button[title="Show selected item in tree"]').click(); await page.locator(`text=Open MCT ${myItemsFolderName} >> span`).nth(3).click();
await page.locator('.c-disclosure-triangle >> nth=0').click();
const treePane = page.getByRole('tree', { await page.locator(`a:has-text("Parent Folder") >> nth=0`).click({
name: 'Main Tree'
});
await treePane.getByRole('treeitem', {
name: 'Parent Folder'
}).click({
button: 'right' button: 'right'
}); });
await page.getByRole('menuitem', { await page.locator('li.icon-move').click();
name: /Move/ await page.locator('form[name="mctForm"] >> .c-disclosure-triangle >> nth=0').click();
}).click(); await page.locator('form[name="mctForm"] >> text=Parent Folder').click();
const createModalTree = page.getByRole('tree', {
name: "Create Modal Tree"
});
const myItemsLocatorTreeItem = createModalTree.getByRole('treeitem', {
name: myItemsFolderName
});
await myItemsLocatorTreeItem.locator('.c-disclosure-triangle').click();
await myItemsLocatorTreeItem.click();
const parentFolderLocatorTreeItem = createModalTree.getByRole('treeitem', {
name: parentFolder.name
});
await parentFolderLocatorTreeItem.locator('.c-disclosure-triangle').click();
await parentFolderLocatorTreeItem.click();
await expect(page.locator('[aria-label="Save"]')).toBeDisabled(); await expect(page.locator('[aria-label="Save"]')).toBeDisabled();
await page.locator('form[name="mctForm"] >> .c-disclosure-triangle >> nth=1').click();
const childFolderLocatorTreeItem = createModalTree.getByRole('treeitem', { await page.locator('form[name="mctForm"] >> text=Child Folder').click();
name: new RegExp(childFolder.name)
});
await childFolderLocatorTreeItem.locator('.c-disclosure-triangle').click();
await childFolderLocatorTreeItem.click();
await expect(page.locator('[aria-label="Save"]')).toBeDisabled(); await expect(page.locator('[aria-label="Save"]')).toBeDisabled();
await page.locator('form[name="mctForm"] >> .c-disclosure-triangle >> nth=2').click();
const grandchildFolderLocatorTreeItem = createModalTree.getByRole('treeitem', { await page.locator('form[name="mctForm"] >> text=Grandchild Folder').click();
name: grandchildFolder.name
});
await grandchildFolderLocatorTreeItem.locator('.c-disclosure-triangle').click();
await grandchildFolderLocatorTreeItem.click();
await expect(page.locator('[aria-label="Save"]')).toBeDisabled(); await expect(page.locator('[aria-label="Save"]')).toBeDisabled();
await page.locator('form[name="mctForm"] >> text=Parent Folder').click();
await parentFolderLocatorTreeItem.click();
await expect(page.locator('[aria-label="Save"]')).toBeDisabled(); await expect(page.locator('[aria-label="Save"]')).toBeDisabled();
await page.locator('[aria-label="Cancel"]').click(); await page.locator('[aria-label="Cancel"]').click();
// Move Child Folder from Parent Folder to My Items // Move Child Folder from Parent Folder to My Items
await treePane.getByRole('treeitem', { await page.locator('.c-disclosure-triangle >> nth=0').click();
name: new RegExp(childFolder.name) await page.locator('.c-disclosure-triangle >> nth=1').click();
}).click({
await page.locator(`a:has-text("Child Folder") >> nth=0`).click({
button: 'right' button: 'right'
}); });
await page.getByRole('menuitem', { await page.locator('li.icon-move').click();
name: /Move/ await page.locator(`form[name="mctForm"] >> text=${myItemsFolderName}`).click();
}).click();
await myItemsLocatorTreeItem.click();
await page.locator('[aria-label="Save"]').click(); await page.locator('text=OK').click();
const myItemsPaneTreeItem = treePane.getByRole('treeitem', {
name: myItemsFolderName
});
// Expect that Child Folder is in My Items, the root folder // Expect that Child Folder is in My Items, the root folder
expect(myItemsPaneTreeItem.locator('nth=0:has(text=Child Folder)')).toBeTruthy(); expect(page.locator(`text=${myItemsFolderName} >> nth=0:has(text=Child Folder)`)).toBeTruthy();
}); });
test('Create a basic object and verify that it cannot be moved to telemetry object without Composition Provider', async ({ page, openmctConfig }) => { test('Create a basic object and verify that it cannot be moved to telemetry object without Composition Provider', async ({ page, openmctConfig }) => {
const { myItemsFolderName } = openmctConfig; const { myItemsFolderName } = openmctConfig;
@ -127,11 +95,11 @@ test.describe('Move & link item tests', () => {
// Create Telemetry Table // Create Telemetry Table
let telemetryTable = 'Test Telemetry Table'; let telemetryTable = 'Test Telemetry Table';
await page.locator('button:has-text("Create")').click(); await page.locator('button:has-text("Create")').click();
await page.locator('li[role="menuitem"]:has-text("Telemetry Table")').click(); await page.locator('li:has-text("Telemetry Table")').click();
await page.locator('text=Properties Title Notes >> input[type="text"]').click(); await page.locator('text=Properties Title Notes >> input[type="text"]').click();
await page.locator('text=Properties Title Notes >> input[type="text"]').fill(telemetryTable); await page.locator('text=Properties Title Notes >> input[type="text"]').fill(telemetryTable);
await page.locator('button:has-text("OK")').click(); await page.locator('text=OK').click();
// Finish editing and save Telemetry Table // Finish editing and save Telemetry Table
await page.locator('.c-button--menu.c-button--major.icon-save').click(); await page.locator('.c-button--menu.c-button--major.icon-save').click();
@ -140,19 +108,19 @@ test.describe('Move & link item tests', () => {
// Create New Folder Basic Domain Object // Create New Folder Basic Domain Object
let folder = 'Test Folder'; let folder = 'Test Folder';
await page.locator('button:has-text("Create")').click(); await page.locator('button:has-text("Create")').click();
await page.locator('li[role="menuitem"]:has-text("Folder")').click(); await page.locator('li:has-text("Folder")').click();
await page.locator('text=Properties Title Notes >> input[type="text"]').click(); await page.locator('text=Properties Title Notes >> input[type="text"]').click();
await page.locator('text=Properties Title Notes >> input[type="text"]').fill(folder); await page.locator('text=Properties Title Notes >> input[type="text"]').fill(folder);
// See if it's possible to put the folder in the Telemetry object during creation (Soft Assert) // See if it's possible to put the folder in the Telemetry object during creation (Soft Assert)
await page.locator(`form[name="mctForm"] >> text=${telemetryTable}`).click(); await page.locator(`form[name="mctForm"] >> text=${telemetryTable}`).click();
let okButton = page.locator('button.c-button.c-button--major:has-text("OK")'); let okButton = await page.locator('button.c-button.c-button--major:has-text("OK")');
let okButtonStateDisabled = await okButton.isDisabled(); let okButtonStateDisabled = await okButton.isDisabled();
expect.soft(okButtonStateDisabled).toBeTruthy(); expect.soft(okButtonStateDisabled).toBeTruthy();
// Continue test regardless of assertion and create it in My Items // Continue test regardless of assertion and create it in My Items
await page.locator(`form[name="mctForm"] >> text=${myItemsFolderName}`).click(); await page.locator(`form[name="mctForm"] >> text=${myItemsFolderName}`).click();
await page.locator('button:has-text("OK")').click(); await page.locator('text=OK').click();
// Open My Items // Open My Items
await page.locator(`text=Open MCT ${myItemsFolderName} >> span`).nth(3).click(); await page.locator(`text=Open MCT ${myItemsFolderName} >> span`).nth(3).click();
@ -170,7 +138,7 @@ test.describe('Move & link item tests', () => {
// See if it's possible to put the folder in the Telemetry object after creation // See if it's possible to put the folder in the Telemetry object after creation
await page.locator(`text=Location Open MCT ${myItemsFolderName} >> span`).nth(3).click(); await page.locator(`text=Location Open MCT ${myItemsFolderName} >> span`).nth(3).click();
await page.locator(`form[name="mctForm"] >> text=${telemetryTable}`).click(); await page.locator(`form[name="mctForm"] >> text=${telemetryTable}`).click();
let okButton2 = page.locator('button.c-button.c-button--major:has-text("OK")'); let okButton2 = await page.locator('button.c-button.c-button--major:has-text("OK")');
let okButtonStateDisabled2 = await okButton2.isDisabled(); let okButtonStateDisabled2 = await okButton2.isDisabled();
expect(okButtonStateDisabled2).toBeTruthy(); expect(okButtonStateDisabled2).toBeTruthy();
}); });
@ -190,80 +158,48 @@ test.describe('Move & link item tests', () => {
name: 'Child Folder', name: 'Child Folder',
parent: parentFolder.uuid parent: parentFolder.uuid
}); });
const grandchildFolder = await createDomainObjectWithDefaults(page, { await createDomainObjectWithDefaults(page, {
type: 'Folder', type: 'Folder',
name: 'Grandchild Folder', name: 'Grandchild Folder',
parent: childFolder.uuid parent: childFolder.uuid
}); });
// Attempt to move parent to its own grandparent // Attempt to link parent to its own grandparent
await page.locator('button[title="Show selected item in tree"]').click(); await page.locator(`text=Open MCT ${myItemsFolderName} >> span`).nth(3).click();
await page.locator('.c-disclosure-triangle >> nth=0').click();
const treePane = page.getByRole('tree', { await page.locator(`a:has-text("Parent Folder") >> nth=0`).click({
name: 'Main Tree'
});
await treePane.getByRole('treeitem', {
name: 'Parent Folder'
}).click({
button: 'right' button: 'right'
}); });
await page.getByRole('menuitem', { await page.locator('li.icon-link').click();
name: /Move/ await page.locator('form[name="mctForm"] >> .c-disclosure-triangle >> nth=0').click();
}).click(); await page.locator('form[name="mctForm"] >> text=Parent Folder').click();
const createModalTree = page.getByRole('tree', {
name: "Create Modal Tree"
});
const myItemsLocatorTreeItem = createModalTree.getByRole('treeitem', {
name: myItemsFolderName
});
await myItemsLocatorTreeItem.locator('.c-disclosure-triangle').click();
await myItemsLocatorTreeItem.click();
const parentFolderLocatorTreeItem = createModalTree.getByRole('treeitem', {
name: parentFolder.name
});
await parentFolderLocatorTreeItem.locator('.c-disclosure-triangle').click();
await parentFolderLocatorTreeItem.click();
await expect(page.locator('[aria-label="Save"]')).toBeDisabled(); await expect(page.locator('[aria-label="Save"]')).toBeDisabled();
await page.locator('form[name="mctForm"] >> .c-disclosure-triangle >> nth=1').click();
const childFolderLocatorTreeItem = createModalTree.getByRole('treeitem', { await page.locator('form[name="mctForm"] >> text=Child Folder').click();
name: new RegExp(childFolder.name)
});
await childFolderLocatorTreeItem.locator('.c-disclosure-triangle').click();
await childFolderLocatorTreeItem.click();
await expect(page.locator('[aria-label="Save"]')).toBeDisabled(); await expect(page.locator('[aria-label="Save"]')).toBeDisabled();
await page.locator('form[name="mctForm"] >> .c-disclosure-triangle >> nth=2').click();
const grandchildFolderLocatorTreeItem = createModalTree.getByRole('treeitem', { await page.locator('form[name="mctForm"] >> text=Grandchild Folder').click();
name: grandchildFolder.name
});
await grandchildFolderLocatorTreeItem.locator('.c-disclosure-triangle').click();
await grandchildFolderLocatorTreeItem.click();
await expect(page.locator('[aria-label="Save"]')).toBeDisabled(); await expect(page.locator('[aria-label="Save"]')).toBeDisabled();
await page.locator('form[name="mctForm"] >> text=Parent Folder').click();
await parentFolderLocatorTreeItem.click();
await expect(page.locator('[aria-label="Save"]')).toBeDisabled(); await expect(page.locator('[aria-label="Save"]')).toBeDisabled();
await page.locator('[aria-label="Cancel"]').click(); await page.locator('[aria-label="Cancel"]').click();
// Move Child Folder from Parent Folder to My Items // Link Child Folder from Parent Folder to My Items
await treePane.getByRole('treeitem', { await page.locator('.c-disclosure-triangle >> nth=0').click();
name: new RegExp(childFolder.name) await page.locator('.c-disclosure-triangle >> nth=1').click();
}).click({
await page.locator(`a:has-text("Child Folder") >> nth=0`).click({
button: 'right' button: 'right'
}); });
await page.getByRole('menuitem', { await page.locator('li.icon-link').click();
name: /Link/ await page.locator(`form[name="mctForm"] >> text=${myItemsFolderName}`).click();
}).click();
await myItemsLocatorTreeItem.click();
await page.locator('[aria-label="Save"]').click(); await page.locator('text=OK').click();
const myItemsPaneTreeItem = treePane.getByRole('treeitem', {
name: myItemsFolderName
});
// Expect that Child Folder is in My Items, the root folder // Expect that Child Folder is in My Items, the root folder
expect(myItemsPaneTreeItem.locator('nth=0:has(text=Child Folder)')).toBeTruthy(); expect(page.locator(`text=${myItemsFolderName} >> nth=0:has(text=Child Folder)`)).toBeTruthy();
}); });
}); });

View File

@ -1,79 +0,0 @@
/*****************************************************************************
* 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
*/
// FIXME: Remove this eslint exception once tests are implemented
// eslint-disable-next-line no-unused-vars
const { createDomainObjectWithDefaults } = require('../../appActions');
const { test, expect } = require('../../pluginFixtures');
test.describe('Notifications List', () => {
test.fixme('Notifications can be dismissed individually', async ({ page }) => {
// Create some persistent notifications
// Verify that they are present in the notifications list
// Dismiss one of the notifications
// Verify that it is no longer present in the notifications list
// Verify that the other notifications are still present in the notifications list
});
});
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: 'networkidle' });
// 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"]');
// Click on the "Save and Finish Editing" option
await page.click('li[title="Save and Finish Editing"]');
// Verify that Notification List is NOT open
expect(await page.locator('div[role="dialog"]').isVisible()).toBe(false);
});
});

View File

@ -40,11 +40,11 @@ test.describe.serial('Condition Set CRUD Operations on @localStorage', () => {
await page.goto('./', { waitUntil: 'networkidle' }); await page.goto('./', { waitUntil: 'networkidle' });
await page.click('button:has-text("Create")'); await page.click('button:has-text("Create")');
await page.locator('li[role="menuitem"]:has-text("Condition Set")').click(); await page.locator('li:has-text("Condition Set")').click();
await Promise.all([ await Promise.all([
page.waitForNavigation(), page.waitForNavigation(),
page.click('button:has-text("OK")') page.click('text=OK')
]); ]);
//Save localStorage for future test execution //Save localStorage for future test execution
@ -98,8 +98,8 @@ test.describe.serial('Condition Set CRUD Operations on @localStorage', () => {
await page.locator('text=Conditions View Snapshot >> button').nth(3).click(); await page.locator('text=Conditions View Snapshot >> button').nth(3).click();
//Edit Condition Set Name from main view //Edit Condition Set Name from main view
await page.locator('.l-browse-bar__object-name').filter({ hasText: 'Unnamed Condition Set' }).first().fill('Renamed Condition Set'); await page.locator('text=Unnamed Condition Set').first().fill('Renamed Condition Set');
await page.locator('.l-browse-bar__object-name').filter({ hasText: 'Renamed Condition Set' }).first().press('Enter'); await page.locator('text=Renamed Condition Set').first().press('Enter');
// Click Save Button // Click Save Button
await page.locator('text=Snapshot Save and Finish Editing Save and Continue Editing >> button').nth(1).click(); await page.locator('text=Snapshot Save and Finish Editing Save and Continue Editing >> button').nth(1).click();
// Click Save and Finish Editing Option // Click Save and Finish Editing Option
@ -163,9 +163,9 @@ test.describe.serial('Condition Set CRUD Operations on @localStorage', () => {
// Click hamburger button // Click hamburger button
await page.locator('[title="More options"]').click(); await page.locator('[title="More options"]').click();
// Click 'Remove' and press OK // Click text=Remove
await page.locator('li[role="menuitem"]:has-text("Remove")').click(); await page.locator('text=Remove').click();
await page.locator('button:has-text("OK")').click(); await page.locator('text=OK').click();
//Expect Unnamed Condition Set to be removed in Main View //Expect Unnamed Condition Set to be removed in Main View
const numberOfConditionSetsAtEnd = await page.locator('a:has-text("Unnamed Condition Set Condition Set")').count(); const numberOfConditionSetsAtEnd = await page.locator('a:has-text("Unnamed Condition Set Condition Set")').count();

View File

@ -23,8 +23,7 @@
const { test, expect } = require('../../../../pluginFixtures'); const { test, expect } = require('../../../../pluginFixtures');
const { createDomainObjectWithDefaults, setStartOffset, setFixedTimeMode, setRealTimeMode } = require('../../../../appActions'); const { createDomainObjectWithDefaults, setStartOffset, setFixedTimeMode, setRealTimeMode } = require('../../../../appActions');
test.describe('Display Layout', () => { test.describe('Testing Display Layout @unstable', () => {
/** @type {import('../../../../appActions').CreatedObjectInfo} */
let sineWaveObject; let sineWaveObject;
test.beforeEach(async ({ page }) => { test.beforeEach(async ({ page }) => {
await page.goto('./', { waitUntil: 'networkidle' }); await page.goto('./', { waitUntil: 'networkidle' });
@ -32,7 +31,8 @@ test.describe('Display Layout', () => {
// Create Sine Wave Generator // Create Sine Wave Generator
sineWaveObject = await createDomainObjectWithDefaults(page, { sineWaveObject = await createDomainObjectWithDefaults(page, {
type: 'Sine Wave Generator' type: 'Sine Wave Generator',
name: "Test Sine Wave Generator"
}); });
}); });
test('alpha-numeric widget telemetry value exactly matches latest telemetry value received in real time', async ({ page }) => { test('alpha-numeric widget telemetry value exactly matches latest telemetry value received in real time', async ({ page }) => {
@ -47,14 +47,7 @@ test.describe('Display Layout', () => {
// Expand the 'My Items' folder in the left tree // Expand the 'My Items' folder in the left tree
await page.locator('.c-tree__item__view-control.c-disclosure-triangle').click(); await page.locator('.c-tree__item__view-control.c-disclosure-triangle').click();
// Add the Sine Wave Generator to the Display Layout and save changes // Add the Sine Wave Generator to the Display Layout and save changes
const treePane = page.getByRole('tree', { await page.dragAndDrop('text=Test Sine Wave Generator', '.l-layout__grid-holder');
name: 'Main Tree'
});
const sineWaveGeneratorTreeItem = treePane.getByRole('treeitem', {
name: new RegExp(sineWaveObject.name)
});
const layoutGridHolder = page.locator('.l-layout__grid-holder');
await sineWaveGeneratorTreeItem.dragTo(layoutGridHolder);
await page.locator('button[title="Save"]').click(); await page.locator('button[title="Save"]').click();
await page.locator('text=Save and Finish Editing').click(); await page.locator('text=Save and Finish Editing').click();
@ -62,12 +55,12 @@ test.describe('Display Layout', () => {
// On getting data, check if the value found in the Display Layout is the most recent value // On getting data, check if the value found in the Display Layout is the most recent value
// from the Sine Wave Generator // from the Sine Wave Generator
const getTelemValuePromise = await subscribeToTelemetry(page, sineWaveObject.uuid); const getTelemValuePromise = await subscribeToTelemetry(page, sineWaveObject.uuid);
const formattedTelemetryValue = getTelemValuePromise; const formattedTelemetryValue = await getTelemValuePromise;
const displayLayoutValuePromise = await page.waitForSelector(`text="${formattedTelemetryValue}"`); const displayLayoutValuePromise = await page.waitForSelector(`text="${formattedTelemetryValue}"`);
const displayLayoutValue = await displayLayoutValuePromise.textContent(); const displayLayoutValue = await displayLayoutValuePromise.textContent();
const trimmedDisplayValue = displayLayoutValue.trim(); const trimmedDisplayValue = displayLayoutValue.trim();
expect(trimmedDisplayValue).toBe(formattedTelemetryValue); await expect(trimmedDisplayValue).toBe(formattedTelemetryValue);
}); });
test('alpha-numeric widget telemetry value exactly matches latest telemetry value received in fixed time', async ({ page }) => { test('alpha-numeric widget telemetry value exactly matches latest telemetry value received in fixed time', async ({ page }) => {
// Create a Display Layout // Create a Display Layout
@ -81,14 +74,7 @@ test.describe('Display Layout', () => {
// Expand the 'My Items' folder in the left tree // Expand the 'My Items' folder in the left tree
await page.locator('.c-tree__item__view-control.c-disclosure-triangle').click(); await page.locator('.c-tree__item__view-control.c-disclosure-triangle').click();
// Add the Sine Wave Generator to the Display Layout and save changes // Add the Sine Wave Generator to the Display Layout and save changes
const treePane = page.getByRole('tree', { await page.dragAndDrop('text=Test Sine Wave Generator', '.l-layout__grid-holder');
name: 'Main Tree'
});
const sineWaveGeneratorTreeItem = treePane.getByRole('treeitem', {
name: new RegExp(sineWaveObject.name)
});
const layoutGridHolder = page.locator('.l-layout__grid-holder');
await sineWaveGeneratorTreeItem.dragTo(layoutGridHolder);
await page.locator('button[title="Save"]').click(); await page.locator('button[title="Save"]').click();
await page.locator('text=Save and Finish Editing').click(); await page.locator('text=Save and Finish Editing').click();
@ -100,12 +86,12 @@ test.describe('Display Layout', () => {
// On getting data, check if the value found in the Display Layout is the most recent value // On getting data, check if the value found in the Display Layout is the most recent value
// from the Sine Wave Generator // from the Sine Wave Generator
const formattedTelemetryValue = getTelemValuePromise; const formattedTelemetryValue = await getTelemValuePromise;
const displayLayoutValuePromise = await page.waitForSelector(`text="${formattedTelemetryValue}"`); const displayLayoutValuePromise = await page.waitForSelector(`text="${formattedTelemetryValue}"`);
const displayLayoutValue = await displayLayoutValuePromise.textContent(); const displayLayoutValue = await displayLayoutValuePromise.textContent();
const trimmedDisplayValue = displayLayoutValue.trim(); const trimmedDisplayValue = displayLayoutValue.trim();
expect(trimmedDisplayValue).toBe(formattedTelemetryValue); await expect(trimmedDisplayValue).toBe(formattedTelemetryValue);
}); });
test('items in a display layout can be removed with object tree context menu when viewing the display layout', async ({ page }) => { test('items in a display layout can be removed with object tree context menu when viewing the display layout', async ({ page }) => {
// Create a Display Layout // Create a Display Layout
@ -119,14 +105,7 @@ test.describe('Display Layout', () => {
// Expand the 'My Items' folder in the left tree // Expand the 'My Items' folder in the left tree
await page.locator('.c-tree__item__view-control.c-disclosure-triangle').click(); await page.locator('.c-tree__item__view-control.c-disclosure-triangle').click();
// Add the Sine Wave Generator to the Display Layout and save changes // Add the Sine Wave Generator to the Display Layout and save changes
const treePane = page.getByRole('tree', { await page.dragAndDrop('text=Test Sine Wave Generator', '.l-layout__grid-holder');
name: 'Main Tree'
});
const sineWaveGeneratorTreeItem = treePane.getByRole('treeitem', {
name: new RegExp(sineWaveObject.name)
});
const layoutGridHolder = page.locator('.l-layout__grid-holder');
await sineWaveGeneratorTreeItem.dragTo(layoutGridHolder);
await page.locator('button[title="Save"]').click(); await page.locator('button[title="Save"]').click();
await page.locator('text=Save and Finish Editing').click(); await page.locator('text=Save and Finish Editing').click();
@ -136,22 +115,19 @@ test.describe('Display Layout', () => {
await page.locator('.c-tree__item.is-navigated-object .c-disclosure-triangle').click(); await page.locator('.c-tree__item.is-navigated-object .c-disclosure-triangle').click();
// Bring up context menu and remove // Bring up context menu and remove
await sineWaveGeneratorTreeItem.nth(1).click({ button: 'right' }); await page.locator('.c-tree__item.is-alias .c-tree__item__name:text("Test Sine Wave Generator")').first().click({ button: 'right' });
await page.locator('li[role="menuitem"]:has-text("Remove")').click(); await page.locator('text=Remove').click();
await page.locator('button:has-text("OK")').click(); await page.locator('text=OK').click();
// delete // delete
expect(await page.locator('.l-layout .l-layout__frame').count()).toEqual(0); expect.soft(await page.locator('.l-layout .l-layout__frame').count()).toEqual(0);
}); });
test('items in a display layout can be removed with object tree context menu when viewing another item', async ({ page }) => { test('items in a display layout can be removed with object tree context menu when viewing another item', async ({ page }) => {
test.info().annotations.push({
type: 'issue',
description: 'https://github.com/nasa/openmct/issues/3117'
});
// Create a Display Layout // Create a Display Layout
const displayLayout = await createDomainObjectWithDefaults(page, { await createDomainObjectWithDefaults(page, {
type: 'Display Layout' type: 'Display Layout',
name: "Test Display Layout"
}); });
// Edit Display Layout // Edit Display Layout
await page.locator('[title="Edit"]').click(); await page.locator('[title="Edit"]').click();
@ -159,14 +135,7 @@ test.describe('Display Layout', () => {
// Expand the 'My Items' folder in the left tree // Expand the 'My Items' folder in the left tree
await page.locator('.c-tree__item__view-control.c-disclosure-triangle').click(); await page.locator('.c-tree__item__view-control.c-disclosure-triangle').click();
// Add the Sine Wave Generator to the Display Layout and save changes // Add the Sine Wave Generator to the Display Layout and save changes
const treePane = page.getByRole('tree', { await page.dragAndDrop('text=Test Sine Wave Generator', '.l-layout__grid-holder');
name: 'Main Tree'
});
const sineWaveGeneratorTreeItem = treePane.getByRole('treeitem', {
name: new RegExp(sineWaveObject.name)
});
const layoutGridHolder = page.locator('.l-layout__grid-holder');
await sineWaveGeneratorTreeItem.dragTo(layoutGridHolder);
await page.locator('button[title="Save"]').click(); await page.locator('button[title="Save"]').click();
await page.locator('text=Save and Finish Editing').click(); await page.locator('text=Save and Finish Editing').click();
@ -175,18 +144,18 @@ test.describe('Display Layout', () => {
// Expand the Display Layout so we can remove the sine wave generator // Expand the Display Layout so we can remove the sine wave generator
await page.locator('.c-tree__item.is-navigated-object .c-disclosure-triangle').click(); await page.locator('.c-tree__item.is-navigated-object .c-disclosure-triangle').click();
// Go to the original Sine Wave Generator to navigate away from the Display Layout // Click the original Sine Wave Generator to navigate away from the Display Layout
await page.goto(sineWaveObject.url); await page.locator('.c-tree__item .c-tree__item__name:text("Test Sine Wave Generator")').click();
// Bring up context menu and remove // Bring up context menu and remove
await sineWaveGeneratorTreeItem.first().click({ button: 'right' }); await page.locator('.c-tree__item.is-alias .c-tree__item__name:text("Test Sine Wave Generator")').click({ button: 'right' });
await page.locator('li[role="menuitem"]:has-text("Remove")').click(); await page.locator('text=Remove').click();
await page.locator('button:has-text("OK")').click(); await page.locator('text=OK').click();
// navigate back to the display layout to confirm it has been removed // navigate back to the display layout to confirm it has been removed
await page.goto(displayLayout.url); await page.locator('.c-tree__item .c-tree__item__name:text("Test Display Layout")').click();
expect(await page.locator('.l-layout .l-layout__frame').count()).toEqual(0); expect.soft(await page.locator('.l-layout .l-layout__frame').count()).toEqual(0);
}); });
}); });

View File

@ -23,35 +23,27 @@
const { test, expect } = require('../../../../pluginFixtures'); const { test, expect } = require('../../../../pluginFixtures');
const { createDomainObjectWithDefaults } = require('../../../../appActions'); const { createDomainObjectWithDefaults } = require('../../../../appActions');
test.describe('Flexible Layout', () => { test.describe('Testing Flexible Layout @unstable', () => {
let sineWaveObject;
let clockObject;
test.beforeEach(async ({ page }) => { test.beforeEach(async ({ page }) => {
await page.goto('./', { waitUntil: 'networkidle' }); await page.goto('./', { waitUntil: 'networkidle' });
// Create Sine Wave Generator // Create Sine Wave Generator
sineWaveObject = await createDomainObjectWithDefaults(page, { await createDomainObjectWithDefaults(page, {
type: 'Sine Wave Generator' type: 'Sine Wave Generator',
name: "Test Sine Wave Generator"
}); });
// Create Clock Object // Create Clock Object
clockObject = await createDomainObjectWithDefaults(page, { await createDomainObjectWithDefaults(page, {
type: 'Clock' type: 'Clock',
name: "Test Clock"
}); });
}); });
test('panes have the appropriate draggable attribute while in Edit and Browse modes', async ({ page }) => { test('panes have the appropriate draggable attribute while in Edit and Browse modes', async ({ page }) => {
const treePane = page.getByRole('tree', {
name: 'Main Tree'
});
const sineWaveGeneratorTreeItem = treePane.getByRole('treeitem', {
name: new RegExp(sineWaveObject.name)
});
const clockTreeItem = treePane.getByRole('treeitem', {
name: new RegExp(clockObject.name)
});
// Create a Flexible Layout // Create a Flexible Layout
await createDomainObjectWithDefaults(page, { await createDomainObjectWithDefaults(page, {
type: 'Flexible Layout' type: 'Flexible Layout',
name: "Test Flexible Layout"
}); });
// Edit Flexible Layout // Edit Flexible Layout
await page.locator('[title="Edit"]').click(); await page.locator('[title="Edit"]').click();
@ -59,95 +51,16 @@ test.describe('Flexible Layout', () => {
// Expand the 'My Items' folder in the left tree // Expand the 'My Items' folder in the left tree
await page.locator('.c-tree__item__view-control.c-disclosure-triangle').first().click(); await page.locator('.c-tree__item__view-control.c-disclosure-triangle').first().click();
// Add the Sine Wave Generator and Clock to the Flexible Layout // Add the Sine Wave Generator and Clock to the Flexible Layout
await sineWaveGeneratorTreeItem.dragTo(page.locator('.c-fl__container.is-empty').first()); await page.dragAndDrop('text=Test Sine Wave Generator', '.c-fl__container.is-empty');
await clockTreeItem.dragTo(page.locator('.c-fl__container.is-empty')); await page.dragAndDrop('text=Test Clock', '.c-fl__container.is-empty');
// Check that panes can be dragged while Flexible Layout is in Edit mode // Check that panes can be dragged while Flexible Layout is in Edit mode
let dragWrapper = page.locator('.c-fl-container__frames-holder .c-fl-frame__drag-wrapper').first(); let dragWrapper = await page.locator('.c-fl-container__frames-holder .c-fl-frame__drag-wrapper').first();
await expect(dragWrapper).toHaveAttribute('draggable', 'true'); await expect(dragWrapper).toHaveAttribute('draggable', 'true');
// Save Flexible Layout // Save Flexible Layout
await page.locator('button[title="Save"]').click(); await page.locator('button[title="Save"]').click();
await page.locator('text=Save and Finish Editing').click(); await page.locator('text=Save and Finish Editing').click();
// Check that panes are not draggable while Flexible Layout is in Browse mode // Check that panes are not draggable while Flexible Layout is in Browse mode
dragWrapper = page.locator('.c-fl-container__frames-holder .c-fl-frame__drag-wrapper').first(); dragWrapper = await page.locator('.c-fl-container__frames-holder .c-fl-frame__drag-wrapper').first();
await expect(dragWrapper).toHaveAttribute('draggable', 'false'); await expect(dragWrapper).toHaveAttribute('draggable', 'false');
}); });
test('items in a flexible layout can be removed with object tree context menu when viewing the flexible layout', async ({ page }) => {
const treePane = page.getByRole('tree', {
name: 'Main Tree'
});
const sineWaveGeneratorTreeItem = treePane.getByRole('treeitem', {
name: new RegExp(sineWaveObject.name)
});
// Create a Display Layout
await createDomainObjectWithDefaults(page, {
type: 'Flexible Layout'
});
// Edit Flexible Layout
await page.locator('[title="Edit"]').click();
// Expand the 'My Items' folder in the left tree
await page.locator('.c-tree__item__view-control.c-disclosure-triangle').first().click();
// Add the Sine Wave Generator to the Flexible Layout and save changes
await sineWaveGeneratorTreeItem.dragTo(page.locator('.c-fl__container.is-empty').first());
await page.locator('button[title="Save"]').click();
await page.locator('text=Save and Finish Editing').click();
expect.soft(await page.locator('.c-fl-container__frame').count()).toEqual(1);
// Expand the Flexible Layout so we can remove the sine wave generator
await page.locator('.c-tree__item.is-navigated-object .c-disclosure-triangle').click();
// Bring up context menu and remove
await sineWaveGeneratorTreeItem.first().click({ button: 'right' });
await page.locator('li[role="menuitem"]:has-text("Remove")').click();
await page.locator('button:has-text("OK")').click();
// Verify that the item has been removed from the layout
expect(await page.locator('.c-fl-container__frame').count()).toEqual(0);
});
test('items in a flexible layout can be removed with object tree context menu when viewing another item', async ({ page }) => {
test.info().annotations.push({
type: 'issue',
description: 'https://github.com/nasa/openmct/issues/3117'
});
const treePane = page.getByRole('tree', {
name: 'Main Tree'
});
const sineWaveGeneratorTreeItem = treePane.getByRole('treeitem', {
name: new RegExp(sineWaveObject.name)
});
// Create a Flexible Layout
const flexibleLayout = await createDomainObjectWithDefaults(page, {
type: 'Flexible Layout'
});
// Edit Flexible Layout
await page.locator('[title="Edit"]').click();
// Expand the 'My Items' folder in the left tree
await page.locator('.c-tree__item__view-control.c-disclosure-triangle').click();
// Add the Sine Wave Generator to the Flexible Layout and save changes
await sineWaveGeneratorTreeItem.dragTo(page.locator('.c-fl__container.is-empty').first());
await page.locator('button[title="Save"]').click();
await page.locator('text=Save and Finish Editing').click();
expect.soft(await page.locator('.c-fl-container__frame').count()).toEqual(1);
// Expand the Flexible Layout so we can remove the sine wave generator
await page.locator('.c-tree__item.is-navigated-object .c-disclosure-triangle').click();
// Go to the original Sine Wave Generator to navigate away from the Flexible Layout
await page.goto(sineWaveObject.url);
// Bring up context menu and remove
await sineWaveGeneratorTreeItem.first().click({ button: 'right' });
await page.locator('li[role="menuitem"]:has-text("Remove")').click();
await page.locator('button:has-text("OK")').click();
// navigate back to the display layout to confirm it has been removed
await page.goto(flexibleLayout.url);
// Verify that the item has been removed from the layout
expect(await page.locator('.c-fl-container__frame').count()).toEqual(0);
});
}); });

View File

@ -1,124 +0,0 @@
/*****************************************************************************
* Open MCT, Copyright (c) 2014-2022, 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 testing the Gauge component.
*/
const { test, expect } = require('../../../../pluginFixtures');
const { createDomainObjectWithDefaults } = require('../../../../appActions');
const uuid = require('uuid').v4;
test.describe('Gauge', () => {
test.beforeEach(async ({ page }) => {
// Open a browser, navigate to the main page, and wait until all networkevents to resolve
await page.goto('./', { waitUntil: 'networkidle' });
});
test('Can add and remove telemetry sources @unstable', async ({ page }) => {
// Create the gauge with defaults
const gauge = await createDomainObjectWithDefaults(page, { type: 'Gauge' });
const editButtonLocator = page.locator('button[title="Edit"]');
const saveButtonLocator = page.locator('button[title="Save"]');
// Create a sine wave generator within the gauge
const swg1 = await createDomainObjectWithDefaults(page, {
type: 'Sine Wave Generator',
name: `swg-${uuid()}`,
parent: gauge.uuid
});
// Navigate to the gauge and verify that
// the SWG appears in the elements pool
await page.goto(gauge.url);
await editButtonLocator.click();
await expect.soft(page.locator(`#inspector-elements-tree >> text=${swg1.name}`)).toBeVisible();
await saveButtonLocator.click();
await page.locator('li[title="Save and Finish Editing"]').click();
// Create another sine wave generator within the gauge
const swg2 = await createDomainObjectWithDefaults(page, {
type: 'Sine Wave Generator',
name: `swg-${uuid()}`,
parent: gauge.uuid
});
// Verify that the 'Replace telemetry source' modal appears and accept it
await expect.soft(page.locator('text=This action will replace the current telemetry source. Do you want to continue?')).toBeVisible();
await page.click('text=Ok');
// Navigate to the gauge and verify that the new SWG
// appears in the elements pool and the old one is gone
await page.goto(gauge.url);
await editButtonLocator.click();
await expect.soft(page.locator(`#inspector-elements-tree >> text=${swg1.name}`)).toBeHidden();
await expect.soft(page.locator(`#inspector-elements-tree >> text=${swg2.name}`)).toBeVisible();
await saveButtonLocator.click();
// Right click on the new SWG in the elements pool and delete it
await page.locator(`#inspector-elements-tree >> text=${swg2.name}`).click({
button: 'right'
});
await page.locator('li[title="Remove this object from its containing object."]').click();
// Verify that the 'Remove object' confirmation modal appears and accept it
await expect.soft(page.locator('text=Warning! This action will remove this object. Are you sure you want to continue?')).toBeVisible();
await page.click('text=Ok');
// Verify that the elements pool shows no elements
await expect(page.locator('text="No contained elements"')).toBeVisible();
});
test('Can create a non-default Gauge', async ({ page }) => {
test.info().annotations.push({
type: 'issue',
description: 'https://github.com/nasa/openmct/issues/5356'
});
//Click the Create button
await page.click('button:has-text("Create")');
// Click the object specified by 'type'
await page.click(`li[role='menuitem']:text("Gauge")`);
// FIXME: We need better selectors for these custom form controls
const displayCurrentValueSwitch = page.locator('.c-toggle-switch__slider >> nth=0');
await displayCurrentValueSwitch.setChecked(false);
await page.click('button[aria-label="Save"]');
// TODO: Verify changes in the UI
});
test('Can edit a single Gauge-specific property', async ({ page }) => {
test.info().annotations.push({
type: 'issue',
description: 'https://github.com/nasa/openmct/issues/5985'
});
// Create the gauge with defaults
await createDomainObjectWithDefaults(page, { type: 'Gauge' });
await page.click('button[title="More options"]');
await page.click('li[role="menuitem"]:has-text("Edit Properties")');
// FIXME: We need better selectors for these custom form controls
const displayCurrentValueSwitch = page.locator('.c-toggle-switch__slider >> nth=0');
await displayCurrentValueSwitch.setChecked(false);
await page.click('button[aria-label="Save"]');
// TODO: Verify changes in the UI
});
});

View File

@ -25,13 +25,13 @@ This test suite is dedicated to tests which verify the basic operations surround
but only assume that example imagery is present. but only assume that example imagery is present.
*/ */
/* globals process */ /* globals process */
const { v4: uuid } = require('uuid');
const { waitForAnimations } = require('../../../../baseFixtures'); const { waitForAnimations } = require('../../../../baseFixtures');
const { test, expect } = require('../../../../pluginFixtures'); const { test, expect } = require('../../../../pluginFixtures');
const { createDomainObjectWithDefaults } = require('../../../../appActions'); const { createDomainObjectWithDefaults } = require('../../../../appActions');
const backgroundImageSelector = '.c-imagery__main-image__background-image'; const backgroundImageSelector = '.c-imagery__main-image__background-image';
const panHotkey = process.platform === 'linux' ? ['Control', 'Alt'] : ['Alt']; const panHotkey = process.platform === 'linux' ? ['Control', 'Alt'] : ['Alt'];
const expectedAltText = process.platform === 'linux' ? 'Ctrl+Alt drag to pan' : 'Alt drag to pan'; const expectedAltText = process.platform === 'linux' ? 'Ctrl+Alt drag to pan' : 'Alt drag to pan';
const thumbnailUrlParamsRegexp = /\?w=100&h=100/;
//The following block of tests verifies the basic functionality of example imagery and serves as a template for Imagery objects embedded in other objects. //The following block of tests verifies the basic functionality of example imagery and serves as a template for Imagery objects embedded in other objects.
test.describe('Example Imagery Object', () => { test.describe('Example Imagery Object', () => {
@ -40,10 +40,10 @@ test.describe('Example Imagery Object', () => {
await page.goto('./', { waitUntil: 'networkidle' }); await page.goto('./', { waitUntil: 'networkidle' });
// Create a default 'Example Imagery' object // Create a default 'Example Imagery' object
const exampleImagery = await createDomainObjectWithDefaults(page, { type: 'Example Imagery' }); await createDomainObjectWithDefaults(page, { type: 'Example Imagery' });
// Verify that the created object is focused // Verify that the created object is focused
await expect(page.locator('.l-browse-bar__object-name')).toContainText(exampleImagery.name); await expect(page.locator('.l-browse-bar__object-name')).toContainText('Unnamed Example Imagery');
await page.locator(backgroundImageSelector).hover({trial: true}); await page.locator(backgroundImageSelector).hover({trial: true});
}); });
@ -188,7 +188,7 @@ test.describe('Example Imagery in Display Layout', () => {
await page.click('button:has-text("Create")'); await page.click('button:has-text("Create")');
// Click text=Example Imagery // Click text=Example Imagery
await page.click('li[role="menuitem"]:has-text("Example Imagery")'); await page.click('text=Example Imagery');
// Clear and set Image load delay to minimum value // Clear and set Image load delay to minimum value
await page.locator('input[type="number"]').fill(''); await page.locator('input[type="number"]').fill('');
@ -197,7 +197,7 @@ test.describe('Example Imagery in Display Layout', () => {
// Click text=OK // Click text=OK
await Promise.all([ await Promise.all([
page.waitForNavigation({waitUntil: 'networkidle'}), page.waitForNavigation({waitUntil: 'networkidle'}),
page.click('button:has-text("OK")'), page.click('text=OK'),
//Wait for Save Banner to appear //Wait for Save Banner to appear
page.waitForSelector('.c-message-banner__message') page.waitForSelector('.c-message-banner__message')
]); ]);
@ -207,58 +207,6 @@ test.describe('Example Imagery in Display Layout', () => {
await page.goto(displayLayout.url); await page.goto(displayLayout.url);
}); });
test('View Large action pauses imagery when in realtime and returns to realtime', async ({ page }) => {
test.info().annotations.push({
type: 'issue',
description: 'https://github.com/nasa/openmct/issues/3647'
});
// Click time conductor mode button
await page.locator('.c-mode-button').click();
// set realtime mode
await page.locator('[data-testid="conductor-modeOption-realtime"]').click();
// pause/play button
const pausePlayButton = await page.locator('.c-button.pause-play');
await expect.soft(pausePlayButton).not.toHaveClass(/is-paused/);
// Open context menu and click view large menu item
await page.locator('button[title="View menu items"]').click();
await page.locator('li[title="View Large"]').click();
await expect(pausePlayButton).toHaveClass(/is-paused/);
await page.locator('[aria-label="Close"]').click();
await expect.soft(pausePlayButton).not.toHaveClass(/is-paused/);
});
test('View Large action leaves keeps realtime mode paused', async ({ page }) => {
test.info().annotations.push({
type: 'issue',
description: 'https://github.com/nasa/openmct/issues/3647'
});
// Click time conductor mode button
await page.locator('.c-mode-button').click();
// set realtime mode
await page.locator('[data-testid="conductor-modeOption-realtime"]').click();
// pause/play button
const pausePlayButton = await page.locator('.c-button.pause-play');
await pausePlayButton.click();
await expect.soft(pausePlayButton).toHaveClass(/is-paused/);
// Open context menu and click view large menu item
await page.locator('button[title="View menu items"]').click();
await page.locator('li[title="View Large"]').click();
await expect(pausePlayButton).toHaveClass(/is-paused/);
await page.locator('[aria-label="Close"]').click();
await expect.soft(pausePlayButton).toHaveClass(/is-paused/);
});
test('Imagery View operations @unstable', async ({ page }) => { test('Imagery View operations @unstable', async ({ page }) => {
test.info().annotations.push({ test.info().annotations.push({
type: 'issue', type: 'issue',
@ -327,7 +275,7 @@ test.describe('Example Imagery in Flexible layout', () => {
await page.click('button:has-text("Create")'); await page.click('button:has-text("Create")');
// Click text=Example Imagery // Click text=Example Imagery
await page.click('li[role="menuitem"]:has-text("Example Imagery")'); await page.click('text=Example Imagery');
// Clear and set Image load delay to minimum value // Clear and set Image load delay to minimum value
await page.locator('input[type="number"]').fill(''); await page.locator('input[type="number"]').fill('');
@ -336,7 +284,7 @@ test.describe('Example Imagery in Flexible layout', () => {
// Click text=OK // Click text=OK
await Promise.all([ await Promise.all([
page.waitForNavigation({waitUntil: 'networkidle'}), page.waitForNavigation({waitUntil: 'networkidle'}),
page.click('button:has-text("OK")'), page.click('text=OK'),
//Wait for Save Banner to appear //Wait for Save Banner to appear
page.waitForSelector('.c-message-banner__message') page.waitForSelector('.c-message-banner__message')
]); ]);
@ -369,7 +317,7 @@ test.describe('Example Imagery in Tabs View', () => {
await page.click('button:has-text("Create")'); await page.click('button:has-text("Create")');
// Click text=Example Imagery // Click text=Example Imagery
await page.click('li[role="menuitem"]:has-text("Example Imagery")'); await page.click('text=Example Imagery');
// Clear and set Image load delay to minimum value // Clear and set Image load delay to minimum value
await page.locator('input[type="number"]').fill(''); await page.locator('input[type="number"]').fill('');
@ -378,7 +326,7 @@ test.describe('Example Imagery in Tabs View', () => {
// Click text=OK // Click text=OK
await Promise.all([ await Promise.all([
page.waitForNavigation({waitUntil: 'networkidle'}), page.waitForNavigation({waitUntil: 'networkidle'}),
page.click('button:has-text("OK")'), page.click('text=OK'),
//Wait for Save Banner to appear //Wait for Save Banner to appear
page.waitForSelector('.c-message-banner__message') page.waitForSelector('.c-message-banner__message')
]); ]);
@ -397,11 +345,13 @@ test.describe('Example Imagery in Time Strip', () => {
test.beforeEach(async ({ page }) => { test.beforeEach(async ({ page }) => {
await page.goto('./', { waitUntil: 'networkidle' }); await page.goto('./', { waitUntil: 'networkidle' });
timeStripObject = await createDomainObjectWithDefaults(page, { timeStripObject = await createDomainObjectWithDefaults(page, {
type: 'Time Strip' type: 'Time Strip',
name: 'Time Strip'.concat(' ', uuid())
}); });
await createDomainObjectWithDefaults(page, { await createDomainObjectWithDefaults(page, {
type: 'Example Imagery', type: 'Example Imagery',
name: 'Example Imagery'.concat(' ', uuid()),
parent: timeStripObject.uuid parent: timeStripObject.uuid
}); });
// Navigate to timestrip // Navigate to timestrip
@ -412,28 +362,17 @@ test.describe('Example Imagery in Time Strip', () => {
type: 'issue', type: 'issue',
description: 'https://github.com/nasa/openmct/issues/5632' description: 'https://github.com/nasa/openmct/issues/5632'
}); });
// Hover over the timestrip to reveal a thumbnail image
await page.locator('.c-imagery-tsv-container').hover(); await page.locator('.c-imagery-tsv-container').hover();
// get url of the hovered image
// Get the img src of the hovered image thumbnail const hoveredImg = page.locator('.c-imagery-tsv div.c-imagery-tsv__image-wrapper:hover img');
const hoveredThumbnailImg = page.locator('.c-imagery-tsv div.c-imagery-tsv__image-wrapper:hover img'); const hoveredImgSrc = await hoveredImg.getAttribute('src');
const hoveredThumbnailImgSrc = await hoveredThumbnailImg.getAttribute('src'); expect(hoveredImgSrc).toBeTruthy();
// Verify that imagery timestrip view uses the thumbnailUrl as img src for thumbnails
expect(hoveredThumbnailImgSrc).toBeTruthy();
expect(hoveredThumbnailImgSrc).toMatch(thumbnailUrlParamsRegexp);
// Click on the hovered thumbnail to open "View Large" view
await page.locator('.c-imagery-tsv-container').click(); await page.locator('.c-imagery-tsv-container').click();
// get image of view large container
// Get the img src of the large view image
const viewLargeImg = page.locator('img.c-imagery__main-image__image'); const viewLargeImg = page.locator('img.c-imagery__main-image__image');
const viewLargeImgSrc = await viewLargeImg.getAttribute('src'); const viewLargeImgSrc = await viewLargeImg.getAttribute('src');
expect(viewLargeImgSrc).toBeTruthy(); expect(viewLargeImgSrc).toBeTruthy();
expect(viewLargeImgSrc).toEqual(hoveredImgSrc);
// Verify that the image in the large view is the same as the hovered thumbnail
expect(viewLargeImgSrc).toEqual(hoveredThumbnailImgSrc.split('?')[0]);
}); });
}); });
@ -450,12 +389,6 @@ test.describe('Example Imagery in Time Strip', () => {
* @param {import('@playwright/test').Page} page * @param {import('@playwright/test').Page} page
*/ */
async function performImageryViewOperationsAndAssert(page) { async function performImageryViewOperationsAndAssert(page) {
// Verify that imagery thumbnails use a thumbnail url
const thumbnailImages = page.locator('.c-thumb__image');
const mainImage = page.locator('.c-imagery__main-image__image');
await expect(thumbnailImages.first()).toHaveAttribute('src', thumbnailUrlParamsRegexp);
await expect(mainImage).not.toHaveAttribute('src', thumbnailUrlParamsRegexp);
// Click previous image button // Click previous image button
const previousImageButton = page.locator('.c-nav--prev'); const previousImageButton = page.locator('.c-nav--prev');
await previousImageButton.click(); await previousImageButton.click();

View File

@ -24,7 +24,9 @@
This test suite is dedicated to tests which verify the basic operations surrounding Notebooks. This test suite is dedicated to tests which verify the basic operations surrounding Notebooks.
*/ */
const { test, expect } = require('../../../../pluginFixtures'); // FIXME: Remove this eslint exception once tests are implemented
// eslint-disable-next-line no-unused-vars
const { test, expect } = require('../../../../baseFixtures');
const { expandTreePaneItemByName, createDomainObjectWithDefaults } = require('../../../../appActions'); const { expandTreePaneItemByName, createDomainObjectWithDefaults } = require('../../../../appActions');
const nbUtils = require('../../../../helper/notebookUtils'); const nbUtils = require('../../../../helper/notebookUtils');
@ -263,77 +265,71 @@ test.describe('Notebook entry tests', () => {
}); });
test.fixme('new entries persist through navigation events without save', async ({ page }) => {}); test.fixme('new entries persist through navigation events without save', async ({ page }) => {});
test.fixme('previous and new entries can be deleted', async ({ page }) => {}); test.fixme('previous and new entries can be deleted', async ({ page }) => {});
test.fixme('when a valid link is entered into a notebook entry, it becomes clickable when viewing', async ({ page }) => { });
const TEST_LINK = 'http://www.google.com';
await page.goto('./#/browse/mine', { waitUntil: 'networkidle' });
// Create Notebook test.describe('Snapshot Menu tests', () => {
const notebook = await createDomainObjectWithDefaults(page, { test.fixme('When no default notebook is selected, Snapshot Menu dropdown should only have a single option', async ({ page }) => {
type: 'Notebook', // There should be no default notebook
name: "Entry Link Test" // Clear default notebook if exists using `localStorage.setItem('notebook-storage', null);`
// refresh page
// Click on 'Notebook Snaphot Menu'
// 'save to Notebook Snapshots' should be only option there
}); });
test.fixme('When default notebook is updated selected, Snapshot Menu dropdown should list it as the newest option', async ({ page }) => {
await expandTreePaneItemByName(page, 'My Items'); // Create 2a notebooks
// Set Notebook A as Default
await page.goto(notebook.url); // Open Snapshot Menu and note that Notebook A is listed
// Close Snapshot Menu
await nbUtils.enterTextEntry(page, `This should be a link: ${TEST_LINK} is it?`); // Set Default Notebook to Notebook B
// Open Snapshot Notebook and note that Notebook B is listed
const validLink = page.locator(`a[href="${TEST_LINK}"]`); // Select Default Notebook Option and verify that Snapshot is added to Notebook B
// Start waiting for popup before clicking. Note no await.
const popupPromise = page.waitForEvent('popup');
await validLink.click();
const popup = await popupPromise;
// Wait for the popup to load.
await popup.waitForLoadState();
expect.soft(popup.url()).toContain('www.google.com');
expect(await validLink.count()).toBe(1);
}); });
test.fixme('when an invalid link is entered into a notebook entry, it does not become clickable when viewing', async ({ page }) => { test.fixme('Can add Snapshots via Snapshot Menu and details are correct', async ({ page }) => {
const TEST_LINK = 'www.google.com'; //Note this should be a visual test, too
await page.goto('./#/browse/mine', { waitUntil: 'networkidle' }); // Create Telemetry object
// Create A notebook with many pages and sections.
// Create Notebook // Set page and section defaults to be between first and last of many. i.e. 3 of 5
const notebook = await createDomainObjectWithDefaults(page, { // Navigate to Telemetry object
type: 'Notebook', // Select Default Notebook Option and verify that Snapshot is added to Notebook A
name: "Entry Link Test" // Verify Snapshot Details appear correctly
}); });
test.fixme('Snapshots adjust time conductor', async ({ page }) => {
await expandTreePaneItemByName(page, 'My Items'); // Create Telemetry object
// Set Telemetry object's timeconductor to Fixed time with Start and Endtimes are recorded
await page.goto(notebook.url); // Embed Telemetry object into notebook
// Set Time Conductor to Local clock
await nbUtils.enterTextEntry(page, `This should NOT be a link: ${TEST_LINK} is it?`); // Click into embedded telemetry object and verify object appears with same fixed time from record
});
const invalidLink = page.locator(`a[href="${TEST_LINK}"]`); });
expect(await invalidLink.count()).toBe(0); test.describe('Snapshot Container tests', () => {
}); test.fixme('5 Snapshots can be added to a container', async ({ page }) => {});
test.fixme('when a nefarious link is entered into a notebook entry, it is sanitized when viewing', async ({ page }) => { test.fixme('5 Snapshots can be added to a container and Deleted with Delete All action', async ({ page }) => {});
const TEST_LINK = 'http://www.google.com?bad='; test.fixme('A snapshot can be Deleted from Container', async ({ page }) => {});
const TEST_LINK_BAD = `http://www.google.com?bad=<script>alert('gimme your cookies')</script>`; test.fixme('A snapshot can be Previewed from Container', async ({ page }) => {});
await page.goto('./#/browse/mine', { waitUntil: 'networkidle' }); test.fixme('A snapshot Container can be open and closed', async ({ page }) => {});
test.fixme('Can add object to Snapshot container and pull into notebook and create a new entry', async ({ page }) => {
// Create Notebook //Create Notebook
const notebook = await createDomainObjectWithDefaults(page, { //Create Telemetry Object
type: 'Notebook', //From Telemetry Object, use 'save to Notebook Snapshots'
name: "Entry Link Test" //Snapshots indicator should blink, click on it to view snapshots
}); //Navigate to Notebook
//Drag and Drop onto droppable area for new entry
await expandTreePaneItemByName(page, 'My Items'); //New Entry created with given snapshot added
//Snapshot removed from container?
await page.goto(notebook.url); });
test.fixme('Can add object to Snapshot container and pull into notebook and existing entry', async ({ page }) => {
await nbUtils.enterTextEntry(page, `This should be a link, BUT not a bad link: ${TEST_LINK_BAD} is it?`); //Create Notebook
//Create Telemetry Object
const sanitizedLink = page.locator(`a[href="${TEST_LINK}"]`); //From Telemetry Object, use 'save to Notebook Snapshots'
const unsanitizedLink = page.locator(`a[href="${TEST_LINK_BAD}"]`); //Snapshots indicator should blink, click on it to view snapshots
//Navigate to Notebook
expect.soft(await sanitizedLink.count()).toBe(1); //Drag and Drop into exiting entry
expect(await unsanitizedLink.count()).toBe(0); //Existing Entry updated with given snapshot
//Snapshot removed from container?
});
test.fixme('Verify Embedded options for PNG, JPG, and Annotate work correctly', async ({ page }) => {
//Add snapshot to container
//Verify PNG, JPG, and Annotate buttons work correctly
}); });
}); });

View File

@ -1,134 +0,0 @@
/*****************************************************************************
* Open MCT, Copyright (c) 2014-2022, 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 the basic operations surrounding Notebooks.
*/
const { test, expect } = require('../../../../pluginFixtures');
// const { expandTreePaneItemByName, createDomainObjectWithDefaults } = require('../../../../appActions');
// const nbUtils = require('../../../../helper/notebookUtils');
test.describe('Snapshot Menu tests', () => {
test.fixme('When no default notebook is selected, Snapshot Menu dropdown should only have a single option', async ({ page }) => {
// There should be no default notebook
// Clear default notebook if exists using `localStorage.setItem('notebook-storage', null);`
// refresh page
// Click on 'Notebook Snaphot Menu'
// 'save to Notebook Snapshots' should be only option there
});
test.fixme('When default notebook is updated selected, Snapshot Menu dropdown should list it as the newest option', async ({ page }) => {
// Create 2a notebooks
// Set Notebook A as Default
// Open Snapshot Menu and note that Notebook A is listed
// Close Snapshot Menu
// Set Default Notebook to Notebook B
// Open Snapshot Notebook and note that Notebook B is listed
// Select Default Notebook Option and verify that Snapshot is added to Notebook B
});
test.fixme('Can add Snapshots via Snapshot Menu and details are correct', async ({ page }) => {
//Note this should be a visual test, too
// Create Telemetry object
// Create A notebook with many pages and sections.
// Set page and section defaults to be between first and last of many. i.e. 3 of 5
// Navigate to Telemetry object
// Select Default Notebook Option and verify that Snapshot is added to Notebook A
// Verify Snapshot Details appear correctly
});
test.fixme('Snapshots adjust time conductor', async ({ page }) => {
// Create Telemetry object
// Set Telemetry object's timeconductor to Fixed time with Start and Endtimes are recorded
// Embed Telemetry object into notebook
// Set Time Conductor to Local clock
// Click into embedded telemetry object and verify object appears with same fixed time from record
});
});
test.describe('Snapshot Container tests', () => {
test.beforeEach(async ({ page }) => {
//Navigate to baseURL
await page.goto('./', { waitUntil: 'networkidle' });
// Create Notebook
// const notebook = await createDomainObjectWithDefaults(page, {
// type: 'Notebook',
// name: "Test Notebook"
// });
// // Create Overlay Plot
// const snapShotObject = await createDomainObjectWithDefaults(page, {
// type: 'Overlay Plot',
// name: "Dropped Overlay Plot"
// });
await page.getByRole('button', { name: ' Snapshot ' }).click();
await page.getByRole('menuitem', { name: ' Save to Notebook Snapshots' }).click();
await page.getByRole('button', { name: 'Show' }).click();
});
test.fixme('5 Snapshots can be added to a container', async ({ page }) => {});
test.fixme('5 Snapshots can be added to a container and Deleted with Delete All action', async ({ page }) => {});
test.fixme('A snapshot can be Deleted from Container with 3 dot action menu', async ({ page }) => {});
test.fixme('A snapshot can be Viewed, Annotated, display deleted, and saved from Container with 3 dot action menu', async ({ page }) => {
await page.locator('.c-snapshot.c-ne__embed').first().getByTitle('More options').click();
await page.getByRole('menuitem', { name: ' View Snapshot' }).click();
await expect(page.locator('.c-overlay__outer')).toBeVisible();
await page.getByTitle('Annotate').click();
await expect(page.locator('#snap-annotation-canvas')).toBeVisible();
await page.getByRole('button', { name: '' }).click();
// await expect(page.locator('#snap-annotation-canvas')).not.toBeVisible();
await page.getByRole('button', { name: 'Save' }).click();
await page.getByRole('button', { name: 'Done' }).click();
//await expect(await page.locator)
});
test('A snapshot can be Quick Viewed from Container with 3 dot action menu', async ({ page }) => {
await page.locator('.c-snapshot.c-ne__embed').first().getByTitle('More options').click();
await page.getByRole('menuitem', { name: 'Quick View' }).click();
await expect(page.locator('.c-overlay__outer')).toBeVisible();
});
test.fixme('A snapshot can be Navigated To from Container with 3 dot action menu', async ({ page }) => {});
test.fixme('A snapshot can be Navigated To Item in Time from Container with 3 dot action menu', async ({ page }) => {});
test.fixme('A snapshot Container can be open and closed', async ({ page }) => {});
test.fixme('Can add object to Snapshot container and pull into notebook and create a new entry', async ({ page }) => {
//Create Notebook
//Create Telemetry Object
//From Telemetry Object, use 'save to Notebook Snapshots'
//Snapshots indicator should blink, click on it to view snapshots
//Navigate to Notebook
//Drag and Drop onto droppable area for new entry
//New Entry created with given snapshot added
//Snapshot removed from container?
});
test.fixme('Can add object to Snapshot container and pull into notebook and existing entry', async ({ page }) => {
//Create Notebook
//Create Telemetry Object
//From Telemetry Object, use 'save to Notebook Snapshots'
//Snapshots indicator should blink, click on it to view snapshots
//Navigate to Notebook
//Drag and Drop into exiting entry
//Existing Entry updated with given snapshot
//Snapshot removed from container?
});
test.fixme('Verify Embedded options for PNG, JPG, and Annotate work correctly', async ({ page }) => {
//Add snapshot to container
//Verify PNG, JPG, and Annotate buttons work correctly
});
});

View File

@ -24,7 +24,7 @@
This test suite is dedicated to tests which verify the basic operations surrounding Notebooks with CouchDB. This test suite is dedicated to tests which verify the basic operations surrounding Notebooks with CouchDB.
*/ */
const { test, expect } = require('../../../../pluginFixtures'); const { test, expect } = require('../../../../baseFixtures');
const { createDomainObjectWithDefaults } = require('../../../../appActions'); const { createDomainObjectWithDefaults } = require('../../../../appActions');
test.describe('Notebook Tests with CouchDB @couchdb', () => { test.describe('Notebook Tests with CouchDB @couchdb', () => {
@ -76,7 +76,6 @@ test.describe('Notebook Tests with CouchDB @couchdb', () => {
await page.locator('text=To start a new entry, click here or drag and drop any object').click(); await page.locator('text=To start a new entry, click here or drag and drop any object').click();
await page.locator('[aria-label="Notebook Entry Input"]').click(); await page.locator('[aria-label="Notebook Entry Input"]').click();
await page.locator('[aria-label="Notebook Entry Input"]').fill(`First Entry`); await page.locator('[aria-label="Notebook Entry Input"]').fill(`First Entry`);
await page.locator('[aria-label="Notebook Entry Input"]').press('Enter');
await page.waitForLoadState('networkidle'); await page.waitForLoadState('networkidle');
expect(addingNotebookElementsRequests.length).toBeLessThanOrEqual(2); expect(addingNotebookElementsRequests.length).toBeLessThanOrEqual(2);
@ -149,17 +148,14 @@ test.describe('Notebook Tests with CouchDB @couchdb', () => {
await page.locator('text=To start a new entry, click here or drag and drop any object').click(); await page.locator('text=To start a new entry, click here or drag and drop any object').click();
await page.locator('[aria-label="Notebook Entry Input"]').click(); await page.locator('[aria-label="Notebook Entry Input"]').click();
await page.locator('[aria-label="Notebook Entry Input"]').fill(`First Entry`); await page.locator('[aria-label="Notebook Entry Input"]').fill(`First Entry`);
await page.locator('[aria-label="Notebook Entry Input"]').press('Enter');
await page.locator('text=To start a new entry, click here or drag and drop any object').click(); await page.locator('text=To start a new entry, click here or drag and drop any object').click();
await page.locator('[aria-label="Notebook Entry Input"] >> nth=1').click(); await page.locator('[aria-label="Notebook Entry Input"] >> nth=1').click();
await page.locator('[aria-label="Notebook Entry Input"] >> nth=1').fill(`Second Entry`); await page.locator('[aria-label="Notebook Entry Input"] >> nth=1').fill(`Second Entry`);
await page.locator('[aria-label="Notebook Entry Input"] >> nth=1').press('Enter');
await page.locator('text=To start a new entry, click here or drag and drop any object').click(); await page.locator('text=To start a new entry, click here or drag and drop any object').click();
await page.locator('[aria-label="Notebook Entry Input"] >> nth=2').click(); await page.locator('[aria-label="Notebook Entry Input"] >> nth=2').click();
await page.locator('[aria-label="Notebook Entry Input"] >> nth=2').fill(`Third Entry`); await page.locator('[aria-label="Notebook Entry Input"] >> nth=2').fill(`Third Entry`);
await page.locator('[aria-label="Notebook Entry Input"] >> nth=2').press('Enter');
// Add three tags // Add three tags
await page.hover(`button:has-text("Add Tag") >> nth=2`); await page.hover(`button:has-text("Add Tag") >> nth=2`);

View File

@ -36,27 +36,27 @@ test.describe('Restricted Notebook', () => {
}); });
test('Can be renamed @addInit', async ({ page }) => { test('Can be renamed @addInit', async ({ page }) => {
await expect(page.locator('.l-browse-bar__object-name')).toContainText(`${notebook.name}`); await expect(page.locator('.l-browse-bar__object-name')).toContainText(`Unnamed ${CUSTOM_NAME}`);
}); });
test('Can be deleted if there are no locked pages @addInit', async ({ page }) => { test('Can be deleted if there are no locked pages @addInit', async ({ page, openmctConfig }) => {
await openObjectTreeContextMenu(page, notebook.url); await openObjectTreeContextMenu(page, notebook.url);
const menuOptions = page.locator('.c-menu ul'); const menuOptions = page.locator('.c-menu ul');
await expect.soft(menuOptions).toContainText('Remove'); await expect.soft(menuOptions).toContainText('Remove');
const restrictedNotebookTreeObject = page.locator(`a:has-text("${notebook.name}")`); const restrictedNotebookTreeObject = page.locator(`a:has-text("Unnamed ${CUSTOM_NAME}")`);
// notebook tree object exists // notebook tree object exists
expect.soft(await restrictedNotebookTreeObject.count()).toEqual(1); expect.soft(await restrictedNotebookTreeObject.count()).toEqual(1);
// Click Remove Text // Click Remove Text
await page.locator('li[role="menuitem"]:has-text("Remove")').click(); await page.locator('text=Remove').click();
// Click 'OK' on confirmation window and wait for save banner to appear // Click 'OK' on confirmation window and wait for save banner to appear
await Promise.all([ await Promise.all([
page.waitForNavigation(), page.waitForNavigation(),
page.locator('button:has-text("OK")').click(), page.locator('text=OK').click(),
page.waitForSelector('.c-message-banner__message') page.waitForSelector('.c-message-banner__message')
]); ]);
@ -134,7 +134,7 @@ test.describe('Restricted Notebook with at least one entry and with the page loc
// Click text=Ok // Click text=Ok
await Promise.all([ await Promise.all([
page.waitForNavigation(), page.waitForNavigation(),
page.locator('button:has-text("OK")').click() page.locator('text=Ok').click()
]); ]);
// deleted page, should no longer exist // deleted page, should no longer exist
@ -145,14 +145,15 @@ test.describe('Restricted Notebook with at least one entry and with the page loc
test.describe('Restricted Notebook with a page locked and with an embed @addInit', () => { test.describe('Restricted Notebook with a page locked and with an embed @addInit', () => {
test.beforeEach(async ({ page }) => { test.beforeEach(async ({ page, openmctConfig }) => {
const notebook = await startAndAddRestrictedNotebookObject(page); const { myItemsFolderName } = openmctConfig;
await nbUtils.dragAndDropEmbed(page, notebook); await startAndAddRestrictedNotebookObject(page);
await nbUtils.dragAndDropEmbed(page, myItemsFolderName);
}); });
test('Allows embeds to be deleted if page unlocked @addInit', async ({ page }) => { test('Allows embeds to be deleted if page unlocked @addInit', async ({ page }) => {
// Click .c-ne__embed__name .c-popup-menu-button // Click .c-ne__embed__name .c-popup-menu-button
await page.locator('.c-ne__embed__name .c-icon-button').click(); // embed popup menu await page.locator('.c-ne__embed__name .c-popup-menu-button').click(); // embed popup menu
const embedMenu = page.locator('body >> .c-menu'); const embedMenu = page.locator('body >> .c-menu');
await expect(embedMenu).toContainText('Remove This Embed'); await expect(embedMenu).toContainText('Remove This Embed');
@ -161,7 +162,7 @@ test.describe('Restricted Notebook with a page locked and with an embed @addInit
test('Disallows embeds to be deleted if page locked @addInit', async ({ page }) => { test('Disallows embeds to be deleted if page locked @addInit', async ({ page }) => {
await lockPage(page); await lockPage(page);
// Click .c-ne__embed__name .c-popup-menu-button // Click .c-ne__embed__name .c-popup-menu-button
await page.locator('.c-ne__embed__name .c-icon-button').click(); // embed popup menu await page.locator('.c-ne__embed__name .c-popup-menu-button').click(); // embed popup menu
const embedMenu = page.locator('body >> .c-menu'); const embedMenu = page.locator('body >> .c-menu');
await expect(embedMenu).not.toContainText('Remove This Embed'); await expect(embedMenu).not.toContainText('Remove This Embed');

View File

@ -36,7 +36,7 @@ async function createNotebookAndEntry(page, iterations = 1) {
//Go to baseURL //Go to baseURL
await page.goto('./', { waitUntil: 'networkidle' }); await page.goto('./', { waitUntil: 'networkidle' });
const notebook = createDomainObjectWithDefaults(page, { type: 'Notebook' }); createDomainObjectWithDefaults(page, { type: 'Notebook' });
for (let iteration = 0; iteration < iterations; iteration++) { for (let iteration = 0; iteration < iterations; iteration++) {
// Create an entry // Create an entry
@ -44,10 +44,7 @@ async function createNotebookAndEntry(page, iterations = 1) {
const entryLocator = `[aria-label="Notebook Entry Input"] >> nth = ${iteration}`; const entryLocator = `[aria-label="Notebook Entry Input"] >> nth = ${iteration}`;
await page.locator(entryLocator).click(); await page.locator(entryLocator).click();
await page.locator(entryLocator).fill(`Entry ${iteration}`); await page.locator(entryLocator).fill(`Entry ${iteration}`);
await page.locator(entryLocator).press('Enter');
} }
return notebook;
} }
/** /**
@ -56,15 +53,13 @@ async function createNotebookAndEntry(page, iterations = 1) {
* @param {number} [iterations = 1] - the number of entries (and tags) to create * @param {number} [iterations = 1] - the number of entries (and tags) to create
*/ */
async function createNotebookEntryAndTags(page, iterations = 1) { async function createNotebookEntryAndTags(page, iterations = 1) {
const notebook = await createNotebookAndEntry(page, iterations); await createNotebookAndEntry(page, iterations);
await page.locator('text=Annotations').click();
for (let iteration = 0; iteration < iterations; iteration++) { for (let iteration = 0; iteration < iterations; iteration++) {
// Hover and click "Add Tag" button // Hover and click "Add Tag" button
// Hover is needed here to "slow down" the actions while running in headless mode // Hover is needed here to "slow down" the actions while running in headless mode
await page.locator(`[aria-label="Notebook Entry"] >> nth = ${iteration}`).click(); await page.hover(`button:has-text("Add Tag") >> nth = ${iteration}`);
await page.hover(`button:has-text("Add Tag")`); await page.locator(`button:has-text("Add Tag") >> nth = ${iteration}`).click();
await page.locator(`button:has-text("Add Tag")`).click();
// Click inside the tag search input // Click inside the tag search input
await page.locator('[placeholder="Type to select tag"]').click(); await page.locator('[placeholder="Type to select tag"]').click();
@ -73,23 +68,19 @@ async function createNotebookEntryAndTags(page, iterations = 1) {
// Hover and click "Add Tag" button // Hover and click "Add Tag" button
// Hover is needed here to "slow down" the actions while running in headless mode // Hover is needed here to "slow down" the actions while running in headless mode
await page.hover(`button:has-text("Add Tag")`); await page.hover(`button:has-text("Add Tag") >> nth = ${iteration}`);
await page.locator(`button:has-text("Add Tag")`).click(); await page.locator(`button:has-text("Add Tag") >> nth = ${iteration}`).click();
// Click inside the tag search input // Click inside the tag search input
await page.locator('[placeholder="Type to select tag"]').click(); await page.locator('[placeholder="Type to select tag"]').click();
// Select the "Science" tag // Select the "Science" tag
await page.locator('[aria-label="Autocomplete Options"] >> text=Science').click(); await page.locator('[aria-label="Autocomplete Options"] >> text=Science').click();
} }
return notebook;
} }
test.describe('Tagging in Notebooks @addInit', () => { test.describe('Tagging in Notebooks @addInit', () => {
test('Can load tags', async ({ page }) => { test('Can load tags', async ({ page }) => {
await createNotebookAndEntry(page); await createNotebookAndEntry(page);
await page.locator('text=Annotations').click();
await page.locator('button:has-text("Add Tag")').click(); await page.locator('button:has-text("Add Tag")').click();
await page.locator('[placeholder="Type to select tag"]').click(); await page.locator('[placeholder="Type to select tag"]').click();
@ -130,12 +121,13 @@ test.describe('Tagging in Notebooks @addInit', () => {
test('Can delete tags', async ({ page }) => { test('Can delete tags', async ({ page }) => {
await createNotebookEntryAndTags(page); await createNotebookEntryAndTags(page);
await page.locator('[aria-label="Notebook Entries"]').click();
// Delete Driving // Delete Driving
await page.hover('[aria-label="Tag"]:has-text("Driving")'); await page.hover('[aria-label="Tag"]:has-text("Driving")');
await page.locator('[aria-label="Tag"]:has-text("Driving") ~ .c-completed-tag-deletion').click(); await page.locator('[aria-label="Tag"]:has-text("Driving") ~ .c-completed-tag-deletion').click();
await expect(page.locator('[aria-label="Tags Inspector"]')).toContainText("Science"); await expect(page.locator('[aria-label="Notebook Entry"]')).toContainText("Science");
await expect(page.locator('[aria-label="Tags Inspector"]')).not.toContainText("Driving"); await expect(page.locator('[aria-label="Notebook Entry"]')).not.toContainText("Driving");
await page.locator('[aria-label="OpenMCT Search"] input[type="search"]').fill('sc'); await page.locator('[aria-label="OpenMCT Search"] input[type="search"]').fill('sc');
await expect(page.locator('[aria-label="Search Result"]')).not.toContainText("Driving"); await expect(page.locator('[aria-label="Search Result"]')).not.toContainText("Driving");
@ -181,10 +173,10 @@ test.describe('Tagging in Notebooks @addInit', () => {
//Go to baseURL //Go to baseURL
await page.goto('./', { waitUntil: 'networkidle' }); await page.goto('./', { waitUntil: 'networkidle' });
const clock = await createDomainObjectWithDefaults(page, { type: 'Clock' }); await createDomainObjectWithDefaults(page, { type: 'Clock' });
const ITERATIONS = 4; const ITERATIONS = 4;
const notebook = await createNotebookEntryAndTags(page, ITERATIONS); await createNotebookEntryAndTags(page, ITERATIONS);
for (let iteration = 0; iteration < ITERATIONS; iteration++) { for (let iteration = 0; iteration < ITERATIONS; iteration++) {
const entryLocator = `[aria-label="Notebook Entry"] >> nth = ${iteration}`; const entryLocator = `[aria-label="Notebook Entry"] >> nth = ${iteration}`;
@ -197,18 +189,11 @@ test.describe('Tagging in Notebooks @addInit', () => {
page.goto('./#/browse/mine?hideTree=false'), page.goto('./#/browse/mine?hideTree=false'),
page.click('.c-disclosure-triangle') page.click('.c-disclosure-triangle')
]); ]);
// Click Unnamed Clock
await page.click('text="Unnamed Clock"');
const treePane = page.getByRole('tree', { // Click Unnamed Notebook
name: 'Main Tree' await page.click('text="Unnamed Notebook"');
});
// Click Clock
await treePane.getByRole('treeitem', {
name: clock.name
}).click();
// Click Notebook
await page.getByRole('treeitem', {
name: notebook.name
}).click();
for (let iteration = 0; iteration < ITERATIONS; iteration++) { for (let iteration = 0; iteration < ITERATIONS; iteration++) {
const entryLocator = `[aria-label="Notebook Entry"] >> nth = ${iteration}`; const entryLocator = `[aria-label="Notebook Entry"] >> nth = ${iteration}`;
@ -222,13 +207,14 @@ test.describe('Tagging in Notebooks @addInit', () => {
page.waitForLoadState('networkidle') page.waitForLoadState('networkidle')
]); ]);
// Click Notebook // Click Unnamed Notebook
await page.click(`text="${notebook.name}"`); await page.click('text="Unnamed Notebook"');
for (let iteration = 0; iteration < ITERATIONS; iteration++) { for (let iteration = 0; iteration < ITERATIONS; iteration++) {
const entryLocator = `[aria-label="Notebook Entry"] >> nth = ${iteration}`; const entryLocator = `[aria-label="Notebook Entry"] >> nth = ${iteration}`;
await expect(page.locator(entryLocator)).toContainText("Science"); await expect(page.locator(entryLocator)).toContainText("Science");
await expect(page.locator(entryLocator)).toContainText("Driving"); await expect(page.locator(entryLocator)).toContainText("Driving");
} }
}); });
}); });

View File

@ -1,156 +0,0 @@
/*****************************************************************************
* 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 testing the operator status plugin.
*/
const path = require('path');
const { test, expect } = require('../../../../pluginFixtures');
/*
Precondition: Inject Example User, Operator Status Plugins
Verify that user 1 sees updates from user/role 2 (Not possible without openmct-yamcs implementation)
Clear Role Status of single user test
STUB (test.fixme) Rolling through each
*/
test.describe('Operator Status', () => {
test.beforeEach(async ({ page }) => {
// FIXME: determine if plugins will be added to index.html or need to be injected
// eslint-disable-next-line no-undef
await page.addInitScript({ path: path.join(__dirname, '../../../../helper/', 'addInitExampleUser.js')});
// eslint-disable-next-line no-undef
await page.addInitScript({ path: path.join(__dirname, '../../../../helper/', 'addInitOperatorStatus.js')});
await page.goto('./', { waitUntil: 'networkidle' });
});
// verify that operator status is visible
test('operator status is visible and expands when clicked', async ({ page }) => {
await expect(page.locator('div[title="Set my operator status"]')).toBeVisible();
await page.locator('div[title="Set my operator status"]').click();
// expect default status to be 'GO'
await expect(page.locator('.c-status-poll-panel')).toBeVisible();
});
test('poll question indicator remains when blank poll set', async ({ page }) => {
await expect(page.locator('div[title="Set the current poll question"]')).toBeVisible();
await page.locator('div[title="Set the current poll question"]').click();
// set to blank
await page.getByRole('button', { name: 'Update' }).click();
// should still be visible
await expect(page.locator('div[title="Set the current poll question"]')).toBeVisible();
});
// Verify that user 1 sees updates from user/role 2 (Not possible without openmct-yamcs implementation)
test('operator status table reflects answered values', async ({ page }) => {
// user navigates to operator status poll
const statusPollIndicator = page.locator('div[title="Set my operator status"]');
await statusPollIndicator.click();
// get user role value
const userRole = page.locator('.c-status-poll-panel__user-role');
const userRoleText = await userRole.innerText();
// get selected status value
const selectStatus = page.locator('select[name="setStatus"]');
await selectStatus.selectOption({ index: 1});
const initialStatusValue = await selectStatus.inputValue();
// open manage status poll
const manageStatusPollIndicator = page.locator('div[title="Set the current poll question"]');
await manageStatusPollIndicator.click();
// parse the table row values
const row = page.locator(`tr:has-text("${userRoleText}")`);
const rowValues = await row.innerText();
const rowValuesArr = rowValues.split('\t');
const COLUMN_STATUS_INDEX = 1;
// check initial set value matches status table
expect(rowValuesArr[COLUMN_STATUS_INDEX].toLowerCase())
.toEqual(initialStatusValue.toLowerCase());
// change user status
await statusPollIndicator.click();
// FIXME: might want to grab a dynamic option instead of arbitrary
await page.locator('select[name="setStatus"]').selectOption({ index: 2});
const updatedStatusValue = await selectStatus.inputValue();
// verify user status is reflected in table
await manageStatusPollIndicator.click();
const updatedRow = page.locator(`tr:has-text("${userRoleText}")`);
const updatedRowValues = await updatedRow.innerText();
const updatedRowValuesArr = updatedRowValues.split('\t');
expect(updatedRowValuesArr[COLUMN_STATUS_INDEX].toLowerCase())
.toEqual(updatedStatusValue.toLowerCase());
});
test('clear poll button removes poll responses', async ({ page }) => {
// user navigates to operator status poll
const statusPollIndicator = page.locator('div[title="Set my operator status"]');
await statusPollIndicator.click();
// get user role value
const userRole = page.locator('.c-status-poll-panel__user-role');
const userRoleText = await userRole.innerText();
// get selected status value
const selectStatus = page.locator('select[name="setStatus"]');
// FIXME: might want to grab a dynamic option instead of arbitrary
await selectStatus.selectOption({ index: 1});
const initialStatusValue = await selectStatus.inputValue();
// open manage status poll
const manageStatusPollIndicator = page.locator('div[title="Set the current poll question"]');
await manageStatusPollIndicator.click();
// parse the table row values
const row = page.locator(`tr:has-text("${userRoleText}")`);
const rowValues = await row.innerText();
const rowValuesArr = rowValues.split('\t');
const COLUMN_STATUS_INDEX = 1;
// check initial set value matches status table
expect(rowValuesArr[COLUMN_STATUS_INDEX].toLowerCase())
.toEqual(initialStatusValue.toLowerCase());
// clear the poll
await page.locator('button[title="Clear the previous poll question"]').click();
const updatedRow = page.locator(`tr:has-text("${userRoleText}")`);
const updatedRowValues = await updatedRow.innerText();
const updatedRowValuesArr = updatedRowValues.split('\t');
const UNSET_VALUE_LABEL = 'Not set';
expect(updatedRowValuesArr[COLUMN_STATUS_INDEX])
.toEqual(UNSET_VALUE_LABEL);
});
test.fixme('iterate through all possible response values', async ({ page }) => {
// test all possible respone values for the poll
});
});

View File

@ -32,7 +32,7 @@ test.use({
} }
}); });
test.fixme('ExportAsJSON', () => { test.describe('ExportAsJSON', () => {
test('User can set autoscale with a valid range @snapshot', async ({ page, openmctConfig }) => { test('User can set autoscale with a valid range @snapshot', async ({ page, openmctConfig }) => {
const { myItemsFolderName } = openmctConfig; const { myItemsFolderName } = openmctConfig;
@ -110,10 +110,10 @@ async function createSinewaveOverlayPlot(page, myItemsFolderName) {
await page.locator('button:has-text("Create")').click(); await page.locator('button:has-text("Create")').click();
// add overlay plot with defaults // add overlay plot with defaults
await page.locator('li[role="menuitem"]:has-text("Overlay Plot")').click(); await page.locator('li:has-text("Overlay Plot")').click();
await Promise.all([ await Promise.all([
page.waitForNavigation(), page.waitForNavigation(),
page.locator('button:has-text("OK")').click(), page.locator('text=OK').click(),
//Wait for Save Banner to appear1 //Wait for Save Banner to appear1
page.waitForSelector('.c-message-banner__message') page.waitForSelector('.c-message-banner__message')
]); ]);
@ -129,10 +129,10 @@ async function createSinewaveOverlayPlot(page, myItemsFolderName) {
await page.locator('button:has-text("Create")').click(); await page.locator('button:has-text("Create")').click();
// add sine wave generator with defaults // add sine wave generator with defaults
await page.locator('li[role="menuitem"]:has-text("Sine Wave Generator")').click(); await page.locator('li:has-text("Sine Wave Generator")').click();
await Promise.all([ await Promise.all([
page.waitForNavigation(), page.waitForNavigation(),
page.locator('button:has-text("OK")').click(), page.locator('text=OK').click(),
//Wait for Save Banner to appear1 //Wait for Save Banner to appear1
page.waitForSelector('.c-message-banner__message') page.waitForSelector('.c-message-banner__message')
]); ]);
@ -156,7 +156,7 @@ async function turnOffAutoscale(page) {
await page.locator('text=Unnamed Overlay Plot Snapshot >> button').nth(3).click(); await page.locator('text=Unnamed Overlay Plot Snapshot >> button').nth(3).click();
// uncheck autoscale // uncheck autoscale
await page.getByRole('listitem').filter({ hasText: 'Auto scale' }).getByRole('checkbox').uncheck(); await page.locator('text=Y Axis Label Log mode Auto scale Padding >> input[type="checkbox"] >> nth=1').uncheck();
// save // save
await page.locator('text=Snapshot Save and Finish Editing Save and Continue Editing >> button').nth(1).click(); await page.locator('text=Snapshot Save and Finish Editing Save and Continue Editing >> button').nth(1).click();

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 18 KiB

View File

@ -88,10 +88,10 @@ async function makeOverlayPlot(page, myItemsFolderName) {
// create overlay plot // create overlay plot
await page.locator('button.c-create-button').click(); await page.locator('button.c-create-button').click();
await page.locator('li[role="menuitem"]:has-text("Overlay Plot")').click(); await page.locator('li:has-text("Overlay Plot")').click();
await Promise.all([ await Promise.all([
page.waitForNavigation({ waitUntil: 'networkidle'}), page.waitForNavigation({ waitUntil: 'networkidle'}),
page.locator('button:has-text("OK")').click(), page.locator('text=OK').click(),
//Wait for Save Banner to appear //Wait for Save Banner to appear
page.waitForSelector('.c-message-banner__message') page.waitForSelector('.c-message-banner__message')
]); ]);
@ -106,7 +106,7 @@ async function makeOverlayPlot(page, myItemsFolderName) {
// create a sinewave generator // create a sinewave generator
await page.locator('button.c-create-button').click(); await page.locator('button.c-create-button').click();
await page.locator('li[role="menuitem"]:has-text("Sine Wave Generator")').click(); await page.locator('li:has-text("Sine Wave Generator")').click();
// set amplitude to 6, offset 4, period 2 // set amplitude to 6, offset 4, period 2
@ -123,7 +123,7 @@ async function makeOverlayPlot(page, myItemsFolderName) {
await Promise.all([ await Promise.all([
page.waitForNavigation({ waitUntil: 'networkidle'}), page.waitForNavigation({ waitUntil: 'networkidle'}),
page.locator('button:has-text("OK")').click(), page.locator('text=OK').click(),
//Wait for Save Banner to appear //Wait for Save Banner to appear
page.waitForSelector('.c-message-banner__message') page.waitForSelector('.c-message-banner__message')
]); ]);
@ -205,8 +205,7 @@ async function enableEditMode(page) {
*/ */
async function enableLogMode(page) { async function enableLogMode(page) {
// turn on log mode // turn on log mode
await page.getByRole('listitem').filter({ hasText: 'Log mode' }).getByRole('checkbox').check(); await page.locator('text=Y Axis Label Log mode Auto scale Padding >> input[type="checkbox"]').first().check();
// await page.locator('text=Y Axis Label Log mode Auto scale Padding >> input[type="checkbox"]').first().check();
} }
/** /**
@ -214,7 +213,7 @@ async function enableLogMode(page) {
*/ */
async function disableLogMode(page) { async function disableLogMode(page) {
// turn off log mode // turn off log mode
await page.getByRole('listitem').filter({ hasText: 'Log mode' }).getByRole('checkbox').uncheck(); await page.locator('text=Y Axis Label Log mode Auto scale Padding >> input[type="checkbox"]').first().uncheck();
} }
/** /**

View File

@ -88,11 +88,11 @@ async function makeStackedPlot(page, myItemsFolderName) {
// create stacked plot // create stacked plot
await page.locator('button.c-create-button').click(); await page.locator('button.c-create-button').click();
await page.locator('li[role="menuitem"]:has-text("Stacked Plot")').click(); await page.locator('li:has-text("Stacked Plot")').click();
await Promise.all([ await Promise.all([
page.waitForNavigation({ waitUntil: 'networkidle'}), page.waitForNavigation({ waitUntil: 'networkidle'}),
page.locator('button:has-text("OK")').click(), page.locator('text=OK').click(),
//Wait for Save Banner to appear //Wait for Save Banner to appear
page.waitForSelector('.c-message-banner__message') page.waitForSelector('.c-message-banner__message')
]); ]);
@ -146,11 +146,11 @@ async function saveStackedPlot(page) {
async function createSineWaveGenerator(page) { async function createSineWaveGenerator(page) {
//Create sine wave generator //Create sine wave generator
await page.locator('button.c-create-button').click(); await page.locator('button.c-create-button').click();
await page.locator('li[role="menuitem"]:has-text("Sine Wave Generator")').click(); await page.locator('li:has-text("Sine Wave Generator")').click();
await Promise.all([ await Promise.all([
page.waitForNavigation({ waitUntil: 'networkidle'}), page.waitForNavigation({ waitUntil: 'networkidle'}),
page.locator('button:has-text("OK")').click(), page.locator('text=OK').click(),
//Wait for Save Banner to appear //Wait for Save Banner to appear
page.waitForSelector('.c-message-banner__message') page.waitForSelector('.c-message-banner__message')
]); ]);

View File

@ -1,124 +0,0 @@
/*****************************************************************************
* Open MCT, Copyright (c) 2014-2022, 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.
*****************************************************************************/
/*
Tests to verify log plot functionality. Note this test suite if very much under active development and should not
necessarily be used for reference when writing new tests in this area.
*/
const { test, expect } = require('../../../../pluginFixtures');
const { createDomainObjectWithDefaults } = require('../../../../appActions');
test.describe('Overlay Plot', () => {
test('Plot legend color is in sync with plot series color', async ({ page }) => {
await page.goto('/', { waitUntil: 'networkidle' });
const overlayPlot = await createDomainObjectWithDefaults(page, {
type: "Overlay Plot"
});
await createDomainObjectWithDefaults(page, {
type: "Sine Wave Generator",
parent: overlayPlot.uuid
});
await page.goto(overlayPlot.url);
// navigate to plot series color palette
await page.click('.l-browse-bar__actions__edit');
await page.locator('li.c-tree__item.menus-to-left .c-disclosure-triangle').click();
await page.locator('.c-click-swatch--menu').click();
await page.locator('.c-palette__item[style="background: rgb(255, 166, 61);"]').click();
// gets color for swatch located in legend
const element = await page.waitForSelector('.plot-series-color-swatch');
const color = await element.evaluate((el) => {
return window.getComputedStyle(el).getPropertyValue('background-color');
});
expect(color).toBe('rgb(255, 166, 61)');
});
test('The elements pool supports dragging series into multiple y-axis buckets', async ({ page }) => {
await page.goto('/', { waitUntil: 'networkidle' });
const overlayPlot = await createDomainObjectWithDefaults(page, {
type: "Overlay Plot"
});
await createDomainObjectWithDefaults(page, {
type: "Sine Wave Generator",
name: 'swg a',
parent: overlayPlot.uuid
});
await createDomainObjectWithDefaults(page, {
type: "Sine Wave Generator",
name: 'swg b',
parent: overlayPlot.uuid
});
await createDomainObjectWithDefaults(page, {
type: "Sine Wave Generator",
name: 'swg c',
parent: overlayPlot.uuid
});
await createDomainObjectWithDefaults(page, {
type: "Sine Wave Generator",
name: 'swg d',
parent: overlayPlot.uuid
});
await createDomainObjectWithDefaults(page, {
type: "Sine Wave Generator",
name: 'swg e',
parent: overlayPlot.uuid
});
await page.goto(overlayPlot.url);
await page.click('button[title="Edit"]');
// Expand the elements pool vertically
await page.locator('.l-pane__handle').nth(2).hover({ trial: true });
await page.mouse.down();
await page.mouse.move(0, 100);
await page.mouse.up();
// Drag swg a, c, e into Y Axis 2
await page.locator('#inspector-elements-tree >> text=swg a').dragTo(page.locator('[aria-label="Element Item Group Y Axis 2"]'));
await page.locator('#inspector-elements-tree >> text=swg c').dragTo(page.locator('[aria-label="Element Item Group Y Axis 2"]'));
await page.locator('#inspector-elements-tree >> text=swg e').dragTo(page.locator('[aria-label="Element Item Group Y Axis 2"]'));
// Drag swg b into Y Axis 3
await page.locator('#inspector-elements-tree >> text=swg b').dragTo(page.locator('[aria-label="Element Item Group Y Axis 3"]'));
const yAxis1Group = page.getByLabel("Y Axis 1");
const yAxis2Group = page.getByLabel("Y Axis 2");
const yAxis3Group = page.getByLabel("Y Axis 3");
// Verify that the elements are in the correct buckets and in the correct order
expect(yAxis1Group.getByRole('listitem', { name: 'swg d' })).toBeTruthy();
expect(yAxis1Group.getByRole('listitem').nth(0).getByText('swg d')).toBeTruthy();
expect(yAxis2Group.getByRole('listitem', { name: 'swg e' })).toBeTruthy();
expect(yAxis2Group.getByRole('listitem').nth(0).getByText('swg e')).toBeTruthy();
expect(yAxis2Group.getByRole('listitem', { name: 'swg c' })).toBeTruthy();
expect(yAxis2Group.getByRole('listitem').nth(1).getByText('swg c')).toBeTruthy();
expect(yAxis2Group.getByRole('listitem', { name: 'swg a' })).toBeTruthy();
expect(yAxis2Group.getByRole('listitem').nth(2).getByText('swg a')).toBeTruthy();
expect(yAxis3Group.getByRole('listitem', { name: 'swg b' })).toBeTruthy();
expect(yAxis3Group.getByRole('listitem').nth(0).getByText('swg b')).toBeTruthy();
});
});

View File

@ -68,10 +68,10 @@ async function makeOverlayPlot(page) {
// create overlay plot // create overlay plot
await page.locator('button.c-create-button').click(); await page.locator('button.c-create-button').click();
await page.locator('li[role="menuitem"]:has-text("Overlay Plot")').click(); await page.locator('li:has-text("Overlay Plot")').click();
await Promise.all([ await Promise.all([
page.waitForNavigation({ waitUntil: 'networkidle'}), page.waitForNavigation({ waitUntil: 'networkidle'}),
page.locator('button:has-text("OK")').click(), page.locator('text=OK').click(),
//Wait for Save Banner to appear //Wait for Save Banner to appear
page.waitForSelector('.c-message-banner__message') page.waitForSelector('.c-message-banner__message')
]); ]);
@ -86,13 +86,13 @@ async function makeOverlayPlot(page) {
// create a sinewave generator // create a sinewave generator
await page.locator('button.c-create-button').click(); await page.locator('button.c-create-button').click();
await page.locator('li[role="menuitem"]:has-text("Sine Wave Generator")').click(); await page.locator('li:has-text("Sine Wave Generator")').click();
// Click OK to make generator // Click OK to make generator
await Promise.all([ await Promise.all([
page.waitForNavigation({ waitUntil: 'networkidle'}), page.waitForNavigation({ waitUntil: 'networkidle'}),
page.locator('button:has-text("OK")').click(), page.locator('text=OK').click(),
//Wait for Save Banner to appear //Wait for Save Banner to appear
page.waitForSelector('.c-message-banner__message') page.waitForSelector('.c-message-banner__message')
]); ]);

View File

@ -25,8 +25,8 @@
* *
*/ */
const { test, expect } = require('../../../../pluginFixtures'); const { test, expect } = require('../../../../baseFixtures');
const { createDomainObjectWithDefaults} = require('../../../../appActions'); const { createDomainObjectWithDefaults } = require('../../../../appActions');
test.describe('Plot Integrity Testing @unstable', () => { test.describe('Plot Integrity Testing @unstable', () => {
let sineWaveGeneratorObject; let sineWaveGeneratorObject;
@ -40,6 +40,7 @@ test.describe('Plot Integrity Testing @unstable', () => {
test('Plots do not re-request data when a plot is clicked', async ({ page }) => { test('Plots do not re-request data when a plot is clicked', async ({ page }) => {
//Navigate to Sine Wave Generator //Navigate to Sine Wave Generator
await page.goto(sineWaveGeneratorObject.url); await page.goto(sineWaveGeneratorObject.url);
//Capture the number of plots points and store as const name numberOfPlotPoints
//Click on the plot canvas //Click on the plot canvas
await page.locator('canvas').nth(1).click(); await page.locator('canvas').nth(1).click();
//No request was made to get historical data //No request was made to get historical data
@ -50,90 +51,4 @@ test.describe('Plot Integrity Testing @unstable', () => {
}); });
expect(createMineFolderRequests.length).toEqual(0); expect(createMineFolderRequests.length).toEqual(0);
}); });
test('Plot is rendered when infinity values exist', async ({ page }) => {
// Edit Plot
await editSineWaveToUseInfinityOption(page, sineWaveGeneratorObject);
//Get pixel data from Canvas
const plotPixelSize = await getCanvasPixelsWithData(page);
expect(plotPixelSize).toBeGreaterThan(0);
});
}); });
/**
* This function edits a sine wave generator with the default options and enables the infinity values option.
*
* @param {import('@playwright/test').Page} page
* @param {import('../../../../appActions').CreateObjectInfo} sineWaveGeneratorObject
* @returns {Promise<CreatedObjectInfo>} An object containing information about the edited domain object.
*/
async function editSineWaveToUseInfinityOption(page, sineWaveGeneratorObject) {
await page.goto(sineWaveGeneratorObject.url);
// Edit LAD table
await page.locator('[title="More options"]').click();
await page.locator('[title="Edit properties of this object."]').click();
// Modify the infinity option to true
const infinityInput = page.locator('[aria-label="Include Infinity Values"]');
await infinityInput.click();
// Click OK button and wait for Navigate event
await Promise.all([
page.waitForLoadState(),
page.click('[aria-label="Save"]'),
// Wait for Save Banner to appear
page.waitForSelector('.c-message-banner__message')
]);
// FIXME: Changes to SWG properties should be reflected on save, but they're not?
// Thus, navigate away and back to the object.
await page.goto('./#/browse/mine');
await page.goto(sineWaveGeneratorObject.url);
await page.locator('c-progress-bar c-telemetry-table__progress-bar').waitFor({
state: 'hidden'
});
// FIXME: The progress bar disappears on series data load, not on plot render,
// so wait for a half a second before evaluating the canvas.
// eslint-disable-next-line playwright/no-wait-for-timeout
await page.waitForTimeout(500);
}
/**
* @param {import('@playwright/test').Page} page
*/
async function getCanvasPixelsWithData(page) {
const getTelemValuePromise = new Promise(resolve => page.exposeFunction('getCanvasValue', resolve));
await page.evaluate(() => {
// 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)
let data;
let canvas;
let ctx;
canvas = document.querySelector('canvas');
ctx = canvas.getContext('2d');
data = ctx.getImageData(0, 0, canvas.width, canvas.height).data;
const imageDataValues = Object.values(data);
let 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({
startIndex: i,
endIndex: i + 3,
value: `rgb(${imageDataValues[i]}, ${imageDataValues[i + 1]}, ${imageDataValues[i + 2]}, ${imageDataValues[i + 3]})`
});
}
i = i + 4;
}
window.getCanvasValue(plotPixels.length);
});
return getTelemValuePromise;
}

View File

@ -1,93 +0,0 @@
/*****************************************************************************
* Open MCT, Copyright (c) 2014-2022, 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 testing the Scatter Plot component.
*/
const { test, expect } = require('../../../../pluginFixtures');
const { createDomainObjectWithDefaults } = require('../../../../appActions');
const uuid = require('uuid').v4;
test.describe('Scatter Plot', () => {
let scatterPlot;
test.beforeEach(async ({ page }) => {
// Open a browser, navigate to the main page, and wait until all networkevents to resolve
await page.goto('./', { waitUntil: 'networkidle' });
// Create the Scatter Plot
scatterPlot = await createDomainObjectWithDefaults(page, { type: 'Scatter Plot' });
});
test('Can add and remove telemetry sources', async ({ page }) => {
const editButtonLocator = page.locator('button[title="Edit"]');
const saveButtonLocator = page.locator('button[title="Save"]');
// Create a sine wave generator within the scatter plot
const swg1 = await createDomainObjectWithDefaults(page, {
type: 'Sine Wave Generator',
name: `swg-${uuid()}`,
parent: scatterPlot.uuid
});
// Navigate to the scatter plot and verify that
// the SWG appears in the elements pool
await page.goto(scatterPlot.url);
await editButtonLocator.click();
await expect.soft(page.locator(`#inspector-elements-tree >> text=${swg1.name}`)).toBeVisible();
await saveButtonLocator.click();
await page.locator('li[title="Save and Finish Editing"]').click();
// Create another sine wave generator within the scatter plot
const swg2 = await createDomainObjectWithDefaults(page, {
type: 'Sine Wave Generator',
name: `swg-${uuid()}`,
parent: scatterPlot.uuid
});
// Verify that the 'Replace telemetry source' modal appears and accept it
await expect.soft(page.locator('text=This action will replace the current telemetry source. Do you want to continue?')).toBeVisible();
await page.click('text=Ok');
// Navigate to the scatter plot and verify that the new SWG
// appears in the elements pool and the old one is gone
await page.goto(scatterPlot.url);
await editButtonLocator.click();
await expect.soft(page.locator(`#inspector-elements-tree >> text=${swg1.name}`)).toBeHidden();
await expect.soft(page.locator(`#inspector-elements-tree >> text=${swg2.name}`)).toBeVisible();
await saveButtonLocator.click();
// Right click on the new SWG in the elements pool and delete it
await page.locator(`#inspector-elements-tree >> text=${swg2.name}`).click({
button: 'right'
});
await page.locator('li[title="Remove this object from its containing object."]').click();
// Verify that the 'Remove object' confirmation modal appears and accept it
await expect.soft(page.locator('text=Warning! This action will remove this object. Are you sure you want to continue?')).toBeVisible();
await page.click('text=Ok');
// Verify that the elements pool shows no elements
await expect(page.locator('text="No contained elements"')).toBeVisible();
});
});

View File

@ -20,7 +20,7 @@
* at runtime from the About dialog for additional information. * at runtime from the About dialog for additional information.
*****************************************************************************/ *****************************************************************************/
const { test, expect } = require('../../../../pluginFixtures'); const { test, expect } = require('../../../../baseFixtures');
const { setFixedTimeMode, setRealTimeMode, setStartOffset, setEndOffset } = require('../../../../appActions'); const { setFixedTimeMode, setRealTimeMode, setStartOffset, setEndOffset } = require('../../../../appActions');
test.describe('Time conductor operations', () => { test.describe('Time conductor operations', () => {

View File

@ -30,7 +30,7 @@ test.describe('Timer', () => {
timer = await createDomainObjectWithDefaults(page, { type: 'timer' }); timer = await createDomainObjectWithDefaults(page, { type: 'timer' });
}); });
test('Can perform actions on the Timer', async ({ page }) => { test('Can perform actions on the Timer', async ({ page, openmctConfig }) => {
test.info().annotations.push({ test.info().annotations.push({
type: 'issue', type: 'issue',
description: 'https://github.com/nasa/openmct/issues/4313' description: 'https://github.com/nasa/openmct/issues/4313'

View File

@ -1,85 +0,0 @@
/*****************************************************************************
* 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.js');
const { createDomainObjectWithDefaults } = require('../../appActions.js');
test.describe('Recent Objects', () => {
test('Recent Objects CRUD operations', async ({ page }) => {
await page.goto('./', { waitUntil: 'networkidle' });
// Create a folder and nest a Clock within it
const recentObjectsList = page.locator('[aria-label="Recent Objects"]');
const folderA = await createDomainObjectWithDefaults(page, {
type: 'Folder'
});
const clock = await createDomainObjectWithDefaults(page, {
type: 'Clock',
parent: folderA.uuid
});
// Drag the Recent Objects panel up a bit
await page.locator('div:nth-child(2) > .l-pane__handle').hover();
await page.mouse.down();
await page.mouse.move(0, 100);
await page.mouse.up();
// Verify that both created objects appear in the list and are in the correct order
expect(recentObjectsList.getByRole('listitem', { name: clock.name })).toBeTruthy();
expect(recentObjectsList.getByRole('listitem', { name: folderA.name })).toBeTruthy();
expect(recentObjectsList.getByRole('listitem', { name: clock.name }).locator('a').getByText(folderA.name)).toBeTruthy();
expect(recentObjectsList.getByRole('listitem').nth(0).getByText(clock.name)).toBeTruthy();
expect(recentObjectsList.getByRole('listitem', { name: clock.name }).locator('a').getByText(folderA.name)).toBeTruthy();
expect(recentObjectsList.getByRole('listitem').nth(1).getByText(folderA.name)).toBeTruthy();
// Navigate to the folder by clicking on the main object name in the recent objects list item
await recentObjectsList.getByRole('listitem', { name: folderA.name }).getByText(folderA.name).click();
await page.waitForURL(`**/${folderA.uuid}?*`);
expect(recentObjectsList.getByRole('listitem').nth(0).getByText(folderA.name)).toBeTruthy();
// Rename
folderA.name = `${folderA.name}-NEW!`;
await page.locator('.l-browse-bar__object-name').fill("");
await page.locator('.l-browse-bar__object-name').fill(folderA.name);
await page.keyboard.press('Enter');
// Verify rename has been applied in recent objects list item and objects paths
expect(page.getByRole('listitem', { name: clock.name }).locator('a').getByText(folderA.name)).toBeTruthy();
expect(recentObjectsList.getByRole('listitem', { name: folderA.name })).toBeTruthy();
// Delete
await page.click('button[title="Show selected item in tree"]');
// Delete the folder via the left tree pane treeitem context menu
await page.getByRole('treeitem', { name: new RegExp(folderA.name) }).locator('a').click({
button: 'right'
});
await page.getByRole('menuitem', { name: /Remove/ }).click();
await page.getByRole('button', { name: 'OK' }).click();
// Verify that the folder and clock are no longer in the recent objects list
await expect(recentObjectsList.getByRole('listitem', { name: folderA.name })).toBeHidden();
await expect(recentObjectsList.getByRole('listitem', { name: clock.name })).toBeHidden();
});
test.fixme("Clicking on the 'target button' scrolls the object into view in the tree and highlights it");
test.fixme("Clicking on an object in the path of a recent object navigates to the object");
test.fixme("Tests for context menu actions from recent objects");
});

View File

@ -31,7 +31,7 @@ test.describe('Grand Search', () => {
test('Can search for objects, and subsequent search dropdown behaves properly', async ({ page, openmctConfig }) => { test('Can search for objects, and subsequent search dropdown behaves properly', async ({ page, openmctConfig }) => {
const { myItemsFolderName } = openmctConfig; const { myItemsFolderName } = openmctConfig;
const createdObjects = await createObjectsForSearch(page); await createObjectsForSearch(page, myItemsFolderName);
// Click [aria-label="OpenMCT Search"] input[type="search"] // Click [aria-label="OpenMCT Search"] input[type="search"]
await page.locator('[aria-label="OpenMCT Search"] input[type="search"]').click(); await page.locator('[aria-label="OpenMCT Search"] input[type="search"]').click();
@ -41,8 +41,8 @@ test.describe('Grand Search', () => {
await expect(page.locator('[aria-label="Search Result"] >> nth=1')).toContainText(`Clock B ${myItemsFolderName} Red Folder Blue Folder`); await expect(page.locator('[aria-label="Search Result"] >> nth=1')).toContainText(`Clock B ${myItemsFolderName} Red Folder Blue Folder`);
await expect(page.locator('[aria-label="Search Result"] >> nth=2')).toContainText(`Clock C ${myItemsFolderName} Red Folder Blue Folder`); await expect(page.locator('[aria-label="Search Result"] >> nth=2')).toContainText(`Clock C ${myItemsFolderName} Red Folder Blue Folder`);
await expect(page.locator('[aria-label="Search Result"] >> nth=3')).toContainText(`Clock D ${myItemsFolderName} Red Folder Blue Folder`); await expect(page.locator('[aria-label="Search Result"] >> nth=3')).toContainText(`Clock D ${myItemsFolderName} Red Folder Blue Folder`);
// Click the Elements pool to dismiss the search menu // Click text=Elements >> nth=0
await page.locator('.l-pane__label:has-text("Elements")').click(); await page.locator('text=Elements').first().click();
await expect(page.locator('[aria-label="Search Result"] >> nth=0')).toBeHidden(); await expect(page.locator('[aria-label="Search Result"] >> nth=0')).toBeHidden();
await page.locator('[aria-label="OpenMCT Search"] [aria-label="Search Input"]').click(); await page.locator('[aria-label="OpenMCT Search"] [aria-label="Search Input"]').click();
@ -72,12 +72,12 @@ test.describe('Grand Search', () => {
await page.locator('[aria-label="OpenMCT Search"] [aria-label="Search Input"]').fill('Cl'); await page.locator('[aria-label="OpenMCT Search"] [aria-label="Search Input"]').fill('Cl');
await Promise.all([ await Promise.all([
page.waitForNavigation(), page.waitForNavigation(),
page.locator('[aria-label="Clock A clock result"] >> text=Clock A').click() page.locator('text=Clock A').click()
]); ]);
await expect(page.locator('.is-object-type-clock')).toBeVisible(); await expect(page.locator('.is-object-type-clock')).toBeVisible();
await page.locator('[aria-label="OpenMCT Search"] [aria-label="Search Input"]').fill('Disp'); await page.locator('[aria-label="OpenMCT Search"] [aria-label="Search Input"]').fill('Disp');
await expect(page.locator('[aria-label="Search Result"] >> nth=0')).toContainText(createdObjects.displayLayout.name); await expect(page.locator('[aria-label="Search Result"] >> nth=0')).toContainText('Unnamed Display Layout');
await expect(page.locator('[aria-label="Search Result"] >> nth=0')).not.toContainText('Folder'); await expect(page.locator('[aria-label="Search Result"] >> nth=0')).not.toContainText('Folder');
await page.locator('[aria-label="OpenMCT Search"] input[type="search"]').fill('Clock C'); await page.locator('[aria-label="OpenMCT Search"] input[type="search"]').fill('Clock C');
@ -185,7 +185,7 @@ async function createFolderObject(page, folderName) {
await page.locator('text=Properties Title Notes >> input[type="text"]').fill(folderName); await page.locator('text=Properties Title Notes >> input[type="text"]').fill(folderName);
// Create folder object // Create folder object
await page.locator('button:has-text("OK")').click(); await page.locator('text=OK').click();
} }
async function waitForSearchCompletion(page) { async function waitForSearchCompletion(page) {
@ -197,56 +197,75 @@ async function waitForSearchCompletion(page) {
* Creates some domain objects for searching * Creates some domain objects for searching
* @param {import('@playwright/test').Page} page * @param {import('@playwright/test').Page} page
*/ */
async function createObjectsForSearch(page) { async function createObjectsForSearch(page, myItemsFolderName) {
//Go to baseURL //Go to baseURL
await page.goto('./', { waitUntil: 'networkidle' }); await page.goto('./', { waitUntil: 'networkidle' });
const redFolder = await createDomainObjectWithDefaults(page, { await page.locator('button:has-text("Create")').click();
type: 'Folder', await page.locator('li:has-text("Folder") >> nth=1').click();
name: 'Red Folder' await Promise.all([
}); page.waitForNavigation(),
await page.locator('text=Properties Title Notes >> input[type="text"]').fill('Red Folder'),
await page.locator(`text=Save In Open MCT ${myItemsFolderName} >> span`).nth(3).click(),
page.locator('button:has-text("OK")').click()
]);
const blueFolder = await createDomainObjectWithDefaults(page, { await page.locator('button:has-text("Create")').click();
type: 'Folder', await page.locator('li:has-text("Folder") >> nth=2').click();
name: 'Blue Folder', await Promise.all([
parent: redFolder.uuid page.waitForNavigation(),
}); await page.locator('text=Properties Title Notes >> input[type="text"]').fill('Blue Folder'),
await page.locator('form[name="mctForm"] >> text=Red Folder').click(),
page.locator('button:has-text("OK")').click()
]);
const clockA = await createDomainObjectWithDefaults(page, { await page.locator('button:has-text("Create")').click();
type: 'Clock', await page.locator('li[title="A digital clock that uses system time and supports a variety of display formats and timezones."]').click();
name: 'Clock A', await Promise.all([
parent: blueFolder.uuid page.waitForNavigation(),
}); await page.locator('text=Properties Title Notes >> input[type="text"] >> nth=0').fill('Clock A'),
const clockB = await createDomainObjectWithDefaults(page, { await page.locator('form[name="mctForm"] >> text=Blue Folder').click(),
type: 'Clock', page.locator('button:has-text("OK")').click()
name: 'Clock B', ]);
parent: blueFolder.uuid
});
const clockC = await createDomainObjectWithDefaults(page, {
type: 'Clock',
name: 'Clock C',
parent: blueFolder.uuid
});
const clockD = await createDomainObjectWithDefaults(page, {
type: 'Clock',
name: 'Clock D',
parent: blueFolder.uuid
});
const displayLayout = await createDomainObjectWithDefaults(page, { await page.locator('button:has-text("Create")').click();
type: 'Display Layout' await page.locator('li[title="A digital clock that uses system time and supports a variety of display formats and timezones."]').click();
}); await Promise.all([
page.waitForNavigation(),
await page.locator('text=Properties Title Notes >> input[type="text"] >> nth=0').fill('Clock B'),
await page.locator('form[name="mctForm"] >> text=Blue Folder').click(),
page.locator('button:has-text("OK")').click()
]);
// Go back into edit mode for the display layout await page.locator('button:has-text("Create")').click();
await page.locator('button[title="Edit"]').click(); await page.locator('li[title="A digital clock that uses system time and supports a variety of display formats and timezones."]').click();
await Promise.all([
page.waitForNavigation(),
await page.locator('text=Properties Title Notes >> input[type="text"] >> nth=0').fill('Clock C'),
await page.locator('form[name="mctForm"] >> text=Blue Folder').click(),
page.locator('button:has-text("OK")').click()
]);
return { await page.locator('button:has-text("Create")').click();
redFolder, await page.locator('li[title="A digital clock that uses system time and supports a variety of display formats and timezones."]').click();
blueFolder, await Promise.all([
clockA, page.waitForNavigation(),
clockB, await page.locator('text=Properties Title Notes >> input[type="text"] >> nth=0').fill('Clock D'),
clockC, await page.locator('form[name="mctForm"] >> text=Blue Folder').click(),
clockD, page.locator('button:has-text("OK")').click()
displayLayout ]);
};
await Promise.all([
page.waitForNavigation(),
page.locator(`a:has-text("${myItemsFolderName}") >> nth=0`).click()
]);
// Click button:has-text("Create")
await page.locator('button:has-text("Create")').click();
// Click li:has-text("Notebook")
await page.locator('li:has-text("Display Layout")').click();
// Click button:has-text("OK")
await Promise.all([
page.waitForNavigation(),
page.locator('button:has-text("OK")').click()
]);
} }

View File

@ -116,9 +116,7 @@ async function getAndAssertTreeItems(page, expected) {
* @param {string} name * @param {string} name
*/ */
async function expandTreePaneItemByName(page, name) { async function expandTreePaneItemByName(page, name) {
const treePane = page.getByRole('tree', { const treePane = page.locator('#tree-pane');
name: 'Main Tree'
});
const treeItem = treePane.locator(`role=treeitem[expanded=false][name=/${name}/]`); const treeItem = treePane.locator(`role=treeitem[expanded=false][name=/${name}/]`);
const expandTriangle = treeItem.locator('.c-disclosure-triangle'); const expandTriangle = treeItem.locator('.c-disclosure-triangle');
await expandTriangle.click(); await expandTriangle.click();

View File

@ -53,7 +53,7 @@ test.describe('Performance tests', () => {
await page.setInputFiles('#fileElem', filePath); await page.setInputFiles('#fileElem', filePath);
// Click text=OK // Click text=OK
await page.locator('button:has-text("OK")').click(); await page.locator('text=OK').click();
await expect(page.locator('a:has-text("Performance Display Layout Display Layout")')).toBeVisible(); await expect(page.locator('a:has-text("Performance Display Layout Display Layout")')).toBeVisible();

View File

@ -57,7 +57,7 @@ test.describe('Visual - Tree Pane', () => {
name: 'Z Clock' name: 'Z Clock'
}); });
const treePane = "[role=tree][aria-label='Main Tree']"; const treePane = "#tree-pane";
await percySnapshot(page, `Tree Pane w/ collapsed tree (theme: ${theme})`, { await percySnapshot(page, `Tree Pane w/ collapsed tree (theme: ${theme})`, {
scope: treePane scope: treePane
@ -94,7 +94,7 @@ test.describe('Visual - Tree Pane', () => {
* @param {string} name * @param {string} name
*/ */
async function expandTreePaneItemByName(page, name) { async function expandTreePaneItemByName(page, name) {
const treePane = page.getByTestId('tree-pane'); const treePane = page.locator('#tree-pane');
const treeItem = treePane.locator(`role=treeitem[expanded=false][name=/${name}/]`); const treeItem = treePane.locator(`role=treeitem[expanded=false][name=/${name}/]`);
const expandTriangle = treeItem.locator('.c-disclosure-triangle'); const expandTriangle = treeItem.locator('.c-disclosure-triangle');
await expandTriangle.click(); await expandTriangle.click();

View File

@ -1,58 +0,0 @@
/*****************************************************************************
* 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 is dedicated to test notification banner functionality and its accessibility attributes.
*/
const { test, expect } = require('../../pluginFixtures');
const percySnapshot = require('@percy/playwright');
const { createDomainObjectWithDefaults } = require('../../appActions');
test.describe('Visual - Check Notification Info Banner of \'Save successful\'', () => {
test.beforeEach(async ({ page }) => {
// Go to baseURL and Hide Tree
await page.goto('./', { waitUntil: 'networkidle' });
});
test('Create a clock, click on \'Save successful\' banner and dismiss it', async ({ page }) => {
// Create a clock domain object
await createDomainObjectWithDefaults(page, { type: 'Clock' });
// Verify there is a button with aria-label="Review 1 Notification"
expect(await page.locator('button[aria-label="Review 1 Notification"]').isVisible()).toBe(true);
// Verify there is a button with aria-label="Clear all notifications"
expect(await page.locator('button[aria-label="Clear all notifications"]').isVisible()).toBe(true);
// Click on the div with role="alert" that has "Save successful" text
await page.locator('div[role="alert"]:has-text("Save successful")').click();
// Verify there is a div with role="dialog"
expect(await page.locator('div[role="dialog"]').isVisible()).toBe(true);
// Verify the div with role="dialog" contains text "Save successful"
expect(await page.locator('div[role="dialog"]').innerText()).toContain('Save successful');
await percySnapshot(page, 'Notification banner');
// Verify there is a button with text "Dismiss"
expect(await page.locator('button:has-text("Dismiss")').isVisible()).toBe(true);
// Click on button with text "Dismiss"
await page.locator('button:has-text("Dismiss")').click();
// Verify there is no div with role="dialog"
expect(await page.locator('div[role="dialog"]').isVisible()).toBe(false);
});
});

View File

@ -65,7 +65,7 @@ export default class ExampleUserProvider extends EventEmitter {
this.user = undefined; this.user = undefined;
this.loggedIn = false; this.loggedIn = false;
this.autoLoginUser = undefined; this.autoLoginUser = undefined;
this.status = STATUSES[0]; this.status = STATUSES[1];
this.pollQuestion = undefined; this.pollQuestion = undefined;
this.defaultStatusRole = defaultStatusRole; this.defaultStatusRole = defaultStatusRole;
@ -124,7 +124,6 @@ export default class ExampleUserProvider extends EventEmitter {
} }
setStatusForRole(role, status) { setStatusForRole(role, status) {
status.timestamp = Date.now();
this.status = status; this.status = status;
this.emit('statusChange', { this.emit('statusChange', {
role, role,
@ -134,23 +133,14 @@ export default class ExampleUserProvider extends EventEmitter {
return true; return true;
} }
// eslint-disable-next-line require-await getPollQuestion() {
async getPollQuestion() { return Promise.resolve({
if (this.pollQuestion) { question: 'Set "GO" if your position is ready for a boarding action on the Klingon cruiser',
return this.pollQuestion; timestamp: Date.now()
} else { });
return undefined;
}
} }
setPollQuestion(pollQuestion) { setPollQuestion(pollQuestion) {
if (!pollQuestion) {
// If the poll question is undefined, set it to a blank string.
// This behavior better reflects how other telemetry systems
// deal with undefined poll questions.
pollQuestion = '';
}
this.pollQuestion = { this.pollQuestion = {
question: pollQuestion, question: pollQuestion,
timestamp: Date.now() timestamp: Date.now()

View File

@ -33,13 +33,11 @@ define([
dataRateInHz: 1, dataRateInHz: 1,
randomness: 0, randomness: 0,
phase: 0, phase: 0,
loadDelay: 0, loadDelay: 0
infinityValues: false
}; };
function GeneratorProvider(openmct, StalenessProvider) { function GeneratorProvider(openmct) {
this.openmct = openmct; this.workerInterface = new WorkerInterface(openmct);
this.workerInterface = new WorkerInterface(openmct, StalenessProvider);
} }
GeneratorProvider.prototype.canProvideTelemetry = function (domainObject) { GeneratorProvider.prototype.canProvideTelemetry = function (domainObject) {
@ -58,8 +56,7 @@ define([
'dataRateInHz', 'dataRateInHz',
'randomness', 'randomness',
'phase', 'phase',
'loadDelay', 'loadDelay'
'infinityValues'
]; ];
request = request || {}; request = request || {};
@ -82,7 +79,6 @@ define([
workerRequest[prop] = Number(workerRequest[prop]); workerRequest[prop] = Number(workerRequest[prop]);
}); });
workerRequest.id = this.openmct.objects.makeKeyString(domainObject.identifier);
workerRequest.name = domainObject.name; workerRequest.name = domainObject.name;
return workerRequest; return workerRequest;

View File

@ -1,151 +0,0 @@
/*****************************************************************************
* Open MCT, Copyright (c) 2014-2022, 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 EventEmitter from 'EventEmitter';
export default class SinewaveLimitProvider extends EventEmitter {
constructor(openmct) {
super();
this.openmct = openmct;
this.observingStaleness = {};
this.watchingTheClock = false;
this.isRealTime = undefined;
}
supportsStaleness(domainObject) {
return domainObject.type === 'generator';
}
isStale(domainObject, options) {
if (!this.providingStaleness(domainObject)) {
return Promise.resolve({
isStale: false,
utc: 0
});
}
const id = this.getObjectKeyString(domainObject);
if (!this.observerExists(id)) {
this.createObserver(id);
}
return Promise.resolve(this.observingStaleness[id].isStale);
}
subscribeToStaleness(domainObject, callback) {
const id = this.getObjectKeyString(domainObject);
if (this.isRealTime === undefined) {
this.updateRealTime(this.openmct.time.clock());
}
this.handleClockUpdate();
if (this.observerExists(id)) {
this.addCallbackToObserver(id, callback);
} else {
this.createObserver(id, callback);
}
const intervalId = setInterval(() => {
if (this.providingStaleness(domainObject)) {
this.updateStaleness(id, !this.observingStaleness[id].isStale);
}
}, 10000);
return () => {
clearInterval(intervalId);
this.updateStaleness(id, false);
this.handleClockUpdate();
this.destroyObserver(id);
};
}
handleClockUpdate() {
let observers = Object.values(this.observingStaleness).length > 0;
if (observers && !this.watchingTheClock) {
this.watchingTheClock = true;
this.openmct.time.on('clock', this.updateRealTime, this);
} else if (!observers && this.watchingTheClock) {
this.watchingTheClock = false;
this.openmct.time.off('clock', this.updateRealTime, this);
}
}
updateRealTime(clock) {
this.isRealTime = clock !== undefined;
if (!this.isRealTime) {
Object.keys(this.observingStaleness).forEach((id) => {
this.updateStaleness(id, false);
});
}
}
updateStaleness(id, isStale) {
this.observingStaleness[id].isStale = isStale;
this.observingStaleness[id].utc = Date.now();
this.observingStaleness[id].callback({
isStale: this.observingStaleness[id].isStale,
utc: this.observingStaleness[id].utc
});
this.emit('stalenessEvent', {
id,
isStale: this.observingStaleness[id].isStale
});
}
createObserver(id, callback) {
this.observingStaleness[id] = {
isStale: false,
utc: Date.now()
};
if (typeof callback === 'function') {
this.addCallbackToObserver(id, callback);
}
}
destroyObserver(id) {
delete this.observingStaleness[id];
}
providingStaleness(domainObject) {
return domainObject.telemetry?.staleness === true && this.isRealTime;
}
getObjectKeyString(object) {
return this.openmct.objects.makeKeyString(object.identifier);
}
addCallbackToObserver(id, callback) {
this.observingStaleness[id].callback = callback;
}
observerExists(id) {
return this.observingStaleness?.[id];
}
}

View File

@ -25,24 +25,14 @@ define([
], function ( ], function (
{ v4: uuid } { v4: uuid }
) { ) {
function WorkerInterface(openmct, StalenessProvider) { function WorkerInterface(openmct) {
// eslint-disable-next-line no-undef // eslint-disable-next-line no-undef
const workerUrl = `${openmct.getAssetPath()}${__OPENMCT_ROOT_RELATIVE__}generatorWorker.js`; const workerUrl = `${openmct.getAssetPath()}${__OPENMCT_ROOT_RELATIVE__}generatorWorker.js`;
this.StalenessProvider = StalenessProvider;
this.worker = new Worker(workerUrl); this.worker = new Worker(workerUrl);
this.worker.onmessage = this.onMessage.bind(this); this.worker.onmessage = this.onMessage.bind(this);
this.callbacks = {}; this.callbacks = {};
this.staleTelemetryIds = {};
this.watchStaleness();
} }
WorkerInterface.prototype.watchStaleness = function () {
this.StalenessProvider.on('stalenessEvent', ({ id, isStale}) => {
this.staleTelemetryIds[id] = isStale;
});
};
WorkerInterface.prototype.onMessage = function (message) { WorkerInterface.prototype.onMessage = function (message) {
message = message.data; message = message.data;
var callback = this.callbacks[message.id]; var callback = this.callbacks[message.id];
@ -93,12 +83,11 @@ define([
}; };
WorkerInterface.prototype.subscribe = function (request, cb) { WorkerInterface.prototype.subscribe = function (request, cb) {
const id = request.id; function callback(message) {
const messageId = this.dispatch('subscribe', request, (message) => {
if (!this.staleTelemetryIds[id]) {
cb(message.data); cb(message.data);
} }
});
var messageId = this.dispatch('subscribe', request, callback);
return function () { return function () {
this.dispatch('unsubscribe', { this.dispatch('unsubscribe', {

View File

@ -76,10 +76,10 @@
name: data.name, name: data.name,
utc: nextStep, utc: nextStep,
yesterday: nextStep - 60 * 60 * 24 * 1000, yesterday: nextStep - 60 * 60 * 24 * 1000,
sin: sin(nextStep, data.period, data.amplitude, data.offset, data.phase, data.randomness, data.infinityValues), sin: sin(nextStep, data.period, data.amplitude, data.offset, data.phase, data.randomness),
wavelengths: wavelengths(), wavelengths: wavelengths(),
intensities: intensities(), intensities: intensities(),
cos: cos(nextStep, data.period, data.amplitude, data.offset, data.phase, data.randomness, data.infinityValues) cos: cos(nextStep, data.period, data.amplitude, data.offset, data.phase, data.randomness)
} }
}); });
nextStep += step; nextStep += step;
@ -117,7 +117,6 @@
var phase = request.phase; var phase = request.phase;
var randomness = request.randomness; var randomness = request.randomness;
var loadDelay = Math.max(request.loadDelay, 0); var loadDelay = Math.max(request.loadDelay, 0);
var infinityValues = request.infinityValues;
var step = 1000 / dataRateInHz; var step = 1000 / dataRateInHz;
var nextStep = start - (start % step) + step; var nextStep = start - (start % step) + step;
@ -128,10 +127,10 @@
data.push({ data.push({
utc: nextStep, utc: nextStep,
yesterday: nextStep - 60 * 60 * 24 * 1000, yesterday: nextStep - 60 * 60 * 24 * 1000,
sin: sin(nextStep, period, amplitude, offset, phase, randomness, infinityValues), sin: sin(nextStep, period, amplitude, offset, phase, randomness),
wavelengths: wavelengths(), wavelengths: wavelengths(),
intensities: intensities(), intensities: intensities(),
cos: cos(nextStep, period, amplitude, offset, phase, randomness, infinityValues) cos: cos(nextStep, period, amplitude, offset, phase, randomness)
}); });
} }
@ -156,20 +155,12 @@
}); });
} }
function cos(timestamp, period, amplitude, offset, phase, randomness, infinityValues) { function cos(timestamp, period, amplitude, offset, phase, randomness) {
if (infinityValues && Math.random() > 0.5) {
return Number.POSITIVE_INFINITY;
}
return amplitude return amplitude
* Math.cos(phase + (timestamp / period / 1000 * Math.PI * 2)) + (amplitude * Math.random() * randomness) + offset; * Math.cos(phase + (timestamp / period / 1000 * Math.PI * 2)) + (amplitude * Math.random() * randomness) + offset;
} }
function sin(timestamp, period, amplitude, offset, phase, randomness, infinityValues) { function sin(timestamp, period, amplitude, offset, phase, randomness) {
if (infinityValues && Math.random() > 0.5) {
return Number.POSITIVE_INFINITY;
}
return amplitude return amplitude
* Math.sin(phase + (timestamp / period / 1000 * Math.PI * 2)) + (amplitude * Math.random() * randomness) + offset; * Math.sin(phase + (timestamp / period / 1000 * Math.PI * 2)) + (amplitude * Math.random() * randomness) + offset;
} }

View File

@ -20,13 +20,19 @@
* at runtime from the About dialog for additional information. * at runtime from the About dialog for additional information.
*****************************************************************************/ *****************************************************************************/
import GeneratorProvider from "./GeneratorProvider"; define([
import SinewaveLimitProvider from "./SinewaveLimitProvider"; "./GeneratorProvider",
import SinewaveStalenessProvider from "./SinewaveStalenessProvider"; "./SinewaveLimitProvider",
import StateGeneratorProvider from "./StateGeneratorProvider"; "./StateGeneratorProvider",
import GeneratorMetadataProvider from "./GeneratorMetadataProvider"; "./GeneratorMetadataProvider"
], function (
GeneratorProvider,
SinewaveLimitProvider,
StateGeneratorProvider,
GeneratorMetadataProvider
) {
export default function (openmct) { return function (openmct) {
openmct.types.addType("example.state-generator", { openmct.types.addType("example.state-generator", {
name: "State Generator", name: "State Generator",
@ -137,26 +143,6 @@ export default function (openmct) {
"telemetry", "telemetry",
"loadDelay" "loadDelay"
] ]
},
{
name: "Include Infinity Values",
control: "toggleSwitch",
cssClass: "l-input",
key: "infinityValues",
property: [
"telemetry",
"infinityValues"
]
},
{
name: "Provide Staleness Updates",
control: "toggleSwitch",
cssClass: "l-input",
key: "staleness",
property: [
"telemetry",
"staleness"
]
} }
], ],
initialize: function (object) { initialize: function (object) {
@ -167,16 +153,14 @@ export default function (openmct) {
dataRateInHz: 1, dataRateInHz: 1,
phase: 0, phase: 0,
randomness: 0, randomness: 0,
loadDelay: 0, loadDelay: 0
infinityValues: false,
staleness: false
}; };
} }
}); });
const stalenessProvider = new SinewaveStalenessProvider(openmct);
openmct.telemetry.addProvider(new GeneratorProvider(openmct, stalenessProvider)); openmct.telemetry.addProvider(new GeneratorProvider(openmct));
openmct.telemetry.addProvider(new GeneratorMetadataProvider()); openmct.telemetry.addProvider(new GeneratorMetadataProvider());
openmct.telemetry.addProvider(new SinewaveLimitProvider()); openmct.telemetry.addProvider(new SinewaveLimitProvider());
openmct.telemetry.addProvider(stalenessProvider); };
}
});

View File

@ -107,15 +107,6 @@ export default function () {
} }
] ]
}, },
{
name: 'Image Thumbnail',
key: 'thumbnail-url',
format: 'thumbnail',
hints: {
thumbnail: 1
},
source: 'url'
},
{ {
name: 'Image Download Name', name: 'Image Download Name',
key: 'imageDownloadName', key: 'imageDownloadName',
@ -152,16 +143,6 @@ export default function () {
] ]
}); });
const formatThumbnail = {
format: function (url) {
return `${url}?w=100&h=100`;
}
};
openmct.telemetry.addFormat({
key: 'thumbnail',
...formatThumbnail
});
openmct.telemetry.addProvider(getRealtimeProvider()); openmct.telemetry.addProvider(getRealtimeProvider());
openmct.telemetry.addProvider(getHistoricalProvider()); openmct.telemetry.addProvider(getHistoricalProvider());
openmct.telemetry.addProvider(getLadProvider()); openmct.telemetry.addProvider(getLadProvider());
@ -261,13 +242,6 @@ function pointForTimestamp(timestamp, name, imageSamples, delay) {
const url = imageSamples[Math.floor(timestamp / delay) % imageSamples.length]; const url = imageSamples[Math.floor(timestamp / delay) % imageSamples.length];
const urlItems = url.split('/'); const urlItems = url.split('/');
const imageDownloadName = `example.imagery.${urlItems[urlItems.length - 1]}`; const imageDownloadName = `example.imagery.${urlItems[urlItems.length - 1]}`;
const navCamTransformations = {
"translateX": 0,
"translateY": 18,
"rotation": 0,
"scale": 0.3,
"cameraAngleOfView": 70
};
return { return {
name, name,
@ -277,7 +251,6 @@ function pointForTimestamp(timestamp, name, imageSamples, delay) {
sunOrientation: getCompassValues(0, 360), sunOrientation: getCompassValues(0, 360),
cameraPan: getCompassValues(0, 360), cameraPan: getCompassValues(0, 360),
heading: getCompassValues(0, 360), heading: getCompassValues(0, 360),
transformations: navCamTransformations,
imageDownloadName imageDownloadName
}; };
} }

View File

@ -28,12 +28,12 @@ module.exports = (config) => {
let singleRun; let singleRun;
if (process.env.KARMA_DEBUG) { if (process.env.KARMA_DEBUG) {
webpackConfig = require("./.webpack/webpack.dev.js"); webpackConfig = require('./webpack.dev.js');
browsers = ["ChromeDebugging"]; browsers = ['ChromeDebugging'];
singleRun = false; singleRun = false;
} else { } else {
webpackConfig = require("./.webpack/webpack.coverage.js"); webpackConfig = require('./webpack.coverage.js');
browsers = ["ChromeHeadless"]; browsers = ['ChromeHeadless'];
singleRun = true; singleRun = true;
} }
@ -42,28 +42,28 @@ module.exports = (config) => {
delete webpackConfig.entry; delete webpackConfig.entry;
config.set({ config.set({
basePath: "", basePath: '',
frameworks: ["jasmine", "webpack"], frameworks: ['jasmine', 'webpack'],
files: [ files: [
"indexTest.js", 'indexTest.js',
// included means: should the files be included in the browser using <script> tag? // included means: should the files be included in the browser using <script> tag?
// We don't want them as a <script> because the shared worker source // We don't want them as a <script> because the shared worker source
// needs loaded remotely by the shared worker process. // needs loaded remotely by the shared worker process.
{ {
pattern: "dist/couchDBChangesFeed.js*", pattern: 'dist/couchDBChangesFeed.js*',
included: false included: false
}, },
{ {
pattern: "dist/inMemorySearchWorker.js*", pattern: 'dist/inMemorySearchWorker.js*',
included: false included: false
}, },
{ {
pattern: "dist/generatorWorker.js*", pattern: 'dist/generatorWorker.js*',
included: false included: false
} }
], ],
port: 9876, port: 9876,
reporters: ["spec", "junit", "coverage-istanbul"], reporters: ['spec', 'junit', 'coverage-istanbul'],
browsers, browsers,
client: { client: {
jasmine: { jasmine: {
@ -73,8 +73,8 @@ module.exports = (config) => {
}, },
customLaunchers: { customLaunchers: {
ChromeDebugging: { ChromeDebugging: {
base: "Chrome", base: 'Chrome',
flags: ["--remote-debugging-port=9222"], flags: ['--remote-debugging-port=9222'],
debug: true debug: true
} }
}, },
@ -90,7 +90,7 @@ module.exports = (config) => {
fixWebpackSourcePaths: true, fixWebpackSourcePaths: true,
skipFilesWithNoCoverage: true, skipFilesWithNoCoverage: true,
dir: "coverage/unit", //Sets coverage file to be consumed by codecov.io dir: "coverage/unit", //Sets coverage file to be consumed by codecov.io
reports: ["lcovonly"] reports: ['lcovonly']
}, },
specReporter: { specReporter: {
maxLogLines: 5, maxLogLines: 5,
@ -102,11 +102,11 @@ module.exports = (config) => {
failFast: false failFast: false
}, },
preprocessors: { preprocessors: {
"indexTest.js": ["webpack", "sourcemap"] 'indexTest.js': ['webpack', 'sourcemap']
}, },
webpack: webpackConfig, webpack: webpackConfig,
webpackMiddleware: { webpackMiddleware: {
stats: "errors-warnings" stats: 'errors-warnings'
}, },
concurrency: 1, concurrency: 1,
singleRun, singleRun,

View File

@ -1,37 +1,35 @@
{ {
"name": "openmct", "name": "openmct",
"version": "2.1.6-SNAPSHOT", "version": "2.1.3-SNAPSHOT",
"description": "The Open MCT core platform", "description": "The Open MCT core platform",
"devDependencies": { "devDependencies": {
"@babel/eslint-parser": "7.18.9", "@babel/eslint-parser": "7.18.9",
"@braintree/sanitize-url": "6.0.2", "@braintree/sanitize-url": "6.0.0",
"@percy/cli": "1.17.0", "@percy/cli": "1.11.0",
"@percy/playwright": "1.0.4", "@percy/playwright": "1.0.4",
"@playwright/test": "1.29.0", "@playwright/test": "1.25.2",
"@types/eventemitter3": "1.2.0", "@types/jasmine": "4.3.0",
"@types/jasmine": "4.3.1", "@types/lodash": "4.14.186",
"@types/lodash": "4.14.191", "babel-loader": "9.0.0",
"babel-loader": "9.1.0",
"babel-plugin-istanbul": "6.1.1", "babel-plugin-istanbul": "6.1.1",
"codecov": "3.8.3", "codecov": "3.8.3",
"comma-separated-values": "3.6.4", "comma-separated-values": "3.6.4",
"copy-webpack-plugin": "11.0.0", "copy-webpack-plugin": "11.0.0",
"css-loader": "6.7.3", "css-loader": "6.7.1",
"d3-axis": "3.0.0", "d3-axis": "3.0.0",
"d3-scale": "3.3.0", "d3-scale": "3.3.0",
"d3-selection": "3.0.0", "d3-selection": "3.0.0",
"eslint": "8.32.0", "eslint": "8.26.0",
"eslint-plugin-compat": "4.0.2", "eslint-plugin-compat": "4.0.2",
"eslint-plugin-playwright": "0.12.0", "eslint-plugin-playwright": "0.11.2",
"eslint-plugin-vue": "9.9.0", "eslint-plugin-vue": "9.7.0",
"eslint-plugin-you-dont-need-lodash-underscore": "6.12.0", "eslint-plugin-you-dont-need-lodash-underscore": "6.12.0",
"eventemitter3": "1.2.0", "eventemitter3": "1.2.0",
"file-saver": "2.0.5", "file-saver": "2.0.5",
"git-rev-sync": "3.0.2", "git-rev-sync": "3.0.2",
"git-revision-webpack-plugin": "5.0.0",
"html2canvas": "1.4.1", "html2canvas": "1.4.1",
"imports-loader": "4.0.1", "imports-loader": "4.0.1",
"jasmine-core": "4.5.0", "jasmine-core": "4.4.0",
"karma": "6.3.20", "karma": "6.3.20",
"karma-chrome-launcher": "3.1.1", "karma-chrome-launcher": "3.1.1",
"karma-cli": "2.0.0", "karma-cli": "2.0.0",
@ -40,49 +38,48 @@
"karma-jasmine": "5.1.0", "karma-jasmine": "5.1.0",
"karma-junit-reporter": "2.0.1", "karma-junit-reporter": "2.0.1",
"karma-sourcemap-loader": "0.3.8", "karma-sourcemap-loader": "0.3.8",
"karma-spec-reporter": "0.0.36", "karma-spec-reporter": "0.0.34",
"karma-webpack": "5.0.0", "karma-webpack": "5.0.0",
"kdbush": "^3.0.0",
"location-bar": "3.0.1", "location-bar": "3.0.1",
"lodash": "4.17.21", "lodash": "4.17.21",
"mini-css-extract-plugin": "2.7.2", "mini-css-extract-plugin": "2.6.1",
"moment": "2.29.4", "moment": "2.29.4",
"moment-duration-format": "2.3.2", "moment-duration-format": "2.3.2",
"moment-timezone": "0.5.40", "moment-timezone": "0.5.37",
"nyc": "15.1.0", "nyc": "15.1.0",
"painterro": "1.2.78", "painterro": "1.2.78",
"playwright-core": "1.29.0", "playwright-core": "1.25.2",
"plotly.js-basic-dist": "2.17.0", "plotly.js-basic-dist": "2.14.0",
"plotly.js-gl2d-dist": "2.17.1", "plotly.js-gl2d-dist": "2.14.0",
"printj": "1.3.1", "printj": "1.3.1",
"resolve-url-loader": "5.0.0", "resolve-url-loader": "5.0.0",
"sanitize-html": "2.8.1", "sass": "1.55.0",
"sass": "1.57.1", "sass-loader": "13.0.2",
"sass-loader": "13.2.0", "sinon": "14.0.1",
"sinon": "15.0.1",
"style-loader": "^3.3.1", "style-loader": "^3.3.1",
"typescript": "4.9.4", "typescript": "4.8.4",
"uuid": "9.0.0", "uuid": "9.0.0",
"vue": "2.6.14", "vue": "^3.1.0",
"@vue/compat": "^3.1.0",
"vue-eslint-parser": "9.1.0", "vue-eslint-parser": "9.1.0",
"vue-loader": "15.9.8", "vue-loader": "^16.0.0",
"vue-template-compiler": "2.6.14", "@vue/compiler-sfc": "^3.1.0",
"webpack": "5.74.0", "webpack": "5.74.0",
"webpack-cli": "5.0.0", "webpack-cli": "4.10.0",
"webpack-dev-server": "4.11.1", "webpack-dev-server": "4.11.1",
"webpack-merge": "5.8.0" "webpack-merge": "5.8.0"
}, },
"scripts": { "scripts": {
"clean": "rm -rf ./dist ./node_modules ./package-lock.json", "clean": "rm -rf ./dist ./node_modules ./package-lock.json",
"clean-test-lint": "npm run clean; npm install; npm run test; npm run lint", "clean-test-lint": "npm run clean; npm install; npm run test; npm run lint",
"start": "npx webpack serve --config ./.webpack/webpack.dev.js", "start": "npx webpack serve --config ./webpack.dev.js",
"start:coverage": "npx webpack serve --config ./.webpack/webpack.coverage.js", "start:coverage": "npx webpack serve --config ./webpack.coverage.js",
"lint": "eslint example src e2e --ext .js,.vue openmct.js --max-warnings=0", "lint": "eslint example src e2e --ext .js,.vue openmct.js --max-warnings=0",
"lint:fix": "eslint example src e2e --ext .js,.vue openmct.js --fix", "lint:fix": "eslint example src e2e --ext .js,.vue openmct.js --fix",
"build:prod": "webpack --config ./.webpack/webpack.prod.js", "build:prod": "webpack --config webpack.prod.js",
"build:dev": "webpack --config ./.webpack/webpack.dev.js", "build:dev": "webpack --config webpack.dev.js",
"build:coverage": "webpack --config ./.webpack/webpack.coverage.js", "build:coverage": "webpack --config webpack.coverage.js",
"build:watch": "webpack --config ./.webpack/webpack.dev.js --watch", "build:watch": "webpack --config webpack.dev.js --watch",
"info": "npx envinfo --system --browsers --npmPackages --binaries --languages --markdown", "info": "npx envinfo --system --browsers --npmPackages --binaries --languages --markdown",
"test": "karma start", "test": "karma start",
"test:debug": "KARMA_DEBUG=true karma start", "test:debug": "KARMA_DEBUG=true karma start",
@ -101,8 +98,7 @@
"cov:e2e:full:publish": "codecov --disable=gcov -f ./coverage/e2e/lcov.info -F e2e-full", "cov:e2e:full:publish": "codecov --disable=gcov -f ./coverage/e2e/lcov.info -F e2e-full",
"cov:e2e:stable:publish": "codecov --disable=gcov -f ./coverage/e2e/lcov.info -F e2e-stable", "cov:e2e:stable:publish": "codecov --disable=gcov -f ./coverage/e2e/lcov.info -F e2e-stable",
"cov:unit:publish": "codecov --disable=gcov -f ./coverage/unit/lcov.info -F unit", "cov:unit:publish": "codecov --disable=gcov -f ./coverage/unit/lcov.info -F unit",
"prepare": "npm run build:prod && npx tsc", "prepare": "npm run build:prod && npx tsc"
"prepack": "git rev-parse HEAD >> version.info; git rev-parse --abbrev-ref HEAD >> version.info"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
@ -119,5 +115,6 @@
"ios_saf > 15" "ios_saf > 15"
], ],
"author": "", "author": "",
"license": "Apache-2.0" "license": "Apache-2.0",
"private": true
} }

View File

@ -256,15 +256,6 @@ define([
}); });
}); });
/**
* MCT's annotation API that enables
* human-created comments and categorization linked to data products
* @type {module:openmct.AnnotationAPI}
* @memberof module:openmct.MCT#
* @name annotation
*/
this.annotation = new api.AnnotationAPI(this);
// Plugins that are installed by default // Plugins that are installed by default
this.install(this.plugins.Plot()); this.install(this.plugins.Plot());
this.install(this.plugins.TelemetryTable.default()); this.install(this.plugins.TelemetryTable.default());

View File

@ -56,12 +56,17 @@ export default class Editor extends EventEmitter {
* Save any unsaved changes from this editing session. This will * Save any unsaved changes from this editing session. This will
* end the current transaction. * end the current transaction.
*/ */
async save() { save() {
const transaction = this.openmct.objects.getActiveTransaction(); const transaction = this.openmct.objects.getActiveTransaction();
await transaction.commit();
return transaction.commit()
.then(() => {
this.editing = false; this.editing = false;
this.emit('isEditing', false); this.emit('isEditing', false);
this.openmct.objects.endTransaction(); this.openmct.objects.endTransaction();
}).catch(error => {
throw error;
});
} }
/** /**
@ -73,10 +78,6 @@ export default class Editor extends EventEmitter {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
const transaction = this.openmct.objects.getActiveTransaction(); const transaction = this.openmct.objects.getActiveTransaction();
if (!transaction) {
return resolve();
}
transaction.cancel() transaction.cancel()
.then(resolve) .then(resolve)
.catch(reject) .catch(reject)

View File

@ -52,29 +52,6 @@ const ANNOTATION_LAST_CREATED = 'annotationLastCreated';
* @property {String} foregroundColor eg. "#ffffff" * @property {String} foregroundColor eg. "#ffffff"
*/ */
/**
* @typedef {import('../objects/ObjectAPI').DomainObject} DomainObject
*/
/**
* @typedef {import('../objects/ObjectAPI').Identifier} Identifier
*/
/**
* @typedef {import('../../../openmct').OpenMCT} OpenMCT
*/
/**
* An interface for interacting with annotations of domain objects.
* An annotation of a domain object is an operator created object for the purposes
* of further describing data in plots, notebooks, maps, etc. For example, an annotation
* could be a tag on a plot notating an interesting set of points labeled SCIENCE. It could
* also be set of notebook entries the operator has tagged DRIVING when a robot monitored by OpenMCT
* about rationals behind why the robot has taken a certain path.
* Annotations are discoverable using search, and are typically rendered in OpenMCT views to bring attention
* to other users.
* @constructor
*/
export default class AnnotationAPI extends EventEmitter { export default class AnnotationAPI extends EventEmitter {
/** /**
@ -104,26 +81,24 @@ export default class AnnotationAPI extends EventEmitter {
} }
}); });
} }
/** /**
* Creates an annotation on a given domain object (e.g., a plot) and a set of targets (e.g., telemetry objects) * Create the a generic annotation
* @typedef {Object} CreateAnnotationOptions * @typedef {Object} CreateAnnotationOptions
* @property {String} name a name for the new annotation (e.g., "Plot annnotation") * @property {String} name a name for the new parameter
* @property {DomainObject} domainObject the domain object this annotation was created with * @property {import('../objects/ObjectAPI').DomainObject} domainObject the domain object to create
* @property {ANNOTATION_TYPES} annotationType the type of annotation to create (e.g., PLOT_SPATIAL) * @property {ANNOTATION_TYPES} annotationType the type of annotation to create
* @property {Tag[]} tags tags to add to the annotation, e.g., SCIENCE for science related annotations * @property {Tag[]} tags
* @property {String} contentText Some text to add to the annotation, e.g. ("This annotation is about science") * @property {String} contentText
* @property {Object<string, Object>} targets The targets ID keystrings and their specific properties. * @property {import('../objects/ObjectAPI').Identifier[]} targets
* For plots, this will be a bounding box, e.g.: {maxY: 100, minY: 0, maxX: 100, minX: 0}
* For notebooks, this will be an entry ID, e.g.: {entryId: "entry-ecb158f5-d23c-45e1-a704-649b382622ba"}
* @property {DomainObject>} targetDomainObjects the targets ID keystrings and the domain objects this annotation points to (e.g., telemetry objects for a plot)
*/ */
/** /**
* @method create * @method create
* @param {CreateAnnotationOptions} options * @param {CreateAnnotationOptions} options
* @returns {Promise<DomainObject>} a promise which will resolve when the domain object * @returns {Promise<import('../objects/ObjectAPI').DomainObject>} a promise which will resolve when the domain object
* has been created, or be rejected if it cannot be saved * has been created, or be rejected if it cannot be saved
*/ */
async create({name, domainObject, annotationType, tags, contentText, targets, targetDomainObjects}) { async create({name, domainObject, annotationType, tags, contentText, targets}) {
if (!Object.keys(this.ANNOTATION_TYPES).includes(annotationType)) { if (!Object.keys(this.ANNOTATION_TYPES).includes(annotationType)) {
throw new Error(`Unknown annotation type: ${annotationType}`); throw new Error(`Unknown annotation type: ${annotationType}`);
} }
@ -132,10 +107,6 @@ export default class AnnotationAPI extends EventEmitter {
throw new Error(`At least one target is required to create an annotation`); throw new Error(`At least one target is required to create an annotation`);
} }
if (!Object.keys(targetDomainObjects).length) {
throw new Error(`At least one targetDomainObject is required to create an annotation`);
}
const domainObjectKeyString = this.openmct.objects.makeKeyString(domainObject.identifier); const domainObjectKeyString = this.openmct.objects.makeKeyString(domainObject.identifier);
const originalPathObjects = await this.openmct.objects.getOriginalPath(domainObjectKeyString); const originalPathObjects = await this.openmct.objects.getOriginalPath(domainObjectKeyString);
const originalContextPath = this.openmct.objects.getRelativePath(originalPathObjects); const originalContextPath = this.openmct.objects.getRelativePath(originalPathObjects);
@ -168,9 +139,7 @@ export default class AnnotationAPI extends EventEmitter {
const success = await this.openmct.objects.save(createdObject); const success = await this.openmct.objects.save(createdObject);
if (success) { if (success) {
this.emit('annotationCreated', createdObject); this.emit('annotationCreated', createdObject);
Object.values(targetDomainObjects).forEach(targetDomainObject => { this.#updateAnnotationModified(domainObject);
this.#updateAnnotationModified(targetDomainObject);
});
return createdObject; return createdObject;
} else { } else {
@ -178,15 +147,8 @@ export default class AnnotationAPI extends EventEmitter {
} }
} }
#updateAnnotationModified(targetDomainObject) { #updateAnnotationModified(domainObject) {
// As certain telemetry objects are immutable, we'll need to check here first this.openmct.objects.mutate(domainObject, this.ANNOTATION_LAST_CREATED, Date.now());
// to see if we can add the annotation last created property.
// TODO: This should be removed once we have a better way to handle immutable telemetry objects
if (targetDomainObject.isMutable) {
this.openmct.objects.mutate(targetDomainObject, this.ANNOTATION_LAST_CREATED, Date.now());
} else {
this.emit('targetDomainObjectAnnotated', targetDomainObject);
}
} }
/** /**
@ -200,7 +162,7 @@ export default class AnnotationAPI extends EventEmitter {
/** /**
* @method isAnnotation * @method isAnnotation
* @param {DomainObject} domainObject the domainObject in question * @param {import('../objects/ObjectAPI').DomainObject} domainObject domainObject the domainObject in question
* @returns {Boolean} Returns true if the domain object is an annotation * @returns {Boolean} Returns true if the domain object is an annotation
*/ */
isAnnotation(domainObject) { isAnnotation(domainObject) {
@ -228,19 +190,56 @@ export default class AnnotationAPI extends EventEmitter {
/** /**
* @method getAnnotations * @method getAnnotations
* @param {Identifier} domainObjectIdentifier - The domain object identifier to use to search for annotations. For example, a telemetry object identifier. * @param {String} query - The keystring of the domain object to search for annotations for
* @returns {DomainObject[]} Returns an array of annotations that match the search query * @returns {import('../objects/ObjectAPI').DomainObject[]} Returns an array of domain objects that match the search query
*/ */
async getAnnotations(domainObjectIdentifier) { async getAnnotations(query) {
const keyStringQuery = this.openmct.objects.makeKeyString(domainObjectIdentifier); const searchResults = (await Promise.all(this.openmct.objects.search(query, null, this.openmct.objects.SEARCH_TYPES.ANNOTATIONS))).flat();
const searchResults = (await Promise.all(this.openmct.objects.search(keyStringQuery, null, this.openmct.objects.SEARCH_TYPES.ANNOTATIONS))).flat();
return searchResults; return searchResults;
} }
/**
* @method addSingleAnnotationTag
* @param {import('../objects/ObjectAPI').DomainObject=} existingAnnotation - An optional annotation to add the tag to. If not specified, we will create an annotation.
* @param {import('../objects/ObjectAPI').DomainObject} targetDomainObject - The domain object the annotation will point to.
* @param {Object=} targetSpecificDetails - Optional object to add to the target object. E.g., for notebooks this would be an entryID
* @param {AnnotationType} annotationType - The type of annotation this is for.
* @returns {import('../objects/ObjectAPI').DomainObject[]} Returns the annotation that was either created or passed as an existingAnnotation
*/
async addSingleAnnotationTag(existingAnnotation, targetDomainObject, targetSpecificDetails, annotationType, tag) {
if (!existingAnnotation) {
const targets = {};
const targetKeyString = this.openmct.objects.makeKeyString(targetDomainObject.identifier);
targets[targetKeyString] = targetSpecificDetails;
const contentText = `${annotationType} tag`;
const annotationCreationArguments = {
name: contentText,
domainObject: targetDomainObject,
annotationType,
tags: [tag],
contentText,
targets
};
const newAnnotation = await this.create(annotationCreationArguments);
return newAnnotation;
} else {
if (!existingAnnotation.tags.includes(tag)) {
throw new Error(`Existing annotation did not contain tag ${tag}`);
}
if (existingAnnotation._deleted) {
this.unDeleteAnnotation(existingAnnotation);
}
return existingAnnotation;
}
}
/** /**
* @method deleteAnnotations * @method deleteAnnotations
* @param {DomainObject[]} existingAnnotation - An array of annotations to delete (set _deleted to true) * @param {import('../objects/ObjectAPI').DomainObject[]} existingAnnotation - An array of annotations to delete (set _deleted to true)
*/ */
deleteAnnotations(annotations) { deleteAnnotations(annotations) {
if (!annotations) { if (!annotations) {
@ -256,7 +255,7 @@ export default class AnnotationAPI extends EventEmitter {
/** /**
* @method deleteAnnotations * @method deleteAnnotations
* @param {DomainObject} annotation - An annotation to undelete (set _deleted to false) * @param {import('../objects/ObjectAPI').DomainObject} existingAnnotation - An annotations to undelete (set _deleted to false)
*/ */
unDeleteAnnotation(annotation) { unDeleteAnnotation(annotation) {
if (!annotation) { if (!annotation) {
@ -266,39 +265,6 @@ export default class AnnotationAPI extends EventEmitter {
this.openmct.objects.mutate(annotation, '_deleted', false); this.openmct.objects.mutate(annotation, '_deleted', false);
} }
getTagsFromAnnotations(annotations, filterDuplicates = true) {
if (!annotations) {
return [];
}
let tagsFromAnnotations = annotations.flatMap((annotation) => {
if (annotation._deleted) {
return [];
} else {
return annotation.tags;
}
});
if (filterDuplicates) {
tagsFromAnnotations = tagsFromAnnotations.filter((tag, index, tagArray) => {
return tagArray.indexOf(tag) === index;
});
}
const fullTagModels = this.#addTagMetaInformationToTags(tagsFromAnnotations);
return fullTagModels;
}
#addTagMetaInformationToTags(tags) {
return tags.map(tagKey => {
const tagModel = this.availableTags[tagKey];
tagModel.tagID = tagKey;
return tagModel;
});
}
#getMatchingTags(query) { #getMatchingTags(query) {
if (!query) { if (!query) {
return []; return [];
@ -317,7 +283,12 @@ export default class AnnotationAPI extends EventEmitter {
#addTagMetaInformationToResults(results, matchingTagKeys) { #addTagMetaInformationToResults(results, matchingTagKeys) {
const tagsAddedToResults = results.map(result => { const tagsAddedToResults = results.map(result => {
const fullTagModels = this.#addTagMetaInformationToTags(result.tags); const fullTagModels = result.tags.map(tagKey => {
const tagModel = this.availableTags[tagKey];
tagModel.tagID = tagKey;
return tagModel;
});
return { return {
fullTagModels, fullTagModels,
@ -367,33 +338,6 @@ export default class AnnotationAPI extends EventEmitter {
return combinedResults; return combinedResults;
} }
/**
* @method #breakApartSeparateTargets
* @param {Array} results A set of search results that could have the multiple targets for the same result
* @returns {Array} The same set of results, but with each target separated out into its own result
*/
#breakApartSeparateTargets(results) {
const separateResults = [];
results.forEach(result => {
Object.keys(result.targets).forEach(targetID => {
const separatedResult = {
...result
};
separatedResult.targets = {
[targetID]: result.targets[targetID]
};
separatedResult.targetModels = result.targetModels.filter(targetModel => {
const targetKeyString = this.openmct.objects.makeKeyString(targetModel.identifier);
return targetKeyString === targetID;
});
separateResults.push(separatedResult);
});
});
return separateResults;
}
/** /**
* @method searchForTags * @method searchForTags
* @param {String} query A query to match against tags. E.g., "dr" will match the tags "drilling" and "driving" * @param {String} query A query to match against tags. E.g., "dr" will match the tags "drilling" and "driving"
@ -416,8 +360,7 @@ export default class AnnotationAPI extends EventEmitter {
const resultsWithValidPath = appliedTargetsModels.filter(result => { const resultsWithValidPath = appliedTargetsModels.filter(result => {
return this.openmct.objects.isReachable(result.targetModels?.[0]?.originalPath); return this.openmct.objects.isReachable(result.targetModels?.[0]?.originalPath);
}); });
const breakApartSeparateTargets = this.#breakApartSeparateTargets(resultsWithValidPath);
return breakApartSeparateTargets; return resultsWithValidPath;
} }
} }

View File

@ -108,7 +108,6 @@ describe("The Annotation API", () => {
annotationType: openmct.annotation.ANNOTATION_TYPES.NOTEBOOK, annotationType: openmct.annotation.ANNOTATION_TYPES.NOTEBOOK,
tags: ['sometag'], tags: ['sometag'],
contentText: "fooContext", contentText: "fooContext",
targetDomainObjects: [mockDomainObject],
targets: {'fooTarget': {}} targets: {'fooTarget': {}}
}; };
const annotationObject = await openmct.annotation.create(annotationCreationArguments); const annotationObject = await openmct.annotation.create(annotationCreationArguments);
@ -125,39 +124,27 @@ describe("The Annotation API", () => {
}); });
describe("Tagging", () => { describe("Tagging", () => {
let tagCreationArguments;
beforeEach(() => {
tagCreationArguments = {
name: 'Test Annotation',
domainObject: mockDomainObject,
annotationType: openmct.annotation.ANNOTATION_TYPES.NOTEBOOK,
tags: ['aWonderfulTag'],
contentText: 'fooContext',
targets: {'fooNameSpace:some-object': {entryId: 'fooBarEntry'}},
targetDomainObjects: [mockDomainObject]
};
});
it("can create a tag", async () => { it("can create a tag", async () => {
const annotationObject = await openmct.annotation.create(tagCreationArguments); const annotationObject = await openmct.annotation.addSingleAnnotationTag(null, mockDomainObject, {entryId: 'foo'}, openmct.annotation.ANNOTATION_TYPES.NOTEBOOK, 'aWonderfulTag');
expect(annotationObject).toBeDefined(); expect(annotationObject).toBeDefined();
expect(annotationObject.type).toEqual('annotation'); expect(annotationObject.type).toEqual('annotation');
expect(annotationObject.tags).toContain('aWonderfulTag'); expect(annotationObject.tags).toContain('aWonderfulTag');
}); });
it("can delete a tag", async () => { it("can delete a tag", async () => {
const annotationObject = await openmct.annotation.create(tagCreationArguments); const annotationObject = await openmct.annotation.addSingleAnnotationTag(null, mockDomainObject, {entryId: 'foo'}, openmct.annotation.ANNOTATION_TYPES.NOTEBOOK, 'aWonderfulTag');
expect(annotationObject).toBeDefined(); expect(annotationObject).toBeDefined();
openmct.annotation.deleteAnnotations([annotationObject]); openmct.annotation.deleteAnnotations([annotationObject]);
expect(annotationObject._deleted).toBeTrue(); expect(annotationObject._deleted).toBeTrue();
}); });
it("throws an error if deleting non-existent tag", async () => { it("throws an error if deleting non-existent tag", async () => {
const annotationObject = await openmct.annotation.create(tagCreationArguments); const annotationObject = await openmct.annotation.addSingleAnnotationTag(null, mockDomainObject, {entryId: 'foo'}, openmct.annotation.ANNOTATION_TYPES.NOTEBOOK, 'aWonderfulTag');
expect(annotationObject).toBeDefined(); expect(annotationObject).toBeDefined();
expect(() => { expect(() => {
openmct.annotation.removeAnnotationTag(annotationObject, 'ThisTagShouldNotExist'); openmct.annotation.removeAnnotationTag(annotationObject, 'ThisTagShouldNotExist');
}).toThrow(); }).toThrow();
}); });
it("can remove all tags", async () => { it("can remove all tags", async () => {
const annotationObject = await openmct.annotation.create(tagCreationArguments); const annotationObject = await openmct.annotation.addSingleAnnotationTag(null, mockDomainObject, {entryId: 'foo'}, openmct.annotation.ANNOTATION_TYPES.NOTEBOOK, 'aWonderfulTag');
expect(annotationObject).toBeDefined(); expect(annotationObject).toBeDefined();
expect(() => { expect(() => {
openmct.annotation.deleteAnnotations([annotationObject]); openmct.annotation.deleteAnnotations([annotationObject]);
@ -165,13 +152,13 @@ describe("The Annotation API", () => {
expect(annotationObject._deleted).toBeTrue(); expect(annotationObject._deleted).toBeTrue();
}); });
it("can add/delete/add a tag", async () => { it("can add/delete/add a tag", async () => {
let annotationObject = await openmct.annotation.create(tagCreationArguments); let annotationObject = await openmct.annotation.addSingleAnnotationTag(null, mockDomainObject, {entryId: 'foo'}, openmct.annotation.ANNOTATION_TYPES.NOTEBOOK, 'aWonderfulTag');
expect(annotationObject).toBeDefined(); expect(annotationObject).toBeDefined();
expect(annotationObject.type).toEqual('annotation'); expect(annotationObject.type).toEqual('annotation');
expect(annotationObject.tags).toContain('aWonderfulTag'); expect(annotationObject.tags).toContain('aWonderfulTag');
openmct.annotation.deleteAnnotations([annotationObject]); openmct.annotation.deleteAnnotations([annotationObject]);
expect(annotationObject._deleted).toBeTrue(); expect(annotationObject._deleted).toBeTrue();
annotationObject = await openmct.annotation.create(tagCreationArguments); annotationObject = await openmct.annotation.addSingleAnnotationTag(null, mockDomainObject, {entryId: 'foo'}, openmct.annotation.ANNOTATION_TYPES.NOTEBOOK, 'aWonderfulTag');
expect(annotationObject).toBeDefined(); expect(annotationObject).toBeDefined();
expect(annotationObject.type).toEqual('annotation'); expect(annotationObject.type).toEqual('annotation');
expect(annotationObject.tags).toContain('aWonderfulTag'); expect(annotationObject.tags).toContain('aWonderfulTag');

View File

@ -23,11 +23,13 @@
import FormController from './FormController'; import FormController from './FormController';
import FormProperties from './components/FormProperties.vue'; import FormProperties from './components/FormProperties.vue';
import EventEmitter from 'EventEmitter';
import Vue from 'vue'; import Vue from 'vue';
import _ from 'lodash';
export default class FormsAPI { export default class FormsAPI extends EventEmitter {
constructor(openmct) { constructor(openmct) {
super();
this.openmct = openmct; this.openmct = openmct;
this.formController = new FormController(openmct); this.formController = new FormController(openmct);
} }
@ -90,75 +92,29 @@ export default class FormsAPI {
/** /**
* Show form inside an Overlay dialog with given form structure * Show form inside an Overlay dialog with given form structure
* @public
* @param {Array<Section>} formStructure a form structure, array of section
* @param {Object} options
* @property {function} onChange a callback function when any changes detected
*/
showForm(formStructure, {
onChange
} = {}) {
let overlay;
const self = this;
const overlayEl = document.createElement('div');
overlayEl.classList.add('u-contents');
overlay = self.openmct.overlays.overlay({
element: overlayEl,
size: 'dialog'
});
let formSave;
let formCancel;
const promise = new Promise((resolve, reject) => {
formSave = resolve;
formCancel = reject;
});
this.showCustomForm(formStructure, {
element: overlayEl,
onChange
})
.then((response) => {
overlay.dismiss();
formSave(response);
})
.catch((response) => {
overlay.dismiss();
formCancel(response);
});
return promise;
}
/**
* Show form as a child of the element provided with given form structure
* *
* @public * @public
* @param {Array<Section>} formStructure a form structure, array of section * @param {Array<Section>} formStructure a form structure, array of section
* @param {Object} options * @param {Object} options
* @property {HTMLElement} element Parent Element to render a Form * @property {HTMLElement} element Parent Element to render a Form
* @property {function} onChange a callback function when any changes detected * @property {function} onChange a callback function when any changes detected
* @property {function} onSave a callback function when form is submitted
* @property {function} onDismiss a callback function when form is dismissed
*/ */
showCustomForm(formStructure, { showForm(formStructure, {
element, element,
onChange onChange
} = {}) { } = {}) {
if (element === undefined) { const changes = {};
throw Error('Required element parameter not provided'); let overlay;
} let onDismiss;
let onSave;
const self = this; const self = this;
const changes = {};
let formSave;
let formCancel;
const promise = new Promise((resolve, reject) => { const promise = new Promise((resolve, reject) => {
formSave = onFormAction(resolve); onSave = onFormAction(resolve);
formCancel = onFormAction(reject); onDismiss = onFormAction(reject);
}); });
const vm = new Vue({ const vm = new Vue({
@ -170,17 +126,26 @@ export default class FormsAPI {
return { return {
formStructure, formStructure,
onChange: onFormPropertyChange, onChange: onFormPropertyChange,
onCancel: formCancel, onDismiss,
onSave: formSave onSave
}; };
}, },
template: '<FormProperties :model="formStructure" @onChange="onChange" @onCancel="onCancel" @onSave="onSave"></FormProperties>' template: '<FormProperties :model="formStructure" @onChange="onChange" @onDismiss="onDismiss" @onSave="onSave"></FormProperties>'
}).$mount(); }).$mount();
const formElement = vm.$el; const formElement = vm.$el;
if (element) {
element.append(formElement); element.append(formElement);
} else {
overlay = self.openmct.overlays.overlay({
element: vm.$el,
size: 'dialog',
onDestroy: () => vm.$destroy()
});
}
function onFormPropertyChange(data) { function onFormPropertyChange(data) {
self.emit('onFormPropertyChange', data);
if (onChange) { if (onChange) {
onChange(data); onChange(data);
} }
@ -193,14 +158,17 @@ export default class FormsAPI {
key = property.join('.'); key = property.join('.');
} }
_.set(changes, key, data.value); changes[key] = data.value;
} }
} }
function onFormAction(callback) { function onFormAction(callback) {
return () => { return () => {
if (element) {
formElement.remove(); formElement.remove();
vm.$destroy(); } else {
overlay.dismiss();
}
if (callback) { if (callback) {
callback(changes); callback(changes);

View File

@ -133,7 +133,7 @@ describe('The Forms API', () => {
}); });
it('when container element is provided', (done) => { it('when container element is provided', (done) => {
openmct.forms.showCustomForm(formStructure, { element }).catch(() => { openmct.forms.showForm(formStructure, { element }).catch(() => {
done(); done();
}); });
const titleElement = element.querySelector('.c-overlay__dialog-title'); const titleElement = element.querySelector('.c-overlay__dialog-title');

View File

@ -73,7 +73,7 @@
tabindex="0" tabindex="0"
class="c-button js-cancel-button" class="c-button js-cancel-button"
aria-label="Cancel" aria-label="Cancel"
@click="onCancel" @click="onDismiss"
> >
{{ cancelLabel }} {{ cancelLabel }}
</button> </button>
@ -164,8 +164,8 @@ export default {
this.$emit('onChange', data); this.$emit('onChange', data);
}, },
onCancel() { onDismiss() {
this.$emit('onCancel'); this.$emit('onDismiss');
}, },
onSave() { onSave() {
this.$emit('onSave'); this.$emit('onSave');

View File

@ -30,7 +30,7 @@
id="fileElem" id="fileElem"
ref="fileInput" ref="fileInput"
type="file" type="file"
:accept="acceptableFileTypes" accept=".json"
style="display:none" style="display:none"
> >
<button <button
@ -72,13 +72,6 @@ export default {
}, },
removable() { removable() {
return (this.fileInfo || this.model.value) && this.model.removable; return (this.fileInfo || this.model.value) && this.model.removable;
},
acceptableFileTypes() {
if (this.model.type) {
return this.model.type;
}
return 'application/json';
} }
}, },
mounted() { mounted() {
@ -87,13 +80,7 @@ export default {
methods: { methods: {
handleFiles() { handleFiles() {
const fileList = this.$refs.fileInput.files; const fileList = this.$refs.fileInput.files;
const file = fileList[0]; this.readFile(fileList[0]);
if (this.acceptableFileTypes === 'application/json') {
this.readFile(file);
} else {
this.handleRawFile(file);
}
}, },
readFile(file) { readFile(file) {
const self = this; const self = this;
@ -117,21 +104,6 @@ export default {
fileReader.readAsText(file); fileReader.readAsText(file);
}, },
handleRawFile(file) {
const fileInfo = {
name: file.name,
body: file
};
this.fileInfo = Object.assign({}, fileInfo);
const data = {
model: this.model,
value: fileInfo
};
this.$emit('onChange', data);
},
selectFile() { selectFile() {
this.$refs.fileInput.click(); this.$refs.fileInput.click();
}, },

View File

@ -26,7 +26,6 @@
v-model="selected" v-model="selected"
required="model.required" required="model.required"
name="mctControl" name="mctControl"
:aria-label="model.ariaLabel || model.name"
@change="onChange($event)" @change="onChange($event)"
> >
<option <option

View File

@ -27,7 +27,6 @@
:class="model.cssClass" :class="model.cssClass"
> >
<textarea <textarea
:id="`${model.key}-textarea`"
v-model="field" v-model="field"
type="text" type="text"
:size="model.size" :size="model.size"

View File

@ -29,7 +29,6 @@
<ToggleSwitch <ToggleSwitch
id="switchId" id="switchId"
:checked="isChecked" :checked="isChecked"
:name="model.name"
@change="toggleCheckBox" @change="toggleCheckBox"
/> />
</span> </span>

View File

@ -3,21 +3,13 @@
class="c-menu" class="c-menu"
:class="options.menuClass" :class="options.menuClass"
> >
<ul <ul v-if="options.actions.length && options.actions[0].length">
v-if="options.actions.length && options.actions[0].length"
role="menu"
>
<template <template
v-for="(actionGroups, index) in options.actions" v-for="(actionGroups, index) in options.actions"
>
<div
:key="index"
role="group"
> >
<li <li
v-for="action in actionGroups" v-for="action in actionGroups"
:key="action.name" :key="action.name"
role="menuitem"
:class="[action.cssClass, action.isDisabled ? 'disabled' : '']" :class="[action.cssClass, action.isDisabled ? 'disabled' : '']"
:title="action.description" :title="action.description"
:data-testid="action.testId || false" :data-testid="action.testId || false"
@ -28,7 +20,6 @@
<div <div
v-if="index !== options.actions.length - 1" v-if="index !== options.actions.length - 1"
:key="index" :key="index"
role="separator"
class="c-menu__section-separator" class="c-menu__section-separator"
> >
</div> </div>
@ -38,17 +29,13 @@
> >
No actions defined. No actions defined.
</li> </li>
</div></template> </template>
</ul> </ul>
<ul <ul v-else>
v-else
role="menu"
>
<li <li
v-for="action in options.actions" v-for="action in options.actions"
:key="action.name" :key="action.name"
role="menuitem"
:class="[action.cssClass, action.isDisabled ? 'disabled' : '']" :class="[action.cssClass, action.isDisabled ? 'disabled' : '']"
:title="action.description" :title="action.description"
:data-testid="action.testId || false" :data-testid="action.testId || false"

View File

@ -5,20 +5,14 @@
> >
<ul <ul
v-if="options.actions.length && options.actions[0].length" v-if="options.actions.length && options.actions[0].length"
role="menu"
class="c-super-menu__menu" class="c-super-menu__menu"
> >
<template <template
v-for="(actionGroups, index) in options.actions" v-for="(actionGroups, index) in options.actions"
>
<div
:key="index"
role="group"
> >
<li <li
v-for="action in actionGroups" v-for="action in actionGroups"
:key="action.name" :key="action.name"
role="menuitem"
:class="[action.cssClass, action.isDisabled ? 'disabled' : '']" :class="[action.cssClass, action.isDisabled ? 'disabled' : '']"
:title="action.description" :title="action.description"
:data-testid="action.testId || false" :data-testid="action.testId || false"
@ -31,7 +25,6 @@
<div <div
v-if="index !== options.actions.length - 1" v-if="index !== options.actions.length - 1"
:key="index" :key="index"
role="separator"
class="c-menu__section-separator" class="c-menu__section-separator"
> >
</div> </div>
@ -41,18 +34,16 @@
> >
No actions defined. No actions defined.
</li> </li>
</div></template> </template>
</ul> </ul>
<ul <ul
v-else v-else
class="c-super-menu__menu" class="c-super-menu__menu"
role="menu"
> >
<li <li
v-for="action in options.actions" v-for="action in options.actions"
:key="action.name" :key="action.name"
role="menuitem"
:class="action.cssClass" :class="action.cssClass"
:title="action.description" :title="action.description"
:data-testid="action.testId || false" :data-testid="action.testId || false"

View File

@ -31,31 +31,7 @@
* @namespace platform/api/notifications * @namespace platform/api/notifications
*/ */
import moment from 'moment'; import moment from 'moment';
import EventEmitter from 'eventemitter3'; import EventEmitter from 'EventEmitter';
/**
* @typedef {object} NotificationProperties
* @property {function} dismiss Dismiss the notification
* @property {NotificationModel} model The Notification model
* @property {(progressPerc: number, progressText: string) => void} [progress] Update the progress of the notification
*/
/**
* @typedef {EventEmitter & NotificationProperties} Notification
*/
/**
* @typedef {object} NotificationLink
* @property {function} onClick The function to be called when the link is clicked
* @property {string} cssClass A CSS class name to style the link
* @property {string} text The text to be displayed for the link
*/
/**
* @typedef {object} NotificationOptions
* @property {number} [autoDismissTimeout] Milliseconds to wait before automatically dismissing the notification
* @property {NotificationLink} [link] A link for the notification
*/
/** /**
* A representation of a banner notification. Banner notifications * A representation of a banner notification. Banner notifications
@ -64,17 +40,13 @@ import EventEmitter from 'eventemitter3';
* dialogs so that the same information can be provided in a dialog * dialogs so that the same information can be provided in a dialog
* and then minimized to a banner notification if needed, or vice-versa. * and then minimized to a banner notification if needed, or vice-versa.
* *
* @see DialogModel
* @typedef {object} NotificationModel * @typedef {object} NotificationModel
* @property {string} message The message to be displayed by the notification * @property {string} message The message to be displayed by the notification
* @property {number | 'unknown'} [progress] The progress of some ongoing task. Should be a number between 0 and 100, or * @property {number | 'unknown'} [progress] The progress of some ongoing task. Should be a number between 0 and 100, or
* with the string literal 'unknown'. * with the string literal 'unknown'.
* @property {string} [progressText] A message conveying progress of some ongoing task. * @property {string} [progressText] A message conveying progress of some ongoing task.
* @property {string} [severity] The severity of the notification. Should be one of 'info', 'alert', or 'error'.
* @property {string} [timestamp] The time at which the notification was created. Should be a string in ISO 8601 format. * @see DialogModel
* @property {boolean} [minimized] Whether or not the notification has been minimized
* @property {boolean} [autoDismiss] Whether the notification should be automatically dismissed after a short period of time.
* @property {NotificationOptions} options The notification options
*/ */
const DEFAULT_AUTO_DISMISS_TIMEOUT = 3000; const DEFAULT_AUTO_DISMISS_TIMEOUT = 3000;
@ -83,19 +55,18 @@ const MINIMIZE_ANIMATION_TIMEOUT = 300;
/** /**
* The notification service is responsible for informing the user of * The notification service is responsible for informing the user of
* events via the use of banner notifications. * events via the use of banner notifications.
*/ * @memberof ui/notification
* @constructor */
export default class NotificationAPI extends EventEmitter { export default class NotificationAPI extends EventEmitter {
constructor() { constructor() {
super(); super();
/** @type {Notification[]} */
this.notifications = []; this.notifications = [];
/** @type {{severity: "info" | "alert" | "error"}} */
this.highest = { severity: "info" }; this.highest = { severity: "info" };
/** /*
* A context in which to hold the active notification and a * A context in which to hold the active notification and a
* handle to its timeout. * handle to its timeout.
* @type {Notification | undefined}
*/ */
this.activeNotification = undefined; this.activeNotification = undefined;
} }
@ -104,12 +75,16 @@ export default class NotificationAPI extends EventEmitter {
* Info notifications are low priority informational messages for the user. They will be auto-destroy after a brief * Info notifications are low priority informational messages for the user. They will be auto-destroy after a brief
* period of time. * period of time.
* @param {string} message The message to display to the user * @param {string} message The message to display to the user
* @param {NotificationOptions} [options] The notification options * @param {Object} [options] object with following properties
* @returns {Notification} * autoDismissTimeout: {number} in miliseconds to automatically dismisses notification
* link: {Object} Add a link to notifications for navigation
* onClick: callback function
* cssClass: css class name to add style on link
* text: text to display for link
* @returns {InfoNotification}
*/ */
info(message, options = {}) { info(message, options = {}) {
/** @type {NotificationModel} */ let notificationModel = {
const notificationModel = {
message: message, message: message,
autoDismiss: true, autoDismiss: true,
severity: "info", severity: "info",
@ -122,7 +97,7 @@ export default class NotificationAPI extends EventEmitter {
/** /**
* Present an alert to the user. * Present an alert to the user.
* @param {string} message The message to display to the user. * @param {string} message The message to display to the user.
* @param {NotificationOptions} [options] object with following properties * @param {Object} [options] object with following properties
* autoDismissTimeout: {number} in milliseconds to automatically dismisses notification * autoDismissTimeout: {number} in milliseconds to automatically dismisses notification
* link: {Object} Add a link to notifications for navigation * link: {Object} Add a link to notifications for navigation
* onClick: callback function * onClick: callback function
@ -131,7 +106,7 @@ export default class NotificationAPI extends EventEmitter {
* @returns {Notification} * @returns {Notification}
*/ */
alert(message, options = {}) { alert(message, options = {}) {
const notificationModel = { let notificationModel = {
message: message, message: message,
severity: "alert", severity: "alert",
options options
@ -172,8 +147,7 @@ export default class NotificationAPI extends EventEmitter {
message: message, message: message,
progressPerc: progressPerc, progressPerc: progressPerc,
progressText: progressText, progressText: progressText,
severity: "info", severity: "info"
options: {}
}; };
return this._notify(notificationModel); return this._notify(notificationModel);
@ -191,13 +165,8 @@ export default class NotificationAPI extends EventEmitter {
* dismissed. * dismissed.
* *
* @private * @private
* @param {Notification | undefined} notification
*/ */
_minimize(notification) { _minimize(notification) {
if (!notification) {
return;
}
//Check this is a known notification //Check this is a known notification
let index = this.notifications.indexOf(notification); let index = this.notifications.indexOf(notification);
@ -235,13 +204,8 @@ export default class NotificationAPI extends EventEmitter {
* dismiss * dismiss
* *
* @private * @private
* @param {Notification | undefined} notification
*/ */
_dismiss(notification) { _dismiss(notification) {
if (!notification) {
return;
}
//Check this is a known notification //Check this is a known notification
let index = this.notifications.indexOf(notification); let index = this.notifications.indexOf(notification);
@ -272,11 +236,10 @@ export default class NotificationAPI extends EventEmitter {
* dismiss or minimize where appropriate. * dismiss or minimize where appropriate.
* *
* @private * @private
* @param {Notification | undefined} notification
*/ */
_dismissOrMinimize(notification) { _dismissOrMinimize(notification) {
let model = notification?.model; let model = notification.model;
if (model?.severity === "info") { if (model.severity === "info") {
this._dismiss(notification); this._dismiss(notification);
} else { } else {
this._minimize(notification); this._minimize(notification);
@ -288,11 +251,10 @@ export default class NotificationAPI extends EventEmitter {
*/ */
_setHighestSeverity() { _setHighestSeverity() {
let severity = { let severity = {
info: 1, "info": 1,
alert: 2, "alert": 2,
error: 3 "error": 3
}; };
this.highest.severity = this.notifications.reduce((previous, notification) => { this.highest.severity = this.notifications.reduce((previous, notification) => {
if (severity[notification.model.severity] > severity[previous]) { if (severity[notification.model.severity] > severity[previous]) {
return notification.model.severity; return notification.model.severity;
@ -350,11 +312,8 @@ export default class NotificationAPI extends EventEmitter {
/** /**
* @private * @private
* @param {NotificationModel} notificationModel
* @returns {Notification}
*/ */
_createNotification(notificationModel) { _createNotification(notificationModel) {
/** @type {Notification} */
let notification = new EventEmitter(); let notification = new EventEmitter();
notification.model = notificationModel; notification.model = notificationModel;
notification.dismiss = () => { notification.dismiss = () => {
@ -374,7 +333,6 @@ export default class NotificationAPI extends EventEmitter {
/** /**
* @private * @private
* @param {Notification | undefined} notification
*/ */
_setActiveNotification(notification) { _setActiveNotification(notification) {
this.activeNotification = notification; this.activeNotification = notification;

View File

@ -19,7 +19,6 @@
* this source code distribution or the Licensing information page available * this source code distribution or the Licensing information page available
* at runtime from the About dialog for additional information. * at runtime from the About dialog for additional information.
*****************************************************************************/ *****************************************************************************/
const DEFAULT_INTERCEPTOR_PRIORITY = 0;
export default class InterceptorRegistry { export default class InterceptorRegistry {
/** /**
* A InterceptorRegistry maintains the definitions for different interceptors that may be invoked on domain objects. * A InterceptorRegistry maintains the definitions for different interceptors that may be invoked on domain objects.
@ -46,6 +45,7 @@ export default class InterceptorRegistry {
* @memberof module:openmct.InterceptorRegistry# * @memberof module:openmct.InterceptorRegistry#
*/ */
addInterceptor(interceptorDef) { addInterceptor(interceptorDef) {
//TODO: sort by priority
this.interceptors.push(interceptorDef); this.interceptors.push(interceptorDef);
} }
@ -56,18 +56,10 @@ export default class InterceptorRegistry {
* @memberof module:openmct.InterceptorRegistry# * @memberof module:openmct.InterceptorRegistry#
*/ */
getInterceptors(identifier, object) { getInterceptors(identifier, object) {
function byPriority(interceptorA, interceptorB) {
let priorityA = interceptorA.priority ?? DEFAULT_INTERCEPTOR_PRIORITY;
let priorityB = interceptorB.priority ?? DEFAULT_INTERCEPTOR_PRIORITY;
return priorityB - priorityA;
}
return this.interceptors.filter(interceptor => { return this.interceptors.filter(interceptor => {
return typeof interceptor.appliesTo === 'function' return typeof interceptor.appliesTo === 'function'
&& interceptor.appliesTo(identifier, object); && interceptor.appliesTo(identifier, object);
}).sort(byPriority); });
} }
} }

View File

@ -75,7 +75,11 @@ class MutableDomainObject {
return eventOff; return eventOff;
} }
$set(path, value) { $set(path, value) {
MutableDomainObject.mutateObject(this, path, value); _.set(this, path, value);
if (path !== 'persisted' && path !== 'modified') {
_.set(this, 'modified', Date.now());
}
//Emit secret synchronization event first, so that all objects are in sync before subsequent events fired. //Emit secret synchronization event first, so that all objects are in sync before subsequent events fired.
this._globalEventEmitter.emit(qualifiedEventName(this, '$_synchronize_model'), this); this._globalEventEmitter.emit(qualifiedEventName(this, '$_synchronize_model'), this);
@ -132,11 +136,8 @@ class MutableDomainObject {
} }
static mutateObject(object, path, value) { static mutateObject(object, path, value) {
if (path !== 'persisted') {
_.set(object, 'modified', Date.now());
}
_.set(object, path, value); _.set(object, path, value);
_.set(object, 'modified', Date.now());
} }
} }

View File

@ -189,17 +189,16 @@ export default class ObjectAPI {
/** /**
* Get a domain object. * Get a domain object.
* *
* @method get
* @memberof module:openmct.ObjectProvider#
* @param {string} key the key for the domain object to load * @param {string} key the key for the domain object to load
* @param {AbortSignal} abortSignal (optional) signal to abort fetch requests * @param {AbortController.signal} abortSignal (optional) signal to abort fetch requests
* @param {boolean} [forceRemote=false] defaults to false. If true, will skip cached and * @returns {Promise} a promise which will resolve when the domain object
* dirty/in-transaction objects use and the provider.get method
* @returns {Promise<DomainObject>} a promise which will resolve when the domain object
* has been saved, or be rejected if it cannot be saved * has been saved, or be rejected if it cannot be saved
*/ */
get(identifier, abortSignal, forceRemote = false) { get(identifier, abortSignal) {
let keystring = this.makeKeyString(identifier); let keystring = this.makeKeyString(identifier);
if (!forceRemote) {
if (this.cache[keystring] !== undefined) { if (this.cache[keystring] !== undefined) {
return this.cache[keystring]; return this.cache[keystring];
} }
@ -213,12 +212,11 @@ export default class ObjectAPI {
return Promise.resolve(dirtyObject); return Promise.resolve(dirtyObject);
} }
} }
}
const provider = this.getProvider(identifier); const provider = this.getProvider(identifier);
if (!provider) { if (!provider) {
throw new Error(`No Provider Matched for keyString "${this.makeKeyString(identifier)}}"`); throw new Error('No Provider Matched');
} }
if (!provider.get) { if (!provider.get) {
@ -359,13 +357,13 @@ export default class ObjectAPI {
async save(domainObject) { async save(domainObject) {
const provider = this.getProvider(domainObject.identifier); const provider = this.getProvider(domainObject.identifier);
let result; let result;
let lastPersistedTime;
if (!this.isPersistable(domainObject.identifier)) { if (!this.isPersistable(domainObject.identifier)) {
result = Promise.reject('Object provider does not support saving'); result = Promise.reject('Object provider does not support saving');
} else if (this.#hasAlreadyBeenPersisted(domainObject)) { } else if (this.#hasAlreadyBeenPersisted(domainObject)) {
result = Promise.resolve(true); result = Promise.resolve(true);
} else { } else {
const persistedTime = Date.now();
const username = await this.#getCurrentUsername(); const username = await this.#getCurrentUsername();
const isNewObject = domainObject.persisted === undefined; const isNewObject = domainObject.persisted === undefined;
let savedResolve; let savedResolve;
@ -377,22 +375,15 @@ export default class ObjectAPI {
savedReject = reject; savedReject = reject;
}); });
this.#mutate(domainObject, 'persisted', persistedTime);
this.#mutate(domainObject, 'modifiedBy', username); this.#mutate(domainObject, 'modifiedBy', username);
if (isNewObject) { if (isNewObject) {
this.#mutate(domainObject, 'created', persistedTime);
this.#mutate(domainObject, 'createdBy', username); this.#mutate(domainObject, 'createdBy', username);
const createdTime = Date.now();
this.#mutate(domainObject, 'created', createdTime);
const persistedTime = Date.now();
this.#mutate(domainObject, 'persisted', persistedTime);
savedObjectPromise = provider.create(domainObject); savedObjectPromise = provider.create(domainObject);
} else { } else {
lastPersistedTime = domainObject.persisted;
const persistedTime = Date.now();
this.#mutate(domainObject, 'persisted', persistedTime);
savedObjectPromise = provider.update(domainObject); savedObjectPromise = provider.update(domainObject);
} }
@ -400,10 +391,6 @@ export default class ObjectAPI {
savedObjectPromise.then(response => { savedObjectPromise.then(response => {
savedResolve(response); savedResolve(response);
}).catch((error) => { }).catch((error) => {
if (!isNewObject) {
this.#mutate(domainObject, 'persisted', lastPersistedTime);
}
savedReject(error); savedReject(error);
}); });
} else { } else {
@ -411,20 +398,9 @@ export default class ObjectAPI {
} }
} }
return result.catch(async (error) => { return result.catch((error) => {
if (error instanceof this.errors.Conflict) { if (error instanceof this.errors.Conflict) {
// Synchronized objects will resolve their own conflicts
if (this.SYNCHRONIZED_OBJECT_TYPES.includes(domainObject.type)) {
this.openmct.notifications.info(`Conflict detected while saving "${this.makeKeyString(domainObject.name)}", attempting to resolve`);
} else {
this.openmct.notifications.error(`Conflict detected while saving ${this.makeKeyString(domainObject.identifier)}`); this.openmct.notifications.error(`Conflict detected while saving ${this.makeKeyString(domainObject.identifier)}`);
if (this.isTransactionActive()) {
this.endTransaction();
}
await this.refresh(domainObject);
}
} }
throw error; throw error;
@ -738,46 +714,6 @@ export default class ObjectAPI {
} }
} }
/**
* Parse and construct an `objectPath` from a `navigationPath`.
*
* A `navigationPath` is a string of the form `"/browse/<keyString>/<keyString>/..."` that is used
* by the Open MCT router to navigate to a specific object.
*
* Throws an error if the `navigationPath` is malformed.
*
* @param {string} navigationPath
* @returns {DomainObject[]} objectPath
*/
async getRelativeObjectPath(navigationPath) {
if (!navigationPath.startsWith('/browse/')) {
throw new Error(`Malformed navigation path: "${navigationPath}"`);
}
navigationPath = navigationPath.replace('/browse/', '');
if (!navigationPath || navigationPath === '/') {
return [];
}
// Remove any query params and split on '/'
const keyStrings = navigationPath.split('?')?.[0].split('/');
if (keyStrings[0] !== 'ROOT') {
keyStrings.unshift('ROOT');
}
const objectPath = (await Promise.all(
keyStrings.map(
keyString => this.supportsMutation(keyString)
? this.getMutable(utils.parseKeyString(keyString))
: this.get(utils.parseKeyString(keyString))
)
)).reverse();
return objectPath;
}
isObjectPathToALink(domainObject, objectPath) { isObjectPathToALink(domainObject, objectPath) {
return objectPath !== undefined return objectPath !== undefined
&& objectPath.length > 1 && objectPath.length > 1

View File

@ -94,35 +94,6 @@ describe("The Object API", () => {
expect(mockProvider.create).not.toHaveBeenCalled(); expect(mockProvider.create).not.toHaveBeenCalled();
expect(mockProvider.update).toHaveBeenCalled(); expect(mockProvider.update).toHaveBeenCalled();
}); });
describe("the persisted timestamp for existing objects", () => {
let persistedTimestamp;
beforeEach(() => {
persistedTimestamp = Date.now() - FIFTEEN_MINUTES;
mockDomainObject.persisted = persistedTimestamp;
mockDomainObject.modified = Date.now();
});
it("is updated", async () => {
await objectAPI.save(mockDomainObject);
expect(mockDomainObject.persisted).toBeDefined();
expect(mockDomainObject.persisted > persistedTimestamp).toBe(true);
});
it("is >= modified timestamp", async () => {
await objectAPI.save(mockDomainObject);
expect(mockDomainObject.persisted >= mockDomainObject.modified).toBe(true);
});
});
describe("the persisted timestamp for new objects", () => {
it("is updated", async () => {
await objectAPI.save(mockDomainObject);
expect(mockDomainObject.persisted).toBeDefined();
});
it("is >= modified timestamp", async () => {
await objectAPI.save(mockDomainObject);
expect(mockDomainObject.persisted >= mockDomainObject.modified).toBe(true);
});
});
it("Sets the current user for 'createdBy' on new objects", async () => { it("Sets the current user for 'createdBy' on new objects", async () => {
await objectAPI.save(mockDomainObject); await objectAPI.save(mockDomainObject);
expect(mockDomainObject.createdBy).toBe(USERNAME); expect(mockDomainObject.createdBy).toBe(USERNAME);

View File

@ -17,7 +17,6 @@ class Overlay extends EventEmitter {
dismissable = true, dismissable = true,
element, element,
onDestroy, onDestroy,
onDismiss,
size size
} = {}) { } = {}) {
super(); super();
@ -33,7 +32,7 @@ class Overlay extends EventEmitter {
OverlayComponent: OverlayComponent OverlayComponent: OverlayComponent
}, },
provide: { provide: {
dismiss: this.notifyAndDismiss.bind(this), dismiss: this.dismiss.bind(this),
element, element,
buttons, buttons,
dismissable: this.dismissable dismissable: this.dismissable
@ -44,10 +43,6 @@ class Overlay extends EventEmitter {
if (onDestroy) { if (onDestroy) {
this.once('destroy', onDestroy); this.once('destroy', onDestroy);
} }
if (onDismiss) {
this.once('dismiss', onDismiss);
}
} }
dismiss() { dismiss() {
@ -56,12 +51,6 @@ class Overlay extends EventEmitter {
this.component.$destroy(); this.component.$destroy();
} }
//Ensures that any callers are notified that the overlay is dismissed
notifyAndDismiss() {
this.emit('dismiss');
this.dismiss();
}
/** /**
* @private * @private
**/ **/

View File

@ -55,7 +55,7 @@ class OverlayAPI {
dismissLastOverlay() { dismissLastOverlay() {
let lastOverlay = this.activeOverlays[this.activeOverlays.length - 1]; let lastOverlay = this.activeOverlays[this.activeOverlays.length - 1];
if (lastOverlay && lastOverlay.dismissable) { if (lastOverlay && lastOverlay.dismissable) {
lastOverlay.notifyAndDismiss(); lastOverlay.dismiss();
} }
} }

View File

@ -15,8 +15,6 @@
ref="element" ref="element"
class="c-overlay__contents js-notebook-snapshot-item-wrapper" class="c-overlay__contents js-notebook-snapshot-item-wrapper"
tabindex="0" tabindex="0"
aria-modal="true"
role="dialog"
></div> ></div>
<div <div
v-if="buttons" v-if="buttons"

View File

@ -36,7 +36,6 @@ export default class TelemetryAPI {
this.formatMapCache = new WeakMap(); this.formatMapCache = new WeakMap();
this.formatters = new Map(); this.formatters = new Map();
this.limitProviders = []; this.limitProviders = [];
this.stalenessProviders = [];
this.metadataCache = new WeakMap(); this.metadataCache = new WeakMap();
this.metadataProviders = [new DefaultMetadataProvider(this.openmct)]; this.metadataProviders = [new DefaultMetadataProvider(this.openmct)];
this.noRequestProviderForAllObjects = false; this.noRequestProviderForAllObjects = false;
@ -115,10 +114,6 @@ export default class TelemetryAPI {
if (provider.supportsLimits) { if (provider.supportsLimits) {
this.limitProviders.unshift(provider); this.limitProviders.unshift(provider);
} }
if (provider.supportsStaleness) {
this.stalenessProviders.unshift(provider);
}
} }
/** /**
@ -130,7 +125,7 @@ export default class TelemetryAPI {
return provider.supportsSubscribe.apply(provider, args); return provider.supportsSubscribe.apply(provider, args);
} }
return this.subscriptionProviders.find(supportsDomainObject); return this.subscriptionProviders.filter(supportsDomainObject)[0];
} }
/** /**
@ -143,25 +138,25 @@ export default class TelemetryAPI {
return provider.supportsRequest.apply(provider, args); return provider.supportsRequest.apply(provider, args);
} }
return this.requestProviders.find(supportsDomainObject); return this.requestProviders.filter(supportsDomainObject)[0];
} }
/** /**
* @private * @private
*/ */
#findMetadataProvider(domainObject) { #findMetadataProvider(domainObject) {
return this.metadataProviders.find((provider) => { return this.metadataProviders.filter(function (p) {
return provider.supportsMetadata(domainObject); return p.supportsMetadata(domainObject);
}); })[0];
} }
/** /**
* @private * @private
*/ */
#findLimitEvaluator(domainObject) { #findLimitEvaluator(domainObject) {
return this.limitProviders.find((provider) => { return this.limitProviders.filter(function (p) {
return provider.supportsLimits(domainObject); return p.supportsLimits(domainObject);
}); })[0];
} }
/** /**
@ -356,101 +351,6 @@ export default class TelemetryAPI {
}.bind(this); }.bind(this);
} }
/**
* Subscribe to staleness updates for a specific domain object.
* The callback will be called whenever staleness changes.
*
* @method subscribeToStaleness
* @memberof module:openmct.TelemetryAPI~StalenessProvider#
* @param {module:openmct.DomainObject} domainObject the object
* to watch for staleness updates
* @param {Function} callback the callback to invoke with staleness data,
* as it is received: ex.
* {
* isStale: <Boolean>,
* timestamp: <timestamp>
* }
* @returns {Function} a function which may be called to terminate
* the subscription to staleness updates
*/
subscribeToStaleness(domainObject, callback) {
const provider = this.#findStalenessProvider(domainObject);
if (!this.stalenessSubscriberCache) {
this.stalenessSubscriberCache = {};
}
const keyString = objectUtils.makeKeyString(domainObject.identifier);
let stalenessSubscriber = this.stalenessSubscriberCache[keyString];
if (!stalenessSubscriber) {
stalenessSubscriber = this.stalenessSubscriberCache[keyString] = {
callbacks: [callback]
};
if (provider) {
stalenessSubscriber.unsubscribe = provider
.subscribeToStaleness(domainObject, (stalenessResponse) => {
stalenessSubscriber.callbacks.forEach((cb) => {
cb(stalenessResponse);
});
});
} else {
stalenessSubscriber.unsubscribe = () => {};
}
} else {
stalenessSubscriber.callbacks.push(callback);
}
return function unsubscribe() {
stalenessSubscriber.callbacks = stalenessSubscriber.callbacks.filter((cb) => {
return cb !== callback;
});
if (stalenessSubscriber.callbacks.length === 0) {
stalenessSubscriber.unsubscribe();
delete this.stalenessSubscriberCache[keyString];
}
}.bind(this);
}
/**
* Request telemetry staleness for a domain object.
*
* @method isStale
* @memberof module:openmct.TelemetryAPI~StalenessProvider#
* @param {module:openmct.DomainObject} domainObject the object
* which has associated telemetry staleness
* @returns {Promise.<StalenessResponseObject>} a promise for a StalenessResponseObject
* or undefined if no provider exists
*/
async isStale(domainObject) {
const provider = this.#findStalenessProvider(domainObject);
if (!provider) {
return;
}
const abortController = new AbortController();
const options = { signal: abortController.signal };
this.requestAbortControllers.add(abortController);
try {
const staleness = await provider.isStale(domainObject, options);
return staleness;
} finally {
this.requestAbortControllers.delete(abortController);
}
}
/**
* @private
*/
#findStalenessProvider(domainObject) {
return this.stalenessProviders.find((provider) => {
return provider.supportsStaleness(domainObject);
});
}
/** /**
* Get telemetry metadata for a given domain object. Returns a telemetry * Get telemetry metadata for a given domain object. Returns a telemetry
* metadata manager which provides methods for interrogating telemetry * metadata manager which provides methods for interrogating telemetry
@ -761,29 +661,6 @@ export default class TelemetryAPI {
* @memberof module:openmct.TelemetryAPI~ * @memberof module:openmct.TelemetryAPI~
*/ */
/**
* Provides telemetry staleness data. To subscribe to telemetry stalenes,
* new StalenessProvider implementations should be
* [registered]{@link module:openmct.TelemetryAPI#addProvider}.
*
* @interface StalenessProvider
* @property {function} supportsStaleness receieves a domainObject and
* returns a boolean to indicate it will provide staleness
* @property {function} subscribeToStaleness receieves a domainObject to
* be subscribed to and a callback to invoke with a StalenessResponseObject
* @property {function} isStale an asynchronous method called with a domainObject
* and an options object which currently has an abort signal, ex.
* { signal: <AbortController.signal> }
* this method should return a current StalenessResponseObject
* @memberof module:openmct.TelemetryAPI~
*/
/**
* @typedef {object} StalenessResponseObject
* @property {Boolean} isStale boolean representing the staleness state
* @property {Number} timestamp Unix timestamp in milliseconds
*/
/** /**
* An interface for retrieving telemetry data associated with a domain * An interface for retrieving telemetry data associated with a domain
* object. * object.

View File

@ -202,13 +202,8 @@ class IndependentTimeContext extends TimeContext {
} }
getUpstreamContext() { getUpstreamContext() {
const objectKey = this.openmct.objects.makeKeyString(this.objectPath[this.objectPath.length - 1].identifier);
const doesObjectHaveTimeContext = this.globalTimeContext.independentContexts.get(objectKey);
if (doesObjectHaveTimeContext) {
return undefined;
}
let timeContext = this.globalTimeContext; let timeContext = this.globalTimeContext;
this.objectPath.some((item, index) => { this.objectPath.some((item, index) => {
const key = this.openmct.objects.makeKeyString(item.identifier); const key = this.openmct.objects.makeKeyString(item.identifier);
//last index is the view object itself //last index is the view object itself

View File

@ -291,6 +291,5 @@ export default class StatusAPI extends EventEmitter {
* The Status type * The Status type
* @typedef {Object} Status * @typedef {Object} Status
* @property {String} key - A unique identifier for this status * @property {String} key - A unique identifier for this status
* @property {String} label - A human readable label for this status * @property {Number} label - A human readable label for this status
* @property {Number} timestamp - The time that the status was set.
*/ */

View File

@ -29,7 +29,7 @@
<td class="js-second-data">{{ formattedTimestamp }}</td> <td class="js-second-data">{{ formattedTimestamp }}</td>
<td <td
class="js-third-data" class="js-third-data"
:class="valueClasses" :class="valueClass"
>{{ value }}</td> >{{ value }}</td>
<td <td
v-if="hasUnits" v-if="hasUnits"
@ -63,12 +63,6 @@ export default {
hasUnits: { hasUnits: {
type: Boolean, type: Boolean,
requred: true requred: true
},
isStale: {
type: Boolean,
default() {
return false;
}
} }
}, },
data() { data() {
@ -87,22 +81,14 @@ export default {
return this.formats[this.valueKey].format(this.datum); return this.formats[this.valueKey].format(this.datum);
}, },
valueClasses() { valueClass() {
let classes = []; if (!this.datum) {
return '';
if (this.isStale) {
classes.push('is-stale');
} }
if (this.datum) {
const limit = this.limitEvaluator.evaluate(this.datum, this.valueMetadata); const limit = this.limitEvaluator.evaluate(this.datum, this.valueMetadata);
if (limit) { return limit ? limit.cssClass : '';
classes.push(limit.cssClass);
}
}
return classes;
}, },
formattedTimestamp() { formattedTimestamp() {

View File

@ -21,10 +21,7 @@
*****************************************************************************/ *****************************************************************************/
<template> <template>
<div <div class="c-lad-table-wrapper u-style-receiver js-style-receiver">
class="c-lad-table-wrapper u-style-receiver js-style-receiver"
:class="staleClass"
>
<table class="c-table c-lad-table"> <table class="c-table c-lad-table">
<thead> <thead>
<tr> <tr>
@ -41,7 +38,6 @@
:domain-object="ladRow.domainObject" :domain-object="ladRow.domainObject"
:path-to-table="objectPath" :path-to-table="objectPath"
:has-units="hasUnits" :has-units="hasUnits"
:is-stale="staleObjects.includes(ladRow.key)"
@rowContextClick="updateViewContext" @rowContextClick="updateViewContext"
/> />
</tbody> </tbody>
@ -50,9 +46,7 @@
</template> </template>
<script> <script>
import LadRow from './LADRow.vue'; import LadRow from './LADRow.vue';
import StalenessUtils from '@/utils/staleness';
export default { export default {
components: { components: {
@ -72,8 +66,7 @@ export default {
data() { data() {
return { return {
items: [], items: [],
viewContext: {}, viewContext: {}
staleObjects: []
}; };
}, },
computed: { computed: {
@ -87,13 +80,6 @@ export default {
}); });
return itemsWithUnits.length !== 0; return itemsWithUnits.length !== 0;
},
staleClass() {
if (this.staleObjects.length !== 0) {
return 'is-stale';
}
return '';
} }
}, },
mounted() { mounted() {
@ -102,17 +88,11 @@ export default {
this.composition.on('remove', this.removeItem); this.composition.on('remove', this.removeItem);
this.composition.on('reorder', this.reorder); this.composition.on('reorder', this.reorder);
this.composition.load(); this.composition.load();
this.stalenessSubscription = {};
}, },
destroyed() { destroyed() {
this.composition.off('add', this.addItem); this.composition.off('add', this.addItem);
this.composition.off('remove', this.removeItem); this.composition.off('remove', this.removeItem);
this.composition.off('reorder', this.reorder); this.composition.off('reorder', this.reorder);
Object.values(this.stalenessSubscription).forEach(stalenessSubscription => {
stalenessSubscription.unsubscribe();
stalenessSubscription.stalenessUtils.destroy();
});
}, },
methods: { methods: {
addItem(domainObject) { addItem(domainObject) {
@ -121,55 +101,23 @@ export default {
item.key = this.openmct.objects.makeKeyString(domainObject.identifier); item.key = this.openmct.objects.makeKeyString(domainObject.identifier);
this.items.push(item); this.items.push(item);
this.stalenessSubscription[item.key] = {};
this.stalenessSubscription[item.key].stalenessUtils = new StalenessUtils(this.openmct, domainObject);
this.openmct.telemetry.isStale(domainObject).then((stalenessResponse) => {
if (stalenessResponse !== undefined) {
this.handleStaleness(item.key, stalenessResponse);
}
});
const stalenessSubscription = this.openmct.telemetry.subscribeToStaleness(domainObject, (stalenessResponse) => {
this.handleStaleness(item.key, stalenessResponse);
});
this.stalenessSubscription[item.key].unsubscribe = stalenessSubscription;
}, },
removeItem(identifier) { removeItem(identifier) {
const SKIP_CHECK = true; let index = this.items.findIndex(item => this.openmct.objects.makeKeyString(identifier) === item.key);
const keystring = this.openmct.objects.makeKeyString(identifier);
const index = this.items.findIndex(item => keystring === item.key);
this.items.splice(index, 1); this.items.splice(index, 1);
this.stalenessSubscription[keystring].unsubscribe();
this.handleStaleness(keystring, { isStale: false }, SKIP_CHECK);
}, },
reorder(reorderPlan) { reorder(reorderPlan) {
const oldItems = this.items.slice(); let oldItems = this.items.slice();
reorderPlan.forEach((reorderEvent) => { reorderPlan.forEach((reorderEvent) => {
this.$set(this.items, reorderEvent.newIndex, oldItems[reorderEvent.oldIndex]); this.$set(this.items, reorderEvent.newIndex, oldItems[reorderEvent.oldIndex]);
}); });
}, },
metadataHasUnits(valueMetadatas) { metadataHasUnits(valueMetadatas) {
const metadataWithUnits = valueMetadatas.filter(metadatum => metadatum.unit); let metadataWithUnits = valueMetadatas.filter(metadatum => metadatum.unit);
return metadataWithUnits.length > 0; return metadataWithUnits.length > 0;
}, },
handleStaleness(id, stalenessResponse, skipCheck = false) {
if (skipCheck || this.stalenessSubscription[id].stalenessUtils.shouldUpdateStaleness(stalenessResponse)) {
const index = this.staleObjects.indexOf(id);
if (stalenessResponse.isStale) {
if (index === -1) {
this.staleObjects.push(id);
}
} else {
if (index !== -1) {
this.staleObjects.splice(index, 1);
}
}
}
},
updateViewContext(rowContext) { updateViewContext(rowContext) {
this.viewContext.row = rowContext; this.viewContext.row = rowContext;
}, },

View File

@ -21,11 +21,7 @@
*****************************************************************************/ *****************************************************************************/
<template> <template>
<div <table class="c-table c-lad-table">
class="c-lad-table-wrapper u-style-receiver js-style-receiver"
:class="staleClass"
>
<table class="c-table c-lad-table">
<thead> <thead>
<tr> <tr>
<th>Name</th> <th>Name</th>
@ -37,9 +33,9 @@
<tbody> <tbody>
<template <template
v-for="ladTable in ladTableObjects" v-for="ladTable in ladTableObjects"
:key="ladTable.key"
> >
<tr <tr
:key="ladTable.key"
class="c-table__group-header js-lad-table-set__table-headers" class="c-table__group-header js-lad-table-set__table-headers"
> >
<td colspan="10"> <td colspan="10">
@ -52,19 +48,15 @@
:domain-object="ladRow.domainObject" :domain-object="ladRow.domainObject"
:path-to-table="ladTable.objectPath" :path-to-table="ladTable.objectPath"
:has-units="hasUnits" :has-units="hasUnits"
:is-stale="staleObjects.includes(ladRow.key)"
@rowContextClick="updateViewContext" @rowContextClick="updateViewContext"
/> />
</template> </template>
</tbody> </tbody>
</table> </table>
</div>
</template> </template>
<script> <script>
import LadRow from './LADRow.vue'; import LadRow from './LADRow.vue';
import StalenessUtils from '@/utils/staleness';
export default { export default {
components: { components: {
@ -82,8 +74,7 @@ export default {
ladTableObjects: [], ladTableObjects: [],
ladTelemetryObjects: {}, ladTelemetryObjects: {},
compositions: [], compositions: [],
viewContext: {}, viewContext: {}
staleObjects: []
}; };
}, },
computed: { computed: {
@ -104,13 +95,6 @@ export default {
} }
return false; return false;
},
staleClass() {
if (this.staleObjects.length !== 0) {
return 'is-stale';
}
return '';
} }
}, },
mounted() { mounted() {
@ -119,8 +103,6 @@ export default {
this.composition.on('remove', this.removeLadTable); this.composition.on('remove', this.removeLadTable);
this.composition.on('reorder', this.reorderLadTables); this.composition.on('reorder', this.reorderLadTables);
this.composition.load(); this.composition.load();
this.stalenessSubscription = {};
}, },
destroyed() { destroyed() {
this.composition.off('add', this.addLadTable); this.composition.off('add', this.addLadTable);
@ -130,11 +112,6 @@ export default {
c.composition.off('add', c.addCallback); c.composition.off('add', c.addCallback);
c.composition.off('remove', c.removeCallback); c.composition.off('remove', c.removeCallback);
}); });
Object.values(this.stalenessSubscription).forEach(stalenessSubscription => {
stalenessSubscription.unsubscribe();
stalenessSubscription.stalenessUtils.destroy();
});
}, },
methods: { methods: {
addLadTable(domainObject) { addLadTable(domainObject) {
@ -183,57 +160,18 @@ export default {
telemetryObjects.push(telemetryObject); telemetryObjects.push(telemetryObject);
this.$set(this.ladTelemetryObjects, ladTable.key, telemetryObjects); this.$set(this.ladTelemetryObjects, ladTable.key, telemetryObjects);
// if tracking already, possibly in another table, return
if (this.stalenessSubscription[telemetryObject.key]) {
return;
} else {
this.stalenessSubscription[telemetryObject.key] = {};
this.stalenessSubscription[telemetryObject.key].stalenessUtils = new StalenessUtils(this.openmct, domainObject);
}
this.openmct.telemetry.isStale(domainObject).then((stalenessResponse) => {
if (stalenessResponse !== undefined) {
this.handleStaleness(telemetryObject.key, stalenessResponse);
}
});
const stalenessSubscription = this.openmct.telemetry.subscribeToStaleness(domainObject, (stalenessResponse) => {
this.handleStaleness(telemetryObject.key, stalenessResponse);
});
this.stalenessSubscription[telemetryObject.key].unsubscribe = stalenessSubscription;
}; };
}, },
removeTelemetryObject(ladTable) { removeTelemetryObject(ladTable) {
return (identifier) => { return (identifier) => {
const SKIP_CHECK = true;
const keystring = this.openmct.objects.makeKeyString(identifier);
let telemetryObjects = this.ladTelemetryObjects[ladTable.key]; let telemetryObjects = this.ladTelemetryObjects[ladTable.key];
let index = telemetryObjects.findIndex(telemetryObject => keystring === telemetryObject.key); let index = telemetryObjects.findIndex(telemetryObject => this.openmct.objects.makeKeyString(identifier) === telemetryObject.key);
telemetryObjects.splice(index, 1); telemetryObjects.splice(index, 1);
this.$set(this.ladTelemetryObjects, ladTable.key, telemetryObjects); this.$set(this.ladTelemetryObjects, ladTable.key, telemetryObjects);
this.stalenessSubscription[keystring].unsubscribe();
this.stalenessSubscription[keystring].stalenessUtils.destroy();
this.handleStaleness(keystring, { isStale: false }, SKIP_CHECK);
}; };
}, },
handleStaleness(id, stalenessResponse, skipCheck = false) {
if (skipCheck || this.stalenessSubscription[id].stalenessUtils.shouldUpdateStaleness(stalenessResponse)) {
const index = this.staleObjects.indexOf(id);
if (stalenessResponse.isStale) {
if (index === -1) {
this.staleObjects.push(id);
}
} else {
if (index !== -1) {
this.staleObjects.splice(index, 1);
}
}
}
},
updateViewContext(rowContext) { updateViewContext(rowContext) {
this.viewContext.row = rowContext; this.viewContext.row = rowContext;
}, },

View File

@ -112,7 +112,11 @@ export default {
} }
}, },
removeFromComposition(telemetryObject) { removeFromComposition(telemetryObject) {
this.composition.remove(telemetryObject); let composition = this.domainObject.composition.filter(id =>
!this.openmct.objects.areIdsEqual(id, telemetryObject.identifier)
);
this.openmct.objects.mutate(this.domainObject, 'composition', composition);
}, },
addTelemetryObject(telemetryObject) { addTelemetryObject(telemetryObject) {
// grab information we need from the added telmetry object // grab information we need from the added telmetry object

View File

@ -104,14 +104,10 @@ export default {
this.$set(this.plotSeries, this.plotSeries.length, series); this.$set(this.plotSeries, this.plotSeries.length, series);
this.setAxesLabels(); this.setAxesLabels();
}, },
removeSeries(seriesKey) { removeSeries(series) {
const seriesIndex = this.plotSeries.findIndex( const index = this.plotSeries.findIndex(plotSeries => this.openmct.objects.areIdsEqual(series.identifier, plotSeries.identifier));
plotSeries => this.openmct.objects.areIdsEqual(seriesKey, plotSeries.identifier) if (index !== undefined) {
); this.$delete(this.plotSeries, index);
const foundSeries = seriesIndex > -1;
if (foundSeries) {
this.$delete(this.plotSeries, seriesIndex);
this.setAxesLabels(); this.setAxesLabels();
} }
}, },

View File

@ -68,7 +68,6 @@ export default function ClockPlugin(options) {
] ]
}, },
{ {
ariaLabel: "12 or 24 hour clock",
control: 'select', control: 'select',
options: [ options: [
{ {

View File

@ -26,7 +26,7 @@ import TelemetryCriterion from "./criterion/TelemetryCriterion";
import { evaluateResults } from './utils/evaluator'; import { evaluateResults } from './utils/evaluator';
import { getLatestTimestamp } from './utils/time'; import { getLatestTimestamp } from './utils/time';
import AllTelemetryCriterion from "./criterion/AllTelemetryCriterion"; import AllTelemetryCriterion from "./criterion/AllTelemetryCriterion";
import { TRIGGER_CONJUNCTION, TRIGGER_LABEL } from "./utils/constants"; import {TRIGGER_CONJUNCTION, TRIGGER_LABEL} from "./utils/constants";
/* /*
* conditionConfiguration = { * conditionConfiguration = {
@ -160,8 +160,7 @@ export default class Condition extends EventEmitter {
} }
criterion.on('criterionUpdated', (obj) => this.handleCriterionUpdated(obj)); criterion.on('criterionUpdated', (obj) => this.handleCriterionUpdated(obj));
criterion.on('telemetryIsOld', (obj) => this.handleOldTelemetryCriterion(obj)); criterion.on('telemetryIsStale', (obj) => this.handleStaleCriterion(obj));
criterion.on('telemetryStaleness', () => this.handleTelemetryStaleness());
if (!this.criteria) { if (!this.criteria) {
this.criteria = []; this.criteria = [];
} }
@ -192,14 +191,12 @@ export default class Condition extends EventEmitter {
const newCriterionConfiguration = this.generateCriterion(criterionConfiguration); const newCriterionConfiguration = this.generateCriterion(criterionConfiguration);
let newCriterion = new TelemetryCriterion(newCriterionConfiguration, this.openmct); let newCriterion = new TelemetryCriterion(newCriterionConfiguration, this.openmct);
newCriterion.on('criterionUpdated', (obj) => this.handleCriterionUpdated(obj)); newCriterion.on('criterionUpdated', (obj) => this.handleCriterionUpdated(obj));
newCriterion.on('telemetryIsOld', (obj) => this.handleOldTelemetryCriterion(obj)); newCriterion.on('telemetryIsStale', (obj) => this.handleStaleCriterion(obj));
newCriterion.on('telemetryStaleness', () => this.handleTelemetryStaleness());
let criterion = found.item; let criterion = found.item;
criterion.unsubscribe(); criterion.unsubscribe();
criterion.off('criterionUpdated', (obj) => this.handleCriterionUpdated(obj)); criterion.off('criterionUpdated', (obj) => this.handleCriterionUpdated(obj));
criterion.off('telemetryIsOld', (obj) => this.handleOldTelemetryCriterion(obj)); criterion.off('telemetryIsStale', (obj) => this.handleStaleCriterion(obj));
newCriterion.off('telemetryStaleness', () => this.handleTelemetryStaleness());
this.criteria.splice(found.index, 1, newCriterion); this.criteria.splice(found.index, 1, newCriterion);
} }
} }
@ -208,9 +205,12 @@ export default class Condition extends EventEmitter {
let found = this.findCriterion(id); let found = this.findCriterion(id);
if (found) { if (found) {
let criterion = found.item; let criterion = found.item;
criterion.off('criterionUpdated', (obj) => this.handleCriterionUpdated(obj)); criterion.off('criterionUpdated', (obj) => {
criterion.off('telemetryIsOld', (obj) => this.handleOldTelemetryCriterion(obj)); this.handleCriterionUpdated(obj);
criterion.off('telemetryStaleness', () => this.handleTelemetryStaleness()); });
criterion.off('telemetryIsStale', (obj) => {
this.handleStaleCriterion(obj);
});
criterion.destroy(); criterion.destroy();
this.criteria.splice(found.index, 1); this.criteria.splice(found.index, 1);
@ -227,7 +227,7 @@ export default class Condition extends EventEmitter {
} }
} }
handleOldTelemetryCriterion(updatedCriterion) { handleStaleCriterion(updatedCriterion) {
this.result = evaluateResults(this.criteria.map(criterion => criterion.result), this.trigger); this.result = evaluateResults(this.criteria.map(criterion => criterion.result), this.trigger);
let latestTimestamp = {}; let latestTimestamp = {};
latestTimestamp = getLatestTimestamp( latestTimestamp = getLatestTimestamp(
@ -239,11 +239,6 @@ export default class Condition extends EventEmitter {
this.conditionManager.updateCurrentCondition(latestTimestamp); this.conditionManager.updateCurrentCondition(latestTimestamp);
} }
handleTelemetryStaleness() {
this.result = evaluateResults(this.criteria.map(criterion => criterion.result), this.trigger);
this.conditionManager.updateCurrentCondition();
}
updateDescription() { updateDescription() {
const triggerDescription = this.getTriggerDescription(); const triggerDescription = this.getTriggerDescription();
let description = ''; let description = '';

View File

@ -82,10 +82,8 @@
</template> </template>
<script> <script>
import Condition from './Condition.vue'; import Condition from './Condition.vue';
import ConditionManager from '../ConditionManager'; import ConditionManager from '../ConditionManager';
import StalenessUtils from '@/utils/staleness';
export default { export default {
components: { components: {
@ -141,13 +139,6 @@ export default {
if (this.stopObservingForChanges) { if (this.stopObservingForChanges) {
this.stopObservingForChanges(); this.stopObservingForChanges();
} }
if (this.stalenessSubscription) {
Object.values(this.stalenessSubscription).forEach(stalenessSubscription => {
stalenessSubscription.unsubscribe();
stalenessSubscription.stalenessUtils.destroy();
});
}
}, },
mounted() { mounted() {
this.composition = this.openmct.composition.get(this.domainObject); this.composition = this.openmct.composition.get(this.domainObject);
@ -159,7 +150,6 @@ export default {
this.conditionManager = new ConditionManager(this.domainObject, this.openmct); this.conditionManager = new ConditionManager(this.domainObject, this.openmct);
this.conditionManager.on('conditionSetResultUpdated', this.handleConditionSetResultUpdated); this.conditionManager.on('conditionSetResultUpdated', this.handleConditionSetResultUpdated);
this.updateDefaultCondition(); this.updateDefaultCondition();
this.stalenessSubscription = {};
}, },
methods: { methods: {
handleConditionSetResultUpdated(data) { handleConditionSetResultUpdated(data) {
@ -220,57 +210,19 @@ export default {
return arr; return arr;
}, },
addTelemetryObject(domainObject) { addTelemetryObject(domainObject) {
const keyString = this.openmct.objects.makeKeyString(domainObject.identifier);
this.telemetryObjs.push(domainObject); this.telemetryObjs.push(domainObject);
this.$emit('telemetryUpdated', this.telemetryObjs); this.$emit('telemetryUpdated', this.telemetryObjs);
if (!this.stalenessSubscription[keyString]) {
this.stalenessSubscription[keyString] = {};
}
this.stalenessSubscription[keyString].stalenessUtils = new StalenessUtils(this.openmct, domainObject);
this.openmct.telemetry.isStale(domainObject).then((stalenessResponse) => {
this.hanldeStaleness(keyString, stalenessResponse);
});
const stalenessSubscription = this.openmct.telemetry.subscribeToStaleness(domainObject, (stalenessResponse) => {
this.hanldeStaleness(keyString, stalenessResponse);
});
this.stalenessSubscription[keyString].unsubscribe = stalenessSubscription;
}, },
removeTelemetryObject(identifier) { removeTelemetryObject(identifier) {
const keyString = this.openmct.objects.makeKeyString(identifier); let index = this.telemetryObjs.findIndex(obj => {
const index = this.telemetryObjs.findIndex(obj => {
let objId = this.openmct.objects.makeKeyString(obj.identifier); let objId = this.openmct.objects.makeKeyString(obj.identifier);
let id = this.openmct.objects.makeKeyString(identifier);
return objId === keyString; return objId === id;
}); });
if (index > -1) { if (index > -1) {
this.telemetryObjs.splice(index, 1); this.telemetryObjs.splice(index, 1);
} }
if (this.stalenessSubscription[keyString]) {
this.stalenessSubscription[keyString].unsubscribe();
this.stalenessSubscription[keyString].stalenessUtils.destroy();
this.emitStaleness({
keyString,
isStale: false
});
}
},
hanldeStaleness(keyString, stalenessResponse) {
if (this.stalenessSubscription[keyString].stalenessUtils.shouldUpdateStaleness(stalenessResponse)) {
this.emitStaleness({
keyString,
isStale: stalenessResponse.isStale
});
}
},
emitStaleness(stalenessObject) {
this.$emit('telemetryStaleness', stalenessObject);
}, },
addCondition() { addCondition() {
this.conditionManager.addCondition(); this.conditionManager.addCondition();

View File

@ -21,10 +21,7 @@
*****************************************************************************/ *****************************************************************************/
<template> <template>
<div <div class="c-cs">
class="c-cs"
:class="{'is-stale': isStale }"
>
<section class="c-cs__current-output c-section"> <section class="c-cs__current-output c-section">
<div class="c-cs__content c-cs__current-output-value"> <div class="c-cs__content c-cs__current-output-value">
<span class="c-cs__current-output-value__label">Current Output</span> <span class="c-cs__current-output-value__label">Current Output</span>
@ -53,7 +50,6 @@
@conditionSetResultUpdated="updateCurrentOutput" @conditionSetResultUpdated="updateCurrentOutput"
@updateDefaultOutput="updateDefaultOutput" @updateDefaultOutput="updateDefaultOutput"
@telemetryUpdated="updateTelemetry" @telemetryUpdated="updateTelemetry"
@telemetryStaleness="handleStaleness"
/> />
</div> </div>
</div> </div>
@ -77,15 +73,9 @@ export default {
currentConditionOutput: '', currentConditionOutput: '',
defaultConditionOutput: '', defaultConditionOutput: '',
telemetryObjs: [], telemetryObjs: [],
testData: {}, testData: {}
staleObjects: []
}; };
}, },
computed: {
isStale() {
return this.staleObjects.length !== 0;
}
},
mounted() { mounted() {
this.conditionSetIdentifier = this.openmct.objects.makeKeyString(this.domainObject.identifier); this.conditionSetIdentifier = this.openmct.objects.makeKeyString(this.domainObject.identifier);
this.testData = { this.testData = {
@ -105,18 +95,6 @@ export default {
}, },
updateTestData(testData) { updateTestData(testData) {
this.testData = testData; this.testData = testData;
},
handleStaleness({ keyString, isStale }) {
const index = this.staleObjects.indexOf(keyString);
if (isStale) {
if (index === -1) {
this.staleObjects.push(keyString);
}
} else {
if (index !== -1) {
this.staleObjects.splice(index, 1);
}
}
} }
} }
}; };

View File

@ -94,7 +94,7 @@
> >
<span v-if="inputIndex < inputCount-1">and</span> <span v-if="inputIndex < inputCount-1">and</span>
</span> </span>
<span v-if="criterion.metadata === 'dataReceived' && criterion.operation.name === IS_OLD_KEY">seconds</span> <span v-if="criterion.metadata === 'dataReceived'">seconds</span>
</template> </template>
<span v-else> <span v-else>
<span <span
@ -122,7 +122,7 @@
<script> <script>
import { OPERATIONS, INPUT_TYPES } from '../utils/operations'; import { OPERATIONS, INPUT_TYPES } from '../utils/operations';
import { TRIGGER_CONJUNCTION, IS_OLD_KEY, IS_STALE_KEY } from "../utils/constants"; import {TRIGGER_CONJUNCTION} from "../utils/constants";
export default { export default {
inject: ['openmct'], inject: ['openmct'],
@ -153,8 +153,7 @@ export default {
rowLabel: '', rowLabel: '',
operationFormat: '', operationFormat: '',
enumerations: [], enumerations: [],
inputTypes: INPUT_TYPES, inputTypes: INPUT_TYPES
IS_OLD_KEY
}; };
}, },
computed: { computed: {
@ -165,7 +164,7 @@ export default {
}, },
filteredOps: function () { filteredOps: function () {
if (this.criterion.metadata === 'dataReceived') { if (this.criterion.metadata === 'dataReceived') {
return this.operations.filter(op => op.name === IS_OLD_KEY || op.name === IS_STALE_KEY); return this.operations.filter(op => op.name === 'isStale');
} else { } else {
return this.operations.filter(op => op.appliesTo.indexOf(this.operationFormat) !== -1); return this.operations.filter(op => op.appliesTo.indexOf(this.operationFormat) !== -1);
} }

Some files were not shown because too many files have changed in this diff Show More