Skip to content
This repository has been archived by the owner on Aug 12, 2022. It is now read-only.

fix: Diagnostics sorting, builtin Redacted() method #199

Merged
merged 1 commit into from
Mar 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 27 additions & 1 deletion provider/diag/diagnostics.go
Original file line number Diff line number Diff line change
Expand Up @@ -144,8 +144,34 @@ func (diags Diagnostics) CountBySeverity(sev Severity) uint64 {
return count
}

func (diags Diagnostics) Redacted() Diagnostics {
res := make(Diagnostics, len(diags))
for i := range diags {
if rd, ok := diags[i].(Redactable); ok {
if r := rd.Redacted(); r != nil {
res[i] = r
continue
}
}

res[i] = diags[i]
}
return res
}

func (diags Diagnostics) Len() int { return len(diags) }
func (diags Diagnostics) Swap(i, j int) { diags[i], diags[j] = diags[j], diags[i] }
func (diags Diagnostics) Less(i, j int) bool {
return diags[i].Severity() > diags[j].Severity() && diags[i].Type() > diags[j].Type()
if diags[i].Severity() > diags[j].Severity() {
return true
} else if diags[i].Severity() < diags[j].Severity() {
return false
}

if diags[i].Type() > diags[j].Type() {
return true
} else if diags[i].Type() < diags[j].Type() {
return false
}
return diags[i].Description().Resource < diags[j].Description().Resource
}
36 changes: 36 additions & 0 deletions provider/diag/diagnostics_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package diag

import (
"errors"
"sort"
"testing"

"github.com/stretchr/testify/assert"
Expand Down Expand Up @@ -202,3 +203,38 @@ func TestDiagnostics_SquashRedactable(t *testing.T) {
}, FlattenDiags(Diagnostics{r}, false))

}

func TestDiagnostics_Sort(t *testing.T) {
resErrA := NewBaseError(errors.New("error test"), RESOLVING, WithResourceName("a"), WithSummary("some summary"))
resErrB := NewBaseError(errors.New("error test"), RESOLVING, WithResourceName("b"), WithSummary("some summary"))

thrErrA := NewBaseError(errors.New("error test"), THROTTLE, WithResourceName("a"), WithSummary("some summary"))
accErrA := NewBaseError(errors.New("error test"), ACCESS, WithResourceName("a"), WithSummary("some summary"))

cases := []struct {
diagsInWrongOrder Diagnostics
expectedOrder []int
}{
{
Diagnostics{resErrB, resErrA},
[]int{1, 0},
},
{
Diagnostics{accErrA, resErrB, thrErrA, resErrA},
[]int{2, 0, 3, 1},
},
}
for caseNo, tc := range cases {
assert.Equal(t, len(tc.diagsInWrongOrder), len(tc.expectedOrder), "bad test")
if t.Failed() {
t.FailNow()
}

sorted := make(Diagnostics, len(tc.diagsInWrongOrder))
copy(sorted, tc.diagsInWrongOrder)
sort.Sort(sorted)
for i := range sorted {
assert.Equalf(t, sorted[i], tc.diagsInWrongOrder[tc.expectedOrder[i]], "Case #%d item %d", caseNo+1, i)
}
}
}