2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-12-18 09:03:12 +00:00
inspec/docs/resources/pip.md.erb

78 lines
1.7 KiB
Text
Raw Normal View History

2016-09-22 12:43:57 +00:00
---
title: About the pip Resource
platform: os
2016-09-22 12:43:57 +00:00
---
# pip
Use the `pip` InSpec audit resource to test packages that are installed using the Python PIP 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.0.0 of InSpec.
## Syntax
2016-09-22 12:43:57 +00:00
A `pip` resource block declares a package and (optionally) a package version:
describe pip('package_name') do
2016-09-22 12:43:57 +00:00
it { should be_installed }
end
where
* `'package_name'` is the name of the package, such as `'Jinja2'`
* `be_installed` tests to see if the package described above is installed
2016-09-22 12:43:57 +00:00
<br>
2016-09-22 12:43:57 +00:00
## Examples
2016-09-22 12:43:57 +00:00
The following examples show how to use this InSpec audit resource.
2016-09-22 12:43:57 +00:00
### Test if Jinja2 is installed on the system
2016-09-22 12:43:57 +00:00
describe pip('Jinja2') do
it { should be_installed }
end
2016-09-22 12:43:57 +00:00
### Test if Jinja2 2.8 is installed on the system
2016-09-22 12:43:57 +00:00
describe pip('Jinja2') do
it { should be_installed }
its('version') { should eq '2.8' }
end
2016-09-22 12:43:57 +00:00
### Test packages installed into a non-default location (e.g. virtualenv) by passing a custom path to pip executable
describe pip('Jinja2', '/path/to/bin/pip') do
it { should be_installed }
its('version') { should eq '2.8' }
end
<br>
2016-09-22 12:43:57 +00:00
## Matchers
2016-09-22 12:43:57 +00:00
For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
2016-09-22 12:43:57 +00:00
### be_installed
2016-09-22 12:43:57 +00:00
The `be_installed` matcher tests if the named package is installed on the system:
2016-09-22 12:43:57 +00:00
it { should be_installed }
2016-09-22 12:43:57 +00:00
### version
2016-09-22 12:43:57 +00:00
The `version` matcher tests if the named package version is on the system:
its('version') { should eq '1.2.3' }