[Test-ObjectGraph] Parents of failing item are also included in the output

[ykuijs]

When the cmdlet finds an issue in the data, the output also contains all parents of that item. This means that a single (small) issue in the data can result in big list of errors. Would be great to either:

• Add an -IgnoreParent parameter that ignores all parent errors
• Or change the default behaviour to not include parents add an -IncludeParents parameter to specify that you are interested in the parents as well.

Reproduction:

$data = @{
    NonNodeData = @{
        AzureAD = @{
            IncorrectParameterName = @(
                @{
                    Param1 = 8
                }
            )
        }
    }
}

$schema = @{
    NonNodeData = @{
        '@Type' = 'PSMapNode'
        AzureAD = @{
            '@Type' = 'PSMapNode'
        }
    }
}

$result = $data | Test-Object $schema
$result

Output:

Path                Value                        Valid Issue
----                -----                        ----- -----
NonNodeData.AzureAD @{IncorrectPa…=@(…)}          [X]  The following nodes are not accepted: IncorrectPa…
NonNodeData         @{AzureAD=@{IncorrectPa…=…}}  [X]  The following nodes are not accepted: AzureAD
                    @{NonNodeData=@{AzureAD=…}}   [X]  The following nodes are not accepted: NonNodeData

The first issue is the actual issue, but the bottom two issues are parents of the top issue. If you resolve the top issue, the bottom two are automatically fixed as well.

There is no specific action needed for fixing the bottom two issues, so that is why I would like to be able to filter those from the output.

[iRon7]

This will be fixed from version 0.3.3:

$data | Test-Object $schema

Path                Value                Valid Issue
----                -----                ----- -----
NonNodeData.AzureAD @{IncorrectPa…=@(…)}  [X]  The following nodes are not accepted: IncorrectParameterName

But they will still be listed in -Elaborate mode:

$data | Test-Object $schema -Elaborate

Path                Value                        Valid Issue
----                -----                        ----- -----
NonNodeData         @{AzureAD=@{IncorrectPa…=…}}  [V]  The node or value is of type 'PSMapNode'
NonNodeData.AzureAD @{IncorrectPa…=@(…)}          [V]  The node or value is of type 'PSMapNode'
NonNodeData.AzureAD @{IncorrectPa…=@(…)}          [X]  The following nodes are not accepted: IncorrectParameterName
NonNodeData         @{AzureAD=@{IncorrectPa…=…}}  [X]  The following nodes are not accepted: AzureAD
                    @{NonNodeData=@{AzureAD=…}}   [X]  The following nodes are not accepted: NonNodeData

[iRon7]

Reopen this issue, as it impacts requirement formulars.
A minimized example might be a requirement to negate a test branch.
A positive approach is usual:

$Schema = @{
    Parent = @{
        '@Type' = 'PSListNode'
        AnInt = @{ '@Type' = 'Int' }
    }
}
@{ Parent = 1, 2, 3 } | Test-ObjectGraph $Schema | Should -BeNullOrEmpty

A negative approach might be that none of the child nodes should be a string, the schema for this should be something like:

$Schema = @{
    Parent = @{                       # any child node is allowed except a child that contains a string value
        '@Type' = 'PSListNode'
        '@Required' = 'Not AString'
        '@AllowExtraNodes' = $true
        AString = @{ '@Type' = 'String' }
    }
}
@{ Parent = 1, 2, 3 } | Test-ObjectGraph $Schema | Should -BeNullOrEmpty

But this isn't working as expected and requires an additional complicated Result class enhancement, implementation and further testing...