mirror of
https://github.com/inspec/inspec
synced 2024-11-23 13:13:22 +00:00
76 lines
1.5 KiB
Text
76 lines
1.5 KiB
Text
---
|
|
title: About the json Resource
|
|
---
|
|
|
|
# json
|
|
|
|
Use the `json` InSpec audit resource to test data in a JSON file.
|
|
|
|
## Syntax
|
|
|
|
A `json` resource block declares the data to be tested. Assume the following JSON file:
|
|
|
|
{
|
|
"name" : "hello",
|
|
"meta" : {
|
|
"creator" : "John Doe"
|
|
},
|
|
"array": [
|
|
"zero",
|
|
"one"
|
|
]
|
|
}
|
|
|
|
This file can be queried using:
|
|
|
|
describe json('/path/to/name.json') do
|
|
its('name') { should eq 'hello' }
|
|
its(['meta','creator']) { should eq 'John Doe' }
|
|
its(['array', 1]) { should eq 'one' }
|
|
end
|
|
|
|
where
|
|
|
|
* `name` is a configuration setting in a JSON file
|
|
* `should eq 'foo'` tests a value of `name` as read from a JSON file versus the value declared in the test
|
|
|
|
|
|
## Matchers
|
|
|
|
This InSpec audit resource has the following matchers:
|
|
|
|
### be
|
|
|
|
<%= partial "/shared/matcher_be" %>
|
|
|
|
### cmp
|
|
|
|
<%= partial "/shared/matcher_cmp" %>
|
|
|
|
### eq
|
|
|
|
<%= partial "/shared/matcher_eq" %>
|
|
|
|
### include
|
|
|
|
<%= partial "/shared/matcher_include" %>
|
|
|
|
### match
|
|
|
|
<%= partial "/shared/matcher_match" %>
|
|
|
|
### name
|
|
|
|
The `name` matcher tests the value of `name` as read from a JSON file versus the value declared in the test:
|
|
|
|
its('name') { should eq 'foo' }
|
|
|
|
## Examples
|
|
|
|
The following examples show how to use this InSpec audit resource.
|
|
|
|
### Test a cookbook version in a policyfile.lock.json file
|
|
|
|
describe json('policyfile.lock.json') do
|
|
its(['cookbook_locks', 'omnibus', 'version']) { should eq('2.2.0') }
|
|
end
|