-
Notifications
You must be signed in to change notification settings - Fork 4
/
client.spec.ts
433 lines (347 loc) · 12.5 KB
/
client.spec.ts
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
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
import { Command } from "./types";
import { version as packageVersion } from "../package.json";
import * as _utils from "./utils";
import { Socket } from "./Socket";
import { client } from "./client";
import resolve from "resolve";
jest.mock("./Socket");
jest.mock("./utils", () => ({
readStdin: jest.fn(),
spawnDaemon: jest.fn(),
daemonRunning: jest.fn(),
}));
const utils = jest.mocked(_utils);
const MockedSocket = Socket as jest.MockedClass<typeof Socket>;
describe("client", () => {
let resolveSyncSpy: jest.SpyInstance;
beforeEach(() => {
resolveSyncSpy = jest.spyOn(resolve, "sync");
});
afterEach(() => {
resolveSyncSpy.mockRestore();
});
describe("help command", () => {
it("returns a help message string", async () => {
for (const argv of [["--help"], ["-h"], ["-v"]]) {
expect(await client(argv)).toStrictEqual({
message: expect.any(String),
});
}
});
});
describe("start command", () => {
it("should return a response with a code if the daemon is running", async () => {
utils.daemonRunning.mockResolvedValueOnce(true);
expect(await client(["start"])).toStrictEqual({
message: "stylelint_d is already running.",
code: 1,
});
});
it("should spawn the daemon process and return a message", async () => {
expect(await client(["start"])).toStrictEqual({
message: "stylelint_d started.",
});
expect(utils.spawnDaemon).toHaveBeenCalled();
});
});
describe("stop command", () => {
it("should return a response with a code if the daemon is not running", async () => {
utils.daemonRunning.mockResolvedValueOnce(false);
expect(await client(["stop"])).toStrictEqual({
message: "stylelint_d is not running.",
code: 1,
});
});
it("should send a stop command to the server and return a message", async () => {
utils.daemonRunning.mockResolvedValueOnce(true);
const { socket } = setup();
socket.getData.mockResolvedValue({
command: Command.STOP,
message: "stylelint_d stopping...",
});
expect(await client(["stop"])).toStrictEqual({
message: "stylelint_d stopping... ok.",
});
expect(socket.send).toHaveBeenCalledWith({
command: Command.STOP,
cwd: expect.any(String),
lintArguments: {},
});
});
it("should return a response with a code if the daemon is running after the server responds", async () => {
utils.daemonRunning.mockResolvedValueOnce(true);
utils.daemonRunning.mockResolvedValueOnce(true);
const { socket } = setup();
socket.getData.mockResolvedValue({
command: Command.STOP,
message: "stylelint_d stopping...",
});
expect(await client(["stop"])).toStrictEqual({
message: "stylelint_d stopping... error, stylelint_d daemon not stopped successfully.",
code: 1,
});
});
});
describe("restart command", () => {
it("should return a response with a code if the daemon is not running", async () => {
utils.daemonRunning.mockResolvedValueOnce(false);
expect(await client(["restart"])).toStrictEqual({
message: "stylelint_d is not running.",
code: 1,
});
});
it("should send a restart command to the server and return a message", async () => {
utils.daemonRunning.mockResolvedValueOnce(true);
utils.daemonRunning.mockResolvedValueOnce(true);
const { socket } = setup();
socket.getData.mockResolvedValue({
command: Command.RESTART,
message: "stylelint_d restarting...",
});
expect(await client(["restart"])).toStrictEqual({
message: "stylelint_d restarting... ok.",
});
expect(socket.send).toHaveBeenCalledWith({
command: Command.RESTART,
cwd: expect.any(String),
lintArguments: {},
});
});
it("should return a response with a code if the daemon is not running after the server responds", async () => {
utils.daemonRunning.mockResolvedValueOnce(true);
utils.daemonRunning.mockResolvedValueOnce(false);
const { socket } = setup();
socket.getData.mockResolvedValue({
command: Command.RESTART,
message: "stylelint_d restarting...",
});
expect(await client(["restart"])).toStrictEqual({
message: "stylelint_d restarting... error, stylelint_d daemon not restarted successfully.",
code: 1,
});
});
});
describe("version command", () => {
it("should return a message with the version", async () => {
for (const argv of [["version"], ["--version"], ["-v"]]) {
expect(await client(argv)).toStrictEqual({
message: packageVersion,
});
}
});
});
describe("status command", () => {
it("should return the right message depending on if the daemon is running", async () => {
utils.daemonRunning.mockResolvedValueOnce(false);
expect(await client(["status"])).toStrictEqual({
message: "stylelint_d is not running.",
});
utils.daemonRunning.mockResolvedValueOnce(true);
expect(await client(["status"])).toStrictEqual({
message: "stylelint_d is running.",
});
});
});
describe("lint command", () => {
it('should add a formatter if given, or "string" otherwise', async () => {
const { socket } = setup();
await client(["file.css"]);
expect(socket.send).toHaveBeenNthCalledWith(1, {
command: Command.LINT,
cwd: expect.any(String),
lintArguments: {
files: ["file.css"],
formatter: "string",
},
});
await client(["--formatter", "something-else", "file.css"]);
expect(socket.send).toHaveBeenNthCalledWith(2, {
command: Command.LINT,
cwd: expect.any(String),
lintArguments: {
files: ["file.css"],
formatter: "something-else",
},
});
});
it("should send a lint command to the server", async () => {
const { socket } = setup();
await client(["some/file.css", "some/otherfile.css"]);
expect(socket.send).toHaveBeenCalledWith({
command: Command.LINT,
cwd: expect.any(String),
lintArguments: {
files: ["some/file.css", "some/otherfile.css"],
formatter: "string",
},
});
});
it("should add the quiet option to the configOverrides", async () => {
const { socket } = setup();
await client(["--quiet", "some/file.css"]);
expect(socket.send).toHaveBeenCalledWith({
command: Command.LINT,
cwd: expect.any(String),
lintArguments: {
configOverrides: {
quiet: true,
},
files: ["some/file.css"],
formatter: "string",
},
});
});
it("should read from stdin if no files are given, even if another flag is passed", async () => {
await client(["--quiet"]);
expect(utils.readStdin).toHaveBeenCalledTimes(1);
});
it("should read from stdin if the stdin flag is passed", async () => {
await client(["--stdin"]);
expect(utils.readStdin).toHaveBeenCalledTimes(1);
});
it("should set the provided stdin text as the code argument", async () => {
utils.readStdin.mockResolvedValueOnce("some stdin code");
const { socket } = setup();
await client(["--stdin", "--stdin-filename", "/path/to/some/filename.css"]);
expect(socket.send).toHaveBeenCalledWith({
command: Command.LINT,
cwd: expect.any(String),
lintArguments: {
code: "some stdin code",
codeFilename: "/path/to/some/filename.css",
formatter: "string",
},
});
});
it("should ignore the codeFilename flag is no stdin was needed", async () => {
const { socket } = setup();
await client(["/some/css/file.css", "--stdin-filename", "/path/to/some/filename.css"]);
expect(socket.send).toHaveBeenCalledWith({
command: Command.LINT,
cwd: expect.any(String),
lintArguments: {
files: ["/some/css/file.css"],
formatter: "string",
},
});
});
it("should set the config file argument if the config flag is passed", async () => {
const { socket } = setup();
await client(["file.css", "--config", "/config/file.json"]);
expect(socket.send).toHaveBeenCalledWith({
command: Command.LINT,
cwd: expect.any(String),
lintArguments: {
files: ["file.css"],
configFile: "/config/file.json",
formatter: "string",
},
});
});
it("should try to resolve the config file to the cwd if it is relative", async () => {
// We don't test the output here because file.json will not resolve to a real file when testing
await client(["file.css", "--config", "file.json"]);
expect(resolve.sync).toHaveBeenCalled();
});
it("should turn the config file path into an absolute path if it is relative", async () => {
const { socket } = setup();
await client(["file.css", "--config", "file.json"]);
expect(socket.send).toHaveBeenCalledWith({
command: Command.LINT,
cwd: expect.any(String),
lintArguments: {
files: ["file.css"],
configFile: `${process.cwd()}/file.json`,
formatter: "string",
},
});
});
it("should add the config basedir to arguments if provided", async () => {
const { socket } = setup();
await client(["file.css", "--config-basedir", "/some/configbasedir"]);
expect(socket.send).toHaveBeenCalledWith({
command: Command.LINT,
cwd: expect.any(String),
lintArguments: {
files: ["file.css"],
configBasedir: "/some/configbasedir",
formatter: "string",
},
});
});
it("should make the config basedir argument absolute if it is a relative path", async () => {
const { socket } = setup();
await client(["file.css", "--config-basedir", "configbasedir"]);
expect(socket.send).toHaveBeenCalledWith({
command: Command.LINT,
cwd: expect.any(String),
lintArguments: {
files: ["file.css"],
configBasedir: `${process.cwd()}/configbasedir`,
formatter: "string",
},
});
});
it("should add customFormatter to the arguments if provided", async () => {
const { socket } = setup();
await client(["file.css", "--custom-formatter", "/some/custom/formatter.js"]);
expect(socket.send).toHaveBeenCalledWith({
command: Command.LINT,
cwd: expect.any(String),
lintArguments: {
files: ["file.css"],
customFormatter: "/some/custom/formatter.js",
formatter: "string",
},
});
});
it("should attempt to resolve the customFromatter file if it's relative", async () => {
await client(["file.css", "--custom-formatter", "formatter.js"]);
expect(resolve.sync).toHaveBeenCalled();
});
it("should add make the customFormatter path absolute if it's relative", async () => {
const { socket } = setup();
await client(["file.css", "--custom-formatter", "formatter.js"]);
expect(socket.send).toHaveBeenCalledWith({
command: Command.LINT,
cwd: expect.any(String),
lintArguments: {
files: ["file.css"],
customFormatter: `${process.cwd()}/formatter.js`,
formatter: "string",
},
});
});
it("should respond with the lint output", async () => {
const { socket } = setup();
socket.getData.mockResolvedValueOnce({
command: Command.LINT,
output: "some output",
errored: false,
});
expect(await client(["file.css"])).toStrictEqual({
message: "some output",
code: 0,
});
});
it("should add a nonzero code if the lint responded with errored as true", async () => {
const { socket } = setup();
socket.getData.mockResolvedValueOnce({
command: Command.LINT,
output: "some other output",
errored: true,
});
expect(await client(["file.css"])).toStrictEqual({
message: "some other output",
code: 2,
});
});
});
});
function setup() {
(
MockedSocket.createClientSocket as jest.MockedFunction<typeof MockedSocket.createClientSocket>
).mockImplementation((): Promise<Socket> => Promise.resolve(MockedSocket.prototype));
MockedSocket.prototype.getData.mockResolvedValue({});
return { socket: MockedSocket.prototype };
}