Add tests for inspector data pivoting (#7282)

* inspector view needs renderWhenVisible function

* add a default visualization source

* add plugin to exercise data pivotting

* use correct key string

* test skeleton

* add e2e test

---------

Co-authored-by: David Tsay <david.e.tsay@nasa.gov>
Co-authored-by: David Tsay <3614296+davetsay@users.noreply.github.com>
This commit is contained in:
Scott Bell
2023-12-19 11:33:50 +01:00
committed by GitHub
parent 0ce36c8297
commit ec910dcbdc
7 changed files with 354 additions and 1 deletions

View File

@ -0,0 +1,75 @@
/*****************************************************************************
* 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.
*****************************************************************************/
import mount from 'utils/mount';
import ExampleDataVisualizationSource from './components/ExampleDataVisualizationSource.vue';
export default function ExampleDataVisualizationSourceViewProvider(openmct) {
return {
key: 'exampleDataVisualizationSource',
name: 'Example Data Visualization Source',
cssClass: 'icon-telemetry',
canView: function (domainObject) {
return domainObject.type === 'exampleDataVisualizationSource';
},
canEdit: function (domainObject) {
if (domainObject.type === 'exampleDataVisualizationSource') {
return true;
}
},
view: function (domainObject) {
let _destroy = null;
return {
show: function (element, isEditing) {
const { destroy } = mount(
{
el: element,
components: {
ExampleDataVisualizationSource
},
provide: {
openmct,
domainObject
},
template: '<example-data-visualization-source></example-data-visualization-source>'
},
{
app: openmct.app,
element
}
);
_destroy = destroy;
},
destroy: function () {
if (_destroy) {
_destroy();
}
}
};
},
priority: function () {
return 1;
}
};
}

View File

@ -0,0 +1,128 @@
<!--
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.
-->
<template>
<div class="c-table c-list-view c-list-view--selectable">
<table class="c-table__body">
<thead class="c-table__header">
<tr>
<th>Name</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr
v-for="item in items"
:key="item.keyString"
class="c-list-item js-folder-child"
@click="selectItem(item, $event)"
>
<td class="c-list-item__name">
<a ref="objectLink" class="c-object-label">
<div
class="c-object-label__type-icon c-list-item__name__type-icon"
:class="item.type.cssClass"
></div>
<div class="c-object-label__name c-list-item__name__name">{{ item.model.name }}</div>
</a>
</td>
<td class="c-list-item__type">
{{ item.type.name }}
</td>
</tr>
</tbody>
</table>
</div>
</template>
<script>
export default {
inject: ['openmct', 'domainObject'],
data() {
return {
items: []
};
},
mounted() {
this.composition = this.openmct.composition.get(this.domainObject);
this.keystring = this.openmct.objects.makeKeyString(this.domainObject.identifier);
this.composition.on('add', this.addedTelemetry);
this.composition.on('remove', this.removedTelemetry);
this.composition.load();
},
unmounted() {
this.composition.off('add', this.addedTelemetry);
this.composition.off('remove', this.removedTelemetry);
},
methods: {
selectItem(item, event) {
event.stopPropagation();
const bounds = this.openmct.time.getBounds();
const selection = [
{
element: this.$el,
context: {
dataVisualization: {
telemetryKeys: [item.objectKeyString],
description: {
text: item.model.name,
icon: item.type.cssClass
},
dataRanges: [
{
bounds
}
],
loading: false
},
item: this.domainObject
}
}
];
this.openmct.selection.select(selection, false);
},
addedTelemetry(child) {
const type = this.openmct.types.get(child.type) || {
definition: {
cssClass: 'icon-object-unknown',
name: 'Unknown Type'
}
};
this.items.push({
model: child,
type: type.definition,
isAlias: this.keystring !== child.location,
objectPath: [child].concat(this.openmct.router.path),
objectKeyString: this.openmct.objects.makeKeyString(child.identifier)
});
},
removedTelemetry(identifier) {
this.items = this.items.filter((i) => {
return (
i.model.identifier.key !== identifier.key ||
i.model.identifier.namespace !== identifier.namespace
);
});
}
}
};
</script>

View File

@ -0,0 +1,46 @@
/*****************************************************************************
* 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.
*****************************************************************************/
import ExampleDataVisualizationSourceViewProvider from './ExampleDataVisualizationSourceViewProvider';
export default function () {
return function install(openmct) {
openmct.objectViews.addProvider(new ExampleDataVisualizationSourceViewProvider(openmct));
openmct.types.addType('exampleDataVisualizationSource', {
name: 'Example Data Visualization Source',
creatable: true,
description: 'An example data visualization source to be used with an inspector.',
cssClass: 'icon-telemetry',
initialize(domainObject) {
domainObject.composition = [];
}
});
openmct.composition.addPolicy((parent, child) => {
if (parent.type === 'exampleDataVisualizationSource') {
return Object.prototype.hasOwnProperty.call(child, 'telemetry');
} else {
return true;
}
});
};
}