inspec/docs/resources/csv.md.erb

---
title: About the csv Resource
platform: os
---

# csv

Use the `csv` InSpec audit resource to test configuration data in a CSV file.

<br>

## Availability

### Installation

This resource is distributed along with InSpec itself. You can use it automatically.

### Version

This resource first became available in v1.0.0 of InSpec.

## 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>

## 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/).