-
Notifications
You must be signed in to change notification settings - Fork 34
/
WorkItemUpdater.ts
361 lines (324 loc) · 16.8 KB
/
WorkItemUpdater.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
import tl = require('vsts-task-lib/task');
import { Settings } from './settings';
import * as vso from 'vso-node-api';
import { IBuildApi } from 'vso-node-api/BuildApi';
import { IRequestHandler } from 'vso-node-api/interfaces/common/VsoBaseInterfaces';
import { WebApi, getHandlerFromToken } from 'vso-node-api/WebApi';
import { BuildStatus, BuildResult, BuildQueryOrder, Build } from 'vso-node-api/interfaces/BuildInterfaces';
import { IWorkItemTrackingApi } from 'vso-node-api/WorkItemTrackingApi';
import { ResourceRef, JsonPatchDocument, JsonPatchOperation, Operation } from 'vso-node-api/interfaces/common/VSSInterfaces';
import { WorkItemExpand, WorkItem, WorkItemField, WorkItemRelation, QueryHierarchyItem } from 'vso-node-api/interfaces/WorkItemTrackingInterfaces';
import { WorkItemQueryResult } from 'vso-node-api/interfaces/WorkItemTrackingInterfaces';
import { IReleaseApi } from 'vso-node-api/ReleaseApi';
import { DeploymentStatus, ReleaseQueryOrder } from 'vso-node-api/interfaces/ReleaseInterfaces';
async function main(): Promise<void> {
try {
const vstsWebApi: WebApi = getVstsWebApi();
const settings: Settings = getSettings();
tl.debug('Get WorkItemTrackingApi');
const workItemTrackingClient: IWorkItemTrackingApi = await vstsWebApi.getWorkItemTrackingApi();
tl.debug('Get workItemsRefs');
const workItemRefs: ResourceRef[] = await getWorkItemsRefs(vstsWebApi, workItemTrackingClient, settings);
let numberOfUpdateWorkitems = 0;
if (!workItemRefs || workItemRefs.length === 0) {
console.log('No workitems found to update.');
}
else {
tl.debug('Loop workItemsRefs');
await asyncForEach(workItemRefs, async (workItemRef: ResourceRef) => {
tl.debug('Found WorkItemRef: ' + workItemRef.id);
const workItem: WorkItem = await workItemTrackingClient.getWorkItem(parseInt(workItemRef.id), undefined, undefined, WorkItemExpand.Relations);
console.log('Found WorkItem: ' + workItem.id);
switch (settings.updateAssignedToWith) {
case 'Creator': {
const creator = workItem.fields['System.CreatedBy'];
tl.debug('Using workitem creator user "' + creator + '" as assignedTo.');
settings.assignedTo = creator;
break;
}
case 'FixedUser': {
tl.debug('Using fixed user "' + settings.assignedTo + '" as assignedTo.');
break;
}
case 'Unassigned': {
tl.debug('Using Unassigned as assignedTo.');
settings.assignedTo = undefined;
break;
}
default: {
tl.debug('Setting assignedTo to requester for build "' + settings.requestedFor + '".');
settings.assignedTo = settings.requestedFor;
break;
}
}
if (await updateWorkItem(workItemTrackingClient, workItem, settings)) {
numberOfUpdateWorkitems++;
}
});
tl.debug('Finished loop workItemsRefs');
}
if (numberOfUpdateWorkitems == 0
&& settings.failTaskIfNoWorkItemsAvailable) {
tl.setResult(tl.TaskResult.Failed, 'Found no workitems to update.');
} else {
tl.setResult(tl.TaskResult.Succeeded, '');
}
} catch (error) {
tl.debug('Caught an error in main: ' + error);
tl.setResult(tl.TaskResult.Failed, error);
}
}
async function asyncForEach(array: any[], callback: any) {
for (let index = 0; index < array.length; index++) {
await callback(array[index], index, array);
}
}
function getVstsWebApi() {
const endpointUrl: string = tl.getVariable('System.TeamFoundationCollectionUri');
const accessToken: string = tl.getEndpointAuthorizationParameter('SYSTEMVSSCONNECTION', 'AccessToken', false);
const credentialHandler: IRequestHandler = getHandlerFromToken(accessToken);
const webApi: WebApi = new WebApi(endpointUrl, credentialHandler);
return webApi;
}
function getSettings(): Settings {
const settings = new Settings();
settings.buildId = parseInt(tl.getVariable('Build.BuildId'));
settings.projectId = tl.getVariable('System.TeamProjectId');
settings.requestedFor = tl.getVariable('Build.RequestedFor');
settings.workitemsSource = tl.getInput('workitemsSource');
settings.workitemsSourceQuery = tl.getInput('workitemsSourceQuery');
settings.allWorkItemsSinceLastRelease = tl.getBoolInput('allWorkItemsSinceLastRelease');
settings.workItemType = tl.getInput('workItemType');
settings.workItemState = tl.getInput('workItemState');
settings.workItemCurrentState = tl.getInput('workItemCurrentState');
settings.workItemKanbanLane = tl.getInput('workItemKanbanLane');
settings.workItemKanbanState = tl.getInput('workItemKanbanState');
settings.workItemDone = tl.getBoolInput('workItemDone');
settings.linkBuild = tl.getBoolInput('linkBuild');
settings.updateAssignedTo = tl.getInput('updateAssignedTo');
settings.updateAssignedToWith = tl.getInput('updateAssignedToWith');
settings.assignedTo = tl.getInput('assignedTo');
settings.updateFields = tl.getInput('updateFields');
settings.bypassRules = tl.getBoolInput('bypassRules');
settings.failTaskIfNoWorkItemsAvailable = tl.getBoolInput('failTaskIfNoWorkItemsAvailable');
settings.addTags = tl.getInput('addTags');
if (settings.addTags) {
settings.addTags = settings.addTags.replace(/(?:\r\n|\r|\n)/g, ';');
}
settings.removeTags = tl.getInput('removeTags');
if (settings.removeTags) {
settings.removeTags = settings.removeTags.replace(/(?:\r\n|\r|\n)/g, ';');
}
const releaseIdString = tl.getVariable('Release.ReleaseId');
const definitionIdString = tl.getVariable('Release.DefinitionId');
const definitionEnvironmentIdString = tl.getVariable('Release.DefinitionEnvironmentId');
if (releaseIdString && releaseIdString !== ''
&& definitionIdString && definitionIdString !== ''
&& definitionEnvironmentIdString && definitionEnvironmentIdString !== '') {
settings.releaseId = parseInt(releaseIdString);
settings.definitionId = parseInt(definitionIdString);
settings.definitionEnvironmentId = parseInt(definitionEnvironmentIdString);
}
tl.debug('BuildId ' + settings.buildId);
tl.debug('ProjectId ' + settings.projectId);
tl.debug('ReleaseId ' + settings.releaseId);
tl.debug('DefinitionId ' + settings.definitionId);
tl.debug('DefinitionEnvironmentId ' + settings.definitionEnvironmentId);
tl.debug('requestedFor ' + settings.requestedFor);
tl.debug('workitemsSource ' + settings.workitemsSource);
tl.debug('workitemsSourceQuery ' + settings.workitemsSourceQuery);
tl.debug('allWorkItemsSinceLastRelease ' + settings.allWorkItemsSinceLastRelease);
tl.debug('workItemType ' + settings.workItemType);
tl.debug('WorkItemState ' + settings.workItemState);
tl.debug('workItemCurrentState ' + settings.workItemCurrentState);
tl.debug('updateWorkItemKanbanLane ' + settings.workItemKanbanLane);
tl.debug('WorkItemKanbanState ' + settings.workItemKanbanState);
tl.debug('WorkItemDone ' + settings.workItemDone);
tl.debug('updateAssignedTo ' + settings.updateAssignedTo);
tl.debug('updateAssignedToWith ' + settings.updateAssignedToWith);
tl.debug('assignedTo ' + settings.assignedTo);
tl.debug('addTags ' + settings.addTags);
tl.debug('updateFields ' + settings.updateFields);
tl.debug('removeTags ' + settings.removeTags);
tl.debug('bypassRules ' + settings.bypassRules);
tl.debug('failTaskIfNoWorkItemsAvailable ' + settings.failTaskIfNoWorkItemsAvailable);
return settings;
}
async function getWorkItemsRefs(vstsWebApi: WebApi, workItemTrackingClient: IWorkItemTrackingApi, settings: Settings): Promise<ResourceRef[]> {
if (settings.workitemsSource === 'Build') {
if (settings.releaseId && settings.allWorkItemsSinceLastRelease) {
console.log('Using Release as WorkItem Source');
const releaseClient: IReleaseApi = await vstsWebApi.getReleaseApi();
const deployments = await releaseClient.getDeployments(settings.projectId, settings.definitionId, settings.definitionEnvironmentId, undefined, undefined, undefined, DeploymentStatus.Succeeded, undefined, undefined, ReleaseQueryOrder.Descending, 1);
if (deployments.length > 0) {
const baseReleaseId = deployments[0].release.id;
tl.debug('Using Release ' + baseReleaseId + ' as BaseRelease for ' + settings.releaseId);
const releaseWorkItemRefs = await releaseClient.getReleaseWorkItemsRefs(settings.projectId, settings.releaseId, baseReleaseId);
const result: ResourceRef[] = [];
releaseWorkItemRefs.forEach((releaseWorkItem) => {
result.push({
id: releaseWorkItem.id.toString(),
url: releaseWorkItem.url
});
});
return result;
}
}
console.log('Using Build as WorkItem Source');
const buildClient: IBuildApi = await vstsWebApi.getBuildApi();
const workItemRefs: ResourceRef[] = await buildClient.getBuildWorkItemsRefs(settings.projectId, settings.buildId);
return workItemRefs;
}
else if (settings.workitemsSource === 'Query') {
console.log('Using Query as WorkItem Source');
const result: ResourceRef[] = [];
const query: QueryHierarchyItem = await workItemTrackingClient.getQuery(settings.projectId, settings.workitemsSourceQuery);
if (query) {
tl.debug('Found queryId ' + query.id + ' from QueryName ' + settings.workitemsSourceQuery);
const queryResult: WorkItemQueryResult = await workItemTrackingClient.queryById(
query.id,
{
project: undefined,
projectId: settings.projectId,
team: undefined,
teamId: undefined
});
queryResult.workItems.forEach((workItem) => {
result.push({
id: workItem.id.toString(),
url: workItem.url
});
});
}
else {
tl.warning('Could not find query ' + settings.workitemsSourceQuery);
}
return result;
}
return undefined;
}
async function updateWorkItem(workItemTrackingClient: IWorkItemTrackingApi, workItem: WorkItem, settings: Settings): Promise<boolean> {
tl.debug('Updating WorkItem: ' + workItem.id);
if (settings.workItemType.split(',').indexOf(workItem.fields['System.WorkItemType']) >= 0) {
if (settings.workItemCurrentState && settings.workItemCurrentState !== '' && settings.workItemCurrentState.split(',').indexOf(workItem.fields['System.State']) === -1) {
console.log('Skipped WorkItem: ' + workItem.id + ' State: "' + workItem.fields['System.State'] + '" => Only updating if state in "' + settings.workItemCurrentState) + '"';
return false;
}
console.log('Updating WorkItem ' + workItem.id);
const document: any[] = [];
const kanbanLane = getWorkItemFields(workItem, (f: string) => f.endsWith('Kanban.Lane'));
tl.debug('Found KanbanLane: ' + kanbanLane);
const kanbanColumn = getWorkItemFields(workItem, (f: string) => f.endsWith('Kanban.Column'));
tl.debug('Found KanbanColumn: ' + kanbanColumn);
const kanbanColumnDone = getWorkItemFields(workItem, (f: string) => f.endsWith('Kanban.Column.Done'));
tl.debug('Found KanbanColumnDone: ' + kanbanColumnDone);
if (settings.workItemState && settings.workItemState !== '') {
addPatchOperation('/fields/System.State', settings.workItemState, document);
}
if (settings.workItemKanbanLane && settings.workItemKanbanLane !== '' && kanbanLane.length > 0) {
kanbanLane.forEach((lane, index) => {
addPatchOperation('/fields/' + lane, settings.workItemKanbanLane, document);
});
}
if (settings.workItemKanbanState && settings.workItemKanbanState !== '' && kanbanColumn.length > 0) {
kanbanColumn.forEach((column, index) => {
addPatchOperation('/fields/' + column, settings.workItemKanbanState, document);
});
}
if (settings.workItemDone && kanbanColumnDone.length > 0) {
kanbanColumnDone.forEach((columnDone, index) => {
addPatchOperation('/fields/' + columnDone, settings.workItemDone, document);
});
}
if (settings.linkBuild) {
const buildRelationUrl = 'vstfs:///Build/Build/$buildId';
const buildRelation = !workItem.relations || workItem.relations.find(r => r.url === buildRelationUrl);
if (buildRelation === null) {
console.log('Linking Build ' + settings.buildId + ' to WorkItem ' + workItem.id);
const relation: WorkItemRelation = {
rel: 'ArtifactLink',
url: buildRelationUrl,
attributes: {
name: 'Build'
}
};
addPatchOperation('/relations/-', relation, document);
}
else {
console.log('Build ' + settings.buildId + ' already linked to WorkItem ' + workItem.id);
}
}
if (settings.updateAssignedTo === 'Always' || (settings.updateAssignedTo === 'Unassigned' && getWorkItemFields(workItem, (f: string) => f === 'System.AssignedTo').length === 0)) {
let operation: Operation = Operation.Add;
if (!settings.assignedTo) {
operation = Operation.Remove;
}
addPatchOperation('/fields/System.AssignedTo', settings.assignedTo, document, operation);
}
if (settings.addTags || settings.removeTags) {
const newTags: string[] = [];
const removeTags: string[] = settings.removeTags ? settings.removeTags.split(';') : [];
if (workItem.fields['System.Tags']) {
tl.debug('Existing tags: ' + workItem.fields['System.Tags']);
workItem.fields['System.Tags'].split(';').forEach((tag: string) => {
if (removeTags.find(e => e.toLowerCase() === tag.trim().toLowerCase())) {
tl.debug('Removing tag: ' + tag);
}
else {
newTags.push(tag.trim());
}
});
}
const addTags: string[] = settings.addTags ? settings.addTags.split(';') : [];
addTags.forEach((tag) => {
if (!newTags.find(e => e.toLowerCase() === tag.toLowerCase())) {
tl.debug('Adding tag: ' + tag);
newTags.push(tag.trim());
}
});
addPatchOperation('/fields/System.Tags', newTags.join('; '), document);
}
if (settings.updateFields) {
const updateFields: string[] = settings.updateFields.split(/\r?\n/);
updateFields.forEach((updateField) => {
const commaIndex = updateField.indexOf(',');
if (commaIndex >= 0) {
addPatchOperation('/fields/' + updateField.substring(0, commaIndex), updateField.substring(commaIndex + 1), document);
}
});
}
tl.debug('Start UpdateWorkItem');
const updatedWorkItem = await workItemTrackingClient.updateWorkItem(
undefined,
document,
workItem.id,
undefined,
settings.bypassRules);
console.log('WorkItem ' + workItem.id + ' updated');
return true;
}
else {
console.log('Skipped ' + workItem.fields['System.WorkItemType'] + ' WorkItem: ' + workItem.id);
}
return false;
}
function getWorkItemFields(workItem: any, predicate: any): string[] {
const result: string[] = [];
Object.keys(workItem.fields).forEach((propertyName, index) => {
if (predicate(propertyName)) {
result.push(propertyName);
}
});
return result;
}
function addPatchOperation(path: any, value: any, document: any[], operation: Operation = Operation.Add) {
const patchOperation: JsonPatchOperation = {
from: undefined,
op: operation,
path: path,
value: value
};
document.push(patchOperation);
console.log('Patch: ' + patchOperation.path + ' ' + patchOperation.value);
}
main();