mirror of
https://github.com/inspec/inspec
synced 2025-02-17 14:38:43 +00:00
20776b363d
* Add support for multiple descriptions for controls
This adds the ability to specify multiple descriptions in controls.
Example:
```ruby
control 'my-control' do
impact 1.0
title 'My control'
desc 'A default description'
desc 'rational', 'I need an example'
describe file('/tmp') do
it { should be_directory }
end
end
```
Many thanks to @jquick for helping me with the unit tests.
* Remove unused `descriptions` method
* Remove unused profile from test mocks
* Respond to feedback
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
24 lines
1,009 B
Ruby
24 lines
1,009 B
Ruby
# encoding: utf-8
|
|
# copyright: 2015, Chef Software, Inc.
|
|
|
|
title '/tmp profile'
|
|
|
|
# you add controls here
|
|
control "tmp-1.0" do # A unique ID for this control
|
|
impact 0.7 # The criticality, if this control fails.
|
|
title "Create /tmp directory" # A human-readable title
|
|
desc "An optional description..." # Describe why this is needed
|
|
desc "label", "An optional description with a label" # Pair a part of the description with a label
|
|
tag data: "temp data" # A tag allows you to associate key information
|
|
tag "security" # to the test
|
|
ref "Document A-12", url: 'http://...' # Additional references
|
|
|
|
describe file('/tmp') do # The actual test
|
|
it { should be_directory }
|
|
end
|
|
end
|
|
|
|
# you can also use plain tests
|
|
describe file('/tmp') do
|
|
it { should be_directory }
|
|
end
|