mirror of
https://github.com/inspec/inspec
synced 2024-11-27 15:10:44 +00:00
4a203e647b
* Refactors csv resource Signed-off-by: kagarmoe <kgarmoe@chef.io> * Copy edits Signed-off-by: kagarmoe <kgarmoe@chef.io> * Copy edit Signed-off-by: kagarmoe <kgarmoe@chef.io> * Clarifies property example Signed-off-by: kagarmoe <kgarmoe@chef.io>
53 lines
1 KiB
Text
53 lines
1 KiB
Text
---
|
|
title: About the csv Resource
|
|
---
|
|
|
|
# csv
|
|
|
|
Use the `csv` InSpec audit resource to test configuration data in a CSV file.
|
|
|
|
<br>
|
|
|
|
## Syntax
|
|
|
|
A `csv` resource block declares the configuration data to be tested:
|
|
|
|
describe csv('file') do
|
|
its('name') { should cmp 'foo' }
|
|
end
|
|
|
|
where
|
|
|
|
* `'file'` is the path to a CSV file
|
|
* `name` is a configuration setting in a CSV file
|
|
* `should eq 'foo'` tests a value of `name` as read from a CSV file versus the value declared in the test
|
|
|
|
<br>
|
|
|
|
## Resource Parameter Examples
|
|
|
|
The following examples show how to use this InSpec audit resource.
|
|
|
|
### Test a CSV file
|
|
|
|
describe csv('some_file.csv') do
|
|
its('setting') { should eq 1 }
|
|
end
|
|
|
|
<br>
|
|
|
|
## Property Examples
|
|
|
|
### name
|
|
|
|
The `name` property tests the value of `name` as read from a CSV file compared to the value declared in the test.
|
|
|
|
its('name') { should cmp 'foo' }
|
|
|
|
<br>
|
|
|
|
## Matchers
|
|
|
|
For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
|
|
|
|
|