mirror of
https://github.com/inspec/inspec
synced 2024-12-24 03:53:15 +00:00
40 lines
947 B
Text
40 lines
947 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>
|
|
|
|
## 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 `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/).
|