Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add SetAndCheckTenantSetting functional testing utility function #1448

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Add SetAndCheckTenantSetting functional testing utility function #1448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3839152
Add SetAndCheckTenantSetting function to functional test utilities
schrolla Nov 1, 2024
42dff7a
Use SetAndTest utility function to retry failed tenant setting precon…
schrolla Nov 1, 2024
6625d2f
* Add WaitOnFirstCheck optional parameter to `SetAndCheckTenantSetting`
schrolla Dec 2, 2024
2031b2f
Add use of `SetAndCheckTenantSetting` to MS.POWERPLATFORM.3.1v1 tests
schrolla Dec 2, 2024
bc0359d
Add use of `SetAndCheckTenantSetting` function throughout PnP testplan
schrolla Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 99 additions & 32 deletions Testing/Functional/Products/FunctionalTestUtils.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,49 +264,49 @@ function UpdateConditionalAccessPolicyByName{
}
}

function UpdateCachedConditionalAccessPolicyByName{
<#
.SYNOPSIS
Wrapper function to locate a given conditional access policy by name for update within an provider setting export.
.PARAMETER DisplayName
The DisplayName of the Directory Setting to be updated.
.PARAMETER Updates
A hashtable of key/value pairs used as a splat for the Update-MgBetaDirectorySetting commandlet.
.PARAMETER OutputFolder
The folder containing the original and updated provider settings exports.
.NOTES
If more than one conditional access policy has the same DisplayName then only the first is updated.
#>
function UpdateCachedConditionalAccessPolicyByName {
<#
.SYNOPSIS
Wrapper function to locate a given conditional access policy by name for update within an provider setting export.
.PARAMETER DisplayName
The DisplayName of the Directory Setting to be updated.
.PARAMETER Updates
A hashtable of key/value pairs used as a splat for the Update-MgBetaDirectorySetting commandlet.
.PARAMETER OutputFolder
The folder containing the original and updated provider settings exports.
.NOTES
If more than one conditional access policy has the same DisplayName then only the first is updated.
#>
[CmdletBinding()]
param (
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[string]
$DisplayName,
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[hashtable]
$Updates,
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[string]
$OutputFolder
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[string]
$DisplayName,
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[hashtable]
$Updates,
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[string]
$OutputFolder
)

$ProviderExport = LoadProviderExport($OutputFolder)

$ConditionalAccessPolicies = $ProviderExport.conditional_access_policies
$Index = $ConditionalAccessPolicies.indexof($($ConditionalAccessPolicies.Where{$_.DisplayName -eq $DisplayName}))
$Index = $ConditionalAccessPolicies.indexof($($ConditionalAccessPolicies.Where{ $_.DisplayName -eq $DisplayName }))

if (-1 -ne $Index){
$Updates.Keys | ForEach-Object{
if (-1 -ne $Index) {
$Updates.Keys | ForEach-Object {
try {
$Update = $Updates.Item($_)
$Policy = $ConditionalAccessPolicies[$Index]
Set-NestedMemberValue -InputObject $Policy -MemberPath $_ -Value $Update
$Update = $Updates.Item($_)
$Policy = $ConditionalAccessPolicies[$Index]
Set-NestedMemberValue -InputObject $Policy -MemberPath $_ -Value $Update
}
catch {
Write-Error "Exception: UpdateCachedConditionalAccessPolicyByName failed"
Write-Error "Exception: UpdateCachedConditionalAccessPolicyByName failed"
}
}

Expand Down Expand Up @@ -334,3 +334,70 @@ function LoadTestResults() {
$IntermediateTestResults = Get-Content "$OutputFolder/TestResults.json" -Raw | ConvertFrom-Json
$IntermediateTestResults
}

function SetAndCheckTenantSetting {
<#
.SYNOPSIS
Function executes one script block until the second block registers it as successful or timeout occurs.
.PARAMETER SetBlock
Script block used to set the tenant setting value
.PARAMETER CheckBlock
A hashtable of key/value pairs used as a splat for the Update-MgBetaDirectorySetting commandlet.
.PARAMETER Retries
Number of times to retry the set block before failing (0 - 10)
.PARAMETER WaitInterval
Number of seconds to wait before each check, except the first which always checks immediately (0 - 3600)
.PARAMETER WaitOnFirstCheck
Delay first check by WaitInterval if true, otherwise check immediately (Default: True)
.NOTES
If the check block does not return true after the last retry, function will throw an error.
#>
[CmdletBinding()]
param (
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[string]
$SetBlock,
[Parameter(Mandatory = $true)]
[ValidateNotNullOrEmpty()]
[string]
$CheckBlock,
[Parameter(Mandatory = $false)]
[ValidateRange(0,10)]
[int]
$Retries = 3,
[Parameter(Mandatory = $false)]
[ValidateRange(0,3600)]
[int]
$WaitInterval = 10,
[Parameter(Mandatory = $false)]
[switch]
$WaitOnFirstCheck = $False
)
$SetAttempts = 0

try {
$SetFunc = [ScriptBlock]::Create($SetBlock)
$CheckFunc = [ScriptBlock]::Create($CheckBlock)
do {
Write-Debug("Running set block: $($SetFunc.Ast.EndBlock)...")
Invoke-Command -ScriptBlock $SetFunc

# Sleep if not first check or option to always wait is set
if($SetAttempts -ne 0 -or $WaitOnFirstCheck) {
Write-Debug("Sleeping for $WaitInterval seconds...")
Start-Sleep $WaitInterval
}
Write-Debug("Running check block: $($CheckFunc.Ast.EndBlock)...")
$CheckSucceeded = Invoke-Command -ScriptBlock $CheckFunc
Write-Verbose("(Attempt $SetAttempts) Check block result = $CheckSucceeded")
++$SetAttempts
} while(-not $CheckSucceeded -and $SetAttempts -lt $Retries)

if(-not $CheckSucceeded) {
throw "Unable to set value after $SetAttempts attempts."
}
} catch {
throw "Error executing script block: $_.StackTrace"
}
}
14 changes: 12 additions & 2 deletions Testing/Functional/Products/TestPlans/powerplatform.testplan.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,12 +90,22 @@ TestPlan:
Tests:
- TestDescription: MS.POWERPLATFORM.3.1v1 Non-Compliant case - Power Platform tenant isolation is NOT enabled
Preconditions:
- Command: '$guid = (Get-AdminPowerAppEnvironment -Default).EnvironmentName | Select-String -Pattern "[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$" -AllMatches | Select-Object -ExpandProperty Matches | Select-Object -ExpandProperty Value; $iso = Get-PowerAppTenantIsolationPolicy -TenantId $guid; $iso.psobject.properties.value.isDisabled = $true; Set-PowerAppTenantIsolationPolicy -TenantId $guid -TenantIsolationPolicy $iso'
- Command: SetAndCheckTenantSetting
Splat:
SetBlock: '$guid = (Get-AdminPowerAppEnvironment -Default).EnvironmentName | Select-String -Pattern "[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$" -AllMatches | Select-Object -ExpandProperty Matches | Select-Object -ExpandProperty Value; $iso = Get-PowerAppTenantIsolationPolicy -TenantId $guid; $iso.psobject.properties.value.isDisabled = $true; Set-PowerAppTenantIsolationPolicy -TenantId $guid -TenantIsolationPolicy $iso'
CheckBlock: '$guid = (Get-AdminPowerAppEnvironment -Default).EnvironmentName | Select-String -Pattern "[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$" -AllMatches | Select-Object -ExpandProperty Matches | Select-Object -ExpandProperty Value; $iso = Get-PowerAppTenantIsolationPolicy -TenantId $guid; $iso.psobject.properties.value.isDisabled -eq $True'
Retries: 3
WaitInterval: 10
Postconditions: []
ExpectedResult: false
- TestDescription: MS.POWERPLATFORM.3.1v1 Compliant case - Power Platform tenant isolation is enabled.
Preconditions:
- Command: '$guid = (Get-AdminPowerAppEnvironment -Default).EnvironmentName | Select-String -Pattern "[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$" -AllMatches | Select-Object -ExpandProperty Matches | Select-Object -ExpandProperty Value; $iso = Get-PowerAppTenantIsolationPolicy -TenantId $guid; $iso.psobject.properties.value.isDisabled = $false; Set-PowerAppTenantIsolationPolicy -TenantId $guid -TenantIsolationPolicy $iso'
- Command: SetAndCheckTenantSetting
Splat:
SetBlock: '$guid = (Get-AdminPowerAppEnvironment -Default).EnvironmentName | Select-String -Pattern "[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$" -AllMatches | Select-Object -ExpandProperty Matches | Select-Object -ExpandProperty Value; $iso = Get-PowerAppTenantIsolationPolicy -TenantId $guid; $iso.psobject.properties.value.isDisabled = $false; Set-PowerAppTenantIsolationPolicy -TenantId $guid -TenantIsolationPolicy $iso'
CheckBlock: '$guid = (Get-AdminPowerAppEnvironment -Default).EnvironmentName | Select-String -Pattern "[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$" -AllMatches | Select-Object -ExpandProperty Matches | Select-Object -ExpandProperty Value; $iso = Get-PowerAppTenantIsolationPolicy -TenantId $guid; $iso.psobject.properties.value.isDisabled -eq $False'
Retries: 3
WaitInterval: 10
Postconditions: []
ExpectedResult: true

Expand Down
Loading
Loading