inspec/docs/resources/cran.md.erb
Unknown 5c1467dfe9 Update software name from InSpec to Chef Inspec
Signed-off-by: IanMadd <maddaus@protonmail.com>
2019-04-29 15:16:56 -04:00

74 lines
1.4 KiB
Text

---
title: About the cran Resource
platform: linux
---
# cran
Use the `cran` Chef InSpec audit resource to test R modules that are installed from CRAN package repository.
<br>
## Availability
### Installation
This resource is distributed along with Chef InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.43.5 of InSpec.
## Syntax
A `cran` resource block declares a package and (optionally) a package version:
describe cran('package_name') do
it { should be_installed }
end
where
* `'package_name'` is the name of the package, such as `'DBI'`
* `be_installed` tests to see if the package described above is installed
<br>
## Examples
The following examples show how to use this Chef InSpec audit resource.
### Test if DBI is installed on the system
describe cran('DBI') do
it { should be_installed }
end
### Test if DBI 0.5.1 is installed on the system
describe cran('DBI') do
it { should be_installed }
its('version') { should eq '0.5.1' }
end
<br>
## Property Examples
### version
The `version` property tests if the named package version is on the system:
its('version') { should eq '1.2.3' }
<br>
## Matchers
This Chef InSpec audit resource has the following matchers:
### be_installed
The `be_installed` matcher tests if the named package is installed on the system:
it { should be_installed }