mirror of
https://github.com/inspec/inspec
synced 2024-12-26 21:13:25 +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>
1 line
5.9 KiB
JSON
1 line
5.9 KiB
JSON
{"controls":[{"status":"passed","code_desc":"File /etc/hosts mode should eq 420","run_time":0.031503,"start_time":"2018-07-30T08:56:41-04:00","resource_title":"File /etc/hosts","expectation_message":"mode should eq 420"},{"status":"passed","code_desc":"File /etc/passwd should exist","run_time":0.003954,"start_time":"2018-07-30T08:56:41-04:00","resource_title":"File /etc/passwd","expectation_message":"should exist"},{"status":"skipped","code_desc":"Operating System Detection","run_time":2.9e-05,"start_time":"2018-07-30T08:56:41-04:00","resource_title":"Operating System Detection","expectation_message":"Skipped control due to only_if condition.","skip_message":"Skipped control due to only_if condition.","resource":"Operating System Detection"}],"other_checks":[],"profiles":[{"name":"wrapper-override","title":"Linux Wrapper Child Profile","maintainer":"Demo, Inc.","copyright":"Demo, Inc.","copyright_email":"support@example.com","license":"Apache-2.0","summary":"Profile that wraps other profiles","version":"0.6.1","depends":[{"name":"myprofile1z","url":"https://s3-eu-west-1.amazonaws.com/apop-bucket/profiles/myprofile1-1.0.0.tar.gz"}],"supports":[],"controls":[{"title":"Profile 1 - Control 1","desc":"Profile 1 - Control 1 description","descriptions":{"default": "Profile 1 - Control description"},"impact":0.8,"refs":[],"tags":{"hosts":null,"file":null,"cce":"CCE-27072-8"},"code":"","source_location":{"ref":"/Users/jquick/.inspec/cache/e39eb85366b272bae98e5eecdfac9f84c50a9ae9dd625fba2ce847268a6c3477/controls/profile1.rb","line":1},"id":"pro1-con1"},{"title":"Profile 1 - Control 2-updated","desc":"Profile 1 - Control 2 description-updated","descriptions":{"default":"Profile 1 - Control 2 description-updated"},"impact":0.999,"refs":[{"ref":[{"url":"https://example.com","ref":"Section 3.5.2.1"}]}],"tags":{"password":null,"password-updated":null},"code":" control 'pro1-con2' do\n impact 0.999\n title 'Profile 1 - Control 2-updated'\n desc 'Profile 1 - Control 2 description-updated'\n tag 'password-updated'\n ref 'Section 3.5.2.1', url: 'https://example.com'\n describe file('/etc/passwd') do\n it { should exist }\n end\n end\n","source_location":{"ref":"wrapper-override/controls/defaut.rb","line":6},"id":"pro1-con2"},{"title":"Profile 1 - Control 3 - useless","desc":"Profile 1 - Control 3 description","descriptions":{"default":"Profile 1 - Control 3 description"},"impact":1,"refs":[],"tags":{},"code":"","source_location":{"ref":"/Users/jquick/.inspec/cache/e39eb85366b272bae98e5eecdfac9f84c50a9ae9dd625fba2ce847268a6c3477/controls/profile1.rb","line":31},"id":"pro1-con4"}],"groups":[{"title":null,"controls":["pro1-con1","pro1-con2","pro1-con4"],"id":"/Users/jquick/.inspec/cache/e39eb85366b272bae98e5eecdfac9f84c50a9ae9dd625fba2ce847268a6c3477/controls/profile1.rb"}],"attributes":[],"sha256":"7436aac31d44de7987419d5f2ffb822f265645f4fc3c5d2ab37d8fff4dd5cf61"},{"name":"myprofile1","title":"My Profile 1 title","maintainer":"Demo, Inc.","copyright":"Demo, Inc.","copyright_email":"support@example.com","license":"Apache-2.0","summary":"My Profile 1 summary","version":"1.0.0","supports":[],"controls":[{"title":"Profile 1 - Control 1","desc":"Profile 1 - Control 1 description","descriptions":{"default":"Profile 1 - Control 1 description"},"impact":0.8,"refs":[],"tags":{"hosts":null,"file":null,"cce":"CCE-27072-8"},"code":"control 'pro1-con1' do\n impact 0.8\n title 'Profile 1 - Control 1'\n desc 'Profile 1 - Control 1 description'\n tag 'hosts','file'\n tag cce: 'CCE-27072-8'\n describe file('/etc/hosts') do\n its('mode') { should eq 0644 }\n end\nend\n","source_location":{"ref":"/Users/jquick/.inspec/cache/e39eb85366b272bae98e5eecdfac9f84c50a9ae9dd625fba2ce847268a6c3477/controls/profile1.rb","line":1},"id":"pro1-con1","results":[{"status":"passed","code_desc":"File /etc/hosts mode should eq 420","run_time":0.031503,"start_time":"2018-07-30T08:56:41-04:00","resource_title":"File /etc/hosts","expectation_message":"mode should eq 420"}]},{"title":"Profile 1 - Control 2-updated","desc":"Profile 1 - Control 2 description-updated","descriptions":{"default":"Profile 1 - Control 2 description-updated"},"impact":0.999,"refs":[{"ref":[{"url":"https://example.com","ref":"Section 3.5.2.1"}]}],"tags":{"password":null,"password-updated":null},"code":"","source_location":{"ref":"wrapper-override/controls/defaut.rb","line":6},"id":"pro1-con2","results":[{"status":"passed","code_desc":"File /etc/passwd should exist","run_time":0.003954,"start_time":"2018-07-30T08:56:41-04:00","resource_title":"File /etc/passwd","expectation_message":"should exist"}]},{"title":"Profile 1 - Control 3 - useless","desc":"Profile 1 - Control 3 description","descriptions":{"default":"Profile 1 - Control 3 description"},"impact":1,"refs":[],"tags":{},"code":"control 'pro1-con4' do\n impact 1\n title 'Profile 1 - Control 3 - useless'\n desc 'Profile 1 - Control 3 description'\n only_if do\n 1.eql?(0)\n end\n describe file('/tmp5') do\n it { should exist }\n end\nend\n","source_location":{"ref":"/Users/jquick/.inspec/cache/e39eb85366b272bae98e5eecdfac9f84c50a9ae9dd625fba2ce847268a6c3477/controls/profile1.rb","line":31},"id":"pro1-con4","results":[{"status":"skipped","code_desc":"Operating System Detection","run_time":2.9e-05,"start_time":"2018-07-30T08:56:41-04:00","resource_title":"Operating System Detection","expectation_message":"Skipped control due to only_if condition.","skip_message":"Skipped control due to only_if condition.","resource":"Operating System Detection"}]}],"groups":[{"title":null,"controls":["pro1-con1","pro1-con2","pro1-con4"],"id":"controls/profile1.rb"}],"attributes":[],"sha256":"c8647b6f09ad17862d82751d0b6cd062b10eeea4f1d885e29180208bea247b2c","parent_profile":"wrapper-override"}],"platform":{"name":"mac_os_x","release":"17.5.0","target":"local://","uuid":"b064e8f0-ab72-4ab9-b793-a87e9a04235e"},"version":"2.2.26","statistics":{"duration":0.039182,"controls":{"total":3,"passed":{"total":2},"skipped":{"total":1},"failed":{"total":0}}}}
|