Skip to content
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

Jump to bottom

feat: Add Sort method to kyaml fn Results #4325

Merged
merged 1 commit into from Dec 2, 2021
Merged

feat: Add Sort method to kyaml fn Results #4325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
59 changes: 59 additions & 0 deletions kyaml/fn/framework/result.go
View file
Open in desktop
Expand Up @@ -5,6 +5,7 @@ package framework

import (
"fmt"
"sort"
"strings"

"sigs.k8s.io/kustomize/kyaml/yaml"
Expand Down Expand Up @@ -126,3 +127,61 @@ func (e Results) ExitCode() int {
}
return 0
}

// Sort performs an in place stable sort of Results
func (e Results) Sort() {
sort.SliceStable(e, func(i, j int) bool {
if fileLess(e, i, j) != 0 {
return fileLess(e, i, j) < 0
}
if severityLess(e, i, j) != 0 {
return severityLess(e, i, j) < 0
}
return resultToString(*e[i]) < resultToString(*e[j])
})
}

func severityLess(items Results, i, j int) int {
severityToNumber := map[Severity]int{
Error: 0,
Warning: 1,
Info: 2,
}

severityLevelI, found := severityToNumber[items[i].Severity]
if !found {
severityLevelI = 3
}
severityLevelJ, found := severityToNumber[items[j].Severity]
if !found {
severityLevelJ = 3
}
return severityLevelI - severityLevelJ
}

func fileLess(items Results, i, j int) int {
var fileI, fileJ File
if items[i].File == nil {
fileI = File{}
} else {
fileI = *items[i].File
}
if items[j].File == nil {
fileJ = File{}
} else {
fileJ = *items[j].File
}
if fileI.Path != fileJ.Path {
if fileI.Path < fileJ.Path {
return -1
} else {
return 1
}
}
return fileI.Index - fileJ.Index
}

func resultToString(item Result) string {
return fmt.Sprintf("resource-ref:%s,field:%s,message:%s",
item.ResourceRef, item.Field, item.Message)
}
274 changes: 274 additions & 0 deletions kyaml/fn/framework/result_test.go
View file
Open in desktop
@@ -0,0 +1,274 @@
// Copyright 2021 The Kubernetes Authors.
// SPDX-License-Identifier: Apache-2.0

package framework_test

import (
"reflect"
"testing"

"sigs.k8s.io/kustomize/kyaml/fn/framework"
"sigs.k8s.io/kustomize/kyaml/yaml"
)

func TestResults_Sort(t *testing.T) {
testcases := []struct {
name string
input framework.Results
output framework.Results
}{
{
name: "sort based on severity",
input: framework.Results{
{
Message: "Error message 1",
Severity: framework.Info,
},
{
Message: "Error message 2",
Severity: framework.Error,
},
},
output: framework.Results{
{
Message: "Error message 2",
Severity: framework.Error,
},
{
Message: "Error message 1",
Severity: framework.Info,
},
},
},
{
name: "sort based on file",
input: framework.Results{
{
Message: "Error message",
Severity: framework.Error,
File: &framework.File{
Path: "resource.yaml",
Index: 1,
},
},
{
Message: "Error message",
Severity: framework.Info,
File: &framework.File{
Path: "resource.yaml",
Index: 0,
},
},
{
Message: "Error message",
Severity: framework.Info,
File: &framework.File{
Path: "other-resource.yaml",
Index: 0,
},
},
{
Message: "Error message",
Severity: framework.Warning,
File: &framework.File{
Path: "resource.yaml",
Index: 2,
},
},
{
Message: "Error message",
Severity: framework.Warning,
},
},
output: framework.Results{
{
Message: "Error message",
Severity: framework.Warning,
},
{
Message: "Error message",
Severity: framework.Info,
File: &framework.File{
Path: "other-resource.yaml",
Index: 0,
},
},
{
Message: "Error message",
Severity: framework.Info,
File: &framework.File{
Path: "resource.yaml",
Index: 0,
},
},
{
Message: "Error message",
Severity: framework.Error,
File: &framework.File{
Path: "resource.yaml",
Index: 1,
},
},
{
Message: "Error message",
Severity: framework.Warning,
File: &framework.File{
Path: "resource.yaml",
Index: 2,
},
},
},
},

{
name: "sort based on other fields",
input: framework.Results{
{
Message: "Error message",
Severity: framework.Error,
ResourceRef: &yaml.ResourceIdentifier{
TypeMeta: yaml.TypeMeta{
APIVersion: "v1",
Kind: "Pod",
},
NameMeta: yaml.NameMeta{
Namespace: "foo-ns",
Name: "bar",
},
},
Field: &framework.Field{
Path: "spec",
},
},
{
Message: "Error message",
Severity: framework.Error,
ResourceRef: &yaml.ResourceIdentifier{
TypeMeta: yaml.TypeMeta{
APIVersion: "v1",
Kind: "Pod",
},
NameMeta: yaml.NameMeta{
Namespace: "foo-ns",
Name: "bar",
},
},
Field: &framework.Field{
Path: "metadata.name",
},
},
{
Message: "Another error message",
Severity: framework.Error,
ResourceRef: &yaml.ResourceIdentifier{
TypeMeta: yaml.TypeMeta{
APIVersion: "v1",
Kind: "Pod",
},
NameMeta: yaml.NameMeta{
Namespace: "foo-ns",
Name: "bar",
},
},
Field: &framework.Field{
Path: "metadata.name",
},
},
{
Message: "Another error message",
Severity: framework.Error,
ResourceRef: &yaml.ResourceIdentifier{
TypeMeta: yaml.TypeMeta{
APIVersion: "v1",
Kind: "ConfigMap",
},
NameMeta: yaml.NameMeta{
Namespace: "foo-ns",
Name: "bar",
},
},
Field: &framework.Field{
Path: "metadata.name",
},
},
},
output: framework.Results{
{
Message: "Another error message",
Severity: framework.Error,
ResourceRef: &yaml.ResourceIdentifier{
TypeMeta: yaml.TypeMeta{
APIVersion: "v1",
Kind: "ConfigMap",
},
NameMeta: yaml.NameMeta{
Namespace: "foo-ns",
Name: "bar",
},
},
Field: &framework.Field{
Path: "metadata.name",
},
},
{
Message: "Another error message",
Severity: framework.Error,
ResourceRef: &yaml.ResourceIdentifier{
TypeMeta: yaml.TypeMeta{
APIVersion: "v1",
Kind: "Pod",
},
NameMeta: yaml.NameMeta{
Namespace: "foo-ns",
Name: "bar",
},
},
Field: &framework.Field{
Path: "metadata.name",
},
},
{
Message: "Error message",
Severity: framework.Error,
ResourceRef: &yaml.ResourceIdentifier{
TypeMeta: yaml.TypeMeta{
APIVersion: "v1",
Kind: "Pod",
},
NameMeta: yaml.NameMeta{
Namespace: "foo-ns",
Name: "bar",
},
},
Field: &framework.Field{
Path: "metadata.name",
},
},
{
Message: "Error message",
Severity: framework.Error,
ResourceRef: &yaml.ResourceIdentifier{
TypeMeta: yaml.TypeMeta{
APIVersion: "v1",
Kind: "Pod",
},
NameMeta: yaml.NameMeta{
Namespace: "foo-ns",
Name: "bar",
},
},
Field: &framework.Field{
Path: "spec",
},
},
},
},
}

for _, tc := range testcases {
tc.input.Sort()
if !reflect.DeepEqual(tc.input, tc.output) {
t.Errorf("in testcase %q, expect: %#v, but got: %#v", tc.name, tc.output, tc.input)
}
}
}