Repository navigation
[Test-ObjectGraph] When the schema specifies that a parameter is required and another parameter is not correct, that other parameter is not listed as failed. #129
Description
When the schema specifies that a parameter is required and another parameter is not correct (incorrect type or using parameter that is unknown), those other parameters are not listed as failed.
Reproduction:
- DefaultLength is specified as string, but the schema expects and int.
- The property DoesNotExist is not specified in the schema.
$data = @{
NonNodeData = @{
AzureAD = @{
AuthenticationMethodPolicy = @(
@{
DefaultLength = 'string'
DoesNotExist = 'string'
DefaultLifetimeInMinutes = 10
}
)
}
}
}
$schema = @{
NonNodeData = @{
'@Type' = 'PSMapNode'
AzureAD = @{
'@Type' = 'PSMapNode'
AuthenticationMethodPolicy = @(
@{
'@Type' = 'PSMapNode'
DefaultLength = @{ '@Type' = 'Int' }
DefaultLifetimeInMinutes = @{ '@Type' = 'Int' }
Ensure = @{ '@Type' = 'String' }
Id = @{ '@Type' = 'String'; '@Required' = $true }
IncludeTargets = @(
@{
'@Type' = 'PSMapNode'
Id = @{ '@Type' = 'String' }
TargetType = @{ '@Type' = 'String' }
}
)
IsUsableOnce = @{ '@Type' = 'Bool' }
MaximumLifetimeInMinutes = @{ '@Type' = 'Int' }
MinimumLifetimeInMinutes = @{ '@Type' = 'Int' }
State = @{ '@Type' = 'String' }
}
)
}
}
}
$result = $data | Test-Object $schema
$resultOutput:
Path Value Valid Issue
---- ----- ----- -----
NonNodeData.AzureAD.AuthenticationMethodPolicy[0] @{DefaultLeng…='string';DefaultLife…=10} [X] The required node condition 'Id' is not met
NonNodeData.AzureAD.AuthenticationMethodPolicy @(@{DefaultLeng…=…;…}) [X] The following nodes are not accepted: 0
NonNodeData.AzureAD @{Authenticat…=@(…)} [X] The following nodes are not accepted: Authenticat…
NonNodeData @{AzureAD=@{Authenticat…=…}} [X] The following nodes are not accepted: AzureAD
@{NonNodeData=@{AzureAD=…}} [X] The following nodes are not accepted: NonNodeDataThe incorrect type of the DefaultLength parameter and the fact that the DoesNotExist parameter is unknown are missing in the list. I would have expected that the code would output all discovered issues.
Metadata
Metadata
Assignees
Labels
No labels
Activity
iRon7 commentedon Oct 20, 2025
Based on this feedback, I have implemented an result class to better handle the result output.
The output of the concerned test is now:
And elaborated (
-Elaborate):Background
Below is some background information on the challenges with I would like to document and confirm a few statements in my Pester tests.
The previous version, had basically two possible output modes for each node test:
-not $ValidateOnly), in this mode the results record is immediately released to the pipeline-ValidateOnly) when a node is found invalid, the specific node test notifies the parent test which checks other requirements and options and notifies its own parent and so on.This Validation mode is also used in the output mode to determine whether a branch in an object graph is valid or not.
Unfortunately as appears from this issue, it isn't enough to test whether a object graph branch is valid or not, it is (sometimes) also required to determine (and feedback) why it (or multiple branches) failed. Hence the
resultclass I have created for the new version. Thisresultclass has now an additional 3rd collection mode that is able to collect the results of a branch and pass that to the parent test.Note here that:
$falseresult) or a result collection to the pipeline (as that blur the general pipeline immediate output mode)Example
A specific configuration has some CMO and FMO nodes:
For a specific FMO application it is important that the company node has at least 1 valid
FMOnode in the list:The example
$Datais accepted ($data | Test-Object $schema) even there are some nodes in thecompanylist invalid (these object-graph branches might be inspected but rejected until an acceptableFMOnode is found):For another company wide application you might want to confirm that all the nodes in the
companyare eitherCMO- orFMOcompliant:The above
$Dataconfiguration will fail because there is an illegalFMOID:But might pass if there e.g. only (valid)
FMOentries...The branch that contains this enhancements, can be found here: https://github.com/iRon7/ObjectGraphTools/tree/iRon7-Updates