Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-11-22 20:53:11 +00:00
Code Issues Projects Releases Packages Wiki Activity
inspec/dev-docs/enhanced-outcomes.md
Deepa Kumaraswamy 1dc2faf205 Proof-read 
Signed-off-by: Deepa Kumaraswamy <dkumaras@progress.com>
2022-06-23 18:33:23 +05:30

2.2 KiB
Raw Blame History

Enhanced Outcomes

Enhanced Outcomes refers to the addition of new control outcomes to the InSpec vocabulary.

Test Outcomes vs. Control Outcomes

It is essential to understand that Enhanced Outcomes refers to new control outcomes, the results of running a control.

The results of running a test, a describe block are determined by RSpec and are limited to Pass, Fail, and Skip.

Test outcomes are much more difficult to extend than control outcomes.

Enhanced Outcomes adds three new control outcomes to the existing Pass, Fail, and Skip outcomes.

Error

The Error outcome represents the situation when the system has encountered an error when attempting to evaluate the control code. However, due to a technical limitation, an accurate outcome cannot be obtained.

In the first iteration of Enhanced Outcomes, the Error outcome is detected:

  • if the status of a test is Failed, and
  • if the message of the test includes the text, Control source error

Then, the entire control should be marked Error.

Additional means of detecting error may be developed in the future.

Error's abbreviation is ERR. Error's UI color assignment is Indigo.

Not Applicable

If the control is not in Error and the impact of control is 0.0, then the control's outcome is Not Applicable.

Not Applicable's abbreviation is N/A. Not Applicable's UI color assignment is Sky Blue.

Not Reviewed

If the control is not in Error or Not Applicable, and all test results are Skipped, then the control outcome is Not Reviewed.

Not Reviewed replaces Skipped as a control outcome.

Not Reviewed's abbreviation is N/R. Not Reviewed's UI color assignment is Amber.

The --enhanced-outcomes option

A new CLI option will be introduced for inspec exec, inspec shell, and inspec schema that controls the Enhanced Outcomes functionality.

InSpec 5

In InSpec 5.x, a user must request the enhanced outcomes functionality explicitly by adding the --enhanced-outcomes option.

InSpec 6

In InSpec 6.x, --enhanced-outcomes will default to true. A user may request disabling the enhanced outcomes functionality by adding the --no-enhanced-outcomes option.