Skip to content

Default states #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pdorschner merged 2 commits into from
Jun 5, 2023
Merged

Default states #80

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
509845b
Add additional test for derived result logic
Jun 5, 2023
d0679d6
Hide state attribute to allow sane handling from API
Jun 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 55 additions & 27 deletions result/overall.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
package result

import (
"errors"
"fmt"
"strings"

Expand All @@ -24,19 +25,21 @@ type Overall struct {
Summary string
stateSetExplicitely bool
Outputs []string // Deprecate this in a future version
partialResults []PartialResult
PartialResults []PartialResult
}

type PartialResult struct {
State int
state int // Result state, either set explicitely or derived from partialResults
Output string
stateSetExplicitely bool // nolint: unused
defaultState int // Default result state, if no partial results are available and no state is set explicitely
defaultStateSet bool // nolint: unused
Perfdata perfdata.PerfdataList
partialResults []PartialResult
PartialResults []PartialResult
}

func (s *PartialResult) String() string {
return fmt.Sprintf("[%s] %s", check.StatusText(s.State), s.Output)
return fmt.Sprintf("[%s] %s", check.StatusText(s.state), s.Output)
}

// Deprecated: Will be removed in a future version, use Add() instead
Expand Down Expand Up @@ -80,11 +83,11 @@ func (o *Overall) Add(state int, output string) {
}

func (o *Overall) AddSubcheck(subcheck PartialResult) {
o.partialResults = append(o.partialResults, subcheck)
o.PartialResults = append(o.PartialResults, subcheck)
}

func (o *PartialResult) AddSubcheck(subcheck PartialResult) {
o.partialResults = append(o.partialResults, subcheck)
o.PartialResults = append(o.PartialResults, subcheck)
}

func (o *Overall) GetStatus() int {
Expand All @@ -101,9 +104,8 @@ func (o *Overall) GetStatus() int {
return check.Unknown
}
} else {
// state set explicitely!

if len(o.partialResults) == 0 {
// state not set explicitely!
if len(o.PartialResults) == 0 {
return check.Unknown
}

Expand All @@ -114,8 +116,8 @@ func (o *Overall) GetStatus() int {
unknowns int
)

for _, sc := range o.partialResults {
switch sc.State {
for _, sc := range o.PartialResults {
switch sc.getState() {
case check.Critical:
criticals++
case check.Warning:
Expand Down Expand Up @@ -180,7 +182,7 @@ func (o *Overall) GetSummary() string {

if !o.stateSetExplicitely {
// No, so lets combine the partial ones
if len(o.partialResults) == 0 {
if len(o.PartialResults) == 0 {
// Oh, we actually don't have those either
o.Summary = "No status information"
return o.Summary
Expand All @@ -193,8 +195,8 @@ func (o *Overall) GetSummary() string {
unknowns int
)

for _, sc := range o.partialResults {
switch sc.State {
for _, sc := range o.PartialResults {
switch sc.state {
case check.Critical:
criticals++
case check.Warning:
Expand Down Expand Up @@ -237,13 +239,13 @@ func (o *Overall) GetOutput() string {
output.WriteString(extra + "\n")
}

if o.partialResults != nil {
if o.PartialResults != nil {
var pdata strings.Builder

// Generate indeted output and perfdata for all partialResults
for i := range o.partialResults {
output.WriteString(o.partialResults[i].getOutput(0))
pdata.WriteString(" " + o.partialResults[i].getPerfdata())
for i := range o.PartialResults {
output.WriteString(o.PartialResults[i].getOutput(0))
pdata.WriteString(" " + o.PartialResults[i].getPerfdata())
}

pdata_string := strings.Trim(pdata.String(), " ")
Expand All @@ -264,8 +266,8 @@ func (s *PartialResult) getPerfdata() string {
output.WriteString(s.Perfdata.String())
}

if s.partialResults != nil {
for _, ss := range s.partialResults {
if s.PartialResults != nil {
for _, ss := range s.PartialResults {
output.WriteString(ss.getPerfdata())
}
}
Expand All @@ -280,29 +282,55 @@ func (s *PartialResult) getOutput(indent_level int) string {
prefix := strings.Repeat(" ", indent_level)
output.WriteString(prefix + "\\_ " + s.String() + "\n")

if s.partialResults != nil {
for _, ss := range s.partialResults {
if s.PartialResults != nil {
for _, ss := range s.PartialResults {
output.WriteString(ss.getOutput(indent_level + 2))
}
}

return output.String()
}

func (s *PartialResult) SetDefaultState(state int) error {
if state < check.OK || state > check.Unknown {
return errors.New("Default State is not a valid result state. Got " + fmt.Sprint(state) + " which is not valid")
}

s.defaultState = state
s.defaultStateSet = true

return nil
}

func (s *PartialResult) SetState(state int) error {
if state < check.OK || state > check.Unknown {
return errors.New("Default State is not a valid result state. Got " + fmt.Sprint(state) + " which is not valid")
}

s.state = state
s.stateSetExplicitely = true

return nil
}

// nolint: unused
func (s *PartialResult) getState() int {
if s.stateSetExplicitely {
return s.State
return s.state
}

if len(s.partialResults) == 0 {
if len(s.PartialResults) == 0 {
if s.defaultStateSet {
return s.defaultState
}

return check.Unknown
}

states := make([]int, len(s.partialResults))
states := make([]int, len(s.PartialResults))

for i := range s.partialResults {
states[i] = s.partialResults[i].State
for i := range s.PartialResults {
states[i] = s.PartialResults[i].state
}

return WorstState(states...)
Expand Down
89 changes: 66 additions & 23 deletions result/overall_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ func ExampleOverall_Add() {
overall.Add(check.Critical, "The other is critical")

fmt.Printf("%#v\n", overall)
// Output: result.Overall{oks:1, warnings:0, criticals:1, unknowns:0, Summary:"", stateSetExplicitely:true, Outputs:[]string{"[OK] One element is good", "[CRITICAL] The other is critical"}, partialResults:[]result.PartialResult(nil)}
// Output: result.Overall{oks:1, warnings:0, criticals:1, unknowns:0, Summary:"", stateSetExplicitely:true, Outputs:[]string{"[OK] One element is good", "[CRITICAL] The other is critical"}, PartialResults:[]result.PartialResult(nil)}
}

func ExampleOverall_GetOutput() {
Expand Down Expand Up @@ -144,7 +144,7 @@ func ExampleOverall_withSubchecks() {
pd_list.Add(&example_perfdata)

subcheck := PartialResult{
State: check.OK,
state: check.OK,
Output: "Subcheck1 Test",
Perfdata: pd_list,
}
Expand Down Expand Up @@ -184,14 +184,16 @@ func TestOverall_withEnhancedSubchecks(t *testing.T) {
pd_list2.Add(&example_perfdata4)

subcheck := PartialResult{
State: check.OK,
Output: "Subcheck1 Test",
Perfdata: pd_list,
state: check.OK,
stateSetExplicitely: true,
Output: "Subcheck1 Test",
Perfdata: pd_list,
}
subcheck2 := PartialResult{
State: check.Warning,
Output: "Subcheck2 Test",
Perfdata: pd_list2,
state: check.Warning,
stateSetExplicitely: true,
Output: "Subcheck2 Test",
Perfdata: pd_list2,
}

overall.AddSubcheck(subcheck)
Expand All @@ -205,20 +207,22 @@ func TestOverall_withEnhancedSubchecks(t *testing.T) {
|pd_test=5s pd_test2=1099511627776kB;@3.14:7036874417766;549755813887:1208925819614629174706176;;18446744073709551615 kl;jr2if;l2rkjasdf=5m asdf=18446744073709551615B
`
assert.Equal(t, expectedString, resString)

assert.Equal(t, check.Warning, overall.GetStatus())
}

func TestOverall_withSubchecks_Simple_Output(t *testing.T) {
var overall Overall

subcheck2 := PartialResult{
State: check.OK,
state: check.OK,
Output: "SubSubcheck",
}
subcheck := PartialResult{
State: check.OK,
state: check.OK,
Output: "PartialResult",
}
subcheck.partialResults = append(subcheck.partialResults, subcheck2)
subcheck.PartialResults = append(subcheck.PartialResults, subcheck2)

overall.AddSubcheck(subcheck)

Expand All @@ -236,11 +240,11 @@ func TestOverall_withSubchecks_Perfdata(t *testing.T) {
var overall Overall

subcheck2 := PartialResult{
State: check.OK,
state: check.OK,
Output: "SubSubcheck",
}
subcheck := PartialResult{
State: check.OK,
state: check.OK,
Output: "PartialResult",
}

Expand All @@ -256,7 +260,7 @@ func TestOverall_withSubchecks_Perfdata(t *testing.T) {

subcheck2.Perfdata.Add(&perf1)
subcheck2.Perfdata.Add(&perf2)
subcheck.partialResults = append(subcheck.partialResults, subcheck2)
subcheck.PartialResults = append(subcheck.PartialResults, subcheck2)

overall.AddSubcheck(subcheck)

Expand All @@ -274,7 +278,7 @@ func TestOverall_withSubchecks_PartialResult(t *testing.T) {
var overall Overall

subcheck3 := PartialResult{
State: check.Critical,
state: check.Critical,
Output: "SubSubSubcheck",
}
subcheck2 := PartialResult{
Expand All @@ -296,8 +300,8 @@ func TestOverall_withSubchecks_PartialResult(t *testing.T) {

subcheck2.Perfdata.Add(&perf1)
subcheck2.Perfdata.Add(&perf2)
subcheck2.partialResults = append(subcheck.partialResults, subcheck3)
subcheck.partialResults = append(subcheck.partialResults, subcheck2)
subcheck2.PartialResults = append(subcheck.PartialResults, subcheck3)
subcheck.PartialResults = append(subcheck.PartialResults, subcheck2)

overall.AddSubcheck(subcheck)

Expand All @@ -316,16 +320,19 @@ func TestOverall_withSubchecks_PartialResultStatus(t *testing.T) {
var overall Overall

subcheck := PartialResult{
State: check.OK,
Output: "Subcheck",
state: check.OK,
stateSetExplicitely: true,
Output: "Subcheck",
}
subsubcheck := PartialResult{
State: check.Warning,
Output: "SubSubcheck",
state: check.Warning,
stateSetExplicitely: true,
Output: "SubSubcheck",
}
subsubsubcheck := PartialResult{
State: check.Critical,
Output: "SubSubSubcheck",
state: check.Critical,
stateSetExplicitely: true,
Output: "SubSubSubcheck",
}

subsubcheck.AddSubcheck(subsubsubcheck)
Expand All @@ -340,3 +347,39 @@ func TestOverall_withSubchecks_PartialResultStatus(t *testing.T) {
assert.Equal(t, res, overall.GetOutput())
assert.Equal(t, 0, overall.GetStatus())
}

func TestDefaultStates1(t *testing.T) {
var overall Overall

subcheck := PartialResult{}

subcheck.SetDefaultState(check.OK)

overall.AddSubcheck(subcheck)

assert.Equal(t, check.OK, overall.GetStatus())
}

func TestDefaultStates2(t *testing.T) {
var overall Overall

subcheck := PartialResult{}

overall.AddSubcheck(subcheck)

assert.Equal(t, check.Unknown, subcheck.getState())
assert.Equal(t, check.Unknown, overall.GetStatus())
}

func TestDefaultStates3(t *testing.T) {
var overall Overall

subcheck := PartialResult{}
subcheck.SetDefaultState(check.OK)

subcheck.SetState(check.Warning)

overall.AddSubcheck(subcheck)

assert.Equal(t, check.Warning, overall.GetStatus())
}