forked from ioBroker/ioBroker.repochecker
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
1091 lines (1008 loc) · 41.1 KB
/
index.js
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
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* 1.1.0 2019.02.19
___ _ _ _____ _ _
/ _ \ | | | | / __ \ | | |
/ /_\ \ __| | __ _ _ __ | |_ ___ _ __ | / \/ |__ ___ ___| | _____ _ __
| _ |/ _` |/ _` | '_ \| __/ _ \ '__| | | | '_ \ / _ \/ __| |/ / _ \ '__|
| | | | (_| | (_| | |_) | || __/ | | \__/\ | | | __/ (__| < __/ |
\_| |_/\__,_|\__,_| .__/ \__\___|_| \____/_| |_|\___|\___|_|\_\___|_|
| |
|_|
*/
let request;
const unzip = require('unzip');
const stream = require('stream');
let https;
if (typeof require !== 'undefined') {
try {
request = require('request');
} catch (e) {
request = function (url, options, cb) {
if (typeof options === 'function') {
cb = options;
options = {};
}
https = https || require('https');
https.get(url, resp => {
let data = '';
resp.on('data', chunk => data += chunk);
resp.on('end', () => cb(null, {statusCode: resp.statusCode, headers: resp.headers}, data));
resp.on('error', () => err => cb(err));
}).on('error', err => cb(err));
}
}
} else {
request = function (url, cb) {
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (this.readyState === 4) {
if (this.status === 200) {
cb(null, {statusCode: this.status}, this.responseText);
} else {
cb(xhttp.statusText, {statusCode: this.status});
}
}
};
xhttp.open('GET', url, true);
xhttp.send();
}
}
function downloadFile(githubUrl, path, binary) {
return new Promise((resolve, reject) => {
console.log('Download ' + githubUrl + (path || ''));
request(githubUrl + (path || ''), {encoding: binary ? null : 'utf8'}, (err, status, body) => {
if (!err && status.statusCode === 200) {
if (binary) {
resolve(body);
} else {
resolve(body.toString());
}
} else {
reject(err || status.statusCode);
}
});
});
}
// check package.json
function checkPackageJson(githubUrl, context) {
context = context || {checks: [], errors: [], warnings: []};
githubUrl = githubUrl.replace('https://raw.githubusercontent.com/', 'https://github.com/');
if (githubUrl.match(/\/$/)) {
githubUrl = githubUrl.substring(0, githubUrl.length - 1);
}
context.githubUrlOriginal = githubUrl;
githubUrl = githubUrl.replace('https://github.com', 'https://raw.githubusercontent.com');
githubUrl = githubUrl + '/master';
console.log('Original URL: ' + context.githubUrlOriginal + ', raw: ' + githubUrl);
context.githubUrl = githubUrl;
return new Promise((resolve, reject) => {
if (context.packageJson) {
return Promise.resolve(context.packageJson);
} else {
return downloadFile(githubUrl, '/package.json')
.then(packageJson => resolve(packageJson))
.catch(e => reject(e));
}
}).then(packageJson => {
return new Promise(resolve => {
context.packageJson = packageJson;
if (typeof context.packageJson === 'string') {
try {
context.packageJson = JSON.parse(context.packageJson);
} catch (e) {
context.errors.push('[E001] Cannot parse packet.json: ' + e);
return resolve(context);
}
}
if (!githubUrl.match(/\/iobroker\./i)) {
context.errors.push('[E002] No "ioBroker." found in the name of repository');
} else {
context.checks.push('"ioBroker" was found in the name of repository');
}
if (githubUrl.indexOf('/iobroker.') !== -1) {
context.errors.push('[E003] Repository must have name ioBroker.adaptername, but now io"b"roker is in lowercase');
} else {
context.checks.push('Repository has name ioBroker.adaptername (not iobroker.adaptername)');
}
const m = githubUrl.match(/\/ioBroker\.(.*)$/);
let adapterName = '';
if (!m || !m[1]) {
context.errors.push('[E004] No adapter name found in URL: ' + githubUrl);
} else {
context.checks.push('Adapter name found in the URL');
adapterName = m[1].replace(/\/master$/, '');
}
context.adapterName = adapterName;
if (adapterName.match(/[A-Z]/)) {
context.errors.push('[E005] Adapter name must be lowercase');
} else {
context.checks.push('Adapter name is lowercase');
}
if (adapterName.match(/[^-_a-z0-9]/)) {
context.errors.push('[E006] Invalid characters found in adapter name "' + adapterName + '". Only lowercase chars, "-" and "_" are allowed');
} else {
context.checks.push('No invalid characters found in "' + adapterName + '"');
}
const n = githubUrl.match(/\/([^\/]+)\/iobroker\./i);
if (!n || !n[1]) {
context.errors.push('[E007] Cannot find author repo in the URL');
} else {
context.authorName = n[1];
}
if (context.packageJson.name !== 'iobroker.' + adapterName.toLowerCase()) {
context.errors.push('[E020] Name of adapter in package.json must be lowercase and be equal to "iobroker.' + adapterName.toLowerCase() + '". Now is "' + packageJson.name + '"');
} else {
context.checks.push('Name of adapter in package.json must be lowercase and be equal to "iobroker.' + adapterName.toLowerCase() + '".');
}
if (!context.packageJson.version) {
context.errors.push('[E009] No version found in the package.json');
} else {
context.checks.push('Version found in package.json');
}
if (!context.packageJson.description) {
context.errors.push('[E010] No description found in the package.json');
} else {
context.checks.push('Description found in package.json');
}
if (!context.packageJson.license) {
context.errors.push('[E011] No license found in the package.json');
} else {
context.checks.push('License found in package.json');
}
if (!context.packageJson.main) {
context.errors.push('[E012] No main found in the package.json');
} else {
context.checks.push('"main" found in package.json');
}
if (!context.packageJson.author) {
context.errors.push('[E013] No author found in the package.json');
} else {
context.checks.push('Author found in package.json');
}
if (context.packageJson._args) {
context.errors.push('[E014] NPM information found in package.json. Please remove all attributes starting with "_"');
} else {
context.checks.push('No npm generated attributes found in package.json');
}
if (!context.packageJson.license) {
context.errors.push('[E015] No license found in package.json');
} else {
context.checks.push('"license" found in package.json');
// check if license valid
if (licenses.indexOf(context.packageJson.license) === -1) {
context.errors.push('[E016] No SPDX license found in package.json. Please use one of listed here: https://spdx.org/licenses/');
} else {
context.checks.push('"license" is valid in package.json');
}
}
if (!context.packageJson.repository) {
context.errors.push('[E017] No repository found in the package.json');
} else {
context.checks.push('Repository found in package.json');
if (context.packageJson.repository.type !== 'git') {
context.errors.push('[E018] Invalid repository type: ' + context.packageJson.repository.type + '. It should be git');
} else {
context.checks.push('Repository type is valid: git');
}
if (context.packageJson.repository.url.indexOf(context.githubUrlOriginal) === -1) {
context.errors.push('[E019] Invalid repository URL: ' + context.packageJson.repository.url + '. Expected: git+' + context.githubUrlOriginal + '.git');
} else {
context.checks.push('Repository URL is valid in package.json');
}
}
// max number is E020
resolve(context);
});
});
}
const allowedTypes = {
"alarm": "security of home, car, boat, ...",
"climate-control": "climate, heaters, air filters, water heaters, ...",
"communication": "deliver data for other services via RESTapi, websockets",
"date-and-time": "schedules, calendars, ...",
"energy": "energy metering",
"metering": "other, but energy metering (water, gas, oil, ...)",
"garden": "mower, springs, ...",
"general": "general purpose adapters, like admin, web, discovery, ...",
"geoposition": "geo-positioning. These adapters delivers or accepst the position of other objects or persons.",
"hardware": "different multi-purpose hardware, arduino, esp, bluetooth, ...",
"household": "vacuum-cleaner, kitchen devices, ...",
"infrastructure": "Network, printers, phones, NAS, ...",
"iot-systems": "Other comprehensive smarthome systems (software and hardware)",
"lighting": "light",
"logic": "rules, scripts, parsers, scenes, ...",
"messaging": "these adapters send and receive messages from message services: telegram, email, whatsapp, ...",
"misc-data": "export/import of some unsorted information, contacts, systeminfo, gazoline prises, share curses, currents (EUR=>USD), ...",
"multimedia": "TV, AV Receivers, TV play boxes, Android/apple TV boxes, multi-room music, IR controls, speech input/output, ...",
"network": "ping, network detectors, UPnP, ...",
"protocols": "Communication protocols: MQTT,",
"storage": "logging, data protocols, SQL/NoSQL DBs, file storage, ...",
"utility": "different help adapters. Like backup, export/import",
"visualization": "visualisation, like vis, material, mobile",
"visualization-icons": "icons for visualisation",
"visualization-widgets": "iobroker.vis widgets",
"weather": "weather info, air quality, environment statistics"
};
const licenses = [
'0BSD',
'AAL',
'Abstyles',
'Adobe-2006',
'Adobe-Glyph',
'ADSL',
'AFL-1.1',
'AFL-1.2',
'AFL-2.0',
'AFL-2.1',
'AFL-3.0',
'Afmparse',
'AGPL-1.0-only',
'AGPL-1.0-or-later',
'AGPL-3.0-only',
'AGPL-3.0-or-later',
'Aladdin',
'AMDPLPA',
'AML',
'AMPAS',
'ANTLR-PD',
'Apache-1.0',
'Apache-1.1',
'Apache-2.0',
'APAFML',
'APL-1.0',
'APSL-1.0',
'APSL-1.1',
'APSL-1.2',
'APSL-2.0',
'Artistic-1.0-cl8',
'Artistic-1.0-Perl',
'Artistic-1.0',
'Artistic-2.0',
'Bahyph',
'Barr',
'Beerware',
'BitTorrent-1.0',
'BitTorrent-1.1',
'Borceux',
'BSD-1-Clause',
'BSD-2-Clause-FreeBSD',
'BSD-2-Clause-NetBSD',
'BSD-2-Clause-Patent',
'BSD-2-Clause',
'BSD-3-Clause-Attribution',
'BSD-3-Clause-Clear',
'BSD-3-Clause-LBNL',
'BSD-3-Clause-No-Nuclear-License-2014',
'BSD-3-Clause-No-Nuclear-License',
'BSD-3-Clause-No-Nuclear-Warranty',
'BSD-3-Clause',
'BSD-4-Clause-UC',
'BSD-4-Clause',
'BSD-Protection',
'BSD-Source-Code',
'BSL-1.0',
'bzip2-1.0.5',
'bzip2-1.0.6',
'Caldera',
'CATOSL-1.1',
'CC-BY-1.0',
'CC-BY-2.0',
'CC-BY-2.5',
'CC-BY-3.0',
'CC-BY-4.0',
'CC-BY-NC-1.0',
'CC-BY-NC-2.0',
'CC-BY-NC-2.5',
'CC-BY-NC-3.0',
'CC-BY-NC-4.0',
'CC-BY-NC-ND-1.0',
'CC-BY-NC-ND-2.0',
'CC-BY-NC-ND-2.5',
'CC-BY-NC-ND-3.0',
'CC-BY-NC-ND-4.0',
'CC-BY-NC-SA-1.0',
'CC-BY-NC-SA-2.0',
'CC-BY-NC-SA-2.5',
'CC-BY-NC-SA-3.0',
'CC-BY-NC-SA-4.0',
'CC-BY-ND-1.0',
'CC-BY-ND-2.0',
'CC-BY-ND-2.5',
'CC-BY-ND-3.0',
'CC-BY-ND-4.0',
'CC-BY-SA-1.0',
'CC-BY-SA-2.0',
'CC-BY-SA-2.5',
'CC-BY-SA-3.0',
'CC-BY-SA-4.0',
'CC0-1.0',
'CDDL-1.0',
'CDDL-1.1',
'CDLA-Permissive-1.0',
'CDLA-Sharing-1.0',
'CECILL-1.0',
'CECILL-1.1',
'CECILL-2.0',
'CECILL-2.1',
'CECILL-B',
'CECILL-C',
'ClArtistic',
'CNRI-Jython',
'CNRI-Python-GPL-Compatible',
'CNRI-Python',
'Condor-1.1',
'copyleft-next-0.3.0',
'copyleft-next-0.3.1',
'CPAL-1.0',
'CPL-1.0',
'CPOL-1.02',
'Crossword',
'CrystalStacker',
'CUA-OPL-1.0',
'Cube',
'curl',
'D-FSL-1.0',
'diffmark',
'DOC',
'Dotseqn',
'DSDP',
'dvipdfm',
'ECL-1.0',
'ECL-2.0',
'EFL-1.0',
'EFL-2.0',
'eGenix',
'Entessa',
'EPL-1.0',
'EPL-2.0',
'ErlPL-1.1',
'EUDatagrid',
'EUPL-1.0',
'EUPL-1.1',
'EUPL-1.2',
'Eurosym',
'Fair',
'Frameworx-1.0',
'FreeImage',
'FSFAP',
'FSFUL',
'FSFULLR',
'FTL',
'GFDL-1.1-only',
'GFDL-1.1-or-later',
'GFDL-1.2-only',
'GFDL-1.2-or-later',
'GFDL-1.3-only',
'GFDL-1.3-or-later',
'Giftware',
'GL2PS',
'Glide',
'Glulxe',
'gnuplot',
'GPL-1.0-only',
'GPL-1.0-or-later',
'GPL-2.0-only',
'GPL-2.0-or-later',
'GPL-3.0-only',
'GPL-3.0-or-later',
'gSOAP-1.3b',
'HaskellReport',
'HPND',
'IBM-pibs',
'ICU',
'IJG',
'ImageMagick',
'iMatix',
'Imlib2',
'Info-ZIP',
'Intel-ACPI',
'Intel',
'Interbase-1.0',
'IPA',
'IPL-1.0',
'ISC',
'JasPer-2.0',
'JSON',
'LAL-1.2',
'LAL-1.3',
'Latex2e',
'Leptonica',
'LGPL-2.0-only',
'LGPL-2.0-or-later',
'LGPL-2.1-only',
'LGPL-2.1-or-later',
'LGPL-3.0-only',
'LGPL-3.0-or-later',
'LGPLLR',
'Libpng',
'libtiff',
'LiLiQ-P-1.1',
'LiLiQ-R-1.1',
'LiLiQ-Rplus-1.1',
'Linux-OpenIB',
'LPL-1.0',
'LPL-1.02',
'LPPL-1.0',
'LPPL-1.1',
'LPPL-1.2',
'LPPL-1.3a',
'LPPL-1.3c',
'MakeIndex',
'MirOS',
'MIT-0',
'MIT-advertising',
'MIT-CMU',
'MIT-enna',
'MIT-feh',
'MIT',
'MITNFA',
'Motosoto',
'mpich2',
'MPL-1.0',
'MPL-1.1',
'MPL-2.0-no-copyleft-exception',
'MPL-2.0',
'MS-PL',
'MS-RL',
'MTLL',
'Multics',
'Mup',
'NASA-1.3',
'Naumen',
'NBPL-1.0',
'NCSA',
'Net-SNMP',
'NetCDF',
'Newsletr',
'NGPL',
'NLOD-1.0',
'NLPL',
'Nokia',
'NOSL',
'Noweb',
'NPL-1.0',
'NPL-1.1',
'NPOSL-3.0',
'NRL',
'NTP',
'OCCT-PL',
'OCLC-2.0',
'ODbL-1.0',
'ODC-By-1.0',
'OFL-1.0',
'OFL-1.1',
'OGL-UK-1.0',
'OGL-UK-2.0',
'OGL-UK-3.0',
'OGTSL',
'OLDAP-1.1',
'OLDAP-1.2',
'OLDAP-1.3',
'OLDAP-1.4',
'OLDAP-2.0.1',
'OLDAP-2.0',
'OLDAP-2.1',
'OLDAP-2.2.1',
'OLDAP-2.2.2',
'OLDAP-2.2',
'OLDAP-2.3',
'OLDAP-2.4',
'OLDAP-2.5',
'OLDAP-2.6',
'OLDAP-2.7',
'OLDAP-2.8',
'OML',
'OpenSSL',
'OPL-1.0',
'OSET-PL-2.1',
'OSL-1.0',
'OSL-1.1',
'OSL-2.0',
'OSL-2.1',
'OSL-3.0',
'PDDL-1.0',
'PHP-3.0',
'PHP-3.01',
'Plexus',
'PostgreSQL',
'psfrag',
'psutils',
'Python-2.0',
'Qhull',
'QPL-1.0',
'Rdisc',
'RHeCos-1.1',
'RPL-1.1',
'RPL-1.5',
'RPSL-1.0',
'RSA-MD',
'RSCPL',
'Ruby',
'SAX-PD',
'Saxpath',
'SCEA',
'Sendmail-8.23',
'Sendmail',
'SGI-B-1.0',
'SGI-B-1.1',
'SGI-B-2.0',
'SimPL-2.0',
'SISSL-1.2',
'SISSL',
'Sleepycat',
'SMLNJ',
'SMPPL',
'SNIA',
'Spencer-86',
'Spencer-94',
'Spencer-99',
'SPL-1.0',
'SugarCRM-1.1.3',
'SWL',
'TCL',
'TCP-wrappers',
'TMate',
'TORQUE-1.1',
'TOSL',
'TU-Berlin-1.0',
'TU-Berlin-2.0',
'Unicode-DFS-2015',
'Unicode-DFS-2016',
'Unicode-TOU',
'Unlicense',
'UPL-1.0',
'Vim',
'VOSTROM',
'VSL-1.0',
'W3C-19980720',
'W3C-20150513',
'W3C',
'Watcom-1.0',
'Wsuipa',
'WTFPL',
'X11',
'Xerox',
'XFree86-1.1',
'xinetd',
'Xnet',
'xpp',
'XSkat',
'YPL-1.0',
'YPL-1.1',
'Zed',
'Zend-2.0',
'Zimbra-1.3',
'Zimbra-1.4',
'zlib-acknowledgement',
'Zlib',
'ZPL-1.1',
'ZPL-2.0',
'ZPL-2.1',
];
function checkIOPackageJson(context) {
context = context || {};
return new Promise((resolve, reject) => {
if (context.ioPackageJson) {
return Promise.resolve(context.ioPackageJson);
} else {
return downloadFile(context.githubUrl, '/io-package.json')
.then(packageJson => resolve(packageJson))
.catch(e => reject(e));
}
}).then(ioPackageJson => {
return new Promise(resolve => {
context.ioPackageJson = ioPackageJson;
if (typeof context.ioPackageJson === 'string') {
try {
context.ioPackageJson = JSON.parse(context.ioPackageJson);
} catch (e) {
context.errors.push('[E100] Cannot parse io-package.json: ' + e);
return resolve(context);
}
}
if (!context.ioPackageJson.native) {
context.errors.push('[E101] io-package.json must have at least empty "native" attribute');
} else {
context.checks.push('"native" found in io-package.json');
}
if (!context.ioPackageJson.common) {
context.errors.push('[E102] io-package.json must have common object');
return resolve(context);
} else {
context.checks.push('"common" found in io-package.json');
if (!context.ioPackageJson.common ||
context.ioPackageJson.common.name !== context.adapterName.toLowerCase()) {
context.errors.push('[E103] common.name in io-package.json must be equal to "' + context.adapterName.toLowerCase() + '". Now is ' + context.ioPackageJson.common.name);
} else {
context.checks.push('"common.name" is valid in io-package.json');
}
if (!context.ioPackageJson.common.title) {
context.errors.push('[E104] No common.title found in io-package.json');
} else {
context.checks.push('"common.title" found in io-package.json');
if (context.ioPackageJson.common.title.match(/iobroker/i)) {
context.errors.push('[E105] Title should not have ioBroker in the name. It is clear, for what this adapter was created. Now: ' + context.ioPackageJson.common.title);
} else {
context.checks.push('"common.title" has no ioBroker in it in io-package.json');
}
if (context.ioPackageJson.common.title.match(/\sadapter|adapter\s/i)) {
context.errors.push('[E106] Title should not have word "adapter" in the name. It is clear, that this is adapter. Now: ' + context.ioPackageJson.common.title);
} else {
context.checks.push('"common.title" has no "adapter" in it in io-package.json');
}
}
if (!context.ioPackageJson.common.version) {
context.errors.push('[E107] No version found in io-package.json');
} else {
context.checks.push('"common.version" found in io-package.json');
}
if (!context.ioPackageJson.common.desc) {
context.errors.push('[E108] No description found in io-package.json');
} else {
context.checks.push('"common.desc" found in io-package.json');
}
if (typeof context.ioPackageJson.common.desc !== 'object') {
context.errors.push('[E109] desc in io-package.json should be an object for many languages. Found only ' + context.ioPackageJson.common.desc);
} else {
context.checks.push('"common.desc" is multilingual in io-package.json');
}
if (!context.ioPackageJson.common.icon) {
context.errors.push('[E110] Icon not found in the io-package.json');
} else {
context.checks.push('"common.icon" found in io-package.json');
}
if (!context.ioPackageJson.common.extIcon) {
context.errors.push('[E111] extIcon not found in the io-package.json');
} else {
context.checks.push('"common.extIcon" found in io-package.json');
if (!context.ioPackageJson.common.extIcon ||
context.ioPackageJson.common.icon !== context.ioPackageJson.common.extIcon.substring(context.ioPackageJson.common.extIcon.length - context.ioPackageJson.common.icon.length)) {
context.errors.push('[E112] extIcon must be the same as an icon but with github path');
} else {
context.checks.push('"common.extIcon" has same path as repo in io-package.json');
}
}
if (!context.ioPackageJson.common.compact && !context.ioPackageJson.common.onlyWWW) {
context.warnings.push('[W113] Adapter should support compact mode');
} else
if (!context.ioPackageJson.common.onlyWWW) {
context.checks.push('"common.compact" found in io-package.json');
}
if (!context.ioPackageJson.common.materialize) {
context.errors.push('[E114] No adapter are allowed in the repo without admin3 support');
} else {
context.checks.push('"common.materialize" found in io-package.json');
}
if (!context.ioPackageJson.common.license) {
context.errors.push('[E115] No license found in io-package.json');
} else {
context.checks.push('"common.license" found in io-package.json');
// check if license valid
if (licenses.indexOf(context.ioPackageJson.common.license) === -1) {
context.errors.push('[E116] No SPDX license found. Please use one of listed here: https://spdx.org/licenses/');
} else {
context.checks.push('"common.license" is valid in io-package.json');
}
if (!context.packageJson ||
context.ioPackageJson.common.license !== context.packageJson.license) {
context.errors.push('[E117] Licenses in package.json and in io-package.json are different');
} else {
context.checks.push('"common.license" is equal in pacjage.json and in io-package.json');
}
}
if (!context.packageJson ||
context.ioPackageJson.common.version !== context.packageJson.version) {
context.errors.push('[E118] Versions in package.json and in io-package.json are different');
} else {
context.checks.push('"common.version" is equal in package.json adn in io-package.json');
}
if (!context.ioPackageJson.common.type) {
context.errors.push('[E119] No type found in io-package.json');
} else {
context.checks.push('"common.type" found in io-package.json');
}
if (!allowedTypes[context.ioPackageJson.common.type]) {
context.errors.push('[E120] Unknown type found in io-package.json');
} else {
context.checks.push('"common.type" has known type in io-package.json');
}
if (!context.ioPackageJson.common.authors) {
context.errors.push('[E121] No authors found in io-package.json');
} else {
context.checks.push('"common.authors" found in io-package.json');
if (!(context.ioPackageJson.common.authors instanceof Array)) {
context.errors.push('[E122] authors must be an Array in io-package.json');
} else {
context.checks.push('"common.authors" is array in io-package.json');
}
if (!context.ioPackageJson.common.authors.length) {
context.errors.push('[E123] Authors may not be empty in io-package.json');
} else {
context.checks.push('"common.authors" is not empty in io-package.json');
}
}
if (context.ioPackageJson.common.extIcon) {
return downloadFile(context.ioPackageJson.common.extIcon)
.then(() => {
context.checks.push('"extIcon" could be downloaded');
if (!context.ioPackageJson.onlyWWW && context.packageJson.main) {
return downloadFile(context.githubUrl, '/' + context.packageJson.main)
.then(() => {
context.checks.push(context.packageJson.main + ' could be downloaded');
})
.catch(err => {
context.errors.push('[E124] Main file not found under URL: ' + context.githubUrl + '/' + context.packageJson.main);
})
.then(() => Promise.resolve(context));
} else {
return Promise.resolve(context);
}
})
.catch(err => {
context.errors.push('[E125] External icon not found under URL: ' + context.ioPackageJson.common.extIcon);
}).then(() => {
resolve(context);
});
} else {
resolve(context);
}
// max number is E123
}
})
});
}
function checkNpm(context) {
return new Promise(resolve => {
request('https://www.npmjs.com/package/iobroker.' + context.adapterName, (err, status, body) => {
if (!body) {
context.errors.push('[E200] Not found on npm. Please publish');
return resolve(context);
}
context.checks.push('Adapter found on npm');
body = body.toString();
const m = body.match(/>collaborators<(.*)<\/ul>/);
if (m) {
if (m[1].indexOf('title="bluefox"') === -1 && m[1].indexOf('title="iobluefox"') === -1) {
context.errors.push(`[E201] Bluefox was not found in the collaborators on NPM!. Please execute in adapter directory: "npm owner add bluefox iobroker.${context.adapterName}"`);
} else {
context.checks.push('Bluefox found in collaborators on NPM');
}
} else {
context.errors.push(`[E201] Bluefox was not found in the collaborators on NPM!. Please execute in adapter directory: "npm owner add bluefox iobroker.${context.adapterName}"`);
}
resolve(context);
// max number is E201
});
});
}
function checkTravis(context) {
return new Promise(resolve => {
let travisURL = context.githubUrlOriginal.replace('github.com', 'api.travis-ci.org') + '.png';
request(travisURL, (err, status, body) => {
if (!status) {
context.errors.push('[E300] Not found on travis. Please setup travis');
return resolve(context);
}
if (!status.headers || !status.headers['content-disposition']){
context.errors.push('[E300] Not found on travis. Please setup travis');
return resolve(context);
}
// inline; filename="passing.png"
const m = status.headers['content-disposition'].match(/filename="(.+)"$/);
if (!m) {
context.errors.push('[E300] Not found on travis. Please setup travis');
return resolve(context);
}
if (m[1] === 'unknown.png') {
context.errors.push('[E300] Not found on travis. Please setup travis');
return resolve(context);
}
context.checks.push('Found on travis-ci');
if (m[1] !== 'passing.png') {
context.errors.push('[E301] Tests on Travis-ci.org are broken. Please fix.');
} else {
context.checks.push('Tests are OK on travis-ci');
}
resolve(context);
// max number is E301
});
});
}
function checkRepo(context) {
return new Promise(resolve => {
if (context.ioPackageJson && context.ioPackageJson.common && context.ioPackageJson.common.type) {
// download latest repo
request('https://raw.githubusercontent.com/ioBroker/ioBroker.repositories/master/sources-dist.json', (err, status, body) => {
err && console.error(err);
if (!body) {
context.errors.push('[E400] Cannot download https://raw.githubusercontent.com/ioBroker/ioBroker.repositories/master/sources-dist.json');
} else {
try {
body = JSON.parse(body);
} catch (e) {
console.error('Cannot parse sources-dist.json: ' + body);
context.errors.push('[E401] Cannot parse sources-dist.json');
body = null;
}
if (body) {
context.latestRepo = body;
if (!context.latestRepo[context.adapterName]) {
context.warnings.push('[W400] Cannot find "' + context.adapterName + '" in latest repository');
} else {
context.checks.push('Adapter found in latest repository');
if (context.latestRepo[context.adapterName].type !== context.ioPackageJson.common.type) {
context.errors.push('[E402] Types of adapter in latest repository and in io-package.json are different "' + context.latestRepo[context.adapterName].type + '" !== "' + context.ioPackageJson.common.type + '"');
} else {
context.checks.push('Types of adapter in latest repository and in io-package.json are equal: "' + context.latestRepo[context.adapterName].type + '"');
}
if (context.latestRepo[context.adapterName].version) {
context.errors.push('[E403] Version set in latest repository');
} else {
context.checks.push('Version does not set in latest repository');
}
const url = 'https://raw.githubusercontent.com/' + context.authorName + '/ioBroker.' + context.adapterName + '/master/';
if (!context.latestRepo[context.adapterName].icon) {
context.errors.push('[E404] Icon does not found in latest repository');
} else {
context.checks.push('Icon found in latest repository');
if (!context.latestRepo[context.adapterName].icon.startsWith(url)) {
context.errors.push('[E405] Icon must be in the following path: ' + url);
} else {
context.checks.push('Icon found in latest repository');
}
}
if (!context.latestRepo[context.adapterName].meta) {
context.errors.push('[E406] Meta URL(latest) not found in latest repository');
} else {
context.checks.push('Meta URL(latest) found in latest repository');
if (context.latestRepo[context.adapterName].meta !== url + 'io-package.json') {
context.errors.push('[E407] Meta URL(latest) must be equal to ' + url + 'io-package.json');
} else {
context.checks.push('Meta URL(latest) is OK in latest repository');
}
}
}
}
}
// download stable repo
request('https://raw.githubusercontent.com/ioBroker/ioBroker.repositories/master/sources-dist-stable.json', (err, status, body) => {
err && console.error(err);
if (!body) {
context.errors.push('[E420] Cannot download https://raw.githubusercontent.com/ioBroker/ioBroker.repositories/master/sources-dist-stable.json');
} else {
try {
body = JSON.parse(body);
} catch (e) {
console.error('Cannot parse sources-dist.json: ' + body);
context.errors.push('[E421] Cannot parse sources-dist-stable.json');
body = null;
}
if (body) {
context.stableRepo = body;
if (context.stableRepo[context.adapterName]) {
if (context.stableRepo[context.adapterName].type !== context.ioPackageJson.common.type) {
context.errors.push('[E422] Types of adapter in stable repository and in io-package.json are different "' + context.stableRepo[context.adapterName].type + '" !== "' + context.ioPackageJson.common.type + '"');
} else {
context.checks.push('Types of adapter in stable repository and in io-package.json are equal: "' + context.stableRepo[context.adapterName].type + '"');
}
if (!context.latestRepo[context.adapterName]) {
context.errors.push('[E423] Adapter was found in stable repository but not in latest repo');
} else {
context.checks.push('Adapter was found in stable repository and in latest repo');
}
if (!context.stableRepo[context.adapterName].version) {
context.errors.push('[E424] No version set in stable repository');
} else {
context.checks.push('Version found in stable repository');
}
const url = 'https://raw.githubusercontent.com/' + context.authorName + '/ioBroker.' + context.adapterName + '/master/';
if (!context.stableRepo[context.adapterName].icon) {
context.errors.push('[E425] Icon does not found in stable repository');
} else {
context.checks.push('Icon found in stable repository');
if (!context.stableRepo[context.adapterName].icon.startsWith(url)) {
context.errors.push('[E426] Icon(stable) must be in the following path: ' + url);
} else {
context.checks.push('Icon(stable) found in latest repository');
}
}
if (!context.stableRepo[context.adapterName].meta) {
context.errors.push('[E427] Meta URL(stable) not found in latest repository');
} else {
context.checks.push('Meta URL(stable) found in latest repository');
if (context.stableRepo[context.adapterName].meta !== url + 'io-package.json') {
context.errors.push('[E428] Meta URL(stable) must be equal to ' + url + 'io-package.json');
} else {
context.checks.push('Meta URL(stable) is OK in latest repository');
}
}
}
}
}
resolve(context);
});