-
Notifications
You must be signed in to change notification settings - Fork 3
/
example_override_section_header_text_test.go
47 lines (40 loc) · 1.69 KB
/
example_override_section_header_text_test.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
// Copyright 2020 Adam Chalkley
//
// https://github.com/atc0005/go-nagios
//
// Licensed under the MIT License. See LICENSE file in the project root for
// full license information.
package nagios_test
import (
"github.com/atc0005/go-nagios"
)
// Ignore this. This is just to satisfy the "whole file" example requirements
// per https://go.dev/blog/examples.
var _ = "https://github.com/atc0005/go-nagios"
// ExampleOverrideSectionHeaders demonstrates overriding the default text with
// values that better fit our use case.
func Example_overrideSectionHeaders() {
// First, create an instance of the Plugin type. By default this value is
// configured to indicate a successful execution. This should be
// overridden by client code to indicate the final plugin state to Nagios
// when the plugin exits.
var plugin = nagios.NewPlugin()
// Second, immediately defer ReturnCheckResults() so that it runs as the
// last step in your client code. If you do not defer ReturnCheckResults()
// immediately any other deferred functions in your client code will not
// run.
//
// Avoid calling os.Exit() directly from your code. If you do, this
// library is unable to function properly; this library expects that it
// will handle calling os.Exit() with the required exit code (and
// specifically formatted output).
//
// For handling error cases, the approach is roughly the same, only you
// call return explicitly to end execution of the client code and allow
// deferred functions to run.
defer plugin.ReturnCheckResults()
// more stuff here
// Override default section headers with our custom values.
plugin.SetErrorsLabel("VALIDATION ERRORS")
plugin.SetDetailedInfoLabel("VALIDATION CHECKS REPORT")
}