Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-11-23 13:13:22 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fixed inputs example to display correct output when the same code is ran.

Browse source 
updated output example

Signed-off-by: Paul Bradford <pbradford@chef.io>
This commit is contained in:
Paul Bradford 2020-04-09 09:37:50 -07:00
parent 7fa8d1ca68
commit c7f2c18305
1 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/inputs.md
View file

@ -26,7 +26,7 @@ input('amplifier_max_volume', value: 10)
control 'Big Rock Show' do control 'Big Rock Show' do
describe input('amplifier_max_volume') do # This line reads the value of the input describe input('amplifier_max_volume') do # This line reads the value of the input
it { should eq 11 } # The UK'S LOUDEST BAND it { should cmp 11 } # The UK'S LOUDEST BAND
end end
end end
``` ```
@ -34,14 +34,14 @@ end
When the above profile is executed by using `inspec exec rock_critic`, you would see something like: When the above profile is executed by using `inspec exec rock_critic`, you would see something like:
``` ```
11 × Big Rock Show: 10
× should eq 10 × 10 is expected to cmp == 11
expected: 10 expected: 11
got: 11 got: 10
(compared using ==) (compared using `cmp` matcher)
Test Summary: 0 successful, 1 failure, 0 skipped Profile Summary: 0 successful controls, 1 control failure, 0 controls skipped
``` ```
That result clearly won't do. Let's override the input's default value. That result clearly won't do. Let's override the input's default value.
@ -49,10 +49,10 @@ That result clearly won't do. Let's override the input's default value.
We can now run that profile with `inspec exec rock_critic --input amplifier_max_volume=11`: We can now run that profile with `inspec exec rock_critic --input amplifier_max_volume=11`:
``` ```
11 ✔ Big Rock Show: 11
✔ should eq 11 ✔ 11 is expected to cmp == 11
Test Summary: 1 successful, 0 failures, 0 skipped Profile Summary: 1 successful control, 0 control failures, 0 controls skipped
``` ```
### Which profiles support inputs? ### Which profiles support inputs?