feat: added overwrite mask switch to all depending on cmdlets (#536)

SebastianSchuetze · web-flow · commit e73cd24d7a32 · 2023-06-29T14:31:28.000+02:00
* feat: added overwritemask switch to all depending cmdlets

* test: added unit test

* fix: syntax error

* fix: syntax error

* fix: added missing heading

* docs: removed duplicate content

* docs: fixed syntax and copy past error
diff --git a/.docs/Add-VSTeamBuildPermission.md b/.docs/Add-VSTeamBuildPermission.md
@@ -101,6 +101,15 @@ Type: VSTeamProjectPermissions
 Required: True
 ```
 
+### OverwriteMask
+
+Switch to overwrite the mask values rather than merge them.
+
+```yaml
+Type: Switch
+Required: False
+```
+
 <!-- #include "./params/projectName.md" -->
 
 ## INPUTS
diff --git a/.docs/Add-VSTeamGitRepositoryPermission.md b/.docs/Add-VSTeamGitRepositoryPermission.md
@@ -72,6 +72,15 @@ Type: VSTeamGitRepositoryPermissions
 Required: True
 ```
 
+### OverwriteMask
+
+Switch to overwrite the mask values rather than merge them.
+
+```yaml
+Type: Switch
+Required: False
+```
+
 <!-- #include "./params/projectName.md" -->
 
 ## INPUTS
diff --git a/.docs/Add-VSTeamProjectPermission.md b/.docs/Add-VSTeamProjectPermission.md
@@ -51,6 +51,15 @@ Type: VSTeamProjectPermissions
 Required: True
 ```
 
+### OverwriteMask
+
+Switch to overwrite the mask values rather than merge them.
+
+```yaml
+Type: Switch
+Required: False
+```
+
 <!-- #include "./params/projectName.md" -->
 
 ## INPUTS
diff --git a/.docs/Add-VSTeamWorkItemAreaPermission.md b/.docs/Add-VSTeamWorkItemAreaPermission.md
@@ -65,6 +65,15 @@ Type: VSTeamWorkItemAreaPermissions
 Required: True
 ```
 
+### OverwriteMask
+
+Switch to overwrite the mask values rather than merge them.
+
+```yaml
+Type: Switch
+Required: False
+```
+
 <!-- #include "./params/projectName.md" -->
 
 ## INPUTS
diff --git a/.docs/Add-VSTeamWorkItemIterationPermission.md b/.docs/Add-VSTeamWorkItemIterationPermission.md
@@ -65,6 +65,15 @@ Type: VSTeamWorkItemIterationPermissions
 Required: True
 ```
 
+### OverwriteMask
+
+Switch to overwrite the mask values rather than merge them.
+
+```yaml
+Type: Switch
+Required: False
+```
+
 <!-- #include "./params/projectName.md" -->
 
 ## INPUTS
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## 7.13.2
+Merged [Pull Request](https://github.com/MethodsAndPractices/vsteam/pull/536) from [Sebastian Schütze](https://github.com/SebastianSchuetze) the following:
+- Fix missing switch OverwriteMask to all cmdlets who are dependant to Add-VSTeamAccessControlList
+
+
 ## 7.13.1
 Merged [Pull Request](https://github.com/MethodsAndPractices/vsteam/pull/532) from [Miguel Nieto](https://github.com/mnieto) the following:
 - Fix Set-VSTeamAccount Error on Module Import [531](https://github.com/MethodsAndPractices/vsteam/issues/531)
diff --git a/Source/Public/Add-VSTeamAccessControlEntry.ps1 b/Source/Public/Add-VSTeamAccessControlEntry.ps1
@@ -35,9 +35,9 @@ function Add-VSTeamAccessControlEntry {
       [Parameter(Mandatory = $true)]
       [ValidateRange(0, [int]::MaxValue)]
       [int] $DenyMask,
-      
+
       [Parameter(Mandatory = $false)]
-      [switch] $OverwriteMask = $false
+      [switch] $OverwriteMask
    )
    process {
 
diff --git a/Source/Public/Add-VSTeamBuildPermission.ps1 b/Source/Public/Add-VSTeamBuildPermission.ps1
@@ -35,7 +35,10 @@ function Add-VSTeamBuildPermission {
       [vsteam_lib.BuildPermissions]$Allow,
 
       [parameter(Mandatory = $false)]
-      [vsteam_lib.BuildPermissions]$Deny
+      [vsteam_lib.BuildPermissions]$Deny,
+
+      [Parameter(Mandatory = $false)]
+      [switch] $OverwriteMask
    )
 
    process {
@@ -66,6 +69,7 @@ function Add-VSTeamBuildPermission {
          -Descriptor $Descriptor `
          -Token $token `
          -AllowMask ([int]$Allow) `
-         -DenyMask ([int]$Deny)
+         -DenyMask ([int]$Deny) `
+         -OverwriteMask:$OverwriteMask.IsPresent
    }
 }
diff --git a/Source/Public/Add-VSTeamGitRepositoryPermission.ps1 b/Source/Public/Add-VSTeamGitRepositoryPermission.ps1
@@ -56,7 +56,10 @@ function Add-VSTeamGitRepositoryPermission {
       [vsteam_lib.GitRepositoryPermissions]$Allow,
 
       [parameter(Mandatory = $false)]
-      [vsteam_lib.GitRepositoryPermissions]$Deny
+      [vsteam_lib.GitRepositoryPermissions]$Deny,
+
+      [Parameter(Mandatory = $false)]
+      [switch] $OverwriteMask
    )
 
    process {
@@ -102,6 +105,7 @@ function Add-VSTeamGitRepositoryPermission {
          -Descriptor $Descriptor `
          -Token $token `
          -AllowMask ([int]$Allow) `
-         -DenyMask ([int]$Deny)
+         -DenyMask ([int]$Deny) `
+         -OverwriteMask:$OverwriteMask.IsPresent
    }
 }
diff --git a/Source/Public/Add-VSTeamProjectPermission.ps1 b/Source/Public/Add-VSTeamProjectPermission.ps1
@@ -32,7 +32,10 @@ function Add-VSTeamProjectPermission {
       [vsteam_lib.ProjectPermissions]$Allow,
 
       [parameter(Mandatory = $false)]
-      [vsteam_lib.ProjectPermissions]$Deny
+      [vsteam_lib.ProjectPermissions]$Deny,
+
+      [Parameter(Mandatory = $false)]
+      [switch] $OverwriteMask
    )
 
    process {
@@ -57,6 +60,7 @@ function Add-VSTeamProjectPermission {
          -Descriptor $Descriptor `
          -Token $token `
          -AllowMask ([int]$Allow) `
-         -DenyMask ([int]$Deny)
+         -DenyMask ([int]$Deny) `
+         -OverwriteMask:$OverwriteMask.IsPresent
    }
 }
diff --git a/Source/Public/Add-VSTeamWorkItemAreaPermission.ps1 b/Source/Public/Add-VSTeamWorkItemAreaPermission.ps1
@@ -45,7 +45,10 @@ function Add-VSTeamWorkItemAreaPermission {
       [vsteam_lib.WorkItemAreaPermissions]$Allow,
 
       [parameter(Mandatory = $false)]
-      [vsteam_lib.WorkItemAreaPermissions]$Deny
+      [vsteam_lib.WorkItemAreaPermissions]$Deny,
+
+      [Parameter(Mandatory = $false)]
+      [switch] $OverwriteMask
    )
 
    process {
@@ -106,6 +109,7 @@ function Add-VSTeamWorkItemAreaPermission {
          -Descriptor $Descriptor `
          -Token $token `
          -AllowMask ([int]$Allow) `
-         -DenyMask ([int]$Deny)
+         -DenyMask ([int]$Deny) `
+         -OverwriteMask:$OverwriteMask.IsPresent
    }
 }
diff --git a/Source/Public/Add-VSTeamWorkItemIterationPermission.ps1 b/Source/Public/Add-VSTeamWorkItemIterationPermission.ps1
@@ -45,7 +45,10 @@ function Add-VSTeamWorkItemIterationPermission {
       [vsteam_lib.WorkItemIterationPermissions]$Allow,
 
       [parameter(Mandatory = $false)]
-      [vsteam_lib.WorkItemIterationPermissions]$Deny
+      [vsteam_lib.WorkItemIterationPermissions]$Deny,
+
+      [Parameter(Mandatory = $false)]
+      [switch] $OverwriteMask
    )
 
    process {
@@ -106,6 +109,7 @@ function Add-VSTeamWorkItemIterationPermission {
          -Descriptor $Descriptor `
          -Token $token `
          -AllowMask ([int]$Allow) `
-         -DenyMask ([int]$Deny)
+         -DenyMask ([int]$Deny) `
+         -OverwriteMask:$OverwriteMask.IsPresent
    }
 }
diff --git a/Source/VSTeam.psd1 b/Source/VSTeam.psd1
@@ -12,7 +12,7 @@
    RootModule           = 'VSTeam.psm1'
 
    # Version number of this module.
-   ModuleVersion        = '7.13.1'
+   ModuleVersion        = '7.13.2'
 
    # Supported PSEditions
    CompatiblePSEditions = @('Core', 'Desktop')
diff --git a/Tests/function/tests/Add-VSTeamProjectPermission.Tests.ps1 b/Tests/function/tests/Add-VSTeamProjectPermission.Tests.ps1
@@ -98,5 +98,21 @@ Describe 'VSTeamProjectPermission' {
             $Method -eq "Post"
          }
       }
+
+      It 'OverwriteMask switch should pass to Invoke-RestMethod' {
+         Add-VSTeamProjectPermission -Project $projectResultObject -User $userSingleResultObject -Allow ([vsteam_lib.ProjectPermissions]'GENERIC_READ,GENERIC_WRITE,WORK_ITEM_DELETE,RENAME') -Deny ([vsteam_lib.ProjectPermissions]'CHANGE_PROCESS,VIEW_TEST_RESULTS') -OverwriteMask
+
+         Should -Invoke Invoke-RestMethod -Exactly -Times 1 -Scope It -ParameterFilter {
+            $Uri -like "https://dev.azure.com/test/_apis/accesscontrolentries/52d39943-cb85-4d7f-8fa8-c6baac873819*" -and
+            $Uri -like "*api-version=$(_getApiVersion Core)*" -and
+            $Body -like "*`"token`": `"`$PROJECT:vstfs:///Classification/TeamProject/010d06f0-00d5-472a-bb47-58947c230876`",*" -and
+            $Body -like "*`"descriptor`": `"Microsoft.IdentityModel.Claims.ClaimsIdentity;788df857-dcd8-444d-885e-bff359bc1982\\test@testuser.com`",*" -and
+            $Body -like "*`"allow`": 73731,*" -and
+            $Body -like "*`"deny`": 8389120,*" -and
+            $Body -like "*`"merge`": false,*" -and
+            $Method -eq "Post"
+         }
+      }
+
    }
 }

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,10 @@ function Add-VSTeamBuildPermission {`
`35`	`35`	`[vsteam_lib.BuildPermissions]$Allow,`
`36`	`36`
`37`	`37`	`[parameter(Mandatory = $false)]`
`38`		`- [vsteam_lib.BuildPermissions]$Deny`
	`38`	`+ [vsteam_lib.BuildPermissions]$Deny,`
	`39`	`+`
	`40`	`+ [Parameter(Mandatory = $false)]`
	`41`	`+ [switch] $OverwriteMask`
`39`	`42`	`)`
`40`	`43`
`41`	`44`	`process {`
`@@ -66,6 +69,7 @@ function Add-VSTeamBuildPermission {`
`66`	`69`	-Descriptor $Descriptor `
`67`	`70`	-Token $token `
`68`	`71`	-AllowMask ([int]$Allow) `
`69`		`- -DenyMask ([int]$Deny)`
	`72`	+ -DenyMask ([int]$Deny) `
	`73`	`+ -OverwriteMask:$OverwriteMask.IsPresent`
`70`	`74`	`}`
`71`	`75`	`}`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,10 @@ function Add-VSTeamGitRepositoryPermission {`
`56`	`56`	`[vsteam_lib.GitRepositoryPermissions]$Allow,`
`57`	`57`
`58`	`58`	`[parameter(Mandatory = $false)]`
`59`		`- [vsteam_lib.GitRepositoryPermissions]$Deny`
	`59`	`+ [vsteam_lib.GitRepositoryPermissions]$Deny,`
	`60`	`+`
	`61`	`+ [Parameter(Mandatory = $false)]`
	`62`	`+ [switch] $OverwriteMask`
`60`	`63`	`)`
`61`	`64`
`62`	`65`	`process {`
`@@ -102,6 +105,7 @@ function Add-VSTeamGitRepositoryPermission {`
`102`	`105`	-Descriptor $Descriptor `
`103`	`106`	-Token $token `
`104`	`107`	-AllowMask ([int]$Allow) `
`105`		`- -DenyMask ([int]$Deny)`
	`108`	+ -DenyMask ([int]$Deny) `
	`109`	`+ -OverwriteMask:$OverwriteMask.IsPresent`
`106`	`110`	`}`
`107`	`111`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,10 @@ function Add-VSTeamProjectPermission {`
`32`	`32`	`[vsteam_lib.ProjectPermissions]$Allow,`
`33`	`33`
`34`	`34`	`[parameter(Mandatory = $false)]`
`35`		`- [vsteam_lib.ProjectPermissions]$Deny`
	`35`	`+ [vsteam_lib.ProjectPermissions]$Deny,`
	`36`	`+`
	`37`	`+ [Parameter(Mandatory = $false)]`
	`38`	`+ [switch] $OverwriteMask`
`36`	`39`	`)`
`37`	`40`
`38`	`41`	`process {`
`@@ -57,6 +60,7 @@ function Add-VSTeamProjectPermission {`
`57`	`60`	-Descriptor $Descriptor `
`58`	`61`	-Token $token `
`59`	`62`	-AllowMask ([int]$Allow) `
`60`		`- -DenyMask ([int]$Deny)`
	`63`	+ -DenyMask ([int]$Deny) `
	`64`	`+ -OverwriteMask:$OverwriteMask.IsPresent`
`61`	`65`	`}`
`62`	`66`	`}`