openmct/platform/telemetry/test/TelemetryCapabilitySpec.js

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

define(
    ["../src/TelemetryCapability"],
    function (TelemetryCapability) {

        describe("The telemetry capability", function () {
            var mockInjector,
                mockQ,
                mockLog,
                mockDomainObject,
                mockTelemetryService,
                mockReject,
                mockUnsubscribe,
                telemetry,
                mockTelemetryAPI,
                mockMetadata,
                mockAPI;

            function mockPromise(value) {
                return {
                    then: function (callback) {
                        return mockPromise(callback(value));
                    }
                };
            }

            function noop() {
            }

            beforeEach(function () {
                mockInjector = jasmine.createSpyObj("$injector", ["get"]);
                mockQ = jasmine.createSpyObj("$q", ["when", "reject"]);
                mockLog = jasmine.createSpyObj("$log", ["warn", "info", "debug"]);
                mockDomainObject = jasmine.createSpyObj(
                    "domainObject",
                    ["getId", "getCapability", "getModel"]
                );
                mockTelemetryService = jasmine.createSpyObj(
                    "telemetryService",
                    ["requestTelemetry", "subscribe"]
                );
                mockReject = jasmine.createSpyObj("reject", ["then"]);
                mockUnsubscribe = jasmine.createSpy("unsubscribe");

                mockInjector.get.and.returnValue(mockTelemetryService);

                mockQ.when.and.callFake(mockPromise);
                mockQ.reject.and.returnValue(mockReject);

                mockDomainObject.getId.and.returnValue("testId");
                mockDomainObject.getModel.and.returnValue({
                    telemetry: {
                        source: "testSource",
                        key: "testKey"
                    }
                });

                mockTelemetryService.requestTelemetry
                    .and.returnValue(mockPromise({}));
                mockTelemetryService.subscribe
                    .and.returnValue(mockUnsubscribe);

                // Bubble up...
                mockReject.then.and.returnValue(mockReject);

                mockTelemetryAPI = jasmine.createSpyObj("telemetryAPI", [
                    "getMetadata",
                    "subscribe",
                    "request",
                    "findRequestProvider",
                    "findSubscriptionProvider"
                ]);

                mockMetadata = jasmine.createSpyObj('telemetryMetadata', [
                    'valuesForHints',
                    'values'
                ]);

                mockMetadata.valuesForHints.and.callFake(function (hints) {
                    var hint = hints[0];
                    var metadatum = {
                        key: 'default' + hint
                    };
                    metadatum[hint] = "foo";
                    return [metadatum];
                });

                mockTelemetryAPI.getMetadata.and.returnValue(mockMetadata);

                mockAPI = {
                    telemetry: mockTelemetryAPI,
                    time: {
                        bounds: function () {
                            return {
                                start: 0,
                                end: 1
                            };
                        },
                        timeSystem: function () {
                            return {
                                key: 'mockTimeSystem'
                            };
                        }
                    }
                };

                telemetry = new TelemetryCapability(
                    mockAPI,
                    mockInjector,
                    mockQ,
                    mockLog,
                    mockDomainObject
                );
            });

            it("applies only to objects with telemetry sources", function () {
                expect(TelemetryCapability.appliesTo({
                    telemetry: { source: "testSource" }
                })).toBeTruthy();
                expect(TelemetryCapability.appliesTo({
                    xtelemetry: { source: "testSource" }
                })).toBeFalsy();
                expect(TelemetryCapability.appliesTo({})).toBeFalsy();
                expect(TelemetryCapability.appliesTo()).toBeFalsy();
            });

            it("gets a telemetry service from the injector", function () {
                telemetry.requestData();
                expect(mockInjector.get)
                    .toHaveBeenCalledWith("telemetryService");
            });

            it("applies request arguments", function () {
                telemetry.requestData({ start: 42 });
                expect(mockTelemetryService.requestTelemetry)
                    .toHaveBeenCalledWith([{
                        id: "testId", // from domain object
                        source: "testSource", // from model
                        key: "testKey", // from model
                        start: 42, // from argument
                        domain: 'mockTimeSystem',
                        domains: [{ domain: "foo", key: 'defaultdomain' }],
                        ranges: [{ range: "foo", key: 'defaultrange' }]
                    }]);
            });

            it("provides an empty series when telemetry is missing", function () {
                var series;
                mockTelemetryService.requestTelemetry.and.returnValue(mockPromise({}));
                telemetry.requestData({}).then(function (s) {
                    series = s;
                });
                expect(series.getPointCount()).toEqual(0);
            });

            it("provides telemetry metadata", function () {
                expect(telemetry.getMetadata()).toEqual({
                    id: "testId", // from domain object
                    source: "testSource",
                    key: "testKey",
                    start: 0,
                    end: 1,
                    domain: 'mockTimeSystem',
                    domains: [{ domain: "foo", key: 'defaultdomain' }],
                    ranges: [{ range: "foo", key: 'defaultrange' }]
                });
            });

            it("uses domain object as a key if needed", function () {
                // Don't include key in telemetry
                mockDomainObject.getModel.and.returnValue({
                    telemetry: { source: "testSource" }
                });

                // Should have used the domain object's ID
                expect(telemetry.getMetadata()).toEqual({
                    id: "testId", // from domain object
                    source: "testSource", // from model
                    key: "testId", // from domain object
                    start: 0,
                    end: 1,
                    domain: 'mockTimeSystem',
                    domains: [{ domain: "foo", key: 'defaultdomain' }],
                    ranges: [{ range: "foo", key: 'defaultrange' }]
                });
            });


            it("warns if no telemetry service can be injected", function () {
                mockInjector.get.and.callFake(function () {
                    throw "";
                });

                // Verify precondition
                expect(mockLog.warn).not.toHaveBeenCalled();

                telemetry.requestData();

                expect(mockLog.info).toHaveBeenCalled();
            });

            it("if a new style telemetry source is available, use it", function () {
                var mockProvider = {};
                mockTelemetryAPI.findSubscriptionProvider.and.returnValue(mockProvider);
                telemetry.subscribe(noop, {});
                expect(mockTelemetryService.subscribe).not.toHaveBeenCalled();
                expect(mockTelemetryAPI.subscribe).toHaveBeenCalled();
            });

            it("if a new style telemetry source is not available, revert to old API", function () {
                mockTelemetryAPI.findSubscriptionProvider.and.returnValue(undefined);
                telemetry.subscribe(noop, {});
                expect(mockTelemetryAPI.subscribe).not.toHaveBeenCalled();
                expect(mockTelemetryService.subscribe).toHaveBeenCalled();
            });

            it("Wraps telemetry returned from the new API as a telemetry series", function () {
                var returnedTelemetry;
                var mockTelemetry = [{
                    prop1: "val1",
                    prop2: "val2",
                    prop3: "val3"
                },
                {
                    prop1: "val4",
                    prop2: "val5",
                    prop3: "val6"
                }];
                var mockProvider = {};

                mockMetadata.values.and.returnValue([
                    {
                        key: 'defaultrange',
                        source: 'prop1'
                    },
                    {
                        key: 'defaultdomain',
                        source: 'prop2'
                    },
                    {
                        key: 'prop3',
                        source: 'prop3'
                    }
                ]);

                mockTelemetryAPI.findRequestProvider.and.returnValue(mockProvider);
                mockTelemetryAPI.request.and.returnValue(Promise.resolve(mockTelemetry));

                return telemetry.requestData({}).then(function (data) {
                    returnedTelemetry = data;

                    expect(returnedTelemetry.getPointCount).toBeDefined();
                    expect(returnedTelemetry.getDomainValue).toBeDefined();
                    expect(returnedTelemetry.getRangeValue).toBeDefined();
                    expect(returnedTelemetry.getPointCount()).toBe(2);
                    // Default domain + remap should work.
                    expect(returnedTelemetry.getDomainValue(0)).toBe('val2');
                    expect(returnedTelemetry.getDomainValue(1)).toBe('val5');
                    // explicit domain should work
                    expect(returnedTelemetry.getDomainValue(0, 'prop3')).toBe('val3');
                    expect(returnedTelemetry.getDomainValue(1, 'prop3')).toBe('val6');
                    // default range + remap should work
                    expect(returnedTelemetry.getRangeValue(0)).toBe('val1');
                    expect(returnedTelemetry.getRangeValue(1)).toBe('val4');
                    // explicit range should work
                    expect(returnedTelemetry.getRangeValue(0, 'prop3')).toBe('val3');
                    expect(returnedTelemetry.getRangeValue(1, 'prop3')).toBe('val6');
                });

            });

            it("allows subscriptions to updates", function () {
                var mockCallback = jasmine.createSpy("callback"),
                    subscription = telemetry.subscribe(mockCallback);

                // Verify subscription to the appropriate object
                expect(mockTelemetryService.subscribe).toHaveBeenCalledWith(
                    jasmine.any(Function),
                    [{
                        id: "testId", // from domain object
                        source: "testSource",
                        key: "testKey",
                        start: 0,
                        end: 1,
                        domain: 'mockTimeSystem',
                        domains: [{ domain: "foo", key: "defaultdomain" }],
                        ranges: [{ range: "foo", key: "defaultrange" }]
                    }]
                );

                // Check that the callback gets invoked
                expect(mockCallback).not.toHaveBeenCalled();
                mockTelemetryService.subscribe.calls.mostRecent().args[0]({
                    testSource: { testKey: { someKey: "some value" } }
                });
                expect(mockCallback).toHaveBeenCalledWith(
                    { someKey: "some value" }
                );

                // Finally, unsubscribe
                expect(mockUnsubscribe).not.toHaveBeenCalled();
                subscription(); // should be an unsubscribe function
                expect(mockUnsubscribe).toHaveBeenCalled();
            });

            it("applies time conductor bounds if request bounds not defined", function () {
                var fullRequest = telemetry.buildRequest({});
                var mockBounds = mockAPI.time.bounds();

                expect(fullRequest.start).toBe(mockBounds.start);
                expect(fullRequest.end).toBe(mockBounds.end);

                fullRequest = telemetry.buildRequest({start: 10, end: 20});

                expect(fullRequest.start).toBe(10);
                expect(fullRequest.end).toBe(20);
            });

            it("applies domain from time system if none defined", function () {
                var fullRequest = telemetry.buildRequest({});
                var mockTimeSystem = mockAPI.time.timeSystem();
                expect(fullRequest.domain).toBe(mockTimeSystem.key);

                fullRequest = telemetry.buildRequest({domain: 'someOtherDomain'});
                expect(fullRequest.domain).toBe('someOtherDomain');
            });
        });
    }
);