Public/New-JiraVersion.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
function New-JiraVersion {
    <#
    .Synopsis
        Creates a new FixVersion in JIRA
    .DESCRIPTION
         This function creates a new FixVersion in JIRA.
    .EXAMPLE
        New-JiraVersion -Name '1.0.0.0' -Project "RD"
        Description
        -----------
        This example creates a new JIRA Version named '1.0.0.0' in project `RD`.
    .EXAMPLE
        $project = Get-JiraProject -Project "RD"
        New-JiraVersion -Name '1.0.0.0' -Project $project -ReleaseDate "2000-12-31"
        Description
        -----------
        Create a new Version in Project `RD` with a set release date.
    .EXAMPLE
        $version = Get-JiraVersion -Name "1.0.0.0" -Project "RD"
        $version = $version.Project.Key "TEST"
        $version | New-JiraVersion
        Description
        -----------
        This example duplicates the Version named '1.0.0.0' in Project `RD` to Project `TEST`.
    .OUTPUTS
        [JiraPS.Version]
    .LINK
        Get-JiraVersion
    .LINK
        Remove-JiraVersion
    .LINK
        Set-JiraVersion
    .LINK
        Get-JiraProject
    .NOTES
        This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA.
    #>

    [CmdletBinding(
        SupportsShouldProcess = $true,
        DefaultParameterSetName = 'byObject'
    )]
    param(
        # Version object that should be created on the server.
        [Parameter(
            Position = 0,
            Mandatory = $true,
            ValueFromPipeline = $true,
            ParameterSetName = 'byObject'
        )]
        [Object] $InputObject,

        # Name of the version to create.
        [Parameter(
            Position = 0,
            Mandatory = $true,
            ParameterSetName = 'byParameters'
        )]
        [String] $Name,

        # Description of the version.
        [Parameter(
            Mandatory = $false,
            ParameterSetName = 'byParameters'
        )]
        [String] $Description,

        # Create the version as archived.
        [Parameter(
            Mandatory = $false,
            ParameterSetName = 'byParameters'
        )]
        [Bool] $Archived,

        # Create the version as released.
        [Parameter(
            Mandatory = $false,
            ParameterSetName = 'byParameters'
        )]
        [Bool] $Released,

        # Date of the release.
        [Parameter(
            Mandatory = $false,
            ParameterSetName = 'byParameters'
        )]
        [DateTime] $ReleaseDate,

        # Date of the release.
        [Parameter(
            Mandatory = $false,
            ParameterSetName = 'byParameters'
        )]
        [DateTime] $StartDate,

        # The Project ID
        [Parameter(
            Mandatory = $true,
            ParameterSetName = 'byParameters'
        )]
        [Object] $Project,

        # Credentials to use to connect to Jira.
        [Parameter(Mandatory = $false)]
        [PSCredential] $Credential
    )
    begin {
        Write-Debug -Message '[New-JiraVersion] Reading information from config file'
        $server = Get-JiraConfigServer -ConfigFile $ConfigFile -ErrorAction Stop

        $restUrl = "$server/rest/api/latest/version"
    }

    process {
        $iwrSplat = @{}
        Switch ($PSCmdlet.ParameterSetName) {
            'byObject' {
                # Validate InputObject type
                if ($InputObject.PSObject.TypeNames[0] -ne "JiraPS.Version") {
                    $message = "Wrong object type provided for Version. Only JiraPS.Version is accepted"
                    $exception = New-Object -TypeName System.ArgumentException -ArgumentList $message
                    Throw $exception
                }

                # Validate mandatory properties
                if (-not ($InputObject.Project -and $InputObject.Name)) {
                    $message = "The Version provided does not contain all necessary information. Mandatory properties: 'Project', 'Name'"
                    $exception = New-Object -TypeName System.ArgumentException -ArgumentList $message
                    Throw $exception
                }

                $iwrSplat["name"] = $InputObject.Name
                $iwrSplat["description"] = $InputObject.Description
                $iwrSplat["archived"] = [bool]($InputObject.Archived)
                $iwrSplat["released"] = [bool]($InputObject.Released)
                $iwrSplat["releaseDate"] = $InputObject.ReleaseDate.ToString('yyyy-MM-dd')
                $iwrSplat["startDate"] = $InputObject.StartDate.ToString('yyyy-MM-dd')
                if ($InputObject.Project.Key) {
                    $iwrSplat["project"] = $InputObject.Project.Key
                }
                elseif ($InputObject.Project.Id) {
                    $iwrSplat["projectId"] = $InputObject.Project.Id
                }
            }
            'byParameters' {
                # Validate Project parameter
                if (-not(($Project.PSObject.TypeNames[0] -ne "JiraPS.Project") -or ($Project -isnot [String]))) {
                    $message = "The Project provided is invalid."
                    $exception = New-Object -TypeName System.ArgumentException -ArgumentList $message
                    Throw $exception
                }

                Write-Debug -Message '[New-JiraVersion] Defining properties'
                $iwrSplat["name"] = $Name
                if ($PSCmdlet.MyInvocation.BoundParameters.ContainsKey("Description")) {
                    $iwrSplat["description"] = $Description
                }
                if ($PSCmdlet.MyInvocation.BoundParameters.ContainsKey("Archived")) {
                    $iwrSplat["archived"] = $Archived
                }
                if ($PSCmdlet.MyInvocation.BoundParameters.ContainsKey("Released")) {
                    $iwrSplat["released"] = $Released
                }
                if ($PSCmdlet.MyInvocation.BoundParameters.ContainsKey("ReleaseDate")) {
                    $iwrSplat["releaseDate"] = Get-Date $ReleaseDate -Format 'yyyy-MM-dd'
                }
                if ($PSCmdlet.MyInvocation.BoundParameters.ContainsKey("StartDate")) {
                    $iwrSplat["startDate"] = Get-Date $StartDate -Format 'yyyy-MM-dd'
                }

                if ($Project.PSObject.TypeNames[0] -eq "JiraPS.Project") {
                    if ($Project.Id) {
                        $iwrSplat["projectId"] = $Project.Id
                    }
                    elseif ($Project.Key) {
                        $iwrSplat["project"] = $Project.Key
                    }
                }
                else {
                    $iwrSplat["projectId"] = (Get-JiraProject $Project -Credential $Credential).Id
                }
            }
        }

        Write-Debug -Message '[New-JiraVersion] Converting to JSON'
        $json = ConvertTo-Json -InputObject $iwrSplat

        if ($PSCmdlet.ShouldProcess($Name, "Creating new Version on JIRA")) {
            Write-Debug -Message '[New-JiraVersion] Preparing for blastoff!'
            $result = Invoke-JiraMethod -Method Post -URI $restUrl -Body $json -Credential $Credential
        }

        If ($result) {
            $result | ConvertTo-JiraVersion -Credential $Credential
        }
        Else {
            Write-Debug -Message '[New-JiraVersion] Jira returned no results to output.'
        }
    }

    end {
        Write-Debug "[New-JiraVersion] Complete"
    }
}