Welcome to mirror list, hosted at ThFree Co, Russian Federation.

NotificationAPISpec.js « notifications « api « src - github.com/nasa/openmct.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: eb44b613b69c1a95088caf2b2fe781a6c1973ed3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/*****************************************************************************
 * 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 NotificationAPI from './NotificationAPI';

describe('The Notifiation API', () => {
    let notificationAPIInstance;
    let defaultTimeout = 4000;

    beforeAll(() => {
        notificationAPIInstance = new NotificationAPI();
    });

    describe('the info method', () => {
        let message = 'Example Notification Message';
        let severity = 'info';
        let notificationModel;

        beforeAll(() => {
            notificationModel = notificationAPIInstance.info(message).model;
        });

        afterAll(() => {
            notificationAPIInstance.dismissAllNotifications();
        });

        it('shows a string message with info severity', () => {
            expect(notificationModel.message).toEqual(message);
            expect(notificationModel.severity).toEqual(severity);
        });

        it('auto dismisses the notification after a brief timeout', (done) => {
            window.setTimeout(() => {
                expect(notificationAPIInstance.notifications.length).toEqual(0);
                done();
            }, defaultTimeout);
        });
    });

    describe('the alert method', () => {
        let message = 'Example alert message';
        let severity = 'alert';
        let notificationModel;

        beforeAll(() => {
            notificationModel = notificationAPIInstance.alert(message).model;
        });

        afterAll(() => {
            notificationAPIInstance.dismissAllNotifications();
        });

        it('shows a string message, with alert severity', () => {
            expect(notificationModel.message).toEqual(message);
            expect(notificationModel.severity).toEqual(severity);
        });

        it('does not auto dismiss the notification', (done) => {
            window.setTimeout(() => {
                expect(notificationAPIInstance.notifications.length).toEqual(1);
                done();
            }, defaultTimeout);
        });
    });

    describe('the error method', () => {
        let message = 'Example error message';
        let severity = 'error';
        let notificationModel;

        beforeAll(() => {
            notificationModel = notificationAPIInstance.error(message).model;
        });

        afterAll(() => {
            notificationAPIInstance.dismissAllNotifications();
        });

        it('shows a string message, with severity error', () => {
            expect(notificationModel.message).toEqual(message);
            expect(notificationModel.severity).toEqual(severity);
        });

        it('does not auto dismiss the notification', (done) => {
            window.setTimeout(() => {
                expect(notificationAPIInstance.notifications.length).toEqual(1);
                done();
            }, defaultTimeout);
        });
    });

    describe('the progress method', () => {
        let title = 'This is a progress notification';
        let message1 = 'Example progress message 1';
        let message2 = 'Example progress message 2';
        let percentage1 = 50;
        let percentage2 = 99.9;
        let severity = 'info';
        let notification;
        let updatedPercentage;
        let updatedMessage;

        beforeAll(() => {
            notification = notificationAPIInstance.progress(title, percentage1, message1);
            notification.on('progress', (percentage, text) => {
                updatedPercentage = percentage;
                updatedMessage = text;
            });
        });

        afterAll(() => {
            notificationAPIInstance.dismissAllNotifications();
        });

        it ('shows a notification with a message, progress message, percentage and info severity', () => {
            expect(notification.model.message).toEqual(title);
            expect(notification.model.severity).toEqual(severity);
            expect(notification.model.progressText).toEqual(message1);
            expect(notification.model.progressPerc).toEqual(percentage1);
        });

        it ('allows dynamically updating the progress attributes', () => {
            notification.progress(percentage2, message2);

            expect(updatedPercentage).toEqual(percentage2);
            expect(updatedMessage).toEqual(message2);
        });

        it ('allows dynamically dismissing of progress notification', () => {
            notification.dismiss();

            expect(notificationAPIInstance.notifications.length).toEqual(0);
        });
    });
});