Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2025-02-16 22:18:38 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #6144 from inspec/nm/plugins-doc-send-report

Browse source 
Updated plugins doc with send_report functionality
This commit is contained in:
Clinton Wolfe 2022-06-22 12:33:20 -04:00 • committed by GitHub
commit 3b93164f4f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
dev-docs/plugins.md
View file

@ -493,6 +493,24 @@ v0.1.0 - Initial version
v0.2.0 - added `run_data.profiles[0].inputs[0].options.sensitive`
v0.3.0 - added resource_name && params
#### Implement send_report
The primary responsibilty of this function is to implement a logic for sending reporter output through email invocations or making API calls. When this is defined in a reporter, rendering of output is skipped.
```ruby
module InspecPlugins::Sweeten
class Reporter < Inspec.plugin(2, :reporter)
def send_report
# logic for sending reporter output using email invocations or API calls.
end
def render
# this will be skipped, will only run send_report
end
end
end
```
## Implementing Streaming Reporter Plugins
Streaming Reporter plugins offer the opportunity to customize or create a plugin which operates real-time as the Chef Inspec tests runs. Streaming reporters perform streaming using RSpec custom formatters.