Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-11-23 21:23:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updates cran resource doc (#2512)

Browse source 
Signed-off-by: kagarmoe <kgarmoe@chef.io>
This commit is contained in:
Kimberly Garmoe 2018-02-02 04:36:36 -08:00 committed by Adam Leff
parent d3a2957766
commit 3e7e806eba
1 changed files with 27 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
docs/resources/cran.md.erb
View file

@ -6,6 +6,8 @@ title: About the cran Resource
Use the `cran` InSpec audit resource to test R modules that are installed from CRAN package repository.
<br>
## Syntax
A `cran` resource block declares a package and (optionally) a package version:
@ -19,24 +21,9 @@ 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>
## Matchers
This 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 }
### version
The `version` matcher tests if the named package version is on the system:
its('version') { should eq '1.2.3' }
## Examples
## Resource Parameter Examples
The following examples show how to use this InSpec audit resource.
@ -51,4 +38,26 @@ The following examples show how to use this InSpec audit resource.
describe cran('DBI') do
it { should be_installed }
its('version') { should eq '0.5.1' }
end
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 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 }