Fixing issue #363 (#367)

Author: DarqueWarrior

.docs/Get-VSTeamProject.md

@@ -59,7 +59,6 @@ Specifies the maximum number to return.
 ```yaml
 Type: Int32
 Parameter Sets: List
-Default value: 100
 ```
 
 ### Skip
@@ -69,7 +68,6 @@ Defines the number of team projects to skip. The default value is 0
 ```yaml
 Type: Int32
 Parameter Sets: List
-Default value: 0
 ```
 
 ### Id
@@ -99,6 +97,12 @@ Parameter Sets: ByID
 
 ## NOTES
 
+You can use PowerShell default values to set top to any value you like.
+
+$Global:PSDefaultParameterValues["*-vsteam*:top"] = 500
+
+However, this function is called by the Project cache which is used by the project validation code. If the value of top is not high enough validation may fail. By default this function returns all projects.
+
 <!-- #include "./common/prerequisites.md" -->
 
 ## RELATED LINKS

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 7.1.2
+
+Changed Get-VSTeamProject to return all projects by default instead of just the top 100. This change was made to address issue #363. If your project name was not in the top 100 projects validation would fail. Returning all projects can have performance issues. You can set the value for top used by setting a PowerShell default value:
+
+```powershell
+$Global:PSDefaultParameterValues["*-vsteam*:top"] = 500
+```
+
 ## 7.1.1
 
 Fixed bug in Test-VSTeamYamlPipeline by adding a Pipelines version value.

Source/Public/Get-VSTeamProject.ps1

@@ -7,10 +7,10 @@ function Get-VSTeamProject {
       [string] $StateFilter = 'WellFormed',
 
       [Parameter(ParameterSetName = 'List')]
-      [int] $Top = 100,
+      [int] $Top,
 
       [Parameter(ParameterSetName = 'List')]
-      [int] $Skip = 0,
+      [int] $Skip,
 
       [Parameter(ParameterSetName = 'ByID')]
       [Alias('ProjectID')]

Source/VSTeam.psd1

@@ -12,7 +12,7 @@
    RootModule           = 'VSTeam.psm1'
 
    # Version number of this module.
-   ModuleVersion        = '7.1.1'
+   ModuleVersion        = '7.1.2'
 
    # Supported PSEditions
    CompatiblePSEditions = @('Core', 'Desktop')

Tests/function/tests/Get-VSTeamProject.Tests.ps1

@@ -2,18 +2,18 @@ Set-StrictMode -Version Latest
 
 Describe 'VSTeamProject' {
    BeforeAll {
-      . "$PSScriptRoot\_testInitialize.ps1" $PSCommandPath   
+      . "$PSScriptRoot\_testInitialize.ps1" $PSCommandPath
       Mock _getInstance { return 'https://dev.azure.com/test' }
       Mock _getApiVersion { return '1.0-unitTests' } -ParameterFilter { $Service -eq 'Core' }
    }
 
    Context 'Get-VSTeamProject' {
       BeforeAll {
-         $env:TEAM_TOKEN = '1234'         
+         $env:TEAM_TOKEN = '1234'
 
          Mock Invoke-RestMethod { Open-SampleFile 'Get-VSTeamProject.json' }
          Mock Invoke-RestMethod { Open-SampleFile 'Get-VSTeamProject-NamePeopleTracker.json' } -ParameterFilter {
-            $Uri -like "*PeopleTracker*" 
+            $Uri -like "*PeopleTracker*"
          }
       }
 
@@ -28,7 +28,6 @@ Describe 'VSTeamProject' {
          Should -Invoke Invoke-RestMethod -Exactly -Times 1 -Scope It -ParameterFilter {
             $Uri -like "*https://dev.azure.com/test/_apis/projects*" -and
             $Uri -like "*api-version=$(_getApiVersion Core)*" -and
-            $Uri -like "*`$top=100*" -and
             $Uri -like "*stateFilter=WellFormed*"
          }
       }
@@ -52,7 +51,6 @@ Describe 'VSTeamProject' {
             $Uri -like "*https://dev.azure.com/test/_apis/projects*" -and
             $Uri -like "*api-version=$(_getApiVersion Core)*" -and
             $Uri -like "*`$skip=1*" -and
-            $Uri -like "*`$top=100*" -and
             $Uri -like "*stateFilter=WellFormed*"
          }
       }
@@ -64,7 +62,6 @@ Describe 'VSTeamProject' {
          Should -Invoke Invoke-RestMethod -Exactly -Times 1 -Scope It -ParameterFilter {
             $Uri -like "*https://dev.azure.com/test/_apis/projects*" -and
             $Uri -like "*api-version=$(_getApiVersion Core)*" -and
-            $Uri -like "*`$top=100*" -and
             $Uri -like "*stateFilter=All*"
          }
       }