-
Notifications
You must be signed in to change notification settings - Fork 2.6k
/
make.js
1033 lines (862 loc) · 39.9 KB
/
make.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
// parse command line options
var argv = require('minimist')(process.argv.slice(2));
// modules
var fs = require('fs');
var os = require('os');
var path = require('path');
var semver = require('semver');
var util = require('./make-util');
var admzip = require('adm-zip');
// util functions
var cd = util.cd;
var cp = util.cp;
var mkdir = util.mkdir;
var rm = util.rm;
var test = util.test;
var run = util.run;
var banner = util.banner;
var rp = util.rp;
var fail = util.fail;
var ensureExists = util.ensureExists;
var pathExists = util.pathExists;
var buildNodeTask = util.buildNodeTask;
var addPath = util.addPath;
var copyTaskResources = util.copyTaskResources;
var matchFind = util.matchFind;
var matchCopy = util.matchCopy;
var ensureTool = util.ensureTool;
var assert = util.assert;
var getExternalsAsync = util.getExternalsAsync;
var createResjson = util.createResjson;
var createTaskLocJson = util.createTaskLocJson;
var validateTask = util.validateTask;
var fileToJson = util.fileToJson;
var createYamlSnippetFile = util.createYamlSnippetFile;
var createMarkdownDocFile = util.createMarkdownDocFile;
var getTaskNodeVersion = util.getTaskNodeVersion;
var writeUpdatedsFromGenTasks = false;
// global paths
var buildPath = path.join(__dirname, '_build');
var buildTasksPath = path.join(__dirname, '_build', 'Tasks');
var buildTestsPath = path.join(__dirname, '_build', 'Tests');
var buildTasksCommonPath = path.join(__dirname, '_build', 'Tasks', 'Common');
var testsLegacyPath = path.join(__dirname, 'Tests-Legacy');
var tasksPath = path.join(__dirname, 'Tasks');
var testsPath = path.join(__dirname, 'Tests');
var testPath = path.join(__dirname, '_test');
var legacyTestTasksPath = path.join(__dirname, '_test', 'Tasks');
var testTestsLegacyPath = path.join(__dirname, '_test', 'Tests-Legacy');
var binPath = path.join(__dirname, 'node_modules', '.bin');
var makeOptionsPath = path.join(__dirname, 'make-options.json');
var gendocsPath = path.join(__dirname, '_gendocs');
var packagePath = path.join(__dirname, '_package');
var coverageTasksPath = path.join(buildPath, 'coverage');
var baseConfigToolPath = path.join(__dirname, 'BuildConfigGen');
var genTaskPath = path.join(__dirname, '_generated');
var genTaskCommonPath = path.join(__dirname, '_generated', 'Common');
var CLI = {};
// node min version
var minNodeVer = '10.24.1';
if (semver.lt(process.versions.node, minNodeVer)) {
fail('requires node >= ' + minNodeVer + '. installed: ' + process.versions.node);
}
// Node 14 is supported by the build system, but not currently by the agent. Block it for now
var supportedNodeTargets = ["Node", "Node10"/*, "Node14"*/];
var node10Version = '10.24.1';
var node20Version = '20.14.0';
// add node modules .bin to the path so we can dictate version of tsc etc...
if (!test('-d', binPath)) {
fail('node modules bin not found. ensure npm install has been run.');
}
addPath(binPath);
// resolve list of tasks
var taskList;
if (argv.task) {
// find using --task parameter
taskList = matchFind(argv.task, tasksPath, { noRecurse: true, matchBase: true })
.map(function (item) {
return path.basename(item);
});
// If base tasks was not found, try to find the task in the _generated tasks folder
if (taskList.length == 0 && fs.existsSync(genTaskPath)) {
taskList = matchFind(argv.task, genTaskPath, { noRecurse: true, matchBase: true })
.map(function (item) {
return path.basename(item);
});
}
if (!taskList.length) {
fail('Unable to find any tasks matching pattern ' + argv.task);
}
} else {
// load the default list
taskList = fileToJson(makeOptionsPath).tasks;
}
// set the runner options. should either be empty or a comma delimited list of test runners.
// for example: ts OR ts,ps
//
// note, currently the ts runner igores this setting and will always run.
process.env['TASK_TEST_RUNNER'] = argv.runner || '';
function getTaskList(taskList) {
let tasksToBuild = taskList;
if (!fs.existsSync(genTaskPath)) return tasksToBuild;
const generatedTaskFolders = fs.readdirSync(genTaskPath)
.filter((taskName) => {
return fs.statSync(path.join(genTaskPath, taskName)).isDirectory();
});
taskList.forEach((taskName) => {
generatedTaskFolders.forEach((generatedTaskName) => {
if (taskName !== generatedTaskName && generatedTaskName.startsWith(taskName)) {
tasksToBuild.push(generatedTaskName);
}
});
});
return tasksToBuild.sort();
}
function ensureBuildTasksAndRemoveTestPath() {
if (!fs.existsSync(buildTasksPath)) {
mkdir('-p', buildTasksPath);
}
rm('-Rf', testPath);
};
CLI.clean = function() {
rm('-Rf', buildPath);
ensureBuildTasksAndRemoveTestPath();
};
//
// Generate documentation (currently only YAML snippets)
// ex: node make.js gendocs
// ex: node make.js gendocs --task ShellScript
//
CLI.gendocs = function() {
rm('-Rf', gendocsPath);
mkdir('-p', gendocsPath);
console.log();
console.log('> generating docs');
taskList.forEach(function(taskName) {
var taskPath = path.join(tasksPath, taskName);
ensureExists(taskPath);
// load the task.json
var taskJsonPath = path.join(taskPath, 'task.json');
if (test('-f', taskJsonPath)) {
var taskDef = fileToJson(taskJsonPath);
validateTask(taskDef);
// create YAML snippet Markdown
var yamlOutputFilename = taskName + '.md';
createYamlSnippetFile(taskDef, gendocsPath, yamlOutputFilename);
// create Markdown documentation file
var mdDocOutputFilename = taskName + '.md';
createMarkdownDocFile(taskDef, taskJsonPath, gendocsPath, mdDocOutputFilename);
}
});
banner('Generating docs successful', true);
}
//
// ex: node make.js build
// ex: node make.js build --task ShellScript
//
CLI.build = async function(/** @type {{ task: string }} */ argv)
{
if (process.env.TF_BUILD) {
fail('Please use serverBuild for CI builds for proper validation');
}
writeUpdatedsFromGenTasks = true;
await CLI.serverBuild(argv);
}
CLI.buildandtest = async function (/** @type {{ task: string }} */ argv) {
await CLI.build(argv);
await CLI.test(argv);
}
CLI.serverBuild = async function(/** @type {{ task: string }} */ argv) {
ensureBuildTasksAndRemoveTestPath();
ensureTool('tsc', '--version', 'Version 4.0.2');
ensureTool('npm', '--version', function (output) {
if (semver.lt(output, '5.6.0')) {
fail('Expected 5.6.0 or higher. To fix, run: npm install -g npm');
}
});
// Need to validate generated tasks first
const makeOptions = fileToJson(makeOptionsPath);
// Verify generated files across tasks are up-to-date
util.processGeneratedTasks(baseConfigToolPath, taskList, makeOptions, writeUpdatedsFromGenTasks, argv.sprint, argv['debug-agent-dir']);
const allTasks = getTaskList(taskList);
// Wrap build function to store files that changes after the build
const buildTaskWrapped = util.syncGeneratedFilesWrapper(buildTaskAsync, genTaskPath, writeUpdatedsFromGenTasks);
const { allTasksNode20, allTasksDefault } = allTasks.
reduce((res, taskName) => {
if (getNodeVersion(taskName) == 20) {
res.allTasksNode20.push(taskName)
} else {
res.allTasksDefault.push(taskName)
}
return res;
}, {allTasksNode20: [], allTasksDefault: []})
if (allTasksNode20.length > 0) {
await util.installNodeAsync('20');
ensureTool('node', '--version', `v${node20Version}`);
for (const taskName of allTasksNode20) {
await buildTaskWrapped(taskName, allTasksNode20.length, 20, !writeUpdatedsFromGenTasks);
}
}
if (allTasksDefault.length > 0) {
await util.installNodeAsync('10');
ensureTool('node', '--version', `v${node10Version}`);
for (const taskName of allTasksDefault) {
await buildTaskWrapped(taskName, allTasksNode20.length, 10, !writeUpdatedsFromGenTasks);
}
}
// Remove Commons from _generated folder as it is not required
if (fs.existsSync(genTaskCommonPath)) {
rm('-Rf', genTaskCommonPath);
}
banner('Build successful', true);
}
function getNodeVersion (taskName) {
let taskPath = tasksPath;
// if task exists inside gen folder prefere it
if (fs.existsSync(path.join(genTaskPath, taskName))) {
taskPath = genTaskPath;
}
// get node runner from task.json
const handlers = getTaskNodeVersion(taskPath, taskName);
if (handlers.includes(20)) return 20;
return 10;
}
async function buildTaskAsync(taskName, taskListLength, nodeVersion, isServerBuild = false) {
let isGeneratedTask = false;
banner(`Building task ${taskName} using Node.js ${nodeVersion}`);
const removeNodeModules = taskListLength > 1;
// If we have the task in generated folder, prefer to build from there and add all generated tasks which starts with task name
var taskPath = path.join(genTaskPath, taskName);
if (fs.existsSync(taskPath)) {
// Need to add all tasks which starts with task name
console.log('Found generated task: ' + taskName);
isGeneratedTask = true;
} else {
taskPath = path.join(tasksPath, taskName);
}
ensureExists(taskPath);
// load the task.json
var outDir;
var shouldBuildNode = test('-f', path.join(taskPath, 'tsconfig.json'));
var taskJsonPath = path.join(taskPath, 'task.json');
if (test('-f', taskJsonPath)) {
var taskDef = fileToJson(taskJsonPath);
validateTask(taskDef);
// fixup the outDir (required for relative pathing in legacy L0 tests)
outDir = path.join(buildTasksPath, taskName);
if(fs.existsSync(outDir))
{
console.log('Remove existing outDir: ' + outDir);
rm('-rf', outDir);
}
// create loc files
createTaskLocJson(taskPath);
createResjson(taskDef, taskPath);
// determine the type of task
shouldBuildNode = shouldBuildNode || supportedNodeTargets.some(node => taskDef.execution.hasOwnProperty(node));
} else {
outDir = path.join(buildTasksPath, path.basename(taskPath));
}
mkdir('-p', outDir);
// get externals
var taskMakePath = path.join(taskPath, 'make.json');
var taskMake = test('-f', taskMakePath) ? fileToJson(taskMakePath) : {};
if (taskMake.hasOwnProperty('externals')) {
console.log('');
console.log('> getting task externals');
await getExternalsAsync(taskMake.externals, outDir);
}
//--------------------------------
// Common: build, copy, install
//--------------------------------
var commonPacks = [];
if (taskMake.hasOwnProperty('common')) {
var common = taskMake['common'];
for (const mod of common) {
var modPath = path.join(taskPath, mod['module']);
var modName = path.basename(modPath);
var modOutDir = path.join(buildTasksCommonPath, modName);
if (!test('-d', modOutDir)) {
banner('Building module ' + modPath, true);
// Ensure that Common folder exists for _generated tasks, otherwise copy it from Tasks folder
if (!fs.existsSync(genTaskCommonPath) && isGeneratedTask) {
cp('-Rf', path.resolve(tasksPath, "Common"), genTaskCommonPath);
}
mkdir('-p', modOutDir);
// create loc files
var modJsonPath = path.join(modPath, 'module.json');
if (test('-f', modJsonPath)) {
createResjson(fileToJson(modJsonPath), modPath);
}
// npm install and compile
if ((mod.type === 'node' && mod.compile == true) || test('-f', path.join(modPath, 'tsconfig.json'))) {
buildNodeTask(modPath, modOutDir, isServerBuild);
}
// copy default resources and any additional resources defined in the module's make.json
console.log();
console.log('> copying module resources');
var modMakePath = path.join(modPath, 'make.json');
var modMake = test('-f', modMakePath) ? fileToJson(modMakePath) : {};
copyTaskResources(modMake, modPath, modOutDir);
// get externals
if (modMake.hasOwnProperty('externals')) {
console.log('');
console.log('> getting module externals');
await getExternalsAsync(modMake.externals, modOutDir);
}
if (mod.type === 'node' && mod.compile == true || test('-f', path.join(modPath, 'package.json'))) {
var commonPack = util.getCommonPackInfo(modOutDir);
// assert the pack file does not already exist (name should be unique)
if (test('-f', commonPack.packFilePath)) {
fail(`Pack file already exists: ${commonPack.packFilePath}`);
}
// pack the Node module. a pack file is required for dedupe.
// installing from a folder creates a symlink, and does not dedupe.
cd(path.dirname(modOutDir));
run(`npm pack ./${path.basename(modOutDir)}`);
}
}
// store the npm pack file info
if (mod.type === 'node' && mod.compile == true) {
commonPacks.push(util.getCommonPackInfo(modOutDir));
// copy ps module resources to the task output dir
} else if (mod.type === 'ps') {
console.log();
console.log('> copying ps module to task');
var dest;
if (mod.hasOwnProperty('dest')) {
dest = path.join(outDir, mod.dest, modName);
} else {
dest = path.join(outDir, 'ps_modules', modName);
}
matchCopy('!Tests', modOutDir, dest, { noRecurse: true, matchBase: true });
}
}
// npm install the common modules to the task dir
if (commonPacks.length) {
cd(taskPath);
var installPaths = commonPacks.map(function (commonPack) {
return `file:${path.relative(taskPath, commonPack.packFilePath)}`;
});
run(`npm install --save-exact ${installPaths.join(' ')}`);
}
}
// build Node task
if (shouldBuildNode) {
buildNodeTask(taskPath, outDir, isServerBuild);
}
// remove the hashes for the common packages, they change every build
if (commonPacks.length) {
var lockFilePath = path.join(taskPath, 'package-lock.json');
if (!test('-f', lockFilePath)) {
lockFilePath = path.join(taskPath, 'npm-shrinkwrap.json');
}
var packageLock = fileToJson(lockFilePath);
var dependencies = packageLock.dependencies || packageLock.packages;
Object.keys(dependencies).forEach(function (dependencyName) {
commonPacks.forEach(function (commonPack) {
if (dependencyName == commonPack.packageName || dependencyName == `node_modules/${commonPack.packageName}`) {
delete dependencies[dependencyName].integrity;
}
});
});
fs.writeFileSync(lockFilePath, JSON.stringify(packageLock, null, ' '));
}
// copy default resources and any additional resources defined in the task's make.json
console.log();
console.log('> copying task resources');
copyTaskResources(taskMake, taskPath, outDir);
if (removeNodeModules) {
const taskNodeModulesPath = path.join(taskPath, 'node_modules');
if (fs.existsSync(taskNodeModulesPath)) {
console.log('\n> removing node modules');
rm('-Rf', taskNodeModulesPath);
}
const taskTestsNodeModulesPath = path.join(taskPath, 'Tests', 'node_modules');
if (fs.existsSync(taskTestsNodeModulesPath)) {
console.log('\n> removing task tests node modules');
rm('-Rf', taskTestsNodeModulesPath);
}
}
// remove duplicated task libs node modules from build tasks.
var buildTasksNodeModules = path.join(buildTasksPath, taskName, 'node_modules');
var duplicateTaskLibPaths = [
'azure-pipelines-tasks-java-common', 'azure-pipelines-tasks-codecoverage-tools', 'azure-pipelines-tasks-codeanalysis-common',
'azure-pipelines-tool-lib', 'azure-pipelines-tasks-utility-common', 'azure-pipelines-tasks-packaging-common', 'artifact-engine',
'azure-pipelines-tasks-azure-arm-rest'
];
for (var duplicateTaskPath of duplicateTaskLibPaths) {
const buildTasksDuplicateNodeModules = path.join(buildTasksNodeModules, duplicateTaskPath, 'node_modules', 'azure-pipelines-task-lib');
if (fs.existsSync(buildTasksDuplicateNodeModules)) {
console.log(`\n> removing duplicated task-lib node modules in ${buildTasksDuplicateNodeModules}`);
rm('-Rf', buildTasksDuplicateNodeModules);
}
}
}
//
// will run tests for the scope of tasks being built
// npm test
// node make.js test
// node make.js test --task ShellScript --suite L0
//
CLI.test = async function(/** @type {{ suite: string; node: string; task: string }} */ argv) {
var minIstanbulVersion = '20';
ensureTool('tsc', '--version', 'Version 4.0.2');
ensureTool('mocha', '--version', '6.2.3');
// build the general tests and ps test infra
rm('-Rf', buildTestsPath);
mkdir('-p', path.join(buildTestsPath));
cd(testsPath);
run(`tsc --rootDir ${testsPath} --outDir ${buildTestsPath}`);
console.log();
console.log('> copying ps test lib resources');
mkdir('-p', path.join(buildTestsPath, 'lib'));
matchCopy(path.join('**', '@(*.ps1|*.psm1)'), path.join(testsPath, 'lib'), path.join(buildTestsPath, 'lib'));
var suiteType = argv.suite || 'L0';
async function runTaskTests(taskName) {
banner('Testing: ' + taskName);
// find the tests
var nodeVersions = argv.node ? new Array(argv.node) : [Math.max(...getTaskNodeVersion(buildTasksPath, taskName))];
var pattern1 = path.join(buildTasksPath, taskName, 'Tests', suiteType + '.js');
var pattern2 = path.join(buildTasksPath, 'Common', taskName, 'Tests', suiteType + '.js');
var taskPath = path.join('**', '_build', 'Tasks', taskName, "**", "*.js").replace(/\\/g, '/');
var isNodeTask = util.isNodeTask(buildTasksPath, taskName);
var isReportWasFormed = false;
var testsSpec = [];
if (fs.existsSync(pattern1)) {
testsSpec.push(pattern1);
}
if (fs.existsSync(pattern2)) {
testsSpec.push(pattern2);
}
if (testsSpec.length == 0) {
console.warn(`Unable to find tests using the following patterns: ${JSON.stringify([pattern1, pattern2])}`);
return;
}
for (let nodeVersion of nodeVersions) {
try {
nodeVersion = String(nodeVersion);
banner('Run Mocha Suits for node ' + nodeVersion);
// setup the version of node to run the tests
await util.installNodeAsync(nodeVersion);
if (isNodeTask && !isReportWasFormed && nodeVersion >= 10) {
run('nyc --all -n ' + taskPath + ' --report-dir ' + coverageTasksPath + ' mocha ' + testsSpec.join(' '), /*inheritStreams:*/true);
util.renameCodeCoverageOutput(coverageTasksPath, taskName);
isReportWasFormed = true;
}
else {
run('mocha ' + testsSpec.join(' '), /*inheritStreams:*/true);
}
} catch (e) {
console.error(e);
process.exit(1);
}
}
}
// Run tests for each task that exists
const allTasks = getTaskList(taskList);
for (const taskName of allTasks) {
var taskPath = path.join(buildTasksPath, taskName);
if (fs.existsSync(taskPath)) {
await runTaskTests(taskName);
}
};
if (!argv.task) {
banner('Running common library tests');
var commonLibPattern = path.join(buildTasksPath, 'Common', '*', 'Tests', suiteType + '.js');
var specs = [];
if (matchFind(commonLibPattern, buildTasksPath).length > 0) {
specs.push(commonLibPattern);
}
if (specs.length > 0) {
// setup the version of node to run the tests
await util.installNodeAsync(argv.node);
run('mocha ' + specs.join(' '), /*inheritStreams:*/true);
} else {
console.warn("No common library tests found");
}
}
// Run common tests
banner('Running common tests');
var commonPattern = path.join(buildTestsPath, suiteType + '.js');
var specs = matchFind(commonPattern, buildTestsPath, { noRecurse: true });
if (specs.length > 0) {
// setup the version of node to run the tests
await util.installNodeAsync(argv.node);
run('mocha ' + specs.join(' '), /*inheritStreams:*/true);
} else {
console.warn("No common tests found");
}
try {
// Installing node version 10 to run code coverage report, since common library tests run under node 6,
// which is incompatible with nyc
await util.installNodeAsync(minIstanbulVersion);
util.rm(path.join(coverageTasksPath, '*coverage-summary.json'));
util.run(`nyc merge ${coverageTasksPath} ${path.join(coverageTasksPath, 'mergedcoverage.json')}`, true);
util.rm(path.join(coverageTasksPath, '*-coverage.json'));
util.run(`nyc report -t ${coverageTasksPath} --report-dir ${coverageTasksPath} --reporter=cobertura`, true);
util.rm(path.join(coverageTasksPath, 'mergedcoverage.json'));
} catch (e) {
console.log('Error while generating coverage report')
}
}
//
// node make.js testLegacy
// node make.js testLegacy --suite L0/XCode
//
CLI.testLegacy = async function(/** @type {{ suite: string; node: string; task: string }} */ argv) {
ensureTool('tsc', '--version', 'Version 4.0.2');
ensureTool('mocha', '--version', '6.2.3');
if (argv.suite) {
fail('The "suite" parameter has been deprecated. Use the "task" parameter instead.');
}
// clean
console.log('removing _test');
rm('-Rf', testPath);
// copy the L0 source files for each task; copy the layout for each task
console.log();
console.log('> copying tasks');
taskList.forEach(function (taskName) {
var testCopySource = path.join(testsLegacyPath, 'L0', taskName);
// copy the L0 source files if exist
if (test('-e', testCopySource)) {
console.log('copying ' + taskName);
var testCopyDest = path.join(testTestsLegacyPath, 'L0', taskName);
matchCopy('*', testCopySource, testCopyDest, { noRecurse: true, matchBase: true });
// copy the task layout
var taskCopySource = path.join(buildTasksPath, taskName);
var taskCopyDest = path.join(legacyTestTasksPath, taskName);
matchCopy('*', taskCopySource, taskCopyDest, { noRecurse: true, matchBase: true });
}
// copy each common-module L0 source files if exist
var taskMakePath = path.join(tasksPath, taskName, 'make.json');
var taskMake = test('-f', taskMakePath) ? fileToJson(taskMakePath) : {};
if (taskMake.hasOwnProperty('common')) {
var common = taskMake['common'];
common.forEach(function(mod) {
// copy the common-module L0 source files if exist and not already copied
var modName = path.basename(mod['module']);
console.log('copying ' + modName);
var modTestCopySource = path.join(testsLegacyPath, 'L0', `Common-${modName}`);
var modTestCopyDest = path.join(testTestsLegacyPath, 'L0', `Common-${modName}`);
if (test('-e', modTestCopySource) && !test('-e', modTestCopyDest)) {
matchCopy('*', modTestCopySource, modTestCopyDest, { noRecurse: true, matchBase: true });
}
var modCopySource = path.join(buildTasksCommonPath, modName);
var modCopyDest = path.join(legacyTestTasksPath, 'Common', modName);
if (test('-e', modCopySource) && !test('-e', modCopyDest)) {
// copy the common module layout
matchCopy('*', modCopySource, modCopyDest, { noRecurse: true, matchBase: true });
}
});
}
});
// short-circuit if no tests
if (!test('-e', testTestsLegacyPath)) {
banner('no legacy tests found', true);
return;
}
// copy the legacy test infra
console.log();
console.log('> copying legacy test infra');
matchCopy('@(definitions|lib|tsconfig.json)', testsLegacyPath, testTestsLegacyPath, { noRecurse: true, matchBase: true });
// copy the lib tests when running all legacy tests
if (!argv.task) {
matchCopy('*', path.join(testsLegacyPath, 'L0', 'lib'), path.join(testTestsLegacyPath, 'L0', 'lib'), { noRecurse: true, matchBase: true });
}
// compile legacy L0 and lib
cd(testTestsLegacyPath);
run('tsc --rootDir ' + testTestsLegacyPath);
// create a test temp dir - used by the task runner to copy each task to an isolated dir
var tempDir = path.join(testTestsLegacyPath, 'Temp');
process.env['TASK_TEST_TEMP'] = tempDir;
mkdir('-p', tempDir);
// suite paths
var testsSpec = matchFind(path.join('**', '_suite.js'), path.join(testTestsLegacyPath, 'L0'));
if (!testsSpec.length) {
fail(`Unable to find tests using the pattern: ${path.join('**', '_suite.js')}`);
}
// setup the version of node to run the tests
await util.installNodeAsync(argv.node);
// mocha doesn't always return a non-zero exit code on test failure. when only
// a single suite fails during a run that contains multiple suites, mocha does
// not appear to always return non-zero. as a workaround, the following code
// creates a wrapper suite with an "after" hook. in the after hook, the state
// of the runnable context is analyzed to determine whether any tests failed.
// if any tests failed, log a ##vso command to fail the build.
var testsSpecPath = ''
var testsSpecPath = path.join(testTestsLegacyPath, 'testsSpec.js');
var contents = 'var __suite_to_run;' + os.EOL;
contents += 'describe(\'Legacy L0\', function (__outer_done) {' + os.EOL;
contents += ' after(function (done) {' + os.EOL;
contents += ' var failedCount = 0;' + os.EOL;
contents += ' var suites = [ this._runnable.parent ];' + os.EOL;
contents += ' while (suites.length) {' + os.EOL;
contents += ' var s = suites.pop();' + os.EOL;
contents += ' suites = suites.concat(s.suites); // push nested suites' + os.EOL;
contents += ' failedCount += s.tests.filter(function (test) { return test.state != "passed" }).length;' + os.EOL;
contents += ' }' + os.EOL;
contents += '' + os.EOL;
contents += ' if (failedCount && process.env.TF_BUILD) {' + os.EOL;
contents += ' console.log("##vso[task.logissue type=error]" + failedCount + " test(s) failed");' + os.EOL;
contents += ' console.log("##vso[task.complete result=Failed]" + failedCount + " test(s) failed");' + os.EOL;
contents += ' }' + os.EOL;
contents += '' + os.EOL;
contents += ' done();' + os.EOL;
contents += ' });' + os.EOL;
testsSpec.forEach(function (itemPath) {
contents += ` __suite_to_run = require(${JSON.stringify(itemPath)});` + os.EOL;
});
contents += '});' + os.EOL;
fs.writeFileSync(testsSpecPath, contents);
run('mocha ' + testsSpecPath, /*inheritStreams:*/true);
}
//
// node make.js package
// This will take the built tasks and create the files we need to publish them.
//
CLI.package = function() {
banner('Starting package process...')
// START LOCAL CONFIG
// console.log('> Cleaning packge path');
// rm('-Rf', packagePath);
// TODO: Only need this when we run locally
//var layoutPath = util.createNonAggregatedZip(buildPath, packagePath);
// END LOCAL CONFIG
// Note: The local section above is needed when running layout locally due to discrepancies between local build and
// slicing in CI. This will get cleaned up after we fully roll out and go to build only changed.
var layoutPath = path.join(packagePath, 'milestone-layout');
util.createNugetPackagePerTask(packagePath, layoutPath);
}
// used by CI that does official publish
CLI.publish = function(/** @type {{ server: string; task: string }} */ argv) {
var server = argv.server;
assert(server, 'server');
// if task specified, skip
if (argv.task) {
banner('Task parameter specified. Skipping publish.');
return;
}
// get the branch/commit info
var refs = util.getRefs();
// test whether to publish the non-aggregated tasks zip
// skip if not the tip of a release branch
var release = refs.head.release;
var commit = refs.head.commit;
if (!release ||
!refs.releases[release] ||
commit != refs.releases[release].commit) {
// warn not publishing the non-aggregated
console.log(`##vso[task.logissue type=warning]Skipping publish for non-aggregated tasks zip. HEAD is not the tip of a release branch.`);
} else {
// store the non-aggregated tasks zip
var nonAggregatedZipPath = path.join(packagePath, 'non-aggregated-tasks.zip');
util.storeNonAggregatedZip(nonAggregatedZipPath, release, commit);
}
// resolve the nupkg path
var nupkgFile;
var nupkgDir = path.join(packagePath, 'pack-target');
if (!test('-d', nupkgDir)) {
fail('nupkg directory does not exist');
}
var fileNames = fs.readdirSync(nupkgDir);
if (fileNames.length != 1) {
fail('Expected exactly one file under ' + nupkgDir);
}
nupkgFile = path.join(nupkgDir, fileNames[0]);
// publish the package
ensureTool('nuget3.exe');
run(`nuget3.exe push ${nupkgFile} -Source ${server} -apikey Skyrise`);
}
var agentPluginTaskNames = ['Cache', 'CacheBeta', 'DownloadPipelineArtifact', 'PublishPipelineArtifact'];
// used to bump the patch version in task.json files
CLI.bump = function() {
verifyAllAgentPluginTasksAreInSkipList();
taskList.forEach(function (taskName) {
// load files
var taskJsonPath = path.join(tasksPath, taskName, 'task.json');
var taskJson = JSON.parse(fs.readFileSync(taskJsonPath));
var taskLocJsonPath = path.join(tasksPath, taskName, 'task.loc.json');
var taskLocJson = JSON.parse(fs.readFileSync(taskLocJsonPath));
// skip agent plugin tasks
if(agentPluginTaskNames.indexOf(taskJson.name) > -1) {
return;
}
if (typeof taskJson.version.Patch != 'number') {
fail(`Error processing '${taskName}'. version.Patch should be a number.`);
}
taskJson.version.Patch = taskJson.version.Patch + 1;
taskLocJson.version.Patch = taskLocJson.version.Patch + 1;
const taskJsonStringified = JSON.stringify(taskJson, null, 2).replace(/(\n|\r\n)/g, os.EOL);
fs.writeFileSync(taskJsonPath, taskJsonStringified);
const taskLocJsonStringified = JSON.stringify(taskLocJson, null, 2).replace(/(\n|\r\n)/g, os.EOL);
fs.writeFileSync(taskLocJsonPath, taskLocJsonStringified);
// Check that task.loc and task.loc.json versions match
if ((taskJson.version.Major !== taskLocJson.version.Major) ||
(taskJson.version.Minor !== taskLocJson.version.Minor) ||
(taskJson.version.Patch !== taskLocJson.version.Patch)) {
console.log(`versions dont match for task '${taskName}', task json: ${JSON.stringify(taskJson.version)} task loc json: ${JSON.stringify(taskLocJson.version)}`);
}
});
}
CLI.getCommonDeps = function() {
var first = true;
var totalReferencesToCommonPackages = 0;
var commonCounts = {};
taskList.forEach(function (taskName) {
var commonDependencies = [];
var packageJsonPath = path.join(tasksPath, taskName, 'package.json');
if (fs.existsSync(packageJsonPath)) {
var packageJson = JSON.parse(fs.readFileSync(packageJsonPath));
if (first)
{
Object.values(packageJson.dependencies).forEach(function (v) {
if (v.indexOf('Tasks/Common') !== -1)
{
var depName = v
.replace('file:../../_build/Tasks/Common/', '')
.replace('-0.1.0.tgz', '')
.replace('-1.0.0.tgz', '')
.replace('-1.0.1.tgz', '')
.replace('-1.0.2.tgz', '')
.replace('-1.1.0.tgz', '')
.replace('-2.0.0.tgz', '')
commonDependencies.push(depName);
totalReferencesToCommonPackages++;
if (commonCounts[depName]) {
commonCounts[depName]++;
} else {
commonCounts[depName] = 1;
}
}
});
}
}
if (commonDependencies.length > 0)
{
console.log('----- ' + taskName + ' (' + commonDependencies.length + ') -----');
commonDependencies.forEach(function (dep) {
console.log(dep);
});
}
});
console.log('');
console.log('##### ##### ##### #####');
console.log('totalReferencesToCommonPackages: ' + totalReferencesToCommonPackages);
console.log('');
Object.keys(commonCounts).forEach(function (k) {
console.log(k + ': ' + commonCounts[k]);
});
}
function verifyAllAgentPluginTasksAreInSkipList() {
var missingTaskNames = [];
taskList.forEach(function (taskName) {
// load files
var taskJsonPath = path.join(tasksPath, taskName, 'task.json');
var taskJson = JSON.parse(fs.readFileSync(taskJsonPath));
if (taskJson.execution && taskJson.execution.AgentPlugin) {
if (agentPluginTaskNames.indexOf(taskJson.name) === -1 && missingTaskNames.indexOf(taskJson.name) === -1) {
missingTaskNames.push(taskJson.name);
}
}
});
if (missingTaskNames.length > 0) {
fail('The following tasks must be added to agentPluginTaskNames: ' + JSON.stringify(missingTaskNames));
}
}
// Merge all tasks in a build config to base tasks
// e.g node make.js mergeBuildConfig --config Node20_225
// This will 'merge' all tasks under build config Node20_225 into base tasks.
// 1. Copy generated task to base task, delete generated files in _generated/Task_Node20 and Tasks/taskname/_buildConfig/Node20.
// 2. Update versionmap.txt file.
// 3. Remove _buildConfigMapping section in task.json and task-loc.json
// 4. Update the buildConfig section in make-option.json.
CLI.mergeBuildConfig = function(/** @type {{ config: string }} */ argv) {
var config = argv.config
banner(`Merging all tasks under ${config} build config into base tasks...`);
util.mergeBuildConfigIntoBaseTasks(config);
}
// Generate sprintly zip
// This methods generate a zip file that contains the tip of all task major versions for the last sprint
// Use:
// node make.js gensprintlyzip --sprint=m153 --outputdir=E:\testing\ --depxmlpath=C:\Users\stfrance\Desktop\tempdeps.xml
//
// Result:
// azure-pipelines.firstpartytasks.m153.zip
//
// The generated zip can be uploaded to an account using tfx cli and it will install all of the tasks contained in the zip.
// The zip should be uploaded to the azure-pipelines-tasks repository
//
// Process:
//
// We create a workspace folder to do all of our work in. This is created in the output directory. output-dir/workspace-GUID
// Inside here, we first create a package file based on the packages we want to download.
// Then nuget restore, then get zips, then create zip.
CLI.gensprintlyzip = function(/** @type {{ sprint: string; outputdir: string; depxmlpath: string }} */ argv) {
var sprint = argv.sprint;
var outputDirectory = argv.outputdir;
var dependenciesXmlFilePath = argv.depxmlpath;
var taskFeedUrl = 'https://mseng.pkgs.visualstudio.com/_packaging/Codex-Deps/nuget/v3/index.json';
console.log('# Creating sprintly zip.');
console.log('\n# Loading tasks from dependencies file.');
var dependencies = fs.readFileSync(dependenciesXmlFilePath, 'utf8');
var dependenciesArr = dependencies.split('\n');
console.log(`Found ${dependenciesArr.length} dependencies.`);
var taskDependencies = [];
var taskStringArr = [];
dependenciesArr.forEach(function (currentDep) {
if (currentDep.indexOf('Mseng.MS.TF.DistributedTask.Tasks.') === -1) {
return;
}
taskStringArr.push(currentDep);
var depDetails = currentDep.split("\"");
var name = depDetails[1];
var version = depDetails[3];
taskDependencies.push({ 'name': name, 'version': version });
});
console.log(`Found ${taskDependencies.length} task dependencies.`);
console.log('\n# Downloading task nuget packages.');
var tempWorkspaceDirectory = `${outputDirectory}\\workspace-${Math.floor(Math.random() * 1000000000)}`;
console.log(`Creating temporary workspace directory ${tempWorkspaceDirectory}`);
fs.mkdirSync(tempWorkspaceDirectory);
console.log('Writing packages.config file');
var packagesConfigPath = `${tempWorkspaceDirectory}\\packages.config`;
var packagesConfigContent = '<?xml version="1.0" encoding="utf-8"?>\n';
packagesConfigContent += '<packages>\n';
taskStringArr.forEach(function (taskString) {
packagesConfigContent += taskString;
});
packagesConfigContent += '</packages>';
fs.writeFileSync(packagesConfigPath, packagesConfigContent);
console.log(`Completed writing packages.json file. ${packagesConfigPath}`);
console.log('\n# Restoring NuGet packages.');
run(`nuget restore ${tempWorkspaceDirectory} -source "${taskFeedUrl}" -packagesdirectory ${tempWorkspaceDirectory}\\packages`);
console.log('Restoring NuGet packages complete.');
console.log(`\n# Creating sprintly zip.`);
var sprintlyZipContentsPath = `${tempWorkspaceDirectory}\\sprintly-zip`;
fs.mkdirSync(sprintlyZipContentsPath);
console.log('Sprintly zip folder created.');