forked from StartAutomating/PSDevOps
-
Notifications
You must be signed in to change notification settings - Fork 0
/
New-ADOWorkItem.ps1
224 lines (196 loc) · 8.54 KB
/
New-ADOWorkItem.ps1
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
function New-ADOWorkItem
{
<#
.Synopsis
Creates new work items in Azure DevOps
.Description
Creates new work items in Azure DevOps or Team Foundation Server.
.Example
@{ Title='New Work Item'; Description='A Description of the New Work Item' } |
New-ADOWorkItem -Organization StartAutomating -Project PSDevOps -Type Issue
.Link
Invoke-ADORestAPI
#>
[CmdletBinding(DefaultParameterSetName='ByID',SupportsShouldProcess=$true)]
[OutputType('PSDevOps.WorkItem')]
param(
# The InputObject
[Parameter(Mandatory,ValueFromPipeline,ValueFromPipelineByPropertyName)]
[PSObject]
$InputObject,
# The type of the work item.
[Parameter(Mandatory, ValueFromPipelineByPropertyName)]
[Alias('WorkItemType')]
[string]
$Type,
# The work item ParentID
[Parameter(ValueFromPipelineByPropertyName)]
[string]
$ParentID,
# The Organization
[Parameter(Mandatory,ValueFromPipelineByPropertyName)]
[Alias('Org')]
[string]
$Organization,
# The Project
[Parameter(Mandatory,ValueFromPipelineByPropertyName)]
[string]
$Project,
# If set, will not validate rules.
[Parameter(ValueFromPipelineByPropertyName)]
[Alias('BypassRules','NoRules','NoRule')]
[switch]
$BypassRule,
# If set, will only validate rules, but will not update the work item.
[Parameter(ValueFromPipelineByPropertyName)]
[Alias('ValidateRules','ValidateRule','CheckRule','CheckRules')]
[switch]
$ValidateOnly,
# If set, will only validate rules, but will not update the work item.
[Parameter(ValueFromPipelineByPropertyName)]
[Alias('SuppressNotifications','SkipNotification','SkipNotifications','NoNotify')]
[switch]
$SupressNotification,
# The server. By default https://dev.azure.com/.
# To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs).
[Parameter(ValueFromPipelineByPropertyName)]
[uri]
$Server = "https://dev.azure.com/",
# The api version. By default, 5.1.
# If targeting TFS, this will need to change to match your server version.
# See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops
[string]
$ApiVersion = "5.1")
dynamicParam { . $GetInvokeParameters -DynamicParameter }
begin {
#region Copy Invoke-ADORestAPI parameters
$invokeParams = . $getInvokeParameters $PSBoundParameters
#endregion Copy Invoke-ADORestAPI parameters
$fixField = {
param($prop, $validFieldTable)
$fieldName =
if ($validFieldTable.Contains($prop.Name)) {
$validFieldTable[$prop.Name].ReferenceName
} else {
$noSpacesPropName = $prop.Name -replace '\s', ''
foreach ($v in $validFieldTable.Values) {
if ($v.Name -replace '\s', '' -eq $noSpacesPropName -or
$v.referenceName -eq $noSpacesPropName) {
$v.referenceName
break
}
}
}
if (-not $fieldName) {
Write-Warning "Could not map $($prop.Name) to a field"
return
}
@{
op = "add"
path = '/fields/' + $fieldName
value = $prop.Value
}
}
#region Output Work Item
$outWorkItem = {
param([Parameter(ValueFromPipeline)]$restResponse)
process {
$out = $restResponse.fields
if (-not $out.ID) {
$out.psobject.properties.add([PSNoteProperty]::new('ID', $restResponse.ID))
}
if (-not $out.Relations -and $restResponse.Relations) {
$out.psobject.properties.add([PSNoteProperty]::new('Relations', $restResponse.Relations))
}
if (-not $out.Organization -and $Organization) {
$out.psobject.properties.add([PSNoteProperty]::new('Organization', $Organization))
}
if (-not $out.Project -and $Project) {
$out.psobject.properties.add([PSNoteProperty]::new('Project', $Project))
}
$out.pstypenames.clear() # and we want them to by formattable, we we give them the following typenames
$wiType = $out.'System.WorkItemType'
if ($workItemType) {
#* $Organization.$Project.$WorkItemType (If Output had WorkItemType).
$out.pstypenames.add("$Organization.$Project.$wiType")
}
#* $Organization.$Project.WorkItem.
$out.pstypenames.add("$Organization.$Project.WorkItem")
if ($workItemType) { #* PSDevOps.$WorkItemType (if output had workItemType).
$out.pstypenames.add("PSDevOps.$wiType")
}
$out.pstypenames.add("PSDevOps.WorkItem") #* PSDevOps.WorkItem
# Decorating the object this way allows it to be generically formatted by the PSDevOps module
$out # and specifically formatted for a given org/project/workitemtype.
}
}
#endregion Output Work Item
}
process {
$uriBase = "$Server".TrimEnd('/'), $Organization, $Project -join '/'
$validFields =
if ($script:ADOFieldCache.$uribase) {
$script:ADOFieldCache.$uribase
} else {
Get-ADOField -Organization $Organization -Project $Project -Server $Server @invokeParams
}
$validFieldTable = $validFields | Group-Object ReferenceName -AsHashTable
$uri = $uriBase, "_apis/wit/workitems", "`$$($Type -replace '\s', '')?" -join '/'
if ($Server -ne 'https://dev.azure.com/' -and
-not $PSBoundParameters.ApiVersion) {
$ApiVersion = '2.0'
}
$uri +=
@(
if ($ApiVersion) {"api-version=$ApiVersion" }
if ($BypassRule) { 'bypassRules=true' }
if ($SupressNotification) { 'supressNotifications=true'}
if ($ValidateOnly) { 'validateOnly=true'}
) -join '&'
$invokeParams.Uri = $uri
if ($InputObject -is [Collections.IDictionary]) {
$InputObject = [PSCustomObject]$InputObject
}
$patchOperations =
@(foreach ($prop in $InputObject.psobject.properties) {
if ($MyInvocation.MyCommand.Parameters.Keys -contains $prop.Name) { continue }
& $fixField $prop $validFieldTable
})
if ($parentID) {
$patchOperations += @{
op='add'
path ='/relations/-'
value = @{
rel = 'System.LinkTypes.Hierarchy-Reverse'
url = $uriBase, '_apis/wit', $ParentID -join '/'
}
}
}
$invokeParams.Body = ConvertTo-Json $patchOperations -Depth 100
$invokeParams.Method = 'POST'
$invokeParams.ContentType = 'application/json-patch+json'
if ($WhatIfPreference) {
$invokeParams.Remove('PersonalAccessToken')
return $invokeParams
}
if (-not $PSCmdlet.ShouldProcess("POST $uri with $($invokeParams.body)")) { return }
$restResponse = Invoke-ADORestAPI @invokeParams 2>&1
if ($restResponse.ErrorDetails.Message) {
$errorDetails = $restResponse.ErrorDetails.Message | ConvertFrom-Json
if ($errorDetails.message -like 'VS402323*') {
$PSCmdlet.WriteError([Management.Automation.ErrorRecord]::new(
[Exception]::new(
$errorDetails.message + [Environment]::NewLine +
"Use Get-ADOWorkItem -WorkItemType to find valid types"
),'UnknownWorkItemType', 'NotSpecified', $restResponse)
)
} else {
return $restResponse
}
} elseif ($restResponse.Exception) {
return $restResponse
}
if (-not $restResponse.fields) { return } # If the return value had no fields property, we're done.
& $outWorkItem $restResponse
}
}