inspec/docs/resources/directory.md.erb
Kimberly Garmoe b0bcc35fda Add one comma in all docs & deletes two repeated sentences. (#2658)
Signed-off-by: kagarmoe <kgarmoe@chef.io>
2018-02-15 22:07:18 -05:00

30 lines
754 B
Text

---
title: About the directory Resource
platform: os
---
# directory
Use the `directory` InSpec audit resource to test if the file type is a directory. This is equivalent to using the `file` resource and the `be_directory` matcher, but provides a simpler and more direct way to test directories.
<br>
## Syntax
A `directory` resource block declares the location of the directory to be tested, and then one (or more) matchers.
describe directory('path') do
its('property') { should cmp 'value' }
end
<br>
## Properties
All of the properties available to `file` may be used with `directory`.
<br>
## Matchers
For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).