-
Notifications
You must be signed in to change notification settings - Fork 433
/
Copy pathReleaseNotesFunctions.ts
1381 lines (1256 loc) · 71.7 KB
/
ReleaseNotesFunctions.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
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
export interface SimpleArtifact {
artifactAlias: string;
buildDefinitionId: string;
buildNumber: string;
buildId: string;
artifactType: string;
isPrimary: boolean;
sourceId: string;
}
interface WorkItemInfo {
id: number;
url: string;
}
interface EnrichedGitPullRequest extends GitPullRequest {
associatedWorkitems: WorkItemInfo[];
associatedCommits: GitCommit[];
}
export class UnifiedArtifactDetails {
build: Build;
commits: Change[];
workitems: WorkItem[];
tests: TestCaseResult[];
constructor ( build: Build, commits: Change[], workitems: WorkItem[], tests: TestCaseResult[]) {
this.build = build;
if (commits) {
this.commits = commits;
} else {
this.commits = [];
}
if (workitems) {
this.workitems = workitems;
} else {
this.workitems = [];
}
if (tests) {
this.tests = tests;
} else {
this.tests = [];
}
}
}
import * as restm from "typed-rest-client/RestClient";
import { PersonalAccessTokenCredentialHandler, BasicCredentialHandler } from "typed-rest-client/Handlers";
import tl = require("azure-pipelines-task-lib/task");
import { ReleaseEnvironment, Artifact, Deployment, DeploymentStatus, Release } from "azure-devops-node-api/interfaces/ReleaseInterfaces";
import { IAgentSpecificApi, AgentSpecificApi } from "./agentSpecific";
import { IReleaseApi } from "azure-devops-node-api/ReleaseApi";
import { IRequestHandler } from "azure-devops-node-api/interfaces/common/VsoBaseInterfaces";
import * as webApi from "azure-devops-node-api/WebApi";
import fs = require("fs");
import { Build, Change, Timeline, TimelineRecord } from "azure-devops-node-api/interfaces/BuildInterfaces";
import { IGitApi, GitApi } from "azure-devops-node-api/GitApi";
import { ResourceRef } from "azure-devops-node-api/interfaces/common/VSSInterfaces";
import { GitCommit, GitPullRequest, GitPullRequestQueryType, GitPullRequestSearchCriteria, PullRequestStatus } from "azure-devops-node-api/interfaces/GitInterfaces";
import { WebApi } from "azure-devops-node-api";
import { TestApi } from "azure-devops-node-api/TestApi";
import { timeout, async } from "q";
import { TestCaseResult } from "azure-devops-node-api/interfaces/TestInterfaces";
import { IWorkItemTrackingApi } from "azure-devops-node-api/WorkItemTrackingApi";
import { WorkItemExpand, WorkItem, ArtifactUriQuery } from "azure-devops-node-api/interfaces/WorkItemTrackingInterfaces";
import { ITfvcApi } from "azure-devops-node-api/TfvcApi";
import * as issue349 from "./Issue349Workaround";
import { ITestApi } from "azure-devops-node-api/TestApi";
import { IBuildApi, BuildApi } from "azure-devops-node-api/BuildApi";
import * as vstsInterfaces from "azure-devops-node-api/interfaces/common/VsoBaseInterfaces";
import { time } from "console";
import { InstalledExtensionQuery } from "azure-devops-node-api/interfaces/ExtensionManagementInterfaces";
import { SSL_OP_SSLEAY_080_CLIENT_DH_BUG } from "constants";
let agentApi = new AgentSpecificApi();
export function getDeploymentCount(environments: ReleaseEnvironment[], environmentName: string): number {
agentApi.logInfo(`Getting deployment count for stage`);
var attemptCount = 0;
for (let environment of environments) {
if (environment.name.toLowerCase() === environmentName) {
agentApi.logInfo(`Found the stage [${environmentName}]`);
var currentDeployment = environment.preDeployApprovals[environment.preDeployApprovals.length - 1];
if (currentDeployment) {
attemptCount = currentDeployment.attempt;
}
}
}
if (attemptCount === 0) {
agentApi.logInfo(`Cannot find any deployment to [${environmentName}]`);
} else {
agentApi.logInfo(`Identified [${environmentName}] as having deployment count of [${attemptCount}]`);
}
return attemptCount;
}
export function getReleaseDefinitionId(environments: ReleaseEnvironment[], environmentName: string): number {
agentApi.logInfo(`Getting the Environment Id`);
var environmentId: number = 0;
for (let environment of environments) {
if (environment.name.toLowerCase() === environmentName) {
environmentId = environment.definitionEnvironmentId;
}
}
if (environmentId === 0) {
throw `Failed to locate environment with name ${environmentName}`;
}
agentApi.logInfo(`Identified [${environmentName}] as having id [${environmentId}]`);
return environmentId;
}
export function getSimpleArtifactArray(artifacts: Artifact[]): SimpleArtifact[] {
var result: SimpleArtifact[] = [];
for (let artifact of artifacts) {
result.push(
{
"artifactAlias": artifact.alias,
"buildDefinitionId": artifact.definitionReference.definition.id,
"buildNumber": artifact.definitionReference.version.name,
"buildId": artifact.definitionReference.version.id,
"artifactType": artifact.type,
"isPrimary": artifact.isPrimary,
"sourceId": artifact.sourceId.split(":")[0]
}
);
}
return result;
}
export async function getPullRequests(gitApi: GitApi, projectName: string): Promise<GitPullRequest[]> {
return new Promise<GitPullRequest[]>(async (resolve, reject) => {
let prList: GitPullRequest[] = [];
try {
var filter: GitPullRequestSearchCriteria = {
creatorId: "",
includeLinks: true,
repositoryId: "",
reviewerId: "",
sourceRefName: "",
sourceRepositoryId: "",
status: PullRequestStatus.Completed,
targetRefName: ""
};
var batchSize: number = 1000; // 1000 seems to be the API max
var skip: number = 0;
do {
agentApi.logDebug(`Get batch of PRs [${skip}] - [${skip + batchSize}]`);
var prListBatch = await gitApi.getPullRequestsByProject( projectName, filter, 0 , skip, batchSize);
agentApi.logDebug(`Adding batch of ${prListBatch.length} PRs`);
prList.push(...prListBatch);
skip += batchSize;
} while (batchSize === prListBatch.length);
resolve(prList);
} catch (err) {
reject(err);
}
});
}
export async function getMostRecentSuccessfulDeployment(releaseApi: IReleaseApi, teamProject: string, releaseDefinitionId: number, environmentId: number, overrideBuildReleaseId: string): Promise<Deployment> {
return new Promise<Deployment>(async (resolve, reject) => {
let mostRecentDeployment: Deployment = null;
try {
// Gets the latest successful deployments - the api returns the deployments in the correct order
var successfulDeployments = await releaseApi.getDeployments(teamProject, releaseDefinitionId, environmentId, null, null, null, DeploymentStatus.Succeeded, null, true, null, null, null, null).catch((reason) => {
reject(reason);
return;
});
if (successfulDeployments && successfulDeployments.length > 0) {
agentApi.logInfo (`Found ${successfulDeployments.length} successful releases`);
if (overrideBuildReleaseId && !isNaN(parseInt(overrideBuildReleaseId))) {
agentApi.logInfo (`Trying to find successful deployment with the override release ID of '${overrideBuildReleaseId}'`);
mostRecentDeployment = successfulDeployments.find (element => element.release.id === parseInt(overrideBuildReleaseId));
if (mostRecentDeployment) {
agentApi.logInfo (`Found matching override release ${mostRecentDeployment.release.name}`);
} else {
agentApi.logError (`Cannot find matching release`);
reject(-1);
return;
}
} else {
mostRecentDeployment = successfulDeployments[0];
agentApi.logInfo (`Finding the last successful release ${mostRecentDeployment.release.name}`);
}
} else {
// There have been no recent successful deployments
}
resolve(mostRecentDeployment);
} catch (err) {
reject(err);
}
});
}
export async function expandTruncatedCommitMessages(restClient: WebApi, globalCommits: Change[], gitHubPat: string, bitbucketUser: string, bitbucketSecret: string): Promise<Change[]> {
return new Promise<Change[]>(async (resolve, reject) => {
var expanded: number = 0;
agentApi.logInfo(`Expanding the truncated commit messages...`);
for (var change of globalCommits) {
if (change.messageTruncated) {
try {
agentApi.logDebug(`Expanding commit [${change.id}]`);
let res: restm.IRestResponse<GitCommit>;
if (change.location.startsWith("https://api.github.com/")) {
agentApi.logDebug(`Need to expand details from GitHub`);
// we build PAT auth object even if we have no token
// this will still allow access to public repos
// if we have a token it will allow access to private ones
let auth = new PersonalAccessTokenCredentialHandler(gitHubPat);
let rc = new restm.RestClient("rest-client", "", [auth], {});
let gitHubRes: any = await rc.get(change.location); // we have to use type any as there is a type mismatch
if (gitHubRes.statusCode === 200) {
change.message = gitHubRes.result.commit.message;
change.messageTruncated = false;
expanded++;
} else {
agentApi.logWarn(`Cannot access API ${gitHubRes.statusCode} accessing ${change.location}`);
agentApi.logWarn(`The most common reason for this failure is that the GitHub Repo is private and a Personal Access Token giving read access needs to be passed as a parameter to this task`);
}
} else if (change.location.startsWith("https://api.bitbucket.org/")) {
agentApi.logDebug(`Need to expand details from BitBucket`);
// we build PAT auth object even if we have no token
// this will still allow access to public repos
// if we have a token it will allow access to private ones
let rc = new restm.RestClient("rest-client");
if (bitbucketUser && bitbucketUser.length > 0 && bitbucketSecret && bitbucketSecret.length > 0 ) {
let auth = new BasicCredentialHandler(bitbucketUser, bitbucketSecret);
rc = new restm.RestClient("rest-client", "", [auth], {});
} else {
agentApi.logInfo(`No Bitbucket user and app secret passed so cannot access private Bitbucket repos`);
}
let bitbucketRes: any = await rc.get(change.location); // we have to use type any as there is a type mismatch
if (bitbucketRes.statusCode === 200) {
change.message = bitbucketRes.result.message;
change.messageTruncated = false;
expanded++;
} else {
agentApi.logWarn(`Cannot access API ${bitbucketRes.statusCode} accessing ${change.location}`);
agentApi.logWarn(`The most common reason for this failure is that the Bitbucket Repo is private and a Personal Access Token giving read access needs to be passed as a parameter to this task`);
}
} else {
agentApi.logDebug(`Need to expand details from Azure DevOps`);
// the REST client is already authorised with the agent token
let vstsRes = await restClient.rest.get<GitCommit>(change.location);
if (vstsRes.statusCode === 200) {
change.message = vstsRes.result.comment;
change.messageTruncated = false;
expanded++;
} else {
agentApi.logWarn(`Cannot access API ${vstsRes.statusCode} accessing ${change.location}`);
agentApi.logWarn(`The most common reason for this failure is that the account defined by the agent access token does not have rights to read the required repo`);
}
}
} catch (err) {
agentApi.logWarn(`Cannot expand message ${err}`);
agentApi.logWarn(`Using ${change.location}`);
}
}
}
agentApi.logInfo(`Expanded truncated commit messages ${expanded}`);
resolve(globalCommits);
});
}
export async function enrichPullRequest(
gitApi: IGitApi,
pullRequests: EnrichedGitPullRequest[],
): Promise<EnrichedGitPullRequest[]> {
return new Promise<EnrichedGitPullRequest[]>(async (resolve, reject) => {
try {
for (let prIndex = 0; prIndex < pullRequests.length; prIndex++) {
const prDetails = pullRequests[prIndex];
// get any missing labels for all the known PRs we are interested in as getPullRequestById does not populate labels, so get those as well
if (!prDetails.labels || prDetails.labels.length === 0 ) {
agentApi.logDebug(`Checking for tags for ${prDetails.pullRequestId}`);
const prLabels = await gitApi.getPullRequestLabels(prDetails.repository.id, prDetails.pullRequestId);
prDetails.labels = prLabels;
}
// and added the WI IDs
var wiRefs = await gitApi.getPullRequestWorkItemRefs(prDetails.repository.id, prDetails.pullRequestId);
prDetails.associatedWorkitems = wiRefs.map(wi => {
return {
id: parseInt(wi.id),
url: wi.url
};
}) ;
agentApi.logDebug(`Added ${prDetails.associatedWorkitems.length} work items for ${prDetails.pullRequestId}`);
prDetails.associatedCommits = [];
var csRefs = await gitApi.getPullRequestCommits(prDetails.repository.id, prDetails.pullRequestId);
for (let csIndex = 0; csIndex < csRefs.length; csIndex++) {
prDetails.associatedCommits.push ( await gitApi.getCommit(csRefs[csIndex].commitId, prDetails.repository.id));
}
agentApi.logDebug(`Added ${prDetails.associatedCommits.length} commits for ${prDetails.pullRequestId}, note this includes commits on the PR source branch not associated directly with the build)`);
}
resolve(pullRequests);
} catch (err) {
reject(err);
}
});
}
export async function enrichChangesWithFileDetails(
gitApi: IGitApi,
tfvcApi: ITfvcApi,
changes: Change[],
gitHubPat: string
): Promise<Change[]> {
return new Promise<Change[]>(async (resolve, reject) => {
try {
var extraDetail = [];
for (let index = 0; index < changes.length; index++) {
const change = changes[index];
try {
agentApi.logInfo (`Enriched change ${change.id} of type ${change.type}`);
if (change.type === "TfsGit") {
// we need the repository ID for the API call
// the alternative is to take the basic location value and build a rest call form that
// neither are that nice.
var url = require("url");
// split the url up, check it is the expected format and then get the ID
var urlParts = url.parse(change.location);
if (urlParts.host === "dev.azure.com") {
var pathParts = urlParts.path.split("/");
var repoId = "";
for (let index = 0; index < pathParts.length; index++) {
if (pathParts[index] === "repositories") {
repoId = pathParts[index + 1];
break;
}
}
let gitDetails = await gitApi.getChanges(change.id, repoId);
agentApi.logInfo (`Enriched with details of ${gitDetails.changes.length} files`);
extraDetail = gitDetails.changes;
} else {
agentApi.logInfo (`Cannot enriched as location URL not in dev.azure.com format`);
}
} else if (change.type === "TfsVersionControl") {
var tfvcDetail = await tfvcApi.getChangesetChanges(parseInt(change.id.substring(1)));
agentApi.logInfo (`Enriched with details of ${tfvcDetail.length} files`);
extraDetail = tfvcDetail;
} else if (change.type === "GitHub") {
let res: restm.IRestResponse<GitCommit>;
// we build PAT auth object even if we have no token
// this will still allow access to public repos
// if we have a token it will allow access to private ones
let auth = new PersonalAccessTokenCredentialHandler(gitHubPat);
let rc = new restm.RestClient("rest-client", "", [auth], {});
let gitHubRes: any = await rc.get(change.location); // we have to use type any as there is a type mismatch
if (gitHubRes.statusCode === 200) {
var gitHubFiles = gitHubRes.result.files;
agentApi.logInfo (`Enriched with details of ${gitHubFiles.length} files`);
extraDetail = gitHubFiles;
} else {
agentApi.logWarn(`Cannot access API ${gitHubRes.statusCode} accessing ${change.location}`);
agentApi.logWarn(`The most common reason for this failure is that the GitHub Repo is private and a Personal Access Token giving read access needs to be passed as a parameter to this task`);
}
} else if (change.type === "Bitbucket") {
agentApi.logWarn(`This task does not currently support getting file details associated to a commit on Bitbucket`);
} else {
agentApi.logWarn(`Cannot preform enrichment as type ${change.type} is not supported for enrichment`);
}
change["changes"] = extraDetail;
} catch (err) {
agentApi.logWarn(`Error ${err} enriching ${change.location}`);
}
}
resolve(changes);
} catch (err) {
reject(err);
}
});
}
// Gets the credential handler. Supports both PAT and OAuth tokens
export function getCredentialHandler(pat: string): IRequestHandler {
if (!pat || pat.length === 0) {
// no pat passed so we need the system token
agentApi.logDebug("Getting System.AccessToken");
var accessToken = agentApi.getSystemAccessToken();
let credHandler: IRequestHandler;
if (!accessToken || accessToken.length === 0) {
throw "Unable to locate access token that will allow access to Azure DevOps API.";
} else {
agentApi.logInfo("Creating the credential handler from the OAUTH token");
// used for local debugging. Allows switching between PAT token and Bearer Token for debugging
credHandler = webApi.getHandlerFromToken(accessToken);
}
return credHandler;
} else {
agentApi.logInfo("Creating the credential handler using override PAT (suitable for local testing or if the OAUTH token cannot be used)");
return webApi.getPersonalAccessTokenHandler(pat);
}
}
export async function getTestsForBuild(
testAPI: TestApi,
teamProject: string,
buildId: number
): Promise<TestCaseResult[]> {
return new Promise<TestCaseResult[]>(async (resolve, reject) => {
let testList: TestCaseResult[] = [];
try {
let builtTestResults = await testAPI.getTestResultsByBuild(teamProject, buildId);
if ( builtTestResults.length > 0 ) {
for (let index = 0; index < builtTestResults.length; index++) {
const test = builtTestResults[index];
if (testList.filter(e => e.testRun.id === `${test.runId}`).length === 0) {
tl.debug(`Adding tests for test run ${test.runId}`);
let run = await testAPI.getTestResults(teamProject, test.runId);
testList.push(...run);
} else {
tl.debug(`Skipping adding tests for test run ${test.runId} as already added`);
}
}
} else {
tl.debug(`No tests associated with build ${buildId}`);
}
resolve(testList);
} catch (err) {
reject(err);
}
});
}
export function addUniqueTestToArray (
masterArray: TestCaseResult[],
newArray: TestCaseResult[]
) {
tl.debug(`The global test array contains ${masterArray.length} items`);
if (newArray.length > 0) {
newArray.forEach(test => {
if (masterArray.filter(e => e.testCaseReferenceId === test.testCaseReferenceId && e.testRun.id === test.testRun.id).length === 0) {
tl.debug(`Adding the test case ${test.testCaseReferenceId} for test run ${test.testRun.id} as not present in the master list`);
masterArray.push(test);
} else {
tl.debug(`Skipping the test case ${test.testCaseReferenceId} for test run ${test.testRun.id} as already present in the master list`);
}
});
}
tl.debug(`The updated global test array contains ${masterArray.length} items`);
return masterArray;
}
export async function getTestsForRelease(
testAPI: TestApi,
teamProject: string,
release: Release
): Promise<TestCaseResult[]> {
return new Promise<TestCaseResult[]>(async (resolve, reject) => {
let testList: TestCaseResult[] = [];
try {
for (let envIndex = 0; envIndex < release.environments.length; envIndex++) {
const env = release.environments[envIndex];
let envTestResults = await testAPI.getTestResultDetailsForRelease(teamProject, release.id, env.id);
if (envTestResults.resultsForGroup.length > 0) {
for (let index = 0; index < envTestResults.resultsForGroup[0].results.length; index++) {
const test = envTestResults.resultsForGroup[0].results[index];
if (testList.filter(e => e.testRun.id === `${test.testRun.id}`).length === 0) {
tl.debug(`Adding tests for test run ${test.testRun.id}`);
let run = await testAPI.getTestResults(teamProject, parseInt(test.testRun.id));
testList.push(...run);
} else {
tl.debug(`Skipping adding tests for test run ${test.testRun.id} as already added`);
}
}
} else {
tl.debug(`No tests associated with release ${release.id} environment ${env.name}`);
}
}
resolve(testList);
} catch (err) {
reject(err);
}
});
}
export function getTemplate(
templateLocation: string,
templatefile: string ,
inlinetemplate: string
): Array<string> {
agentApi.logDebug(`Using template mode ${templateLocation}`);
var template;
const handlebarIndicator = "{{";
if (templateLocation === "File") {
if (fs.existsSync(templatefile)) {
agentApi.logInfo (`Loading template file ${templatefile}`);
template = fs.readFileSync(templatefile, "utf8").toString();
} else {
agentApi.logError (`Cannot find template file ${templatefile}`);
return template;
}
} else {
agentApi.logInfo ("Using in-line template");
template = inlinetemplate;
}
// we now only handle handlebar templates
if (template.includes(handlebarIndicator)) {
agentApi.logDebug("Loading handlebar template");
}
else {
agentApi.logError("The template is not on handlebars format, load template has been skipped");
template = "";
}
return template;
}
export async function getAllDirectRelatedWorkitems (
workItemTrackingApi: IWorkItemTrackingApi,
workItems: WorkItem[]
) {
var relatedWorkItems = [...workItems]; // a clone
for (let wiIndex = 0; wiIndex < workItems.length; wiIndex++) {
var wi = workItems[wiIndex];
agentApi.logInfo(`Looking for parents and children of WI [${wi.id}]`);
for (let relIndex = 0; relIndex < wi.relations.length; relIndex++) {
var relation = wi.relations[relIndex];
if ((relation.attributes.name === "Child") ||
(relation.attributes.name === "Parent")) {
var urlParts = relation.url.split("/");
var id = parseInt(urlParts[urlParts.length - 1]);
if (!relatedWorkItems.find(element => element.id === id)) {
agentApi.logInfo(`Add ${relation.attributes.name} WI ${id}`);
relatedWorkItems.push(await workItemTrackingApi.getWorkItem(id, null, null, WorkItemExpand.All, null));
} else {
agentApi.logInfo(`Skipping ${id} as already in the relations list`);
}
}
}
}
return relatedWorkItems;
}
export async function getAllParentWorkitems (
workItemTrackingApi: IWorkItemTrackingApi,
relatedWorkItems: WorkItem[],
) {
var allRelatedWorkItems = [...relatedWorkItems]; // a clone
var knownWI = allRelatedWorkItems.length;
var addedOnThisPass = 0;
do {
// reset the count
addedOnThisPass = 0;
// look for all the parent
for (let wiIndex = 0; wiIndex < allRelatedWorkItems.length; wiIndex++) {
var wi = allRelatedWorkItems[wiIndex];
agentApi.logInfo(`Looking for parents of WI [${wi.id}]`);
for (let relIndex = 0; relIndex < wi.relations.length; relIndex++) {
var relation = wi.relations[relIndex];
if (relation.attributes.name === "Parent") {
var urlParts = relation.url.split("/");
var id = parseInt(urlParts[urlParts.length - 1]);
if (!allRelatedWorkItems.find(element => element.id === id)) {
agentApi.logInfo(`Add ${relation.attributes.name} WI ${id}`);
allRelatedWorkItems.push(await workItemTrackingApi.getWorkItem(id, null, null, WorkItemExpand.All, null));
// if we add something add to the count
addedOnThisPass ++;
} else {
agentApi.logInfo(`Skipping ${id} as already in the found parent list`);
}
}
}
}
} while (addedOnThisPass !== 0); // exit if we added nothing in this pass
agentApi.logInfo(`Added ${allRelatedWorkItems.length - knownWI} parent WI to the list of direct relations`);
return allRelatedWorkItems;
}
export async function getFullWorkItemDetails (
workItemTrackingApi: IWorkItemTrackingApi,
workItemRefs: ResourceRef[]
) {
var workItemIds = workItemRefs.map(wi => parseInt(wi.id));
let fullWorkItems: WorkItem[] = [];
agentApi.logInfo(`Get details of [${workItemIds.length}] WIs`);
if (workItemIds && workItemIds.length > 0) {
var indexStart = 0;
var indexEnd = (workItemIds.length > 200) ? 200 : workItemIds.length ;
while ((indexEnd <= workItemIds.length) && (indexStart !== indexEnd)) {
var subList = workItemIds.slice(indexStart, indexEnd);
agentApi.logInfo(`Getting full details of WI batch from index: [${indexStart}] to [${indexEnd}]`);
var subListDetails = await workItemTrackingApi.getWorkItems(subList, null, null, WorkItemExpand.All, null);
agentApi.logInfo(`Adding [${subListDetails.length}] items`);
fullWorkItems = fullWorkItems.concat(subListDetails);
indexStart = indexEnd;
indexEnd = ((workItemIds.length - indexEnd) > 200) ? indexEnd + 200 : workItemIds.length;
}
}
return fullWorkItems;
}
// The Argument compareReleaseDetails is used in the template processing. Renaming or removing will break the templates
export function processTemplate(
template,
workItems: WorkItem[],
commits: Change[],
buildDetails: Build,
releaseDetails: Release,
compareReleaseDetails: Release,
customHandlebarsExtensionCode: string,
customHandlebarsExtensionFile: string,
customHandlebarsExtensionFolder: string,
pullRequests: EnrichedGitPullRequest[],
globalBuilds: UnifiedArtifactDetails[],
globalTests: TestCaseResult[],
releaseTests: TestCaseResult[],
relatedWorkItems: WorkItem[],
compareBuildDetails: Build,
currentStage: TimelineRecord,
inDirectlyAssociatedPullRequests: EnrichedGitPullRequest[]
): string {
var output = "";
if (template.length > 0) {
agentApi.logDebug("Processing template");
agentApi.logDebug(` WI: ${workItems.length}`);
agentApi.logDebug(` CS: ${commits.length}`);
agentApi.logDebug(` PR: ${pullRequests.length}`);
agentApi.logDebug(` Builds: ${globalBuilds.length}`);
agentApi.logDebug(` Global Tests: ${globalTests.length}`);
agentApi.logDebug(` Release Tests: ${releaseTests.length}`);
agentApi.logDebug(` Related WI: ${relatedWorkItems.length}`);
agentApi.logDebug(` Indirect PR: ${inDirectlyAssociatedPullRequests.length}`);
// it is a handlebar template
agentApi.logDebug("Processing handlebar template");
const handlebars = require("handlebars");
// load the extension library so it can be accessed in templates
agentApi.logInfo("Loading handlebars-helpers extension");
const helpers = require("handlebars-helpers")({
handlebars: handlebars
});
// add a custom helper to expand json
handlebars.registerHelper("json", function(context) {
return JSON.stringify(context);
});
// add our helper to find children and parents
handlebars.registerHelper("lookup_a_work_item", function (array, url) {
var urlParts = url.split("/");
var wiId = parseInt(urlParts[urlParts.length - 1]);
return array.find(element => element.id === wiId);
}
);
// add our helper to find PR
handlebars.registerHelper("lookup_a_pullrequest", function (array, url) {
var urlParts = url.split("%2F");
var prId = parseInt(urlParts[urlParts.length - 1]);
return array.find(element => element.pullRequestId === prId);
}
);
// add our helper to get first line of commit message
handlebars.registerHelper("get_only_message_firstline", function (msg) {
return msg.split(`\n`)[0];
}
);
// add our helper to find PR
handlebars.registerHelper("lookup_a_pullrequest_by_merge_commit", function (array, commitId) {
return array.find(element => element.lastMergeCommit.commitId === commitId);
}
);
if (typeof customHandlebarsExtensionCode !== undefined && customHandlebarsExtensionCode && customHandlebarsExtensionCode.length > 0) {
agentApi.logDebug(`Saving custom Handlebars code to file in folder ${customHandlebarsExtensionFolder}`);
if (!customHandlebarsExtensionFolder || customHandlebarsExtensionFolder.length === 0) {
// cannot use process.env.Agent_TempDirectory as only set on Windows agent, so build it up from the agent base
// Note that the name is case sensitive on Mac and Linux
// Also #832 found that the temp file has to be under the same folder structure as the main .js files
// else you cannot load any modules
customHandlebarsExtensionFolder = __dirname;
}
agentApi.logInfo("Loading custom handlebars extension");
writeFile(`${customHandlebarsExtensionFolder}/${customHandlebarsExtensionFile}.js`, customHandlebarsExtensionCode, true, false);
var tools = require(`${customHandlebarsExtensionFolder}/${customHandlebarsExtensionFile}`);
handlebars.registerHelper(tools);
} else {
agentApi.logDebug(`No custom Handlebars code to process`);
}
// compile the template
try {
var handlebarsTemplate = handlebars.compile(template);
// execute the compiled template
output = handlebarsTemplate({
"workItems": workItems,
"commits": commits,
"buildDetails": buildDetails,
"releaseDetails": releaseDetails,
"compareReleaseDetails": compareReleaseDetails,
"pullRequests": pullRequests,
"builds": globalBuilds,
"tests": globalTests,
"releaseTests": releaseTests,
"relatedWorkItems": relatedWorkItems,
"compareBuildDetails": compareBuildDetails,
"inDirectlyAssociatedPullRequests": inDirectlyAssociatedPullRequests
});
agentApi.logInfo( "Completed processing template");
} catch (err) {
agentApi.logError(`Error Processing handlebars [${err}]`);
}
} else {
agentApi.logError( `Cannot load template file [${template}] or it is empty`);
} // if no template
return output;
}
export function writeFile(filename: string, data: string, replaceFile: boolean, appendToFile: boolean) {
if (replaceFile) {
agentApi.logInfo(`Writing output file ${filename}`);
fs.writeFileSync(filename, data, "utf8");
} else {
if (appendToFile) {
agentApi.logInfo(`Appending output to file ${filename}`);
fs.appendFileSync(filename, data, "utf8");
} else {
agentApi.logInfo(`Prepending output to file ${filename}`);
var oldContent = "";
if (fs.existsSync(filename)) {
oldContent = fs.readFileSync(filename, "utf8");
}
fs.writeFileSync(filename, data, "utf8");
fs.appendFileSync(filename, oldContent);
}
}
agentApi.logInfo(`Finished writing output file ${filename}`);
}
export async function getLastSuccessfulBuildByStage(
buildApi: IBuildApi,
teamProject: string,
stageName: string,
buildId: number,
buildDefId: number,
tags: string[],
overrideBuildReleaseId: string
) {
if (stageName.length === 0) {
agentApi.logInfo ("No stage name provided, cannot find last successful build by stage");
return {
id: 0,
stage: null
};
}
let builds = await buildApi.getBuilds(teamProject, [buildDefId]);
if (builds.length > 1 ) {
agentApi.logInfo(`Found '${builds.length}' matching builds to consider`);
// check of we are using an override
if (overrideBuildReleaseId && overrideBuildReleaseId.length > 0) {
agentApi.logInfo(`An override build number has been passed, will only consider this build`);
var overrideBuild = builds.find(element => element.id.toString() === overrideBuildReleaseId);
if (overrideBuild) {
agentApi.logInfo(`Found the over ride build ${overrideBuildReleaseId}`);
// we need to find the required timeline record
let timeline = await buildApi.getBuildTimeline(teamProject, overrideBuild.id);
let record = timeline.records.find(element => element.name === stageName);
return {
id: overrideBuild.id,
stage: record
};
} else {
agentApi.logError(`There is no build matching the override ID of ${overrideBuildReleaseId}`);
return;
}
}
for (let buildIndex = 0; buildIndex < builds.length; buildIndex++) {
const build = builds[buildIndex];
agentApi.logInfo (`Comparing ${build.id} against ${buildId}`);
// force the cast to string as was getting a type mimatch
if (build.id.toString() === buildId.toString()) {
agentApi.logInfo("Ignore compare against self");
} else {
if (tags.length === 0 ||
(tags.length > 0 && build.tags.sort().join(",") === tags.sort().join(","))) {
agentApi.logInfo("Considering build");
let timeline = await buildApi.getBuildTimeline(teamProject, build.id);
if (timeline && timeline.records) {
for (let timelineIndex = 0; timelineIndex < timeline.records.length; timelineIndex++) {
const record = timeline.records[timelineIndex];
if (record.type === "Stage") {
if ((record.name === stageName || record.identifier === stageName) &&
(record.state.toString() === "2" || record.state.toString() === "completed") && // completed
(record.result.toString() === "0" || record.result.toString() === "succeeded")) { // succeeded
agentApi.logInfo (`Found required stage ${record.name} in the completed and successful state in build ${build.id}`);
return {
id: build.id,
stage: record
};
}
}
}
} else {
agentApi.logInfo("Skipping check as no timeline available for this build");
}
} else {
agentApi.logInfo(`Skipping build as does not have the correct tags`);
}
}
}
}
return {
id: 0,
stage: null
};
}
export async function generateReleaseNotes(
pat: string,
tpcUri: string,
teamProject: string,
buildId: number,
releaseId: number,
releaseDefinitionId: number,
overrideStageName: string,
environmentName: string,
activateFix: string,
templateLocation: string,
templateFile: string,
inlineTemplate: string,
outputFile: string,
outputVariableName: string,
sortWi: boolean,
showOnlyPrimary: boolean,
replaceFile: boolean,
appendToFile: boolean,
getParentsAndChildren: boolean,
searchCrossProjectForPRs: boolean,
stopOnRedeploy: boolean,
customHandlebarsExtensionCode: string,
customHandlebarsExtensionFile: string,
customHandlebarsExtensionFolder: string,
gitHubPat: string,
bitbucketUser: string,
bitbucketSecret: string,
dumpPayloadToConsole: boolean,
dumpPayloadToFile: boolean,
dumpPayloadFileName: string,
checkStage: boolean,
getAllParents: boolean,
tags: string,
overrideBuildReleaseId: string,
getIndirectPullRequests: boolean
): Promise<number> {
return new Promise<number>(async (resolve, reject) => {
if (!gitHubPat) {
// a check to make sure we don't get a null
gitHubPat = "";
}
let credentialHandler: vstsInterfaces.IRequestHandler = getCredentialHandler(pat);
let organisation = new webApi.WebApi(tpcUri, credentialHandler);
var releaseApi: IReleaseApi = await organisation.getReleaseApi();
var buildApi: IBuildApi = await organisation.getBuildApi();
var gitApi: IGitApi = await organisation.getGitApi();
var testApi: ITestApi = await organisation.getTestApi();
var workItemTrackingApi: IWorkItemTrackingApi = await organisation.getWorkItemTrackingApi();
var tfvcApi: ITfvcApi = await organisation.getTfvcApi();
// the result containers
var globalCommits: Change[] = [];
var globalWorkItems: ResourceRef[] = [];
var globalPullRequests: EnrichedGitPullRequest[] = [];
var inDirectlyAssociatedPullRequests: EnrichedGitPullRequest[] = [];
var globalBuilds: UnifiedArtifactDetails[] = [];
var globalTests: TestCaseResult[] = [];
var releaseTests: TestCaseResult[] = [];
var mostRecentSuccessfulDeploymentName: string = "";
let mostRecentSuccessfulDeploymentRelease: Release;
let mostRecentSuccessfulBuild: Build;
var currentRelease: Release;
var currentBuild: Build;
var currentStage: TimelineRecord;
try {
if ((releaseId === undefined) || !releaseId) {
agentApi.logInfo("Getting the current build details");
currentBuild = await buildApi.getBuild(teamProject, buildId);
if (!currentBuild) {
agentApi.logError (`Unable to locate the current build with id ${buildId} in the project ${teamProject}`);
reject (-1);
return;
}
if (checkStage) {
var stageName = tl.getVariable("System.StageName");
var tagArray = [];
if (tags && tags.length > 0 ) {
tagArray = tags.split(",");
agentApi.logInfo(`Only considering builds with the tag(s) '${tags}'`);
}
if (overrideStageName && overrideStageName.length > 0) {
agentApi.logInfo(`Overriding current stage '${stageName}' with '${overrideStageName}'`);
stageName = overrideStageName;
}
var lastGoodBuildId;
if (overrideBuildReleaseId && overrideBuildReleaseId.length > 0 ) {
if (isNaN(parseInt(overrideBuildReleaseId, 10))) {
agentApi.logError(`The override build ID '${overrideBuildReleaseId}' is not a number `);
resolve(-1);
return;
}
agentApi.logInfo (`Using the override for the last successful build of ID '${overrideBuildReleaseId}'`);
}
agentApi.logInfo (`Getting items associated the builds since the last successful build to the stage '${stageName}'`);
var successfulStageDetails = await getLastSuccessfulBuildByStage(buildApi, teamProject, stageName, buildId, currentBuild.definition.id, tagArray, overrideBuildReleaseId);
lastGoodBuildId = successfulStageDetails.id;
if (lastGoodBuildId !== 0) {
console.log(`Getting the details between ${lastGoodBuildId} and ${buildId}`);
currentStage = successfulStageDetails.stage;
mostRecentSuccessfulBuild = await buildApi.getBuild(teamProject, lastGoodBuildId);
// There is only a workaround for Git but not for TFVC :(
if (mostRecentSuccessfulBuild.repository.type === "TfsGit") {
agentApi.logInfo("Using workaround for build API limitation (see issue #349)");
let currentBuild = await buildApi.getBuild(teamProject, buildId);
let commitInfo = await issue349.getCommitsAndWorkItemsForGitRepo(organisation, mostRecentSuccessfulBuild.sourceVersion, currentBuild.sourceVersion, currentBuild.repository.id);
globalCommits = commitInfo.commits;
globalWorkItems = commitInfo.workItems;
} else {
// Fall back to original behavior
globalCommits = await buildApi.getChangesBetweenBuilds(teamProject, lastGoodBuildId, buildId);
globalWorkItems = await buildApi.getWorkItemsBetweenBuilds(teamProject, lastGoodBuildId, buildId);
}
globalTests = await getTestsForBuild(testApi, teamProject, buildId);
} else {
console.log("There has been no past successful build for this stage, so we can just get details from this build");
globalCommits = await buildApi.getBuildChanges(teamProject, buildId);
globalWorkItems = await buildApi.getBuildWorkItemsRefs(teamProject, buildId);
}
} else {
agentApi.logInfo (`Getting items associated with only the current build`);
globalCommits = await buildApi.getBuildChanges(teamProject, buildId, "", 5000);
globalWorkItems = await buildApi.getBuildWorkItemsRefs(teamProject, buildId, 5000);
}
console.log("Get the file details associated with the commits");
globalCommits = await enrichChangesWithFileDetails(gitApi, tfvcApi, globalCommits, gitHubPat);
console.log("Get any test details associated with the build");
globalTests = await getTestsForBuild(testApi, teamProject, buildId);
} else {
environmentName = (overrideStageName || environmentName).toLowerCase();
agentApi.logInfo("Getting the current release details");
currentRelease = await releaseApi.getRelease(teamProject, releaseId);
agentApi.logInfo(`Show associated items for primary artifact only is set to ${showOnlyPrimary}`);
// check of redeploy
if (stopOnRedeploy === true) {
if ( getDeploymentCount(currentRelease.environments, environmentName) > 1) {
agentApi.logWarn(`Skipping release note generation as this deploy is a re-deployment`);
resolve(-1);
return;
}
}
if (!currentRelease) {
agentApi.logError(`Unable to locate the current release with id ${releaseId}`);
resolve(-1);
return;
}
var environmentId = getReleaseDefinitionId(currentRelease.environments, environmentName);
if (overrideBuildReleaseId && overrideBuildReleaseId.length > 0 ) {
if (isNaN(parseInt(overrideBuildReleaseId, 10))) {