inspec/lib/resources/windows_feature.rb

84 lines
2.4 KiB
Ruby
Raw Normal View History

2015-09-20 15:42:09 +00:00
# encoding: utf-8
2015-10-06 16:55:44 +00:00
# author: Christoph Hartmann
# author: Dominik Richter
2015-09-20 15:42:09 +00:00
# check for a Windows feature
# Usage:
# describe windows_feature('DHCP Server') do
# it{ should be_installed }
# end
#
# deprecated serverspec syntax:
# describe windows_feature('IIS-Webserver') do
# it{ should be_installed.by("dism") }
# end
#
# describe windows_feature('Web-Webserver') do
# it{ should be_installed.by("powershell") }
# end
#
# This implementation uses the Get-WindowsFeature commandlet:
# Get-WindowsFeature | Where-Object {$_.Name -eq 'XPS Viewer' -or $_.DisplayName -eq 'XPS Viewe
# r'} | Select-Object -Property Name,DisplayName,Description,Installed,InstallState | ConvertTo-Json
# {
# "Name": "XPS-Viewer",
# "DisplayName": "XPS Viewer",
# "Description": "The XPS Viewer is used to read, set permissions for, and digitally sign XPS documents.",
# "Installed": false,
# "InstallState": 0
# }
2015-10-26 03:04:18 +00:00
class WindowsFeature < Inspec.resource(1)
2015-09-20 15:42:09 +00:00
name 'windows_feature'
2015-11-27 13:02:38 +00:00
desc 'Use the windows_feature InSpec audit resource to test features on Microsoft Windows.'
example "
describe windows_feature('dhcp') do
it { should be_installed }
end
"
2015-09-20 15:42:09 +00:00
def initialize(feature)
@feature = feature
@cache = nil
# verify that this resource is only supported on Windows
2015-10-26 03:04:18 +00:00
return skip_resource 'The `windows_feature` resource is not supported on your OS.' if inspec.os[:family] != 'windows'
2015-09-20 15:42:09 +00:00
end
# returns true if the package is installed
def installed?(_provider = nil, _version = nil)
info[:installed] == true
end
# returns the package description
def info
return @cache if !@cache.nil?
features_cmd = "Get-WindowsFeature | Where-Object {$_.Name -eq '#{@feature}' -or $_.DisplayName -eq '#{@feature}'} | Select-Object -Property Name,DisplayName,Description,Installed,InstallState | ConvertTo-Json"
2015-10-26 03:04:18 +00:00
cmd = inspec.command(features_cmd)
2015-09-20 15:42:09 +00:00
@cache = {
name: @feature,
type: 'windows-feature',
}
# cannot rely on exit code for now, successful command returns exit code 1
# return nil if cmd.exit_status != 0
# try to parse json
begin
params = JSON.parse(cmd.stdout)
rescue JSON::ParserError => _e
return @cache
end
@cache = {
name: params['Name'],
description: params['Description'],
installed: params['Installed'],
type: 'windows-feature',
}
end
def to_s
"Windows Feature '#{@feature}'"
2015-09-20 15:42:09 +00:00
end
end