Skip to content

Commit

Permalink
pkg:objstate: extend tests coverage for merge
Browse files Browse the repository at this point in the history 
Extend tests coverage by adding unit tests for the rest of the functions
for merge pkg.

Signed-off-by: Shereen Haj <[email protected]>
  • Loading branch information
@shajmakh
shajmakh committed Feb 3, 2025
1 parent a145443 commit 5e86d83
Showing 1 changed file with 275 additions and 0 deletions.
275 changes: 275 additions & 0 deletions pkg/objectstate/merge/merge_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ package merge
import (
"reflect"
"testing"
"time"

corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
Expand All @@ -27,6 +28,9 @@ import (
nropv1 "github.com/openshift-kni/numaresources-operator/api/v1"
)

// time and date format representation used to parse time from string
const layout = "Jan 27, 2024 at 3:04pm (MST)"

// defines test function input
type input struct {
current client.Object
Expand Down Expand Up @@ -372,3 +376,274 @@ func TestAnnotations(t *testing.T) {
})
}
}

func TestMetadataForUpdate(t *testing.T) {
curtm, _ := time.Parse(layout, "Jan 27, 2024 at 4:04pm (PST)")

Check failure on line 381 in pkg/objectstate/merge/merge_test.go

View workflow job for this annotation

GitHub Actions / golangci-lint 

SA1002: parsing time "Jan 27, 2024 at 3:04pm (MST)" as "Jan 27, 2024 at 3:04pm (MST)": cannot parse ", 2024 at 3:04pm (MST)" as "7, " (staticcheck)
oldtm, _ := time.Parse(layout, "Jan 26, 2024 at 8:04pm (PST)")

Check failure on line 382 in pkg/objectstate/merge/merge_test.go

View workflow job for this annotation

GitHub Actions / golangci-lint 

SA1002: parsing time "Jan 27, 2024 at 3:04pm (MST)" as "Jan 27, 2024 at 3:04pm (MST)": cannot parse ", 2024 at 3:04pm (MST)" as "7, " (staticcheck)

tests := []struct {
name string
input input
expected client.Object
err error
}{
{
name: "old metadata should be updated to the new one",
input: input{
current: &nropv1.NUMAResourcesOperator{
TypeMeta: metav1.TypeMeta{
Kind: "numaresourcesoperator",
},
ObjectMeta: metav1.ObjectMeta{
Name: "nro",
SelfLink: "my.nro.url",
UID: "e0870767-1248-42c3-8978-e1ef2e8eaad6",
ResourceVersion: "32695003",
Generation: 5,
CreationTimestamp: metav1.Time{curtm},

Check failure on line 403 in pkg/objectstate/merge/merge_test.go

View workflow job for this annotation

GitHub Actions / golangci-lint 

composites: k8s.io/apimachinery/pkg/apis/meta/v1.Time struct literal uses unkeyed fields (govet)

Check failure on line 403 in pkg/objectstate/merge/merge_test.go

View workflow job for this annotation

GitHub Actions / test-units 

k8s.io/apimachinery/pkg/apis/meta/v1.Time struct literal uses unkeyed fields
Labels: map[string]string{
"test1": "label1",
"test2": "label2",
},
Annotations: map[string]string{
"ann1": "val1",
"ann2": "val2",
},
Finalizers: []string{"finalizer-newstr"},
ManagedFields: []metav1.ManagedFieldsEntry{
{
Manager: "manager",
Operation: metav1.ManagedFieldsOperationApply,
APIVersion: "v1",
},
},
},
},
updated: &nropv1.NUMAResourcesOperator{
TypeMeta: metav1.TypeMeta{
Kind: "numaresourcesoperator",
},
ObjectMeta: metav1.ObjectMeta{
Name: "nro",
UID: "e0870767-1248-42c3-8978-e1ef2e8eaad6",
ResourceVersion: "12695003",
Generation: 4,
CreationTimestamp: metav1.Time{oldtm},

Check failure on line 431 in pkg/objectstate/merge/merge_test.go

View workflow job for this annotation

GitHub Actions / golangci-lint 

composites: k8s.io/apimachinery/pkg/apis/meta/v1.Time struct literal uses unkeyed fields (govet)

Check failure on line 431 in pkg/objectstate/merge/merge_test.go

View workflow job for this annotation

GitHub Actions / test-units 

k8s.io/apimachinery/pkg/apis/meta/v1.Time struct literal uses unkeyed fields
Labels: map[string]string{
"test1": "",
},
Annotations: map[string]string{
"ann1": "val1",
"ann3": "val3",
},
},
},
},
expected: &nropv1.NUMAResourcesOperator{
TypeMeta: metav1.TypeMeta{
Kind: "numaresourcesoperator",
},
ObjectMeta: metav1.ObjectMeta{
Name: "nro",
SelfLink: "my.nro.url",
UID: "e0870767-1248-42c3-8978-e1ef2e8eaad6",
ResourceVersion: "32695003",
Generation: 5,
CreationTimestamp: metav1.Time{curtm},

Check failure on line 452 in pkg/objectstate/merge/merge_test.go

View workflow job for this annotation

GitHub Actions / golangci-lint 

composites: k8s.io/apimachinery/pkg/apis/meta/v1.Time struct literal uses unkeyed fields (govet)

Check failure on line 452 in pkg/objectstate/merge/merge_test.go

View workflow job for this annotation

GitHub Actions / test-units 

k8s.io/apimachinery/pkg/apis/meta/v1.Time struct literal uses unkeyed fields
Labels: map[string]string{
"test1": "",
"test2": "label2",
},
Annotations: map[string]string{
"ann1": "val1",
"ann2": "val2",
"ann3": "val3",
},
Finalizers: []string{"finalizer-newstr"},
ManagedFields: []metav1.ManagedFieldsEntry{
{
Manager: "manager",
Operation: metav1.ManagedFieldsOperationApply,
APIVersion: "v1",
},
},
},
},
},
{
name: "merging 2 different kinds is forbidden",
input: input{
current: &nropv1.NUMAResourcesOperator{
TypeMeta: metav1.TypeMeta{
Kind: "numaresourcesoperator",
},
},
updated: &corev1.ServiceAccount{
TypeMeta: metav1.TypeMeta{
Kind: "ServiceAccount",
},
},
},
err: ErrMismatchingObjects,
},
}

for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got, err := MetadataForUpdate(test.input.current, test.input.updated)
if err != test.err {
t.Errorf("got error: %v, while expected to fail due to: %v", err, test.err)
}
if !reflect.DeepEqual(got, test.expected) {
t.Errorf("expected: %v, got: %v", test.expected, got)
}
})
}
}

func TestServiceAccountForUpdate(t *testing.T) {
curtm, _ := time.Parse(layout, "Jan 27, 2024 at 4:04pm (PST)")

Check failure on line 505 in pkg/objectstate/merge/merge_test.go

View workflow job for this annotation

GitHub Actions / golangci-lint 

SA1002: parsing time "Jan 27, 2024 at 3:04pm (MST)" as "Jan 27, 2024 at 3:04pm (MST)": cannot parse ", 2024 at 3:04pm (MST)" as "7, " (staticcheck)
oldtm, _ := time.Parse(layout, "Jan 26, 2024 at 8:04pm (PST)")

tests := []struct {
name string
input input
expected client.Object
err error
}{
{
name: "call with wrong object type",
input: input{
current: &nropv1.NUMAResourcesOperator{
TypeMeta: metav1.TypeMeta{
Kind: "numaresourcesoperator",
},
},
updated: &nropv1.NUMAResourcesOperator{
TypeMeta: metav1.TypeMeta{
Kind: "numaresourcesoperator",
},
},
},
err: ErrWrongObjectType,
},
{
name: "call with mismatching object types",
input: input{
current: &corev1.ServiceAccount{
TypeMeta: metav1.TypeMeta{
Kind: "ServiceAccount",
},
},
updated: &nropv1.NUMAResourcesOperator{
TypeMeta: metav1.TypeMeta{
Kind: "numaresourcesoperator",
},
},
},
err: ErrMismatchingObjects,
},
{
name: "old metadata should be updated to the new one",
input: input{
current: &corev1.ServiceAccount{
TypeMeta: metav1.TypeMeta{
Kind: "serviceaccount",
},
Secrets: []corev1.ObjectReference{
{Name: "builder-dockercfg-XXXX"},
},
ObjectMeta: metav1.ObjectMeta{
Name: "builder",
SelfLink: "my.sa.url",
UID: "e0870767-1248-42c3-8978-e1ef2e8eaad6",
ResourceVersion: "32695003",
Generation: 5,
CreationTimestamp: metav1.Time{curtm},

Check failure on line 562 in pkg/objectstate/merge/merge_test.go

View workflow job for this annotation

GitHub Actions / test-units 

k8s.io/apimachinery/pkg/apis/meta/v1.Time struct literal uses unkeyed fields
Labels: map[string]string{
"test1": "label1",
"test2": "label2",
},
Annotations: map[string]string{
"ann1": "val1",
"ann2": "val2",
},
Finalizers: []string{"finalizer-newstr"},
ManagedFields: []metav1.ManagedFieldsEntry{
{
Manager: "manager",
Operation: metav1.ManagedFieldsOperationApply,
APIVersion: "v1",
},
},
},
},
updated: &corev1.ServiceAccount{
TypeMeta: metav1.TypeMeta{
Kind: "serviceaccount",
},
ObjectMeta: metav1.ObjectMeta{
Name: "builder",
UID: "e0870767-1248-42c3-8978-e1ef2e8eaad6",
ResourceVersion: "12695003",
Generation: 4,
CreationTimestamp: metav1.Time{oldtm},

Check failure on line 590 in pkg/objectstate/merge/merge_test.go

View workflow job for this annotation

GitHub Actions / test-units 

k8s.io/apimachinery/pkg/apis/meta/v1.Time struct literal uses unkeyed fields
Labels: map[string]string{
"test1": "",
},
Annotations: map[string]string{
"ann1": "val1",
"ann3": "val3",
},
},
},
},
expected: &corev1.ServiceAccount{
TypeMeta: metav1.TypeMeta{
Kind: "serviceaccount",
},
Secrets: []corev1.ObjectReference{
{Name: "builder-dockercfg-XXXX"},
},
ObjectMeta: metav1.ObjectMeta{
Name: "builder",
SelfLink: "my.sa.url",
UID: "e0870767-1248-42c3-8978-e1ef2e8eaad6",
ResourceVersion: "32695003",
Generation: 5,
CreationTimestamp: metav1.Time{curtm},

Check failure on line 614 in pkg/objectstate/merge/merge_test.go

View workflow job for this annotation

GitHub Actions / test-units 

k8s.io/apimachinery/pkg/apis/meta/v1.Time struct literal uses unkeyed fields
Labels: map[string]string{
"test1": "",
"test2": "label2",
},
Annotations: map[string]string{
"ann1": "val1",
"ann2": "val2",
"ann3": "val3",
},
Finalizers: []string{"finalizer-newstr"},
ManagedFields: []metav1.ManagedFieldsEntry{
{
Manager: "manager",
Operation: metav1.ManagedFieldsOperationApply,
APIVersion: "v1",
},
},
},
},
},
}

for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got, err := ServiceAccountForUpdate(test.input.current, test.input.updated)
if err != test.err {
t.Errorf("expected error: %v, got: %v", test.err, err)
return
}
if !reflect.DeepEqual(got, test.expected) {
t.Errorf("expected updated service account: %v, got: %v", test.expected, got)
}
})
}
}

0 comments on commit 5e86d83

Please sign in to comment.