packagemanager-service.test.js
13.4 KB
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
/*
*
* ADOBE CONFIDENTIAL
* __________________
*
* Copyright 2017 Adobe Systems Incorporated
* All Rights Reserved.
*
* NOTICE: All information contained herein is, and remains
* the property of Adobe Systems Incorporated and its suppliers,
* if any. The intellectual and technical concepts contained
* herein are proprietary to Adobe Systems Incorporated and its
* suppliers and are protected by trade secret or copyright law.
* Dissemination of this information or reproduction of this material
* is strictly forbidden unless prior written permission is obtained
* from Adobe Systems Incorporated.
*/
/* eslint max-nested-callbacks: [2, 10]*/
/* globals sinon, describe, it, expect, before, beforeEach, afterEach */
define([
'screens/player/firmware/packagemanager/packagemanager',
'screens/player/firmware/packagemanager/impl/packagemanager-service',
'screens/player/firmware/packagemanager/spi/sync',
'screens/player/firmware/filesystem/filesystem',
'screens/player/store/store',
'screens/player/firmware/preferences/preferences',
'screens/player/shared/serviceadmin',
'screens/player/shared/test-helper/service',
'screens/player/shared/test-helper/stub-service-interface'
], function(PackageManager, PackageManagerService, SyncSpi, FilesystemService, Store, Preferences, ServiceAdmin, serviceTestHelper, stubServiceInterface) {
'use strict';
var PACKAGE_URL = '/some/some.zip';
var TARGET_PATH = 'path';
var UPDATE_MODE = 'replace';
var TITLE = 'title';
var UID = 'uid';
var SERVER_URL = 'http://aem-instance:4502';
var USER_DATA_PATH = '/some/path';
var PACKAGE_TIMESTAMP = 100;
var TIMESTAMP_NOT_EXPIRED = 50;
var TIMESTAMP_EXPIRED = 150;
var TIMESTAMP_FORCE_UPDATE = 0;
var PROGRESS = 1;
var STATUS = 1;
describe('screens/player/firmware/packagemanager/impl/packagemanager-service', function() {
var packageManager;
var sync;
var filesystem;
var preferences;
var someError;
var expectedResolvedPayload;
var expectedRejectedPayload;
var expectedStartedEventPayload;
var expectedProgressEventPayload;
beforeEach(function() {
packageManager = new PackageManagerService();
sync = stubServiceInterface(ServiceAdmin, SyncSpi);
filesystem = stubServiceInterface(ServiceAdmin, FilesystemService);
filesystem.api.getUserDataPath.returns(Promise.resolve(USER_DATA_PATH));
filesystem.api.joinPath.returns(USER_DATA_PATH + '/www');
preferences = stubServiceInterface(ServiceAdmin, Preferences);
preferences.api.getPreferences.returns({ server: SERVER_URL });
someError = new Error('some error');
expectedResolvedPayload = {
title: TITLE,
url: SERVER_URL + PACKAGE_URL
};
expectedRejectedPayload = {
title: TITLE,
url: SERVER_URL + PACKAGE_URL,
error: someError
};
expectedStartedEventPayload = {
title: TITLE,
url: SERVER_URL + PACKAGE_URL
};
expectedProgressEventPayload = {
progress: PROGRESS,
status: STATUS,
title: TITLE,
url: SERVER_URL + PACKAGE_URL
};
});
afterEach(function() {
sync.restore();
filesystem.restore();
preferences.restore();
});
before(function() {
serviceTestHelper.runDefaultTests(packageManager, PackageManager.serviceName);
});
describe('updatePackage', function() {
describe('updates a package when package does not exist yet', function() {
beforeEach(function() {
filesystem.api.readFileAsText.returns(Promise.reject(someError));
});
it('returns resolved promise with newly synced package', function() {
sync.api.sync.returns(Promise.resolve());
return packageManager.updatePackage(PACKAGE_URL, TARGET_PATH, TIMESTAMP_EXPIRED, UPDATE_MODE, TITLE, UID).then(function(payload) {
expectFilesystemToBeCalled();
expectSyncToBeCalled();
expect(payload).to.deep.equal(expectedResolvedPayload);
});
});
it('emits "STARTED" event', function() {
var spy = sinon.spy();
packageManager.on(PackageManager.EVENTS.SYNC_STARTED, spy);
sync.api.sync.returns(Promise.resolve());
return packageManager.updatePackage(PACKAGE_URL, TARGET_PATH, TIMESTAMP_EXPIRED, UPDATE_MODE, TITLE, UID).then(function(payload) {
expect(spy).to.have.been.calledWithExactly(expectedStartedEventPayload);
});
});
it('emits "PROGRESS" event', function() {
var spy = sinon.spy();
packageManager.on(PackageManager.EVENTS.SYNC_PROGRESS, spy);
sync.api.sync.returns(Promise.resolve());
sync.api.sync.callsArgWith(3, {status: STATUS, progress: PROGRESS});
return packageManager.updatePackage(PACKAGE_URL, TARGET_PATH, TIMESTAMP_EXPIRED, UPDATE_MODE, TITLE, UID).then(function(payload) {
expect(spy).to.have.been.calledWithExactly(expectedProgressEventPayload);
});
});
it('returns rejected promise in case sync fails', function(done) {
sync.api.sync.returns(Promise.reject(someError));
return packageManager.updatePackage(PACKAGE_URL, TARGET_PATH, TIMESTAMP_EXPIRED, UPDATE_MODE, TITLE, UID).catch(function(payload) {
expectFilesystemToBeCalled();
expectSyncToBeCalled();
expect(payload).to.deep.equal(expectedRejectedPayload);
done();
});
});
});
describe('does not update a package that has not expired', function() {
beforeEach(function() {
sync.api.sync.returns(Promise.resolve());
filesystem.api.readFileAsText.returns(Promise.resolve('{ "lastModified": ' + PACKAGE_TIMESTAMP + ' }'));
});
it('returns resolved promise with existing package infos', function() {
return packageManager.updatePackage(PACKAGE_URL, TARGET_PATH, TIMESTAMP_NOT_EXPIRED, UPDATE_MODE, TITLE, UID).then(function(payload) {
expectFilesystemToBeCalled();
expectSyncNotToBeCalled();
expect(payload).to.deep.equal(expectedResolvedPayload);
});
});
it('does not emit "STARTED" event', function() {
var spy = sinon.spy();
packageManager.on(PackageManager.EVENTS.SYNC_STARTED, spy);
return packageManager.updatePackage(PACKAGE_URL, TARGET_PATH, TIMESTAMP_NOT_EXPIRED, UPDATE_MODE, TITLE, UID).then(function(payload) {
expect(spy).not.called;
});
});
it('does not emit "PROGRESS" event', function() {
var spy = sinon.spy();
packageManager.on(PackageManager.EVENTS.SYNC_PROGRESS, spy);
sync.api.sync.callsArgWith(3, {status: STATUS, progress: PROGRESS});
return packageManager.updatePackage(PACKAGE_URL, TARGET_PATH, TIMESTAMP_NOT_EXPIRED, UPDATE_MODE, TITLE, UID).then(function(payload) {
expect(spy).not.called;
});
});
});
describe('updates a package that has expired', function() {
beforeEach(function() {
filesystem.api.readFileAsText.returns(Promise.resolve('{ "lastModified": ' + PACKAGE_TIMESTAMP + ' }'));
});
it('returns resolved promise with newly synced package', function() {
sync.api.sync.returns(Promise.resolve());
return packageManager.updatePackage(PACKAGE_URL, TARGET_PATH, TIMESTAMP_EXPIRED, UPDATE_MODE, TITLE, UID).then(function(payload) {
expectFilesystemToBeCalled();
expectSyncToBeCalled();
expect(payload).to.deep.equal(expectedResolvedPayload);
});
});
it('emits "STARTED" event', function() {
var spy = sinon.spy();
packageManager.on(PackageManager.EVENTS.SYNC_STARTED, spy);
sync.api.sync.returns(Promise.resolve());
return packageManager.updatePackage(PACKAGE_URL, TARGET_PATH, TIMESTAMP_EXPIRED, UPDATE_MODE, TITLE, UID).then(function(payload) {
expect(spy).to.have.been.calledWithExactly(expectedStartedEventPayload);
});
});
it('emits "PROGRESS" event', function() {
var spy = sinon.spy();
packageManager.on(PackageManager.EVENTS.SYNC_PROGRESS, spy);
sync.api.sync.returns(Promise.resolve());
sync.api.sync.callsArgWith(3, {status: STATUS, progress: PROGRESS});
return packageManager.updatePackage(PACKAGE_URL, TARGET_PATH, TIMESTAMP_EXPIRED, UPDATE_MODE, TITLE, UID).then(function(payload) {
expect(spy).to.have.been.calledWithExactly(expectedProgressEventPayload);
});
});
it('returns rejected promise in case sync fails', function(done) {
sync.api.sync.returns(Promise.reject(someError));
return packageManager.updatePackage(PACKAGE_URL, TARGET_PATH, TIMESTAMP_EXPIRED, UPDATE_MODE, TITLE, UID).catch(function(payload) {
expectFilesystemToBeCalled();
expectSyncToBeCalled();
expect(payload).to.deep.equal(expectedRejectedPayload);
done();
});
});
});
describe('forces the update of an existing package when given timestamp is 0', function() {
beforeEach(function() {
filesystem.api.readFileAsText.returns(Promise.resolve('{ "lastModified": ' + PACKAGE_TIMESTAMP + ' }'));
});
it('returns resolved promise with newly synced package', function() {
sync.api.sync.returns(Promise.resolve());
return packageManager.updatePackage(PACKAGE_URL, TARGET_PATH, TIMESTAMP_FORCE_UPDATE, UPDATE_MODE, TITLE, UID).then(function(payload) {
expectSyncToBeCalled();
expect(payload).to.deep.equal(expectedResolvedPayload);
});
});
it('emits "STARTED" event', function() {
var spy = sinon.spy();
packageManager.on(PackageManager.EVENTS.SYNC_STARTED, spy);
sync.api.sync.returns(Promise.resolve());
return packageManager.updatePackage(PACKAGE_URL, TARGET_PATH, TIMESTAMP_FORCE_UPDATE, UPDATE_MODE, TITLE, UID).then(function(payload) {
expect(spy).to.have.been.calledWithExactly(expectedStartedEventPayload);
});
});
it('emits "PROGRESS" event', function() {
var spy = sinon.spy();
packageManager.on(PackageManager.EVENTS.SYNC_PROGRESS, spy);
sync.api.sync.returns(Promise.resolve());
sync.api.sync.callsArgWith(3, {status: STATUS, progress: PROGRESS});
return packageManager.updatePackage(PACKAGE_URL, TARGET_PATH, TIMESTAMP_FORCE_UPDATE, UPDATE_MODE, TITLE, UID).then(function(payload) {
expect(spy).to.have.been.calledWithExactly(expectedProgressEventPayload);
});
});
it('returns rejected promise in case sync fails', function(done) {
sync.api.sync.returns(Promise.reject(someError));
return packageManager.updatePackage(PACKAGE_URL, TARGET_PATH, TIMESTAMP_FORCE_UPDATE, UPDATE_MODE, TITLE, UID).catch(function(payload) {
expectSyncToBeCalled();
expect(payload).to.deep.equal(expectedRejectedPayload);
done();
});
});
});
});
function expectFilesystemToBeCalled() {
expect(filesystem.api.getUserDataPath.called);
expect(filesystem.api.readFileAsText.called);
expect(filesystem.api.readFileAsText.getCall(0).args[0]).contain(USER_DATA_PATH);
}
function expectSyncToBeCalled() {
expect(sync.api.sync.called);
expect(sync.api.sync.getCall(0).args[0]).contain(PACKAGE_URL);
expect(sync.api.sync.getCall(0).args[2]).equal(UPDATE_MODE);
}
function expectSyncNotToBeCalled() {
expect(sync.api.sync).not.called;
}
});
});