Public/Invoke-JiraIssueTransition.ps1
|
function Invoke-JiraIssueTransition { # .ExternalHelp ..\JiraPS-help.xml [CmdletBinding()] param( [Parameter( Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName )] [ValidateNotNullOrEmpty()] [ValidateScript( { if (("JiraPS.Issue" -notin $_.PSObject.TypeNames) -and (($_ -isnot [String]))) { $exception = ([System.ArgumentException]"Invalid Type for Parameter") #fix code highlighting] $errorId = 'ParameterType.NotJiraIssue' $errorCategory = 'InvalidArgument' $errorTarget = $_ $errorItem = New-Object -TypeName System.Management.Automation.ErrorRecord $exception, $errorId, $errorCategory, $errorTarget $errorItem.ErrorDetails = "Wrong object type provided for Issue. Expected [JiraPS.Issue] or [String], but was $($_.GetType().Name)" $PSCmdlet.ThrowTerminatingError($errorItem) <# #ToDo:CustomClass Once we have custom classes, this check can be done with Type declaration #> } else { return $true } } )] [Alias('Key')] [Object] $Issue, [Parameter( Mandatory )] [Object] $Transition, [PSCustomObject] $Fields, [Object] $Assignee, [String] $Comment, [Parameter()] [System.Management.Automation.PSCredential] [System.Management.Automation.Credential()] $Credential = [System.Management.Automation.PSCredential]::Empty, [Switch] $Passthru ) begin { Write-Verbose "[$($MyInvocation.MyCommand.Name)] Function started" } process { Write-DebugMessage "[$($MyInvocation.MyCommand.Name)] ParameterSetName: $($PsCmdlet.ParameterSetName)" Write-DebugMessage "[$($MyInvocation.MyCommand.Name)] PSBoundParameters: $($PSBoundParameters | Out-String)" # Find the proper object for the Issue $issueObj = Resolve-JiraIssueObject -InputObject $Issue -Credential $Credential if ("JiraPS.Transition" -in $Transition.PSObject.TypeNames) { Write-DebugMessage "[$($MyInvocation.MyCommand.Name)] Transition parameter is a JiraPS.Transition object" $transitionId = $Transition.Id } else { Write-DebugMessage "[$($MyInvocation.MyCommand.Name)] Attempting to cast Transition parameter [$Transition] as int for transition ID" try { $transitionId = [Int]"$Transition" } catch { $exception = ([System.ArgumentException]"Invalid Type for Parameter") $errorId = 'ParameterType.NotJiraTransition' $errorCategory = 'InvalidArgumenty' $errorTarget = $Transition $errorItem = New-Object -TypeName System.Management.Automation.ErrorRecord $exception, $errorId, $errorCategory, $errorTargetError $errorItem.ErrorDetails = "Wrong object type provided for Transition. Expected [JiraPS.Transition] or [Int], but was $($Transition.GetType().Name)" $PSCmdlet.ThrowTerminatingError($errorItem) } } Write-DebugMessage "[$($MyInvocation.MyCommand.Name)] Checking that the issue can perform the given transition" if (($issueObj.Transition.Id) -notcontains $transitionId) { $exception = ([System.ArgumentException]"Invalid value for Parameter") $errorId = 'ParameterValue.InvalidTransition' $errorCategory = 'InvalidArgument' $errorTarget = $Issue $errorItem = New-Object -TypeName System.Management.Automation.ErrorRecord $exception, $errorId, $errorCategory, $errorTarget $errorItem.ErrorDetails = "The specified Jira issue cannot perform transition [$transitionId]. Check the issue's Transition property and provide a transition valid for its current state." $PSCmdlet.ThrowTerminatingError($errorItem) } $requestBody = @{ 'transition' = @{ 'id' = $transitionId } } if ($Assignee) { if ($Assignee -eq 'Unassigned') { <# #ToDo:Deprecated This behavior should be deprecated #> Write-DebugMessage "[$($MyInvocation.MyCommand.Name)] 'Unassigned' String passed. Issue will be assigned to no one." $assigneeString = "" $validAssignee = $true } else { if ($assigneeObj = Get-JiraUser -InputObject $Assignee -Credential $Credential) { Write-Debug "[$($MyInvocation.MyCommand.Name)] User found (name=[$($assigneeObj.Name)],RestUrl=[$($assigneeObj.RestUrl)])" $assigneeString = $assigneeObj.Name $validAssignee = $true } else { $exception = ([System.ArgumentException]"Invalid value for Parameter") $errorId = 'ParameterValue.InvalidAssignee' $errorCategory = 'InvalidArgument' $errorTarget = $Assignee $errorItem = New-Object -TypeName System.Management.Automation.ErrorRecord $exception, $errorId, $errorCategory, $errorTarget $errorItem.ErrorDetails = "Unable to validate Jira user [$Assignee]. Use Get-JiraUser for more details." $PSCmdlet.ThrowTerminatingError($errorItem) } } } if ($validAssignee) { Write-DebugMessage "[$($MyInvocation.MyCommand.Name)] Updating Assignee" $requestBody += @{ 'fields' = @{ 'assignee' = @{ 'name' = $assigneeString } } } } $requestBody += @{ 'update' = @{} } if ($Fields) { Write-Debug "[$($MyInvocation.MyCommand.Name)] Resolving `$Fields" foreach ($key in $Fields.Keys) { $name = $key $value = $Fields.$key Write-DebugMessage "[$($MyInvocation.MyCommand.Name)] Attempting to identify field (name=[$name], value=[$value])" if ($field = Get-JiraField -Field $name -Credential $Credential) { # For some reason, this was coming through as a hashtable instead of a String, # which was causing ConvertTo-Json to crash later. # Not sure why, but this forces $id to be a String and not a hashtable. $id = "$($field.ID)" Write-DebugMessage "[$($MyInvocation.MyCommand.Name)] Field [$name] was identified as ID [$id]" $requestBody.update.$id = @( @{ 'set' = $value }) } else { $exception = ([System.ArgumentException]"Invalid value for Parameter") $errorId = 'ParameterValue.InvalidFields' $errorCategory = 'InvalidArgument' $errorTarget = $Fields $errorItem = New-Object -TypeName System.Management.Automation.ErrorRecord $exception, $errorId, $errorCategory, $errorTarget $errorItem.ErrorDetails = "Unable to identify field [$name] from -Fields hashtable. Use Get-JiraField for more information." $PSCmdlet.ThrowTerminatingError($errorItem) } } } if ($Comment) { Write-DebugMessage "[$($MyInvocation.MyCommand.Name)] Adding comment" $requestBody.update.comment += , @{ 'add' = @{ 'body' = $Comment } } } $parameter = @{ URI = "{0}/transitions" -f $issueObj.RestURL Method = "POST" Body = ConvertTo-Json -InputObject $requestBody -Depth 4 Credential = $Credential } Write-Debug "[$($MyInvocation.MyCommand.Name)] Invoking JiraMethod with `$parameter" Invoke-JiraMethod @parameter if ($Passthru) { Get-JiraIssue $issueObj } } end { Write-Verbose "[$($MyInvocation.MyCommand.Name)] Complete" } } |