forked from VoxaAI/voxa-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
/
createJavascript.spec.ts
790 lines (703 loc) · 35.3 KB
/
createJavascript.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
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
/*
* Copyright (c) 2019 Rain Agency <[email protected]>
* Author: Rain Agency <[email protected]>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
import { expect } from "chai";
import fs from "fs-extra";
import inquirer from "inquirer";
import path from "path";
import simple from "simple-mock";
import { action } from "../src/commands/create";
describe("Javascript project generator", () => {
before(done => {
simple.mock(process, "cwd").callFn(() => path.join(__dirname, "out", "javascript"));
fs.remove(path.join(__dirname, "out", "javascript")).then(done);
});
after(() => {
simple.restore();
});
function getFilePath(...args: any[]) {
return path.join(__dirname, "out", "javascript", ...args);
}
describe("Generate a basic project", () => {
before(async () => {
simple.mock(inquirer, "prompt").resolveWith({
appName: "my skill",
author: "Rain",
language: "javascript",
voxaCli: false,
canFulfill: true,
analytics: [],
platform: ["all"]
});
await action();
});
it("should have a src folder", async () => {
const filePath = getFilePath("my-skill", "src");
const pathExists = await fs.pathExists(filePath);
expect(pathExists).to.be.true;
});
it("should have a server.js file", async () => {
const filePath = getFilePath("my-skill", "server.js");
const pathExists = await fs.pathExists(filePath);
expect(pathExists).to.be.true;
});
it("should have a .gitignore file", async () => {
const filePath = getFilePath("my-skill", ".gitignore");
const pathExists = await fs.pathExists(filePath);
expect(pathExists).to.be.true;
});
it("should have a README file with the name of the skill", async () => {
const filePath = getFilePath("my-skill", "README.md");
const pathExists = await fs.pathExists(filePath);
const fileContent = await fs.readFile(filePath, "utf8");
expect(pathExists).to.be.true;
expect(fileContent).to.contain("my skill");
});
it("should have a package.json file with the name of the skill and author", async () => {
const filePath = getFilePath("my-skill", "package.json");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.contain('"name": "my-skill",');
expect(fileContent).to.contain('"author": "Rain",');
});
it("should have a test folder", async () => {
const filePath = getFilePath("my-skill", "test");
const pathExists = await fs.pathExists(filePath);
expect(pathExists).to.be.true;
});
});
describe("Generate a basic project in the same directory", () => {
before(async () => {
simple.mock(inquirer, "prompt").resolveWith({
appName: "my skill",
author: "Rain",
newDir: false,
language: "javascript",
voxaCli: false,
canFulfill: true,
analytics: [],
platform: ["all"]
});
await action();
});
it("should have a src folder", async () => {
const filePath = getFilePath("src");
const pathExists = await fs.pathExists(filePath);
expect(pathExists).to.be.true;
});
it("should have a server.js file", async () => {
const filePath = getFilePath("server.js");
const pathExists = await fs.pathExists(filePath);
expect(pathExists).to.be.true;
});
it("should have a README file with the name of the skill", async () => {
const filePath = getFilePath("README.md");
const pathExists = await fs.pathExists(filePath);
const fileContent = await fs.readFile(filePath, "utf8");
expect(pathExists).to.be.true;
expect(fileContent).to.contain("my skill");
});
it("should have a package.json file with the name of the skill and author", async () => {
const filePath = getFilePath("package.json");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.contain('"name": "my-skill",');
expect(fileContent).to.contain('"author": "Rain",');
});
it("should have a test folder", async () => {
const filePath = getFilePath("test");
const pathExists = await fs.pathExists(filePath);
expect(pathExists).to.be.true;
});
});
describe("Generate a Javascript project with voxa-cli", () => {
before(async () => {
simple.mock(inquirer, "prompt").resolveWith({
appName: "voxa cli skill",
author: "Rain",
language: "javascript",
voxaCli: true,
canFulfill: true,
analytics: [],
platform: ["all"]
});
await action();
});
it("should have the interaction.json file", async () => {
const filePath = getFilePath("voxa-cli-skill", "interaction.json");
const pathExists = await fs.pathExists(filePath);
expect(pathExists).to.be.true;
});
it("should have voxa-cli package in package.json", async () => {
const filePath = getFilePath("voxa-cli-skill", "package.json");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.contain('"voxa-cli"');
expect(fileContent).to.contain('"interaction": "voxa interaction"');
});
it("should have interaction usage in README file", async () => {
const filePath = getFilePath("voxa-cli-skill", "README.md");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.contain("## Interaction Model and Publishing Information");
expect(fileContent).to.contain("$ yarn interaction");
expect(fileContent).to.contain("- [Intents and Utterances](#)");
expect(fileContent).to.contain("- [Publishing Information](#)");
});
});
describe("Generate a Javascript project without voxa-cli", () => {
before(async () => {
simple.mock(inquirer, "prompt").resolveWith({
appName: "no voxa cli skill",
author: "Rain",
language: "javascript",
voxaCli: false,
canFulfill: true,
analytics: [],
platform: ["all"]
});
await action();
});
it("should not have the interaction.json file", async () => {
const filePath = getFilePath("no-voxa-cli-skill", "interaction.json");
const pathExists = await fs.pathExists(filePath);
expect(pathExists).to.not.be.true;
});
it("should not have voxa-cli package in package.json", async () => {
const filePath = getFilePath("no-voxa-cli-skill", "package.json");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.not.contain('"voxa-cli": "2.1.2"');
expect(fileContent).to.not.contain('"interaction": "voxa interaction"');
});
it("should not have interaction usage in README file", async () => {
const filePath = getFilePath("no-voxa-cli-skill", "README.md");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.not.contain("## Interaction Model and Publishing Information");
expect(fileContent).to.not.contain("$ yarn interaction");
expect(fileContent).to.not.contain("- [Intents and Utterances](#)");
expect(fileContent).to.not.contain("- [Publishing Information](#)");
});
});
describe("Generate a Javascript project that uses canfulfill intents", () => {
before(async () => {
simple.mock(inquirer, "prompt").resolveWith({
appName: "can fulfill skill",
author: "Rain",
language: "javascript",
voxaCli: false,
canFulfill: true,
analytics: [],
platform: ["all"]
});
await action();
});
it("should have canfulfill reference in index file", async () => {
const filePath = getFilePath("can-fulfill-skill", "src", "app", "index.js");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.contain("defaultFulfillIntents");
});
});
describe("Generate a Javascript project that uses all analytics", () => {
before(async () => {
simple.mock(inquirer, "prompt").resolveWith({
appName: "all analytics skill",
author: "Rain",
language: "javascript",
voxaCli: false,
canFulfill: true,
analytics: ["all"],
platform: ["all"]
});
await action();
});
it("should have all analytics in index file", async () => {
const filePath = getFilePath("all-analytics-skill", "src", "app", "index.js");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.contain('const voxaGA = require("voxa-ga");');
expect(fileContent).to.contain('const voxaDashbot = require("voxa-dashbot").register;');
expect(fileContent).to.contain('const voxaChatbase = require("voxa-chatbase");');
expect(fileContent).to.contain("voxaGA(voxaApp, config.googleAnalytics);");
expect(fileContent).to.contain("voxaDashbot(voxaApp, config.dashbot);");
expect(fileContent).to.contain("voxaChatbase(voxaApp, config.chatbase);");
});
it("should have all analytics in the package.json file", async () => {
const filePath = getFilePath("all-analytics-skill", "package.json");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.contain('"voxa-chatbase"');
expect(fileContent).to.contain('"voxa-dashbot"');
expect(fileContent).to.contain('"voxa-ga"');
});
it("should have all analytics basic configurations in the config files", async () => {
const localPath = getFilePath("all-analytics-skill", "src", "config", "local.example.json");
const stagingPath = getFilePath("all-analytics-skill", "src", "config", "staging.json");
const prodPath = getFilePath("all-analytics-skill", "src", "config", "production.json");
const localContent = JSON.parse(await fs.readFile(localPath, "utf8"));
const stagingContent = JSON.parse(await fs.readFile(stagingPath, "utf8"));
const prodContent = JSON.parse(await fs.readFile(prodPath, "utf8"));
const ga =
'"googleAnalytics":{"trackingId":"UA-XXXX-X","appName":"all-analytics-skill","ignoreUsers":[],"suppressSending":true}';
const chatbase = '"dashbot":{"suppressSending":true,"alexa":"key"}';
const dashbot =
'"chatbase":{"apiKey":"<chatbase apiKey>","ignoreUsers":[],"suppressSending":true}';
const prodGa =
'"googleAnalytics":{"trackingId":"UA-XXXX-X","appName":"all-analytics-skill","ignoreUsers":[],"suppressSending":false}';
const prodChatbase = '"dashbot":{"suppressSending":false,"alexa":"key"}';
const prodDashbot =
'"chatbase":{"apiKey":"<chatbase apiKey>","ignoreUsers":[],"suppressSending":false}';
expect(JSON.stringify(localContent)).to.contain(ga);
expect(JSON.stringify(localContent)).to.contain(chatbase);
expect(JSON.stringify(localContent)).to.contain(dashbot);
expect(JSON.stringify(stagingContent)).to.contain(ga);
expect(JSON.stringify(stagingContent)).to.contain(chatbase);
expect(JSON.stringify(stagingContent)).to.contain(dashbot);
expect(JSON.stringify(prodContent)).to.contain(prodGa);
expect(JSON.stringify(prodContent)).to.contain(prodChatbase);
expect(JSON.stringify(prodContent)).to.contain(prodDashbot);
});
});
describe("Generate a Javascript project doesn't use any analytics", () => {
before(async () => {
simple.mock(inquirer, "prompt").resolveWith({
appName: "no analytics skill",
author: "Rain",
language: "javascript",
voxaCli: false,
canFulfill: true,
analytics: ["none"],
platform: ["all"]
});
await action();
});
it("should not have analytics references in index file", async () => {
const filePath = getFilePath("no-analytics-skill", "src", "app", "index.js");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.not.contain('const voxaGA = require("voxa-ga");');
expect(fileContent).to.not.contain('const voxaDashbot = require("voxa-dashbot").register;');
expect(fileContent).to.not.contain('const voxaChatbase = require("voxa-chatbase");');
expect(fileContent).to.not.contain("voxaGA(voxaApp, config.googleAnalytics);");
expect(fileContent).to.not.contain("voxaDashbot(voxaApp, config.dashbot);");
expect(fileContent).to.not.contain("voxaChatbase(voxaApp, config.chatbase);");
});
it("should not have analytics packages in the package.json file", async () => {
const filePath = getFilePath("no-analytics-skill", "package.json");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.not.contain('"voxa-chatbase": "0.1.1"');
expect(fileContent).to.not.contain('"voxa-dashbot": "2.0.3"');
expect(fileContent).to.not.contain('"voxa-ga": "2.0.1"');
});
it("should not have analytics basic configurations in the config files", async () => {
const localPath = getFilePath("no-analytics-skill", "src", "config", "local.example.json");
const stagingPath = getFilePath("no-analytics-skill", "src", "config", "staging.json");
const prodPath = getFilePath("no-analytics-skill", "src", "config", "production.json");
const localContent = JSON.parse(await fs.readFile(localPath, "utf8"));
const stagingContent = JSON.parse(await fs.readFile(stagingPath, "utf8"));
const prodContent = JSON.parse(await fs.readFile(prodPath, "utf8"));
const ga =
'"googleAnalytics":{"trackingId":"UA-XXXX-X","appName":"no-analytics-skill","ignoreUsers":[],"suppressSending":true}';
const chatbase = '"dashbot":{"suppressSending":true,"alexa":"key"}';
const dashbot =
'"chatbase":{"apiKey":"<chatbase apiKey>","ignoreUsers":[],"suppressSending":true}';
const prodGa =
'"googleAnalytics":{"trackingId":"UA-XXXX-X","appName":"no-analytics-skill","ignoreUsers":[],"suppressSending":false}';
const prodChatbase = '"dashbot":{"suppressSending":false,"alexa":"key"}';
const prodDashbot =
'"chatbase":{"apiKey":"<chatbase apiKey>","ignoreUsers":[],"suppressSending":false}';
expect(JSON.stringify(localContent)).to.not.contain(ga);
expect(JSON.stringify(localContent)).to.not.contain(chatbase);
expect(JSON.stringify(localContent)).to.not.contain(dashbot);
expect(JSON.stringify(stagingContent)).to.not.contain(ga);
expect(JSON.stringify(stagingContent)).to.not.contain(chatbase);
expect(JSON.stringify(stagingContent)).to.not.contain(dashbot);
expect(JSON.stringify(prodContent)).to.not.contain(prodGa);
expect(JSON.stringify(prodContent)).to.not.contain(prodChatbase);
expect(JSON.stringify(prodContent)).to.not.contain(prodDashbot);
});
});
describe("Generate a Javascript project that uses only Google Analytics", () => {
before(async () => {
simple.mock(inquirer, "prompt").resolveWith({
appName: "ga analytics skill",
author: "Rain",
language: "javascript",
voxaCli: false,
canFulfill: true,
analytics: ["ga"],
platform: ["all"]
});
await action();
});
it("should have only google analytics references in index file", async () => {
const filePath = getFilePath("ga-analytics-skill", "src", "app", "index.js");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.contain('const voxaGA = require("voxa-ga");');
expect(fileContent).to.not.contain('const voxaDashbot = require("voxa-dashbot").register;');
expect(fileContent).to.not.contain('const voxaChatbase = require("voxa-chatbase");');
expect(fileContent).to.contain("voxaGA(voxaApp, config.googleAnalytics);");
expect(fileContent).to.not.contain("voxaDashbot(voxaApp, config.dashbot);");
expect(fileContent).to.not.contain("voxaChatbase(voxaApp, config.chatbase);");
});
it("should have only the voxa-ga package in the package.json file", async () => {
const filePath = getFilePath("ga-analytics-skill", "package.json");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.not.contain('"voxa-chatbase": "0.1.1"');
expect(fileContent).to.not.contain('"voxa-dashbot": "2.0.3"');
expect(fileContent).to.contain('"voxa-ga": "2.0.1"');
});
it("should have only the google analytics basic configuration in the config files", async () => {
const localPath = getFilePath("ga-analytics-skill", "src", "config", "local.example.json");
const stagingPath = getFilePath("ga-analytics-skill", "src", "config", "staging.json");
const prodPath = getFilePath("ga-analytics-skill", "src", "config", "production.json");
const localContent = JSON.parse(await fs.readFile(localPath, "utf8"));
const stagingContent = JSON.parse(await fs.readFile(stagingPath, "utf8"));
const prodContent = JSON.parse(await fs.readFile(prodPath, "utf8"));
const ga =
'"googleAnalytics":{"trackingId":"UA-XXXX-X","appName":"ga-analytics-skill","ignoreUsers":[],"suppressSending":true}';
const chatbase = '"dashbot":{"suppressSending":true,"alexa":"key"}';
const dashbot =
'"chatbase":{"apiKey":"<chatbase apiKey>","ignoreUsers":[],"suppressSending":true}';
const prodGa =
'"googleAnalytics":{"trackingId":"UA-XXXX-X","appName":"ga-analytics-skill","ignoreUsers":[],"suppressSending":false}';
const prodChatbase = '"dashbot":{"suppressSending":false,"alexa":"key"}';
const prodDashbot =
'"chatbase":{"apiKey":"<chatbase apiKey>","ignoreUsers":[],"suppressSending":false}';
expect(JSON.stringify(localContent)).to.contain(ga);
expect(JSON.stringify(localContent)).to.not.contain(chatbase);
expect(JSON.stringify(localContent)).to.not.contain(dashbot);
expect(JSON.stringify(stagingContent)).to.contain(ga);
expect(JSON.stringify(stagingContent)).to.not.contain(chatbase);
expect(JSON.stringify(stagingContent)).to.not.contain(dashbot);
expect(JSON.stringify(prodContent)).to.contain(prodGa);
expect(JSON.stringify(prodContent)).to.not.contain(prodChatbase);
expect(JSON.stringify(prodContent)).to.not.contain(prodDashbot);
});
});
describe("Generate a Javascript project that uses only Google Analytics and Dashbot", () => {
before(async () => {
simple.mock(inquirer, "prompt").resolveWith({
appName: "ga dashbot analytics skill",
author: "Rain",
language: "javascript",
voxaCli: false,
canFulfill: true,
analytics: ["ga", "dashbot"],
platform: ["all"]
});
await action();
});
it("should have only google analytics and dashbot references in index file", async () => {
const filePath = getFilePath("ga-dashbot-analytics-skill", "src", "app", "index.js");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.contain('const voxaGA = require("voxa-ga");');
expect(fileContent).to.contain('const voxaDashbot = require("voxa-dashbot").register;');
expect(fileContent).to.not.contain('const voxaChatbase = require("voxa-chatbase");');
expect(fileContent).to.contain("voxaGA(voxaApp, config.googleAnalytics);");
expect(fileContent).to.contain("voxaDashbot(voxaApp, config.dashbot);");
expect(fileContent).to.not.contain("voxaChatbase(voxaApp, config.chatbase);");
});
it("should have only the voxa-ga and the voxa-dashbot packages in the package.json file", async () => {
const filePath = getFilePath("ga-dashbot-analytics-skill", "package.json");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.not.contain('"voxa-chatbase": "0.1.1"');
expect(fileContent).to.contain('"voxa-dashbot": "2.0.3"');
expect(fileContent).to.contain('"voxa-ga": "2.0.1"');
});
it("should have only the google analytics and dashbot basic configuration in the config files", async () => {
const localPath = getFilePath(
"ga-dashbot-analytics-skill",
"src",
"config",
"local.example.json"
);
const stagingPath = getFilePath(
"ga-dashbot-analytics-skill",
"src",
"config",
"staging.json"
);
const prodPath = getFilePath(
"ga-dashbot-analytics-skill",
"src",
"config",
"production.json"
);
const localContent = JSON.parse(await fs.readFile(localPath, "utf8"));
const stagingContent = JSON.parse(await fs.readFile(stagingPath, "utf8"));
const prodContent = JSON.parse(await fs.readFile(prodPath, "utf8"));
const ga =
'"googleAnalytics":{"trackingId":"UA-XXXX-X","appName":"ga-dashbot-analytics-skill","ignoreUsers":[],"suppressSending":true}';
const dashbot = '"dashbot":{"suppressSending":true,"alexa":"key"}';
const chatbase =
'"chatbase":{"apiKey":"<chatbase apiKey>","ignoreUsers":[],"suppressSending":true}';
const prodGa =
'"googleAnalytics":{"trackingId":"UA-XXXX-X","appName":"ga-dashbot-analytics-skill","ignoreUsers":[],"suppressSending":false}';
const prodDashbot = '"dashbot":{"suppressSending":false,"alexa":"key"}';
const prodChatbase =
'"chatbase":{"apiKey":"<chatbase apiKey>","ignoreUsers":[],"suppressSending":false}';
expect(JSON.stringify(localContent)).to.contain(ga);
expect(JSON.stringify(localContent)).to.not.contain(chatbase);
expect(JSON.stringify(localContent)).to.contain(dashbot);
expect(JSON.stringify(stagingContent)).to.contain(ga);
expect(JSON.stringify(stagingContent)).to.not.contain(chatbase);
expect(JSON.stringify(stagingContent)).to.contain(dashbot);
expect(JSON.stringify(prodContent)).to.contain(prodGa);
expect(JSON.stringify(prodContent)).to.not.contain(prodChatbase);
expect(JSON.stringify(prodContent)).to.contain(prodDashbot);
});
});
describe("Generate a Javascript project that store user information in DynamoDB", () => {
before(async () => {
simple.mock(inquirer, "prompt").resolveWith({
appName: "user skill",
author: "Rain",
language: "javascript",
voxaCli: false,
canFulfill: true,
analytics: ["none"],
saveUserInfo: true,
platform: ["all"]
});
await action();
});
it("should have a User service file", async () => {
const filePath = getFilePath("user-skill", "src", "services", "User.js");
const pathExists = await fs.pathExists(filePath);
expect(pathExists).to.be.true;
});
it("should have a dynamoDB table presets in the config files", async () => {
const localFilePath = getFilePath("user-skill", "src", "config", "local.example.json");
const stagingFilePath = getFilePath("user-skill", "src", "config", "staging.json");
const prodFilePath = getFilePath("user-skill", "src", "config", "production.json");
const localFileContent = JSON.parse(await fs.readFile(localFilePath, "utf8"));
const stagingFileContent = JSON.parse(await fs.readFile(stagingFilePath, "utf8"));
const prodFileContent = JSON.parse(await fs.readFile(prodFilePath, "utf8"));
expect(JSON.stringify(localFileContent)).to.contain(
'"dynamoDB":{"tables":{"users":"users"}}'
);
expect(JSON.stringify(stagingFileContent)).to.contain(
'"dynamoDB":{"tables":{"users":"users"}}'
);
expect(JSON.stringify(prodFileContent)).to.contain('"dynamoDB":{"tables":{"users":"users"}}');
});
it("should have lifecycle methods to retrieve and save user info in the session", async () => {
const filePath = getFilePath("user-skill", "src", "app", "index.js");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.contain('const User = require("../services/User");');
expect(fileContent).to.contain("voxaEvent.model.user = user;");
expect(fileContent).to.contain("user.newSession();");
expect(fileContent).to.contain("await user.save({ userId: voxaEvent.user.userId });");
});
it("should have DynamoDB configurations for the user table in serverless file", async () => {
const filePath = getFilePath("user-skill", "serverless.yml");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.contain("DynamoDBCapacity:");
expect(fileContent).to.contain("Resource: !GetAtt TableUsers.Arn");
expect(fileContent).to.contain("TableUsers:");
// tslint:disable-next-line:no-invalid-template-strings
expect(fileContent).to.contain("TableName: ${self:custom.config.dynamoDB.tables.users}");
});
});
describe("Generate a Javascript project that doesn't store user information in DynamoDB", () => {
before(async () => {
simple.mock(inquirer, "prompt").resolveWith({
appName: "no user skill",
author: "Rain",
language: "javascript",
voxaCli: false,
canFulfill: true,
analytics: ["none"],
saveUserInfo: false,
platform: ["all"]
});
await action();
});
it("should not have a User service file", async () => {
const filePath = getFilePath("no-user-skill", "src", "services", "User.js");
const pathExists = await fs.pathExists(filePath);
expect(pathExists).to.be.false;
});
it("should not have a dynamoDB table presets in the config files", async () => {
const localFilePath = getFilePath("no-user-skill", "src", "config", "local.example.json");
const stagingFilePath = getFilePath("no-user-skill", "src", "config", "staging.json");
const prodFilePath = getFilePath("no-user-skill", "src", "config", "production.json");
const localFileContent = JSON.parse(await fs.readFile(localFilePath, "utf8"));
const stagingFileContent = JSON.parse(await fs.readFile(stagingFilePath, "utf8"));
const prodFileContent = JSON.parse(await fs.readFile(prodFilePath, "utf8"));
expect(JSON.stringify(localFileContent)).to.not.contain(
'"dynamoDB":{"tables":{"users":"users"}}'
);
expect(JSON.stringify(stagingFileContent)).to.not.contain(
'"dynamoDB":{"tables":{"users":"users"}}'
);
expect(JSON.stringify(prodFileContent)).to.not.contain(
'"dynamoDB":{"tables":{"users":"users"}}'
);
});
it("should not have lifecycle methods to retrieve and save user info in the session", async () => {
const filePath = getFilePath("no-user-skill", "src", "app", "index.js");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.not.contain('const User = require("../services/User");');
expect(fileContent).to.not.contain("voxaEvent.model.user = user;");
expect(fileContent).to.not.contain("user.newSession();");
expect(fileContent).to.not.contain("await user.save({ userId: voxaEvent.user.userId });");
});
it("should not have DynamoDB configurations for the user table in serverless file", async () => {
const filePath = getFilePath("no-user-skill", "serverless.yml");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.not.contain("DynamoDBCapacity:");
expect(fileContent).to.not.contain("Resource: !GetAtt TableUsers.Arn");
expect(fileContent).to.not.contain("TableUsers:");
// tslint:disable-next-line:no-invalid-template-strings
expect(fileContent).to.not.contain("TableName: ${self:custom.config.dynamoDB.tables.users}");
});
});
describe("Generate a Javascript project only for Alexa", () => {
before(async () => {
simple.mock(inquirer, "prompt").resolveWith({
appName: "my alexa skill",
author: "Rain",
language: "javascript",
voxaCli: false,
canFulfill: false,
analytics: [],
platform: ["alexa"]
});
await action();
});
it("should have support only for Alexa platform in the index file", async () => {
const filePath = getFilePath("my-alexa-skill", "src", "app", "index.js");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.contain("AlexaPlatform,");
expect(fileContent).to.contain("exports.alexaSkill = new AlexaPlatform(voxaApp);");
expect(fileContent).to.not.contain("DialogflowPlatform,");
expect(fileContent).to.not.contain("exports.telegramBot = new DialogflowPlatform(voxaApp);");
expect(fileContent).to.not.contain("FacebookPlatform,");
expect(fileContent).to.not.contain("exports.facebookBot = new FacebookPlatform(voxaApp);");
expect(fileContent).to.not.contain("GoogleAssistantPlatform,");
expect(fileContent).to.not.contain(
"exports.assistantAction = new GoogleAssistantPlatform(voxaApp);"
);
});
it("should have an endpoint only for Alexa in the server file", async () => {
const filePath = getFilePath("my-alexa-skill", "server.js");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.contain("alexaSkill,");
expect(fileContent).to.contain('"/alexa": alexaSkill,');
expect(fileContent).to.not.contain("assistantAction,");
expect(fileContent).to.not.contain('"/googleAction": assistantAction,');
expect(fileContent).to.not.contain("facebookBot,");
expect(fileContent).to.not.contain('"/facebook": facebookBot,');
expect(fileContent).to.not.contain("telegramBot,");
expect(fileContent).to.not.contain('"/telegram": telegramBot,');
});
it("should have function configuration only for Alexa in serverless file", async () => {
const filePath = getFilePath("my-alexa-skill", "serverless.yml");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.contain("handler: src/handler.alexaHandler");
expect(fileContent).to.not.contain("handler: src/handler.assistantHandler");
expect(fileContent).to.not.contain("handler: src/handler.facebookHandler");
expect(fileContent).to.not.contain("handler: src/handler.telegramHandler");
});
it("should export only the Alexa lambda handler in the handler file", async () => {
const filePath = getFilePath("my-alexa-skill", "src", "handler.js");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.contain("alexaSkill,");
expect(fileContent).to.contain("exports.alexaHandler = alexaSkill.lambda();");
expect(fileContent).to.not.contain("assistantAction,");
expect(fileContent).to.not.contain(
"exports.assistantHandler = assistantAction.lambdaHTTP();"
);
expect(fileContent).to.not.contain("facebookBot,");
expect(fileContent).to.not.contain("exports.facebookHandler = facebookBot.lambdaHTTP();");
expect(fileContent).to.not.contain("telegramBot,");
expect(fileContent).to.not.contain("exports.telegramHandler = telegramBot.lambdaHTTP();");
});
});
describe("Generate a Javascript project for Alexa using account linking", () => {
before(async () => {
simple.mock(inquirer, "prompt").resolveWith({
appName: "my account linking skill",
author: "Rain",
language: "javascript",
voxaCli: false,
canFulfill: false,
analytics: [],
platform: ["alexa"],
accountLinking: true
});
await action();
});
it("should have an endpoint for account linking in the server file with its configurations", async () => {
const filePath = getFilePath("my-account-linking-skill", "server.js");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.contain('const accountLinkingRoutes = require("./web/routes");');
expect(fileContent).to.contain("expressApp.use(accountLinkingRoutes);");
expect(fileContent).to.contain("expressApp.use(express.urlencoded({ extended: true }));");
expect(fileContent).to.contain('expressApp.use(express.static(__dirname + "/web/public"));');
expect(fileContent).to.contain('expressApp.set("views", __dirname + "/web/views");');
expect(fileContent).to.contain('expressApp.set("view engine", "ejs");');
});
it("should have the lambda function configuration for http in serverless", async () => {
const filePath = getFilePath("my-account-linking-skill", "serverless.yml");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.contain("accountLinking:");
expect(fileContent).to.contain("handler: web/handler.expressHandler");
});
it("should have a web folder containing the express app handler and routes, static and views folders", async () => {
const filePath = getFilePath("my-account-linking-skill", "web");
const pathExists = await fs.pathExists(filePath);
expect(pathExists).to.be.true;
});
});
describe("Generate a Javascript project for Alexa without account linking", () => {
before(async () => {
simple.mock(inquirer, "prompt").resolveWith({
appName: "no account linking skill",
author: "Rain",
language: "javascript",
voxaCli: false,
canFulfill: false,
analytics: [],
platform: ["alexa"],
accountLinking: false
});
await action();
});
it("should not have an endpoint for account linking in the server file with its configurations", async () => {
const filePath = getFilePath("no-account-linking-skill", "server.js");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.not.contain('const accountLinkingRoutes = require("./web/routes");');
expect(fileContent).to.not.contain("expressApp.use(accountLinkingRoutes);");
expect(fileContent).to.not.contain("expressApp.use(express.urlencoded({ extended: true }));");
expect(fileContent).to.not.contain(
'expressApp.use(express.static(__dirname + "/web/public"));'
);
expect(fileContent).to.not.contain('expressApp.set("views", __dirname + "/web/views");');
expect(fileContent).to.not.contain('expressApp.set("view engine", "ejs");');
});
it("should not have the lambda function configuration for http in serverless", async () => {
const filePath = getFilePath("no-account-linking-skill", "serverless.yml");
const fileContent = await fs.readFile(filePath, "utf8");
expect(fileContent).to.not.contain("accountLinking:");
expect(fileContent).to.not.contain("handler: web/handler.expressHandler");
});
it("should not have a web folder containing the express app handler and routes, static and views folders", async () => {
const filePath = getFilePath("no-account-linking-skill", "web");
const pathExists = await fs.pathExists(filePath);
expect(pathExists).to.be.false;
});
});
});