inspec/docs/resources/vbscript.md.erb
Franklin Webber a9726910ff Fixes resources in the docs
* Fixes the npm package example to state 'npm' vs 'gem'
* Fixes powershell resource to specify the resource instead of 'script'
* Updates the example to rename variable 'script'

While ruby would allow the local variable and the presence of the InSpec method at the same time I think that it is bad form. Other resource examples also use 'script'.

* Changes pip to show generic example

Other package like resources show a generic example in the default.

Signed-off-by: Franklin Webber <franklin@chef.io>
2016-11-19 17:57:03 -08:00

69 lines
1.2 KiB
Text

---
title: About the vbscript Resource
---
# vbscript
Use the `vbscript` InSpec audit resource to test a VBScript on the Windows platform.
## Syntax
A `vbscript` resource block tests the output of a VBScript on the Windows platform:
describe vbscript('script contents') do
its('stdout') { should eq 'output' }
end
where
* `'script_name'` is the name of the VBScript to test
* `('output')` is the expected output of the VBScript
## Matchers
This InSpec audit resource has the following matchers:
### be
<%= partial "/shared/matcher_be" %>
### cmp
<%= partial "/shared/matcher_cmp" %>
### eq
<%= partial "/shared/matcher_eq" %>
### include
<%= partial "/shared/matcher_include" %>
### match
<%= partial "/shared/matcher_match" %>
## Examples
The following examples show how to use this InSpec audit resource.
### Test a VBScript
A VBScript file similar to:
script = <<-EOH
WScript.Echo "hello"
EOH
may be tested for multiple lines:
describe vbscript(script) do
its('stdout') { should eq "hello\r\n" }
end
and tested for whitespace removal from standard output:
describe vbscript(script) do
its('strip') { should eq "hello" }
end