mirror of
https://github.com/inspec/inspec
synced 2024-11-23 21:23:29 +00:00
d5f33f0b99
* Update pip resource for #516 allow user to set path to pip executable Signed-off-by: Anthony Shaw <anthonyshaw@apache.org> * support virtualenv path, pip file exec and better logic Signed-off-by: Anthony Shaw <anthonyshaw@apache.org> * add tests for the change to the pip path and resource Signed-off-by: Anthony Shaw <anthonyshaw@apache.org> * tests are case sensitive, although command line is not Signed-off-by: Anthony Shaw <anthonyshaw@apache.org> * use a path verification method instead of a class method Signed-off-by: Anthony Shaw <anthonyshaw@apache.org> * use guard clauses instead of conditionals Signed-off-by: Anthony Shaw <anthonyshaw@apache.org> * change the control flow to return nil when commands are not available Signed-off-by: Anthony Shaw <anthonyshaw@apache.org> * fix the return values when custom pip path is not valid Signed-off-by: Anthony Shaw <anthonyshaw@apache.org> * Refactor pip path detection to fix unit tests Signed-off-by: Adam Leff <adam@leff.co>
89 lines
2.4 KiB
Ruby
89 lines
2.4 KiB
Ruby
# encoding: utf-8
|
|
# author: Christoph Hartmann
|
|
# author: Dominik Richter
|
|
|
|
# Usage:
|
|
# describe pip('Jinja2') do
|
|
# it { should be_installed }
|
|
# end
|
|
#
|
|
|
|
module Inspec::Resources
|
|
class PipPackage < Inspec.resource(1)
|
|
name 'pip'
|
|
desc 'Use the pip InSpec audit resource to test packages that are installed using the pip installer.'
|
|
example "
|
|
describe pip('Jinja2') do
|
|
it { should be_installed }
|
|
end
|
|
|
|
describe pip('django', '/path/to/virtualenv/bin/pip') do
|
|
it { should be_installed }
|
|
its('version') { should eq('1.11.4')}
|
|
end
|
|
"
|
|
|
|
def initialize(package_name, pip_path = nil)
|
|
@package_name = package_name
|
|
@pip_cmd = pip_path || default_pip_path
|
|
return skip_resource 'pip not found' unless inspec.command(@pip_cmd).exist?
|
|
end
|
|
|
|
def info
|
|
return @info if defined?(@info)
|
|
|
|
@info = {}
|
|
@info[:type] = 'pip'
|
|
cmd = inspec.command("#{@pip_cmd} show #{@package_name}")
|
|
return @info if cmd.exit_status != 0
|
|
|
|
params = SimpleConfig.new(
|
|
cmd.stdout,
|
|
assignment_regex: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
|
|
multiple_values: false,
|
|
).params
|
|
@info[:name] = params['Name']
|
|
@info[:version] = params['Version']
|
|
@info[:installed] = true
|
|
@info
|
|
end
|
|
|
|
def installed?
|
|
info[:installed] == true
|
|
end
|
|
|
|
def version
|
|
info[:version]
|
|
end
|
|
|
|
def to_s
|
|
"Pip Package #{@package_name}"
|
|
end
|
|
|
|
private
|
|
|
|
def default_pip_path
|
|
return 'pip' unless inspec.os.windows?
|
|
|
|
# Pip is not on the default path for Windows, therefore we do some logic
|
|
# to find the binary on Windows
|
|
cmd = inspec.command('New-Object -Type PSObject | Add-Member -MemberType NoteProperty -Name Pip -Value (Invoke-Command -ScriptBlock {where.exe pip}) -PassThru | Add-Member -MemberType NoteProperty -Name Python -Value (Invoke-Command -ScriptBlock {where.exe python}) -PassThru | ConvertTo-Json')
|
|
begin
|
|
paths = JSON.parse(cmd.stdout)
|
|
# use pip if it on system path
|
|
pipcmd = paths['Pip']
|
|
# calculate path on windows
|
|
if defined?(paths['Python']) && pipcmd.nil?
|
|
pipdir = paths['Python'].split('\\')
|
|
# remove python.exe
|
|
pipdir.pop
|
|
pipcmd = pipdir.push('Scripts').push('pip.exe').join('/')
|
|
end
|
|
rescue JSON::ParserError => _e
|
|
return nil
|
|
end
|
|
|
|
pipcmd
|
|
end
|
|
end
|
|
end
|