Sha256: 634b4c43b38518ebe48d4e3f62dff214d95653c2e0e8d9489ada07ae7861dcca
Contents?: true
Size: 1.9 KB
Versions: 20
Compression:
Stored size: 1.9 KB
Contents
---
title: About the cpan Resource
platform: linux
---
# cpan
Use the `cpan` InSpec audit resource to test Perl modules that are installed by system packages or the CPAN installer.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.43.5 of InSpec.
## Syntax
A `cpan` resource block declares a package and (optionally) a package version:
describe cpan('package_name') do
it { should be_installed }
end
where
* `'package_name'` is the name of the package, such as `'DBD::Pg'`
* `be_installed` tests to see if the package described above is installed
<br>
## Resource Parameters
This resource uses package names and perl library paths as resource parameters.
<br>
## Resource Parameter Examples
### Test if DBD::Pg is installed on the system
describe cpan('DBD:Pg') do
it { should be_installed }
end
### Test if DBD::Pg 3.7.0 is installed on the system
describe cpan('DBD::Pg') do
it { should be_installed }
its('version') { should eq '3.7.0' }
end
### Test if DBD::Pg is installed within a custom PERL5LIB path on the system
Hint: You can pass multiple paths separated with a colon
`/path/to/perl5/lib:/usr/share/perl5/vendor_perl/lib/perl5`
describe cpan('DBD::Pg', '/home/jdoe/perl5/lib/perl5') do
it { should be_installed }
end
<br>
## Property Examples
The following examples show how to use this InSpec audit resource.
### version
The `version` property tests if the named package version is on the system:
its('version') { should eq '1.2.3' }
<br>
## Matchers
For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
### be_installed
The `be_installed` matcher tests if the named package is installed on the system:
it { should be_installed }
Version data entries
20 entries across 20 versions & 2 rubygems