Skip to content

Commit afe3fc2

Browse files
928PJY928PJY
authored
fix UT (#55)
1 parent 9177a2a commit afe3fc2

File tree

2 files changed

+50
-43
lines changed

2 files changed

+50
-43
lines changed

‎src/credential/credentialController.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ export class CredentialController {
145145
let opened = await vscode.env.openExternal(vscode.Uri.parse(signUrl));
146146
if (!opened) {
147147
// User decline to open external URL to sign in
148-
throw new DocsError(`Sign-in with AAD Failed: Please Allow Code to open `, ErrorCode.AADSignInExternalUrlDeclined);
148+
throw new DocsError(`Sign-in with AAD Failed: Please Allow to open external URL to Sign-In`, ErrorCode.AADSignInExternalUrlDeclined);
149149
}
150150

151151
try {
@@ -180,7 +180,7 @@ export class CredentialController {
180180
let opened = await vscode.env.openExternal(vscode.Uri.parse(signUrl));
181181
if (!opened) {
182182
// User decline to open external URL to sign in
183-
throw new DocsError(`Sign-in with GitHub Failed: Please Allow Code to open `, ErrorCode.GitHubSignInExternalUrlDeclined);
183+
throw new DocsError(`Sign-in with GitHub Failed: Please Allow to open external URL to Sign-In`, ErrorCode.GitHubSignInExternalUrlDeclined);
184184
}
185185

186186
try {

‎test/componentTests/credentialController.test.ts

+48-41
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
import * as vscode from 'vscode';
2-
import { CredentialExpired, CredentialReset, EnvironmentChanged, BaseEvent, CredentialRetrieveFromLocalCredentialManager, UserSignedOut, UserSignInProgress, UserSigningIn, UserSignInSucceeded, UserSignInFailed } from '../../src/common/loggingEvents';
2+
import * as assert from 'assert';
3+
import { CredentialExpired, CredentialReset, EnvironmentChanged, BaseEvent, CredentialRetrieveFromLocalCredentialManager, UserSignInProgress, UserSignInSucceeded, UserSignInFailed, UserSignInTriggered, UserSignOutSucceeded, UserSignOutTriggered } from '../../src/common/loggingEvents';
34
import { EventStream } from '../../src/common/eventStream';
45
import { CredentialController, Credential } from '../../src/credential/credentialController';
56
import { KeyChain } from '../../src/credential/keyChain';
67
import { EnvironmentController } from '../../src/common/environmentController';
78
import { SinonSandbox, createSandbox, SinonStub } from 'sinon';
8-
import { expect } from 'chai';
99
import TestEventBus from '../utils/testEventBus';
1010
import { UserInfo, uriHandler } from '../../src/shared';
1111
import { getFakeEnvironmentController } from '../utils/faker';
1212
import extensionConfig from '../../src/config';
13+
import { DocsError } from '../../src/error/docsError';
14+
import { ErrorCode } from '../../src/error/errorCode';
15+
import { TimeOutError } from '../../src/error/timeOutError';
1316

1417
const fakedAADCallbackURL = <vscode.Uri>{
1518
authority: 'ceapex.docs-build',
@@ -110,9 +113,9 @@ describe('CredentialController', () => {
110113
}
111114

112115
function AssertCredentialReset(credential: Credential) {
113-
expect(isResetAADInfoCalled).to.be.true;
114-
expect(isResetUserInfoCalled).to.be.true;
115-
expect(credential).to.deep.equal(<Credential>{
116+
assert.equal(isResetAADInfoCalled, true);
117+
assert.equal(isResetUserInfoCalled, true);
118+
assert.deepStrictEqual(credential, <Credential>{
116119
signInStatus: 'SignedOut',
117120
aadInfo: undefined,
118121
userInfo: undefined
@@ -135,7 +138,7 @@ describe('CredentialController', () => {
135138
it(`CredentialController Initialize should be Called`, () => {
136139
credentialController.eventHandler(event);
137140

138-
expect(isCredentialControllerInitializeCalled).to.be.true;
141+
assert.equal(isCredentialControllerInitializeCalled, true);
139142
});
140143
});
141144
});
@@ -146,7 +149,7 @@ describe('CredentialController', () => {
146149

147150
let credential = credentialController.credential;
148151
AssertCredentialReset(credential);
149-
expect(testEventBus.getEvents()).to.deep.equal([new CredentialReset()]);
152+
assert.deepStrictEqual(testEventBus.getEvents(), [new CredentialReset()]);
150153
});
151154

152155
describe(`Initialize`, () => {
@@ -169,8 +172,8 @@ describe('CredentialController', () => {
169172
userToken: 'fake-token'
170173
}
171174
};
172-
expect(credential).to.deep.equal(expectedCredential);
173-
expect(testEventBus.getEvents()).to.deep.equal([new CredentialRetrieveFromLocalCredentialManager(expectedCredential)]);
175+
assert.deepStrictEqual(credential, expectedCredential);
176+
assert.deepStrictEqual(testEventBus.getEvents(), [new CredentialRetrieveFromLocalCredentialManager(expectedCredential)]);
174177
});
175178

176179
it(`Should be 'SignedOut' status if the user info can not be retrieved from keyChain`, async () => {
@@ -183,7 +186,7 @@ describe('CredentialController', () => {
183186
// Assert
184187
let credential = credentialController.credential;
185188
AssertCredentialReset(credential);
186-
expect(testEventBus.getEvents()).to.deep.equal([new CredentialReset()]);
189+
assert.deepStrictEqual(testEventBus.getEvents(), [new CredentialReset()]);
187190
});
188191
});
189192

@@ -209,7 +212,7 @@ describe('CredentialController', () => {
209212
);
210213

211214
// act
212-
await credentialController.signIn();
215+
await credentialController.signIn('fakedCorrelationId');
213216

214217
// Assert
215218
let credential = credentialController.credential;
@@ -224,17 +227,17 @@ describe('CredentialController', () => {
224227
aadInfo: 'aad-code',
225228
userInfo: expectedUserInfo
226229
};
227-
expect(credential).to.deep.equal(expectedCredential);
228-
expect(isSetAADInfoCalled).to.be.true;
229-
expect(setAADInfo).to.equal('aad-code');
230-
expect(isSetUserInfoCalled).to.be.true;
231-
expect(setUserInfo).to.deep.equal(expectedUserInfo);
232-
expect(testEventBus.getEvents()).to.deep.equal([
230+
assert.deepStrictEqual(credential, expectedCredential);
231+
assert.equal(isSetAADInfoCalled, true);
232+
assert.equal(setAADInfo, 'aad-code');
233+
assert.equal(isSetUserInfoCalled, true);
234+
assert.deepStrictEqual(setUserInfo, expectedUserInfo);
235+
assert.deepStrictEqual(testEventBus.getEvents(), [
233236
new CredentialReset(),
234-
new UserSigningIn(),
237+
new UserSignInTriggered('fakedCorrelationId'),
235238
new UserSignInProgress(`Sign-in to docs build with AAD...`, 'Sign-in'),
236239
new UserSignInProgress(`Sign-in to docs build with GitHub account...`, 'Sign-in'),
237-
new UserSignInSucceeded(expectedCredential)
240+
new UserSignInSucceeded('fakedCorrelationId', expectedCredential)
238241
]);
239242
});
240243

@@ -243,17 +246,17 @@ describe('CredentialController', () => {
243246
stubOpenExternal = sinon.stub(vscode.env, 'openExternal').resolves(false);
244247

245248
// Act
246-
await credentialController.signIn();
249+
await credentialController.signIn('fakedCorrelationId');
247250

248251
// Assert
249252
let credential = credentialController.credential;
250253
AssertCredentialReset(credential);
251-
expect(testEventBus.getEvents()).to.deep.equal([
254+
assert.deepStrictEqual(testEventBus.getEvents(), [
252255
new CredentialReset(),
253-
new UserSigningIn(),
256+
new UserSignInTriggered('fakedCorrelationId'),
254257
new UserSignInProgress(`Sign-in to docs build with AAD...`, 'Sign-in'),
255-
new UserSignInFailed(`Sign-in with AAD Failed`),
256-
new CredentialReset()
258+
new CredentialReset(),
259+
new UserSignInFailed('fakedCorrelationId', new DocsError(`Sign-in with AAD Failed: Please Allow to open external URL to Sign-In`, ErrorCode.AADSignInExternalUrlDeclined)),
257260
]);
258261
});
259262

@@ -274,18 +277,18 @@ describe('CredentialController', () => {
274277
);
275278

276279
// Act
277-
await credentialController.signIn();
280+
await credentialController.signIn('fakedCorrelationId');
278281

279282
// Assert
280283
let credential = credentialController.credential;
281284
AssertCredentialReset(credential);
282-
expect(testEventBus.getEvents()).to.deep.equal([
285+
assert.deepStrictEqual(testEventBus.getEvents(), [
283286
new CredentialReset(),
284-
new UserSigningIn(),
287+
new UserSignInTriggered('fakedCorrelationId'),
285288
new UserSignInProgress(`Sign-in to docs build with AAD...`, 'Sign-in'),
286289
new UserSignInProgress(`Sign-in to docs build with GitHub account...`, 'Sign-in'),
287-
new UserSignInFailed(`Sign-in with GitHub Failed`),
288-
new CredentialReset()
290+
new CredentialReset(),
291+
new UserSignInFailed('fakedCorrelationId', new DocsError(`Sign-in with GitHub Failed: Please Allow to open external URL to Sign-In`, ErrorCode.GitHubSignInExternalUrlDeclined)),
289292
]);
290293
});
291294

@@ -298,17 +301,17 @@ describe('CredentialController', () => {
298301
stubOpenExternal = sinon.stub(vscode.env, 'openExternal').resolves(true);
299302

300303
// Act
301-
await credentialController.signIn();
304+
await credentialController.signIn('fakedCorrelationId');
302305

303306
// Assert
304307
let credential = credentialController.credential;
305308
AssertCredentialReset(credential);
306-
expect(testEventBus.getEvents()).to.deep.equal([
309+
assert.deepStrictEqual(testEventBus.getEvents(), [
307310
new CredentialReset(),
308-
new UserSigningIn(),
311+
new UserSignInTriggered('fakedCorrelationId'),
309312
new UserSignInProgress(`Sign-in to docs build with AAD...`, 'Sign-in'),
310-
new UserSignInFailed(`Sign-in with AAD Failed: Timeout`),
311-
new CredentialReset()
313+
new CredentialReset(),
314+
new UserSignInFailed('fakedCorrelationId', new DocsError(`Sign-in with AAD Failed: Time out`, ErrorCode.AADSignInTimeOut, new TimeOutError('Time out'))),
312315
]);
313316
});
314317

@@ -332,18 +335,18 @@ describe('CredentialController', () => {
332335
);
333336

334337
// Act
335-
await credentialController.signIn();
338+
await credentialController.signIn('fakedCorrelationId');
336339

337340
// Assert
338341
let credential = credentialController.credential;
339342
AssertCredentialReset(credential);
340-
expect(testEventBus.getEvents()).to.deep.equal([
343+
assert.deepStrictEqual(testEventBus.getEvents(), [
341344
new CredentialReset(),
342-
new UserSigningIn(),
345+
new UserSignInTriggered('fakedCorrelationId'),
343346
new UserSignInProgress(`Sign-in to docs build with AAD...`, 'Sign-in'),
344347
new UserSignInProgress(`Sign-in to docs build with GitHub account...`, 'Sign-in'),
345-
new UserSignInFailed(`Sign-in with GitHub Failed: Timeout`),
346-
new CredentialReset()
348+
new CredentialReset(),
349+
new UserSignInFailed('fakedCorrelationId', new DocsError(`Sign-in with GitHub Failed: Time out`, ErrorCode.GitHubSignInTimeOut, new TimeOutError('Time out'))),
347350
]);
348351
});
349352
});
@@ -354,11 +357,15 @@ describe('CredentialController', () => {
354357
credentialController.initialize();
355358

356359
// Act - Sign-out
357-
credentialController.signOut();
360+
credentialController.signOut('fakedCorrelationId');
358361

359362
// Assert
360363
let credential = credentialController.credential;
361364
AssertCredentialReset(credential);
362-
expect(testEventBus.getEvents()).to.deep.equal([new CredentialReset(), new UserSignedOut()]);
365+
assert.deepStrictEqual(testEventBus.getEvents(), [
366+
new UserSignOutTriggered('fakedCorrelationId'),
367+
new CredentialReset(),
368+
new UserSignOutSucceeded('fakedCorrelationId')
369+
]);
363370
});
364371
});

0 commit comments

Comments
 (0)