Skip to content
Navigation Menu
{{ message }}
forked from pnp/cli-microsoft365
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCommand.spec.ts
More file actions
357 lines (312 loc) · 9.27 KB
/
Copy pathCommand.spec.ts
File metadata and controls
357 lines (312 loc) · 9.27 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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
import * as assert from 'assert';
import * as chalk from 'chalk';
import * as sinon from 'sinon';
import appInsights from './appInsights';
import auth from './Auth';
import { Cli } from './cli';
import { Logger } from './cli/Logger';
import Command, {
CommandError, CommandOption,
CommandTypes
} from './Command';
import Utils from './Utils';
class MockCommand1 extends Command {
public get name(): string {
return 'mock-command';
}
public get description(): string {
return 'Mock command description';
}
public alias(): string[] | undefined {
return ['mc1'];
}
public autocomplete(): string[] | undefined {
const autocomplete = ['param1', 'param2'];
const parentAutocomplete: string[] | undefined = super.autocomplete();
if (parentAutocomplete) {
return autocomplete.concat(parentAutocomplete);
}
else {
return autocomplete;
}
}
public allowUnknownOptions(): boolean {
return true;
}
public commandAction(logger: Logger, args: any, cb: (err?: any) => void): void {
this.showDeprecationWarning(logger, 'mc1', this.name);
cb();
}
public validate(): boolean | string {
return true;
}
public types(): CommandTypes | undefined {
return {
string: ['option2']
};
}
public options(): CommandOption[] {
return [
{
option: '--debug'
},
{
option: '--option1 [option1]'
},
{
option: '--option2 [option2]'
}
];
}
public trackUnknownOptionsPublic(telemetryProps: any, options: any) {
return this.trackUnknownOptions(telemetryProps, options);
}
public addUnknownOptionsToPayloadPublic(payload: any, options: any) {
return this.addUnknownOptionsToPayload(payload, options);
}
}
class MockCommand2 extends Command {
public get name(): string {
return 'Mock command 2 [opt]';
}
public get description(): string {
return 'Mock command 2 description';
}
public commandAction(): void {
}
public commandHelp(args: any, log: (message: string) => void): void {
log('MockCommand2 help');
}
public handlePromiseError(response: any, logger: Logger, callback: (err?: any) => void): void {
this.handleRejectedODataJsonPromise(response, logger, callback);
}
}
class MockCommand3 extends Command {
public get name(): string {
return 'mock-command';
}
public get description(): string {
return 'Mock command description';
}
public commandAction(): void {
}
public commandHelp(): void {
}
public options(): CommandOption[] {
return [
{
option: '--debug'
},
{
option: '--option1 [option1]'
}
];
}
}
describe('Command', () => {
let telemetry: any;
let logger: Logger;
let loggerLogToStderrSpy: sinon.SinonSpy;
let cli: Cli;
before(() => {
sinon.stub(auth, 'restoreAuth').callsFake(() => Promise.resolve());
sinon.stub(appInsights, 'trackEvent').callsFake((t) => {
telemetry = t;
});
logger = {
log: () => { },
logRaw: () => { },
logToStderr: () => { }
};
loggerLogToStderrSpy = sinon.spy(logger, 'logToStderr');
cli = Cli.getInstance();
});
beforeEach(() => {
telemetry = null;
auth.service.connected = true;
cli.currentCommandName = undefined;
});
afterEach(() => {
Utils.restore([
process.exit
]);
auth.service.connected = false;
});
after(() => {
Utils.restore([
appInsights.trackEvent,
auth.restoreAuth
]);
});
it('has no autocomplete by default', () => {
const cmd = new MockCommand2();
assert.strictEqual(typeof cmd.autocomplete(), 'undefined');
});
it('returns true by default', () => {
const cmd = new MockCommand2();
assert.strictEqual(cmd.validate({}), true);
});
it('does not define option types by default', () => {
const cmd = new MockCommand2();
assert.strictEqual(typeof cmd.types(), 'undefined');
});
it('removes optional arguments from command name', () => {
const cmd = new MockCommand2();
assert.strictEqual(cmd.getCommandName(), 'Mock command 2');
});
it('displays error message when it\'s serialized in the error property', () => {
const mock = new MockCommand2();
mock.handlePromiseError({
error: JSON.stringify({
error: {
message: 'An error has occurred'
}
})
}, logger, (err?: any) => {
assert.strictEqual(JSON.stringify(err), JSON.stringify(new CommandError('An error has occurred')));
});
});
it('displays the raw error message when the serialized value from the error property is not an error object', () => {
const mock = new MockCommand2();
mock.handlePromiseError({
error: JSON.stringify({
error: {
id: '123'
}
})
}, logger, (err?: any) => {
assert.strictEqual(JSON.stringify(err), JSON.stringify(new CommandError(JSON.stringify({
error: {
id: '123'
}
}))));
});
});
it('displays the raw error message when the serialized value from the error property is not a JSON object', () => {
const mock = new MockCommand2();
mock.handlePromiseError({
error: 'abc'
}, logger, (err?: any) => {
assert.strictEqual(JSON.stringify(err), JSON.stringify(new CommandError('abc')));
});
});
it('displays error message coming from ADALJS', () => {
const mock = new MockCommand2();
mock.handlePromiseError({
error: { error_description: 'abc' }
}, logger, (err?: any) => {
assert.strictEqual(JSON.stringify(err), JSON.stringify(new CommandError('abc')));
});
});
it('shows deprecation warning when command executed using the deprecated name', () => {
cli.currentCommandName = 'mc1';
const mock = new MockCommand1();
mock.commandAction(logger, {}, (): void => {
assert(loggerLogToStderrSpy.calledWith(chalk.yellow(`Command 'mc1' is deprecated. Please use 'mock-command' instead`)));
});
});
it('logs command name in the telemetry when command name used', (done) => {
const mock = new MockCommand1();
mock.action(logger, { options: {} }, () => {
try {
assert.strictEqual(telemetry.name, 'mock-command');
done();
}
catch (e) {
done(e);
}
});
});
it('logs command alias in the telemetry when command alias used', (done) => {
cli.currentCommandName = 'mc1';
const mock = new MockCommand1();
mock.action(logger, { options: {} }, () => {
try {
assert.strictEqual(telemetry.name, 'mc1');
done();
}
catch (e) {
done(e);
}
});
});
it('logs empty command name in telemetry when command called using something else than name or alias', (done) => {
cli.currentCommandName = 'foo';
const mock = new MockCommand1();
mock.action(logger, { options: {} }, () => {
try {
assert.strictEqual(telemetry.name, '');
done();
}
catch (e) {
done(e);
}
});
});
it('correctly handles error when instance of error returned from the promise', (done) => {
const cmd = new MockCommand3();
(cmd as any).handleRejectedODataPromise(new Error('An error has occurred'), undefined, (msg: any): void => {
try {
assert.strictEqual(JSON.stringify(msg), JSON.stringify(new CommandError('An error has occurred')));
done();
}
catch (e) {
done(e);
}
});
});
it('correctly handles graph response (code) from the promise', (done) => {
const errorMessage = "forbidden-message";
const errorCode = "Access Denied";
const cmd = new MockCommand3();
(cmd as any).handleRejectedODataPromise({ error: { error: { message: errorMessage, code: errorCode } } }, undefined, (msg: any): void => {
try {
assert.strictEqual(JSON.stringify(msg), JSON.stringify(new CommandError(errorCode + " - " + errorMessage)));
done();
}
catch (e) {
done(e);
}
});
});
it('correctly handles graph response error (without code) from the promise', (done) => {
const errorMessage = "forbidden-message";
const cmd = new MockCommand3();
(cmd as any).handleRejectedODataPromise({ error: { error: { message: errorMessage } } }, undefined, (msg: any): void => {
try {
assert.strictEqual(JSON.stringify(msg), JSON.stringify(new CommandError(errorMessage)));
done();
}
catch (e) {
done(e);
}
});
});
it('tracks the use of unknown options in telemetry', () => {
const command = new MockCommand1();
const actual = {
prop1: true
};
const expected = JSON.stringify({
prop1: true,
// this is expected, because we're not tracking the actual value but rather
// whether the property is used or not, so the tracked value for an unknown
// property will be always true
Prop2: true
});
command.trackUnknownOptionsPublic(actual, { Prop2: false });
assert.strictEqual(JSON.stringify(actual), expected);
});
it('adds unknown options to payload', () => {
const command = new MockCommand1();
const actual = {
prop1: true
};
const expected = JSON.stringify({
prop1: true,
Prop2: false
});
command.addUnknownOptionsToPayloadPublic(actual, { Prop2: false });
assert.strictEqual(JSON.stringify(actual), expected);
});
});
You can’t perform that action at this time.