Rule not finding field in JSON Configuration

[sapritchard]

Hi, I'm just starting to work with PSRule in an effort to migrate from an internally built infrastructure testing platform that uses Pester. Our infrastructure is defined in JSON configuration files with a custom schema. Our configurations will remain as they are I'll just be moving to PSRule rule modules for configuration validation and eventually configuration drift detection.

My problem that I'm struggling to work out and I'm sure it's just me understanding at this stage, I do read the docs (thank you for excellent documentation), is that if I collect a configuration file using a $config = Get-ChildItem -Path 'C:\file_path\' -Include 'datacenter.json' -Recurse then pipe that into my test rule $config | Assert-PSRule -Path 'C:\file_path\test.datacenter.Rule.yaml'. I get a failure of:

| REASON:
    | - Path .Type.datacenter.Name: The field '.Type.datacenter.Name' does not exist.

But when running supplying the config file as the value to the -InputPath parameter all works fine and I can pass or deliberately fail based on the values in the config file.

Can I please get any guidance on what I may be doing wrong, collecting files will be key as part of the effort and building out the validation pipeline in jenkins.

Config schema example:

{
"Type": {
		"datacenter": {
			"Name": [
				"DEV_LAB"
			]
		}
	}
}

Rule:

# Synopsis: Name array contains at least one member.
apiVersion: github.com/microsoft/PSRule/v1
kind: Rule
metadata:
  name: datacenter.name.member.count
  ref: VAF-011
spec:
  condition:
    field: Type.datacenter.Name
    greaterOrEquals: 1

[sapritchard]

Apologies wrong error message:

| REASON:
    | - Path Type.datacenter.Name: The field 'Type.datacenter.Name' does not exist.

[BernieWhite]

If you're using PSRule v2.9.0, then try adding -Format Json to the end of your Assert-PSRule command line.

The reason is because you are piping a file object to Assert-PSRule, and by default it's going to look at and analyze the file object instead of the content of the file. Since the file object doesn't have that property the rule failed as expected.

Also, you can simplify this if you want by removing the Get-ChildItem part.

e.g.

Assert-PSRule -Path .\file_path\test.datacenter.Rule.yaml -InputPath .\file_path\**\*.json -Format Json

---

Also noting there is changes to how this works in v3 which is preview, so if you are developing something new, be aware of these changes so you can avoid rework if you want to upgrade to v3 when it's GA.

You can read more about the changes here:

• https://microsoft.github.io/PSRule/v3/deprecations/#input-format-of-files-and-strings
• https://microsoft.github.io/PSRule/v3/concepts/formats/

[sapritchard]

Gotcha @BernieWhite I'll give that a go, thanks heaps. I do have a few questions but one thing at a time. Will let you know how I go.

[sapritchard]

Sorted thanks @BernieWhite