refactor(pkg): rename internals so their names actually make sense
A "program" was in fact a plugin, while a "plugin" represented the plugin's results.
This commit is contained in:
parent
ffbec78937
commit
1a29325c34
SSH key fingerprint:
SHA256:l7PFUUF5TCDsvYeQC9OnTNz08dFY7Fvf4Hv3neIqYpg
9 changed files with 189 additions and 179 deletions
|
|
@ -1,106 +1,20 @@
|
|||
// Package plugin implements a helper that can be used to implement a Nagios,
|
||||
// Centreon, Icinga... service monitoring plugin.
|
||||
package plugin // import nocternity.net/gomonop/pkg/plugin
|
||||
|
||||
import (
|
||||
"container/list"
|
||||
"fmt"
|
||||
"strings"
|
||||
import "nocternity.net/gomonop/pkg/results"
|
||||
|
||||
"nocternity.net/gomonop/pkg/perfdata"
|
||||
)
|
||||
// Plugin represents the interface to a monitoring plugin.
|
||||
type Plugin interface {
|
||||
// Results accesses the results of the monitoring plugin.
|
||||
Results() *results.Results
|
||||
|
||||
// Plugin represents the monitoring plugin's state, including its name,
|
||||
// return status and message, additional lines of text, and performance
|
||||
// data to be encoded in the output.
|
||||
type Plugin struct {
|
||||
name string
|
||||
status Status
|
||||
message string
|
||||
extraText *list.List
|
||||
perfData map[string]*perfdata.PerfData
|
||||
// CheckArguments ensures that the arguments that were passed to the plugin
|
||||
// actually make sense. Errors should be stored in the plugin's results.
|
||||
CheckArguments() bool
|
||||
|
||||
// RunCheck actually runs whatever checks are implemented by the plugin and
|
||||
// updates the results accordingly.
|
||||
RunCheck()
|
||||
}
|
||||
|
||||
// New creates the plugin with `name` as its name and an unknown status.
|
||||
func New(name string) *Plugin {
|
||||
p := new(Plugin)
|
||||
p.name = name
|
||||
p.status = StatusUnknown
|
||||
p.message = "no status set"
|
||||
p.perfData = make(map[string]*perfdata.PerfData)
|
||||
return p
|
||||
}
|
||||
|
||||
// SetState sets the plugin's output code to `status` and its message to
|
||||
// the specified `message`.
|
||||
func (p *Plugin) SetState(status Status, message string) {
|
||||
p.status = status
|
||||
p.message = message
|
||||
}
|
||||
|
||||
// AddLine adds the specified string to the extra output text buffer.
|
||||
func (p *Plugin) AddLine(line string) {
|
||||
if p.extraText == nil {
|
||||
p.extraText = list.New()
|
||||
}
|
||||
p.extraText.PushBack(line)
|
||||
}
|
||||
|
||||
// AddLinef formats the input and adds it to the text buffer.
|
||||
func (p *Plugin) AddLinef(format string, data ...interface{}) {
|
||||
p.AddLine(fmt.Sprintf(format, data...))
|
||||
}
|
||||
|
||||
// AddLines add the specified `lines` to the output text.
|
||||
func (p *Plugin) AddLines(lines []string) {
|
||||
for _, line := range lines {
|
||||
p.AddLine(line)
|
||||
}
|
||||
}
|
||||
|
||||
// AddPerfData adds performance data described by the "pd" argument to the
|
||||
// output's performance data. If two performance data records are added for
|
||||
// the same label, the program panics.
|
||||
func (p *Plugin) AddPerfData(pd *perfdata.PerfData) {
|
||||
_, exists := p.perfData[pd.Label]
|
||||
if exists {
|
||||
panic("duplicate performance data " + pd.Label)
|
||||
}
|
||||
p.perfData[pd.Label] = pd
|
||||
}
|
||||
|
||||
// String generates the plugin's text output from its name, status, text data
|
||||
// and performance data.
|
||||
func (p *Plugin) String() string {
|
||||
var strBuilder strings.Builder
|
||||
strBuilder.WriteString(p.name)
|
||||
strBuilder.WriteString(" ")
|
||||
strBuilder.WriteString(p.status.String())
|
||||
strBuilder.WriteString(": ")
|
||||
strBuilder.WriteString(p.message)
|
||||
if len(p.perfData) > 0 {
|
||||
strBuilder.WriteString(" | ")
|
||||
needSep := false
|
||||
for _, data := range p.perfData {
|
||||
if needSep {
|
||||
strBuilder.WriteString(", ")
|
||||
} else {
|
||||
needSep = true
|
||||
}
|
||||
strBuilder.WriteString(data.String())
|
||||
}
|
||||
}
|
||||
if p.extraText != nil {
|
||||
for em := p.extraText.Front(); em != nil; em = em.Next() {
|
||||
strBuilder.WriteString("\n")
|
||||
//nolint:forcetypeassert // we want to panic if this isn't a string
|
||||
strBuilder.WriteString(em.Value.(string))
|
||||
}
|
||||
}
|
||||
return strBuilder.String()
|
||||
}
|
||||
|
||||
// ExitCode returns the plugin's exit code.
|
||||
func (p *Plugin) ExitCode() int {
|
||||
return int(p.status)
|
||||
}
|
||||
// Builder is a function that can be called in order to instantiate a plugin.
|
||||
type Builder func() Plugin
|
||||
|
|
|
|||
|
|
@ -1,175 +0,0 @@
|
|||
package plugin // import nocternity.net/gomonop/pkg/plugin
|
||||
|
||||
import (
|
||||
"container/list"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"nocternity.net/gomonop/pkg/perfdata"
|
||||
)
|
||||
|
||||
func TestNew(t *testing.T) {
|
||||
p := New("test")
|
||||
|
||||
assert.Equal(t, p.name, "test")
|
||||
assert.Equal(t, p.status, StatusUnknown)
|
||||
assert.Equal(t, p.message, "no status set")
|
||||
assert.Nil(t, p.extraText)
|
||||
assert.NotNil(t, p.perfData)
|
||||
}
|
||||
|
||||
func TestSetState(t *testing.T) {
|
||||
p := Plugin{}
|
||||
|
||||
p.SetState(StatusWarning, "test")
|
||||
|
||||
assert.Equal(t, p.status, StatusWarning)
|
||||
assert.Equal(t, p.message, "test")
|
||||
}
|
||||
|
||||
func TestAddLineFirst(t *testing.T) {
|
||||
p := Plugin{}
|
||||
|
||||
p.AddLine("test")
|
||||
|
||||
assert.NotNil(t, p.extraText)
|
||||
assert.Equal(t, p.extraText.Len(), 1)
|
||||
assert.Equal(t, p.extraText.Front().Value, "test")
|
||||
}
|
||||
|
||||
func TestAddLineNext(t *testing.T) {
|
||||
p := Plugin{}
|
||||
p.extraText = list.New()
|
||||
|
||||
p.AddLine("test")
|
||||
|
||||
assert.Equal(t, p.extraText.Len(), 1)
|
||||
assert.Equal(t, p.extraText.Front().Value, "test")
|
||||
}
|
||||
|
||||
func TestAddLinef(t *testing.T) {
|
||||
p := Plugin{}
|
||||
|
||||
p.AddLinef("test %d", 123)
|
||||
|
||||
assert.Equal(t, p.extraText.Len(), 1)
|
||||
assert.Equal(t, p.extraText.Front().Value, "test 123")
|
||||
}
|
||||
|
||||
func TestAddLines(t *testing.T) {
|
||||
p := Plugin{}
|
||||
|
||||
p.AddLines([]string{"test", "test2"})
|
||||
|
||||
assert.Equal(t, p.extraText.Len(), 2)
|
||||
assert.Equal(t, p.extraText.Front().Value, "test")
|
||||
assert.Equal(t, p.extraText.Front().Next().Value, "test2")
|
||||
}
|
||||
|
||||
func TestAddPerfData(t *testing.T) {
|
||||
p := Plugin{}
|
||||
p.perfData = make(map[string]*perfdata.PerfData)
|
||||
|
||||
p.AddPerfData(&perfdata.PerfData{Label: "test"})
|
||||
|
||||
value, ok := p.perfData["test"]
|
||||
assert.True(t, ok)
|
||||
assert.Equal(t, value.Label, "test")
|
||||
}
|
||||
|
||||
func TestAddPerfDataDuplicate(t *testing.T) {
|
||||
p := Plugin{}
|
||||
p.perfData = make(map[string]*perfdata.PerfData)
|
||||
p.perfData["test"] = &perfdata.PerfData{Label: "test"}
|
||||
|
||||
assert.Panics(t, func() { p.AddPerfData(&perfdata.PerfData{Label: "test"}) })
|
||||
}
|
||||
|
||||
func TestString(t *testing.T) {
|
||||
type Test struct {
|
||||
Plugin
|
||||
expected string
|
||||
}
|
||||
|
||||
pdat := perfdata.PerfData{Label: "test"}
|
||||
tests := []Test{
|
||||
{
|
||||
Plugin{
|
||||
name: "test",
|
||||
status: StatusWarning,
|
||||
message: "test",
|
||||
perfData: make(map[string]*perfdata.PerfData),
|
||||
},
|
||||
"test WARNING: test",
|
||||
},
|
||||
{
|
||||
func() Plugin {
|
||||
p := Plugin{
|
||||
name: "test",
|
||||
status: StatusWarning,
|
||||
message: "test",
|
||||
perfData: make(map[string]*perfdata.PerfData),
|
||||
extraText: list.New(),
|
||||
}
|
||||
p.extraText.PushBack("test 1")
|
||||
p.extraText.PushBack("test 2")
|
||||
return p
|
||||
}(),
|
||||
"test WARNING: test\ntest 1\ntest 2",
|
||||
},
|
||||
{
|
||||
func() Plugin {
|
||||
p := Plugin{
|
||||
name: "test",
|
||||
status: StatusWarning,
|
||||
message: "test",
|
||||
perfData: make(map[string]*perfdata.PerfData),
|
||||
}
|
||||
p.perfData["test 1"] = &pdat
|
||||
p.perfData["test 2"] = &pdat
|
||||
return p
|
||||
}(),
|
||||
"test WARNING: test | " + pdat.String() + ", " +
|
||||
pdat.String(),
|
||||
},
|
||||
{
|
||||
func() Plugin {
|
||||
p := Plugin{
|
||||
name: "test",
|
||||
status: StatusWarning,
|
||||
message: "test",
|
||||
perfData: make(map[string]*perfdata.PerfData),
|
||||
extraText: list.New(),
|
||||
}
|
||||
p.perfData["test 1"] = &pdat
|
||||
p.perfData["test 2"] = &pdat
|
||||
p.extraText.PushBack("test 1")
|
||||
p.extraText.PushBack("test 2")
|
||||
return p
|
||||
}(),
|
||||
"test WARNING: test | " + pdat.String() + ", " +
|
||||
pdat.String() + "\ntest 1\ntest 2",
|
||||
},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
result := test.Plugin.String()
|
||||
assert.Equal(t, test.expected, result, "Expected '%s', got '%s'", test.expected, result)
|
||||
}
|
||||
}
|
||||
|
||||
func TestExitCode(t *testing.T) {
|
||||
p := Plugin{}
|
||||
|
||||
p.status = StatusOK
|
||||
assert.Equal(t, int(StatusOK), p.ExitCode())
|
||||
|
||||
p.status = StatusWarning
|
||||
assert.Equal(t, int(StatusWarning), p.ExitCode())
|
||||
|
||||
p.status = StatusCritical
|
||||
assert.Equal(t, int(StatusCritical), p.ExitCode())
|
||||
|
||||
p.status = StatusUnknown
|
||||
assert.Equal(t, int(StatusUnknown), p.ExitCode())
|
||||
}
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
package plugin // import nocternity.net/gomonop/pkg/plugin
|
||||
|
||||
// Status represents the return status of the monitoring plugin. The
|
||||
// corresponding integer value will be used as the program's exit code,
|
||||
// to be interpreted by the monitoring system.
|
||||
type Status int
|
||||
|
||||
// Plugin exit statuses.
|
||||
const (
|
||||
StatusOK Status = iota
|
||||
StatusWarning
|
||||
StatusCritical
|
||||
StatusUnknown
|
||||
)
|
||||
|
||||
// String representations of the plugin statuses.
|
||||
func (s Status) String() string {
|
||||
return [...]string{"OK", "WARNING", "ERROR", "UNKNOWN"}[s]
|
||||
}
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
package plugin // import nocternity.net/gomonop/pkg/plugin
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
func TestStatusDefaultOK(t *testing.T) {
|
||||
var s Status
|
||||
assert.Equal(t, StatusOK, s)
|
||||
}
|
||||
|
||||
func TestStatusToString(t *testing.T) {
|
||||
assert.Equal(t, "OK", StatusOK.String())
|
||||
assert.Equal(t, "WARNING", StatusWarning.String())
|
||||
assert.Equal(t, "ERROR", StatusCritical.String())
|
||||
assert.Equal(t, "UNKNOWN", StatusUnknown.String())
|
||||
}
|
||||
|
||||
func TestStatusToInt(t *testing.T) {
|
||||
assert.Equal(t, 0, int(StatusOK))
|
||||
assert.Equal(t, 1, int(StatusWarning))
|
||||
assert.Equal(t, 2, int(StatusCritical))
|
||||
assert.Equal(t, 3, int(StatusUnknown))
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue