Skip to content

Commit e911928

Browse files
evidolobevidolob
authored
Fix json schema status bar item tests (#674)
* Fix json schema status bar item tests Signed-off-by: Yevhen Vydolob <yvydolob@redhat.com> * Skip telemetry tests Signed-off-by: Yevhen Vydolob <yvydolob@redhat.com>
1 parent 611d4b5 commit e911928

File tree

6 files changed

+67
-64
lines changed

6 files changed

+67
-64
lines changed

‎package.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@
215215
"@types/fs-extra": "^9.0.6",
216216
"@types/mocha": "^2.2.48",
217217
"@types/node": "^12.12.6",
218-
"@types/sinon": "^9.0.5",
218+
"@types/sinon": "^10.0.6",
219219
"@types/sinon-chai": "^3.2.5",
220220
"@types/vscode": "^1.52.0",
221221
"@types/webpack": "^4.4.10",
@@ -233,8 +233,8 @@
233233
"prettier": "2.2.1",
234234
"process": "^0.11.10",
235235
"rimraf": "^3.0.2",
236-
"sinon": "^9.0.3",
237-
"sinon-chai": "^3.5.0",
236+
"sinon": "^12.0.1",
237+
"sinon-chai": "^3.7.0",
238238
"ts-loader": "^9.2.5",
239239
"ts-node": "^3.3.0",
240240
"typescript": "4.4.3",

‎src/schema-status-bar-item.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,15 @@ export function createJSONSchemaStatusBarItem(context: ExtensionContext, languag
5555
context.subscriptions.push(statusBarItem);
5656

5757
context.subscriptions.push(window.onDidChangeActiveTextEditor(updateStatusBar));
58-
setTimeout(() => updateStatusBar(window.activeTextEditor), 5000);
58+
59+
updateStatusBar(window.activeTextEditor);
5960
}
6061

6162
async function updateStatusBar(editor: TextEditor): Promise<void> {
6263
if (editor && editor.document.languageId === 'yaml') {
6364
// get schema info there
6465
const schema = await client.sendRequest(getSchema, editor.document.uri.toString());
65-
if (schema.length === 0) {
66+
if (!schema || schema.length === 0) {
6667
statusBarItem.text = 'No JSON Schema';
6768
statusBarItem.tooltip = 'Select JSON Schema';
6869
statusBarItem.backgroundColor = undefined;

‎test/helper.ts‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import * as vscode from 'vscode';
88
import * as path from 'path';
99
import assert = require('assert');
1010
import { CommonLanguageClient } from 'vscode-languageclient/lib/common/commonClient';
11-
import { MessageTransports } from 'vscode-languageclient';
11+
import { MessageTransports, ProtocolRequestType, ProtocolRequestType0, RequestType, RequestType0 } from 'vscode-languageclient';
1212

1313
export let doc: vscode.TextDocument;
1414
export let editor: vscode.TextEditor;
@@ -152,4 +152,23 @@ export class TestLanguageClient extends CommonLanguageClient {
152152
protected createMessageTransports(): Promise<MessageTransports> {
153153
throw new Error('Method not implemented.');
154154
}
155+
156+
sendRequest<R, PR, E, RO>(type: ProtocolRequestType0<R, PR, E, RO>, token?: vscode.CancellationToken): Promise<R>;
157+
sendRequest<P, R, PR, E, RO>(
158+
type: ProtocolRequestType<P, R, PR, E, RO>,
159+
params: P,
160+
token?: vscode.CancellationToken
161+
): Promise<R>;
162+
sendRequest<R, E>(type: RequestType0<R, E>, token?: vscode.CancellationToken): Promise<R>;
163+
sendRequest<P, R, E>(type: RequestType<P, R, E>, params: P, token?: vscode.CancellationToken): Promise<R>;
164+
sendRequest<R>(method: string, token?: vscode.CancellationToken): Promise<R>;
165+
/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-unused-vars*/
166+
sendRequest<R>(method: string, param: any, token?: vscode.CancellationToken): Promise<R>;
167+
sendRequest<R>(
168+
method: any,
169+
param?: any,
170+
token?: any
171+
): Promise<R> | Promise<R> | Promise<R> | Promise<R> | Promise<R> | Promise<R> {
172+
return Promise.resolve(void 0);
173+
}
155174
}

‎test/json-schema-selection.test.ts‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ chai.use(sinonChai);
1616

1717
describe('Status bar should work in multiple different scenarios', () => {
1818
const sandbox = sinon.createSandbox();
19-
let clock: sinon.SinonFakeTimers;
2019
let clcStub: sinon.SinonStubbedInstance<TestLanguageClient>;
2120
let registerCommandStub: sinon.SinonStub;
2221
let createStatusBarItemStub: sinon.SinonStub;
@@ -28,20 +27,20 @@ describe('Status bar should work in multiple different scenarios', () => {
2827
createStatusBarItemStub = sandbox.stub(vscode.window, 'createStatusBarItem');
2928
onDidChangeActiveTextEditorStub = sandbox.stub(vscode.window, 'onDidChangeActiveTextEditor');
3029
sandbox.stub(vscode.window, 'activeTextEditor').returns(undefined);
31-
clock = sandbox.useFakeTimers();
3230
sandbox.stub(jsonStatusBar, 'statusBarItem').returns(undefined);
3331
});
3432

3533
afterEach(() => {
36-
clock.restore();
3734
sandbox.restore();
3835
});
3936

40-
it('Should create status bar item for JSON Schema', () => {
37+
it('Should create status bar item for JSON Schema', async () => {
4138
const context: vscode.ExtensionContext = {
4239
subscriptions: [],
4340
} as vscode.ExtensionContext;
44-
createStatusBarItemStub.returns({});
41+
const statusBar = ({ show: sandbox.stub() } as unknown) as vscode.StatusBarItem;
42+
createStatusBarItemStub.returns(statusBar);
43+
clcStub.sendRequest.resolves([]);
4544

4645
createJSONSchemaStatusBarItem(context, (clcStub as unknown) as CommonLanguageClient);
4746

@@ -66,7 +65,7 @@ describe('Status bar should work in multiple different scenarios', () => {
6665
expect(statusBar.text).to.equal('bar schema');
6766
expect(statusBar.tooltip).to.equal('Select JSON Schema');
6867
expect(statusBar.backgroundColor).to.be.undefined;
69-
expect(statusBar.show).calledOnce;
68+
expect(statusBar.show).calledTwice;
7069
});
7170

7271
it('Should inform if there are no schema', async () => {
@@ -85,7 +84,7 @@ describe('Status bar should work in multiple different scenarios', () => {
8584
expect(statusBar.text).to.equal('No JSON Schema');
8685
expect(statusBar.tooltip).to.equal('Select JSON Schema');
8786
expect(statusBar.backgroundColor).to.be.undefined;
88-
expect(statusBar.show).calledOnce;
87+
expect(statusBar.show).calledTwice;
8988
});
9089

9190
it('Should inform if there are more than one schema', async () => {
@@ -104,6 +103,6 @@ describe('Status bar should work in multiple different scenarios', () => {
104103
expect(statusBar.text).to.equal('Multiple JSON Schemas...');
105104
expect(statusBar.tooltip).to.equal('Multiple JSON Schema used to validate this file, click to select one');
106105
expect(statusBar.backgroundColor).to.eql({ id: 'statusBarItem.warningBackground' });
107-
expect(statusBar.show).calledOnce;
106+
expect(statusBar.show).calledTwice;
108107
});
109108
});

‎test/telemetry.test.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ class TelemetryStub implements TelemetryService {
2929
throw new Error('Method not implemented.');
3030
}
3131
}
32-
describe('Telemetry Test', () => {
32+
// skip this suite as `useFakeTimers` hung's vscode and CI newer finish build
33+
describe.skip('Telemetry Test', () => {
3334
const sandbox = sinon.createSandbox();
3435
const testOutputChannel = vscode.window.createOutputChannel('YAML_TEST');
3536
afterEach(() => {

‎yarn.lock‎

Lines changed: 32 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -117,31 +117,31 @@
117117
component-type "^1.2.1"
118118
join-component "^1.1.0"
119119

120-
"@sinonjs/commons@^1.6.0", "@sinonjs/commons@^1.7.0", "@sinonjs/commons@^1.8.1":
120+
"@sinonjs/commons@^1.6.0", "@sinonjs/commons@^1.7.0", "@sinonjs/commons@^1.8.3":
121121
version "1.8.3"
122122
resolved "https://registry.yarnpkg.com/@sinonjs/commons/-/commons-1.8.3.tgz#3802ddd21a50a949b6721ddd72da36e67e7f1b2d"
123123
integrity sha512-xkNcLAn/wZaX14RPlwizcKicDk9G3F8m2nU3L7Ukm5zBgTwiT0wsoFAHx9Jq56fJA1z/7uKGtCRu16sOUCLIHQ==
124124
dependencies:
125125
type-detect "4.0.8"
126126

127-
"@sinonjs/fake-timers@^6.0.0", "@sinonjs/fake-timers@^6.0.1":
128-
version "6.0.1"
129-
resolved "https://registry.yarnpkg.com/@sinonjs/fake-timers/-/fake-timers-6.0.1.tgz#293674fccb3262ac782c7aadfdeca86b10c75c40"
130-
integrity sha512-MZPUxrmFubI36XS1DI3qmI0YdN1gks62JtFZvxR67ljjSNCeK6U08Zx4msEWOXuofgqUt6zPHSi1H9fbjR/NRA==
131-
dependencies:
132-
"@sinonjs/commons" "^1.7.0"
133-
134-
"@sinonjs/fake-timers@^7.1.0":
127+
"@sinonjs/fake-timers@^7.0.4", "@sinonjs/fake-timers@^7.1.0":
135128
version "7.1.2"
136129
resolved "https://registry.yarnpkg.com/@sinonjs/fake-timers/-/fake-timers-7.1.2.tgz#2524eae70c4910edccf99b2f4e6efc5894aff7b5"
137130
integrity sha512-iQADsW4LBMISqZ6Ci1dupJL9pprqwcVFTcOsEmQOEhW+KLCVn/Y4Jrvg2k19fIHCp+iFprriYPTdRcQR8NbUPg==
138131
dependencies:
139132
"@sinonjs/commons" "^1.7.0"
140133

141-
"@sinonjs/samsam@^5.3.1":
142-
version "5.3.1"
143-
resolved "https://registry.yarnpkg.com/@sinonjs/samsam/-/samsam-5.3.1.tgz#375a45fe6ed4e92fca2fb920e007c48232a6507f"
144-
integrity sha512-1Hc0b1TtyfBu8ixF/tpfSHTVWKwCBLY4QJbkgnE7HcwyvT2xArDxb4K7dMgqRm3szI+LJbzmW/s4xxEhv6hwDg==
134+
"@sinonjs/fake-timers@^8.1.0":
135+
version "8.1.0"
136+
resolved "https://registry.yarnpkg.com/@sinonjs/fake-timers/-/fake-timers-8.1.0.tgz#3fdc2b6cb58935b21bfb8d1625eb1300484316e7"
137+
integrity sha512-OAPJUAtgeINhh/TAlUID4QTs53Njm7xzddaVlEs/SXwgtiD1tW22zAB/W1wdqfrpmikgaWQ9Fw6Ws+hsiRm5Vg==
138+
dependencies:
139+
"@sinonjs/commons" "^1.7.0"
140+
141+
"@sinonjs/samsam@^6.0.2":
142+
version "6.0.2"
143+
resolved "https://registry.yarnpkg.com/@sinonjs/samsam/-/samsam-6.0.2.tgz#a0117d823260f282c04bff5f8704bdc2ac6910bb"
144+
integrity sha512-jxPRPp9n93ci7b8hMfJOFDPRLFYadN6FSpeROFTR4UNF4i5b+EK6m4QXPO46BDhFgRy1JuS87zAnFOzCUwMJcQ==
145145
dependencies:
146146
"@sinonjs/commons" "^1.6.0"
147147
lodash.get "^4.4.2"
@@ -223,25 +223,13 @@
223223
"@types/chai" "*"
224224
"@types/sinon" "*"
225225

226-
"@types/sinon@*":
226+
"@types/sinon@*", "@types/sinon@^10.0.6":
227227
version "10.0.6"
228228
resolved "https://registry.yarnpkg.com/@types/sinon/-/sinon-10.0.6.tgz#bc3faff5154e6ecb69b797d311b7cf0c1b523a1d"
229229
integrity sha512-6EF+wzMWvBNeGrfP3Nx60hhx+FfwSg1JJBLAAP/IdIUq0EYkqCYf70VT3PhuhPX9eLD+Dp+lNdpb/ZeHG8Yezg==
230230
dependencies:
231231
"@sinonjs/fake-timers" "^7.1.0"
232232

233-
"@types/sinon@^9.0.5":
234-
version "9.0.11"
235-
resolved "https://registry.yarnpkg.com/@types/sinon/-/sinon-9.0.11.tgz#7af202dda5253a847b511c929d8b6dda170562eb"
236-
integrity sha512-PwP4UY33SeeVKodNE37ZlOsR9cReypbMJOhZ7BVE0lB+Hix3efCOxiJWiE5Ia+yL9Cn2Ch72EjFTRze8RZsNtg==
237-
dependencies:
238-
"@types/sinonjs__fake-timers" "*"
239-
240-
"@types/sinonjs__fake-timers@*":
241-
version "6.0.4"
242-
resolved "https://registry.yarnpkg.com/@types/sinonjs__fake-timers/-/sinonjs__fake-timers-6.0.4.tgz#0ecc1b9259b76598ef01942f547904ce61a6a77d"
243-
integrity sha512-IFQTJARgMUBF+xVd2b+hIgXWrZEjND3vJtRCvIelcFB5SIXfjV4bOHbHJ0eXKh+0COrBRc8MqteKAz/j88rE0A==
244-
245233
"@types/source-list-map@*":
246234
version "0.1.2"
247235
resolved "https://registry.yarnpkg.com/@types/source-list-map/-/source-list-map-0.1.2.tgz#0078836063ffaf17412349bba364087e0ac02ec9"
@@ -1190,7 +1178,7 @@ destroy@^1.0.4:
11901178
resolved "https://registry.yarnpkg.com/destroy/-/destroy-1.0.4.tgz#978857442c44749e4206613e37946205826abd80"
11911179
integrity sha1-l4hXRCxEdJ5CBmE+N5RiBYJqvYA=
11921180

1193-
diff@5.0.0:
1181+
diff@5.0.0, diff@^5.0.0:
11941182
version "5.0.0"
11951183
resolved "https://registry.yarnpkg.com/diff/-/diff-5.0.0.tgz#7ed6ad76d859d030787ec35855f5b1daf31d852b"
11961184
integrity sha512-/VTCrvm5Z0JGty/BWHljh+BAiw3IK+2j87NGMu8Nwc/f48WoDAC395uomO9ZD117ZOBaHmkX1oyLvkVM/aIT3w==
@@ -1200,11 +1188,6 @@ diff@^3.1.0:
12001188
resolved "https://registry.yarnpkg.com/diff/-/diff-3.5.0.tgz#800c0dd1e0a8bfbc95835c202ad220fe317e5a12"
12011189
integrity sha512-A46qtFgd+g7pDZinpnwiRJtxbC1hpgf0uzP3iG89scHk0AUC7A1TGxf5OiiOUv/JMZR8GOt8hL900hV0bOy5xA==
12021190

1203-
diff@^4.0.2:
1204-
version "4.0.2"
1205-
resolved "https://registry.yarnpkg.com/diff/-/diff-4.0.2.tgz#60f3aecb89d5fae520c11aa19efc2bb982aade7d"
1206-
integrity sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==
1207-
12081191
dir-glob@^3.0.1:
12091192
version "3.0.1"
12101193
resolved "https://registry.yarnpkg.com/dir-glob/-/dir-glob-3.0.1.tgz#56dbf73d992a4a93ba1584f4534063fd2e41717f"
@@ -2644,13 +2627,13 @@ neo-async@^2.6.2:
26442627
resolved "https://registry.yarnpkg.com/neo-async/-/neo-async-2.6.2.tgz#b4aafb93e3aeb2d8174ca53cf163ab7d7308305f"
26452628
integrity sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==
26462629

2647-
nise@^4.0.4:
2648-
version "4.1.0"
2649-
resolved "https://registry.yarnpkg.com/nise/-/nise-4.1.0.tgz#8fb75a26e90b99202fa1e63f448f58efbcdedaf6"
2650-
integrity sha512-eQMEmGN/8arp0xsvGoQ+B1qvSkR73B1nWSCh7nOt5neMCtwcQVYQGdzQMhcNscktTsWB54xnlSQFzOAPJD8nXA==
2630+
nise@^5.1.0:
2631+
version "5.1.0"
2632+
resolved "https://registry.yarnpkg.com/nise/-/nise-5.1.0.tgz#713ef3ed138252daef20ec035ab62b7a28be645c"
2633+
integrity sha512-W5WlHu+wvo3PaKLsJJkgPup2LrsXCcm7AWwyNZkUnn5rwPkuPBi3Iwk5SQtN0mv+K65k7nKKjwNQ30wg3wLAQQ==
26512634
dependencies:
26522635
"@sinonjs/commons" "^1.7.0"
2653-
"@sinonjs/fake-timers" "^6.0.0"
2636+
"@sinonjs/fake-timers" "^7.0.4"
26542637
"@sinonjs/text-encoding" "^0.7.1"
26552638
just-extend "^4.0.2"
26562639
path-to-regexp "^1.7.0"
@@ -3249,22 +3232,22 @@ signal-exit@^3.0.2, signal-exit@^3.0.3:
32493232
resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.5.tgz#9e3e8cc0c75a99472b44321033a7702e7738252f"
32503233
integrity sha512-KWcOiKeQj6ZyXx7zq4YxSMgHRlod4czeBQZrPb8OKcohcqAXShm7E20kEMle9WBt26hFcAf0qLOcp5zmY7kOqQ==
32513234

3252-
sinon-chai@^3.5.0:
3235+
sinon-chai@^3.7.0:
32533236
version "3.7.0"
32543237
resolved "https://registry.yarnpkg.com/sinon-chai/-/sinon-chai-3.7.0.tgz#cfb7dec1c50990ed18c153f1840721cf13139783"
32553238
integrity sha512-mf5NURdUaSdnatJx3uhoBOrY9dtL19fiOtAdT1Azxg3+lNJFiuN0uzaU3xX1LeAfL17kHQhTAJgpsfhbMJMY2g==
32563239

3257-
sinon@^9.0.3:
3258-
version "9.2.4"
3259-
resolved "https://registry.yarnpkg.com/sinon/-/sinon-9.2.4.tgz#e55af4d3b174a4443a8762fa8421c2976683752b"
3260-
integrity sha512-zljcULZQsJxVra28qIAL6ow1Z9tpattkCTEJR4RBP3TGc00FcttsP5pK284Nas5WjMZU5Yzy3kAIp3B3KRf5Yg==
3240+
sinon@^12.0.1:
3241+
version "12.0.1"
3242+
resolved "https://registry.yarnpkg.com/sinon/-/sinon-12.0.1.tgz#331eef87298752e1b88a662b699f98e403c859e9"
3243+
integrity sha512-iGu29Xhym33ydkAT+aNQFBINakjq69kKO6ByPvTsm3yyIACfyQttRTP03aBP/I8GfhFmLzrnKwNNkr0ORb1udg==
32613244
dependencies:
3262-
"@sinonjs/commons" "^1.8.1"
3263-
"@sinonjs/fake-timers" "^6.0.1"
3264-
"@sinonjs/samsam" "^5.3.1"
3265-
diff "^4.0.2"
3266-
nise "^4.0.4"
3267-
supports-color "^7.1.0"
3245+
"@sinonjs/commons" "^1.8.3"
3246+
"@sinonjs/fake-timers" "^8.1.0"
3247+
"@sinonjs/samsam" "^6.0.2"
3248+
diff "^5.0.0"
3249+
nise "^5.1.0"
3250+
supports-color "^7.2.0"
32683251

32693252
slash@^3.0.0:
32703253
version "3.0.0"
@@ -3429,7 +3412,7 @@ supports-color@^5.3.0:
34293412
dependencies:
34303413
has-flag "^3.0.0"
34313414

3432-
supports-color@^7.1.0:
3415+
supports-color@^7.1.0, supports-color@^7.2.0:
34333416
version "7.2.0"
34343417
resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-7.2.0.tgz#1b7dcdcb32b8138801b3e478ba6a51caa89648da"
34353418
integrity sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==

0 commit comments

Comments
 (0)
⚡