Skip to content

Commit 49d5c7f

Browse files
DarqueWarriorDarqueWarrior
authored
Fixed a bug in Test-VSTeamYamlPipeline (#359)
* Added AlphabeticParamsOrder to build docs * Fixed bug in Test-VSTeamYamlPipeline I had to add a Pipelines version * Updated change log and version. * Fixing unit tests. * Fixed gen-help
1 parent 07a284a commit 49d5c7f

File tree

9 files changed

+42
-12
lines changed

9 files changed

+42
-12
lines changed

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Changelog
22

3+
## 7.1.1
4+
5+
Fixed bug in Test-VSTeamYamlPipeline by adding a Pipelines version value.
6+
37
## 7.1.0
48

59
Added:

‎Source/Classes/Versions.cs‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ public enum APIs
77
Build, Release, Core, Git, DistributedTask, DistributedTaskReleased,
88
VariableGroups, Tfvc, Packaging, MemberEntitlementManagement,
99
ExtensionsManagement, ServiceEndpoints, Graph, TaskGroups, Policy,
10-
Processes, Version, HierarchyQuery
10+
Processes, Version, HierarchyQuery, Pipelines
1111
}
1212

1313
public static class Versions
@@ -37,6 +37,9 @@ public static void SetApiVersion(APIs service, string version)
3737
case APIs.DistributedTaskReleased:
3838
DistributedTaskReleased = version;
3939
break;
40+
case APIs.Pipelines:
41+
Pipelines = version;
42+
break;
4043
case APIs.VariableGroups:
4144
VariableGroups = version;
4245
break;
@@ -88,6 +91,8 @@ public static string GetApiVersion(APIs service)
8891
return DistributedTask;
8992
case APIs.DistributedTaskReleased:
9093
return DistributedTaskReleased;
94+
case APIs.Pipelines:
95+
return Pipelines;
9196
case APIs.VariableGroups:
9297
return VariableGroups;
9398
case APIs.Tfvc:
@@ -133,6 +138,7 @@ public static string GetApiVersion(APIs service)
133138
public static string Release { get; set; } = "3.0-preview";
134139
public static string DistributedTask { get; set; } = "3.0-preview";
135140
public static string DistributedTaskReleased { get; set; } = "";
141+
public static string Pipelines { get; set; } = "";
136142
public static string VariableGroups { get; set; } = "";
137143
public static string TaskGroups { get; set; } = "3.0-preview";
138144
public static string Tfvc { get; set; } = "3.0";

‎Source/Private/common.ps1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ function _getApiVersion {
177177
'DistributedTaskReleased', 'VariableGroups', 'Tfvc',
178178
'Packaging', 'MemberEntitlementManagement',
179179
'ExtensionsManagement', 'ServiceEndpoints', 'Graph',
180-
'TaskGroups', 'Policy', 'Processes', 'HierarchyQuery')]
180+
'TaskGroups', 'Policy', 'Processes', 'HierarchyQuery', 'Pipelines')]
181181
[string] $Service,
182182

183183
[parameter(ParameterSetName = 'Target')]

‎Source/Public/Get-VSTeamAPIVersion.ps1‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
function Get-VSTeamAPIVersion {
2-
[CmdletBinding(HelpUri='https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamAPIVersion')]
2+
[CmdletBinding(HelpUri = 'https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamAPIVersion')]
33
[OutputType([System.Collections.Hashtable])]
44
param(
55
[Parameter(Mandatory = $false, Position = 0)]
6-
[ValidateSet('Build', 'Release', 'Core', 'Git', 'DistributedTask', 'DistributedTaskReleased', 'VariableGroups', 'Tfvc', 'Packaging', 'MemberEntitlementManagement', 'ExtensionsManagement', 'ServiceEndpoints', 'Graph', 'TaskGroups', 'Policy', 'Processes', 'HierarchyQuery')]
6+
[ValidateSet('Build', 'Release', 'Core', 'Git', 'DistributedTask',
7+
'DistributedTaskReleased', 'VariableGroups', 'Tfvc',
8+
'Packaging', 'MemberEntitlementManagement',
9+
'ExtensionsManagement', 'ServiceEndpoints', 'Graph',
10+
'TaskGroups', 'Policy', 'Processes', 'HierarchyQuery',
11+
'Pipelines')]
712
[string] $Service
813
)
914

@@ -30,6 +35,7 @@ function Get-VSTeamAPIVersion {
3035
Policy = $(_getApiVersion Policy)
3136
Processes = $(_getApiVersion Processes)
3237
HierarchyQuery = $(_getApiVersion HierarchyQuery)
38+
Pipelines = $(_getApiVersion Pipelines)
3339
}
3440
}
3541
}

‎Source/Public/Set-VSTeamAPIVersion.ps1‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ function Set-VSTeamAPIVersion {
1313
'DistributedTaskReleased', 'VariableGroups', 'Tfvc',
1414
'Packaging', 'MemberEntitlementManagement',
1515
'ExtensionsManagement', 'ServiceEndpoints', 'Graph',
16-
'TaskGroups', 'Policy', 'HierarchyQuery')]
16+
'TaskGroups', 'Policy', 'Processes', 'HierarchyQuery',
17+
'Pipelines')]
1718
[string] $Service,
1819

1920
[parameter(ParameterSetName = 'Service', Mandatory = $true, Position = 1)]
@@ -37,6 +38,7 @@ function Set-VSTeamAPIVersion {
3738
[vsteam_lib.Versions]::Release = '5.0'
3839
[vsteam_lib.Versions]::DistributedTask = '5.0-preview'
3940
[vsteam_lib.Versions]::DistributedTaskReleased = ''
41+
[vsteam_lib.Versions]::Pipelines = ''
4042
[vsteam_lib.Versions]::HierarchyQuery = '5.0-preview'
4143
[vsteam_lib.Versions]::VariableGroups = '5.0-preview'
4244
[vsteam_lib.Versions]::Tfvc = '5.0'
@@ -57,6 +59,7 @@ function Set-VSTeamAPIVersion {
5759
[vsteam_lib.Versions]::Release = '5.1'
5860
[vsteam_lib.Versions]::DistributedTask = '5.1-preview'
5961
[vsteam_lib.Versions]::DistributedTaskReleased = ''
62+
[vsteam_lib.Versions]::Pipelines = '5.1-preview'
6063
[vsteam_lib.Versions]::HierarchyQuery = '5.1-preview'
6164
[vsteam_lib.Versions]::VariableGroups = '5.1-preview'
6265
[vsteam_lib.Versions]::Tfvc = '5.1'
@@ -77,6 +80,7 @@ function Set-VSTeamAPIVersion {
7780
[vsteam_lib.Versions]::Release = '4.0-preview'
7881
[vsteam_lib.Versions]::DistributedTask = '4.0-preview'
7982
[vsteam_lib.Versions]::DistributedTaskReleased = ''
83+
[vsteam_lib.Versions]::Pipelines = ''
8084
[vsteam_lib.Versions]::HierarchyQuery = ''
8185
[vsteam_lib.Versions]::VariableGroups = '4.0-preview'
8286
[vsteam_lib.Versions]::Tfvc = '4.0'
@@ -97,6 +101,7 @@ function Set-VSTeamAPIVersion {
97101
[vsteam_lib.Versions]::Release = '4.1-preview'
98102
[vsteam_lib.Versions]::DistributedTask = '4.1-preview'
99103
[vsteam_lib.Versions]::DistributedTaskReleased = ''
104+
[vsteam_lib.Versions]::Pipelines = ''
100105
[vsteam_lib.Versions]::HierarchyQuery = ''
101106
[vsteam_lib.Versions]::VariableGroups = '4.1-preview'
102107
[vsteam_lib.Versions]::Tfvc = '4.1'
@@ -117,6 +122,7 @@ function Set-VSTeamAPIVersion {
117122
[vsteam_lib.Versions]::Release = '3.0-preview'
118123
[vsteam_lib.Versions]::DistributedTask = '3.0-preview'
119124
[vsteam_lib.Versions]::DistributedTaskReleased = ''
125+
[vsteam_lib.Versions]::Pipelines = ''
120126
[vsteam_lib.Versions]::HierarchyQuery = ''
121127
[vsteam_lib.Versions]::VariableGroups = '' # Was introduced in Update 1
122128
[vsteam_lib.Versions]::TaskGroups = '3.0-preview'
@@ -137,6 +143,7 @@ function Set-VSTeamAPIVersion {
137143
[vsteam_lib.Versions]::Release = '3.1-preview'
138144
[vsteam_lib.Versions]::DistributedTask = '3.1-preview'
139145
[vsteam_lib.Versions]::DistributedTaskReleased = ''
146+
[vsteam_lib.Versions]::Pipelines = ''
140147
[vsteam_lib.Versions]::HierarchyQuery = ''
141148
[vsteam_lib.Versions]::VariableGroups = '3.1-preview' # Resource of DistributedTask area
142149
[vsteam_lib.Versions]::TaskGroups = '3.1-preview' # Resource of DistributedTask area
@@ -158,6 +165,7 @@ function Set-VSTeamAPIVersion {
158165
[vsteam_lib.Versions]::Release = '3.2-preview'
159166
[vsteam_lib.Versions]::DistributedTask = '3.2-preview'
160167
[vsteam_lib.Versions]::DistributedTaskReleased = ''
168+
[vsteam_lib.Versions]::Pipelines = ''
161169
[vsteam_lib.Versions]::HierarchyQuery = ''
162170
[vsteam_lib.Versions]::VariableGroups = '3.2-preview' # Resource of DistributedTask area
163171
[vsteam_lib.Versions]::TaskGroups = '3.2-preview' # Resource of DistributedTask area
@@ -179,6 +187,7 @@ function Set-VSTeamAPIVersion {
179187
[vsteam_lib.Versions]::Release = '5.1'
180188
[vsteam_lib.Versions]::DistributedTask = '6.0-preview'
181189
[vsteam_lib.Versions]::DistributedTaskReleased = '5.1'
190+
[vsteam_lib.Versions]::Pipelines = '5.1-preview'
182191
[vsteam_lib.Versions]::HierarchyQuery = '5.1-preview'
183192
[vsteam_lib.Versions]::VariableGroups = '5.1-preview.1'
184193
[vsteam_lib.Versions]::TaskGroups = '6.0-preview'
@@ -239,6 +248,10 @@ function Set-VSTeamAPIVersion {
239248
# Get-VSTeamOption -area 'distributedtask' -resource 'jobrequests'
240249
Write-Verbose "DistributedTaskReleased: $([vsteam_lib.Versions]::DistributedTaskReleased)"
241250

251+
# Testing pipelines
252+
# Get-VSTeamOption -area 'pipelines' -resource 'runs'
253+
Write-Verbose "Pipelines: $([vsteam_lib.Versions]::Pipelines)"
254+
242255
# Get-VSTeamOption -area 'Contribution' -resource 'HierarchyQuery'
243256
Write-Verbose "HierarchyQuery: $([vsteam_lib.Versions]::HierarchyQuery)"
244257

‎Source/Public/Test-VSTeamYamlPipeline.ps1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ function Test-VSTeamYamlPipeline {
3535
-Area pipelines `
3636
-id "$PipelineId/runs" `
3737
-Body ($body | ConvertTo-Json -Compress -Depth 100) `
38-
-Version $(_getApiVersion Build)
38+
-Version $(_getApiVersion Pipelines)
3939
}
4040
catch {
4141
if ($PSItem -match 'PipelineValidationException') {

‎Source/VSTeam.psd1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
RootModule = 'VSTeam.psm1'
1313

1414
# Version number of this module.
15-
ModuleVersion = '7.1.0'
15+
ModuleVersion = '7.1.1'
1616

1717
# Supported PSEditions
1818
CompatiblePSEditions = @('Core', 'Desktop')

‎Tests/function/tests/Test-VSTeamYamlPipeline.Tests.ps1‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Set-StrictMode -Version Latest
33
Describe 'VSTeamYamlPipeline' {
44
BeforeAll {
55
. "$PSScriptRoot\_testInitialize.ps1" $PSCommandPath
6-
6+
77
$testYamlPath = "$sampleFiles\azure-pipelines.test.yml"
88
Mock _getInstance { return 'https://dev.azure.com/test' }
99
Mock Invoke-RestMethod { Open-SampleFile 'pipelineDefYamlResult.json' }
@@ -16,7 +16,7 @@ Describe 'VSTeamYamlPipeline' {
1616

1717
Should -Invoke Invoke-RestMethod -Exactly -Scope It -Times 1 -ParameterFilter {
1818
$Uri -like "*https://dev.azure.com/test/project/_apis/pipelines/24/runs*" -and
19-
$Uri -like "*api-version=$(_getApiVersion Build)*" -and
19+
$Uri -like "*api-version=$(_getApiVersion Pipelines)*" -and
2020
$Body -like '*"PreviewRun":*true*' -and
2121
$Body -notlike '*YamlOverride*'
2222
}
@@ -27,7 +27,7 @@ Describe 'VSTeamYamlPipeline' {
2727

2828
Should -Invoke Invoke-RestMethod -Exactly -Scope It -Times 1 -ParameterFilter {
2929
$Uri -like "*https://dev.azure.com/test/project/_apis/pipelines/24/runs*" -and
30-
$Uri -like "*api-version=$(_getApiVersion Build)*" -and
30+
$Uri -like "*api-version=$(_getApiVersion Pipelines)*" -and
3131
$Body -like '*"PreviewRun":*true*' -and
3232
$Body -like '*YamlOverride*'
3333
}
@@ -40,12 +40,12 @@ Describe 'VSTeamYamlPipeline' {
4040

4141
Should -Invoke Invoke-RestMethod -Exactly -Scope It -Times 1 -ParameterFilter {
4242
$Uri -like "*https://dev.azure.com/test/project/_apis/pipelines/24/runs*" -and
43-
$Uri -like "*api-version=$(_getApiVersion Build)*" -and
43+
$Uri -like "*api-version=$(_getApiVersion Pipelines)*" -and
4444
$Body -like '*"PreviewRun":*true*' -and
4545
$Body -like '*YamlOverride*'
4646
}
4747
}
48-
48+
4949
It 'Should create Yaml result' {
5050
$yamlResult = Test-VSTeamYamlPipeline -projectName project -PipelineId 24 -FilePath $testYamlPath
5151

‎Tests/library/VersionsTests.cs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ public class VersionsTests
1515
[DataRow("GitV1", APIs.Git)]
1616
[DataRow("DistributedTaskV1", APIs.DistributedTask)]
1717
[DataRow("DistributedTaskReleasedV1", APIs.DistributedTaskReleased)]
18+
[DataRow("Pipelines", APIs.Pipelines)]
1819
[DataRow("VariableGroupsV1", APIs.VariableGroups)]
1920
[DataRow("TfvcV1", APIs.Tfvc)]
2021
[DataRow("PackagingV1", APIs.Packaging)]

0 commit comments

Comments
 (0)