Skip to content

fake-client in UTs #2541

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

Closed
wants to merge 1 commit into from
Closed

fake-client in UTs #2541

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 57 additions & 34 deletions pkg/controller.v1beta1/experiment/manifest/generator_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,13 @@ import (

"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
"go.uber.org/mock/gomock"
batchv1 "k8s.io/api/batch/v1"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/client/fake"

commonapiv1beta1 "github.com/kubeflow/katib/pkg/apis/controller/common/v1beta1"
experimentsv1beta1 "github.com/kubeflow/katib/pkg/apis/controller/experiments/v1beta1"
Expand All @@ -37,13 +39,12 @@ import (

func TestGetRunSpecWithHP(t *testing.T) {

mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()

c := katibclientmock.NewMockClient(mockCtrl)

scheme := runtime.NewScheme()
v1.AddToScheme(scheme)
fakeClient := fake.NewClientBuilder().WithScheme(scheme).Build()
katibClient := katibclientmock.NewFakeClient(fakeClient)
p := &DefaultGenerator{
client: c,
client: katibClient,
}

expectedJob := batchv1.Job{
Expand Down Expand Up @@ -152,15 +153,7 @@ func TestGetRunSpecWithHP(t *testing.T) {
}

func TestGetRunSpecWithHPConfigMap(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()

c := katibclientmock.NewMockClient(mockCtrl)

p := &DefaultGenerator{
client: c,
}

// Mocking the ConfigMap
templatePath := "trial-template-path"

trialSpec := `apiVersion: batch/v1
Expand Down Expand Up @@ -222,17 +215,23 @@ spec:
}

cases := map[string]struct {
mockConfigMapGetter func() *gomock.Call
objects []runtime.Object
instance *experimentsv1beta1.Experiment
parameterAssignments []commonapiv1beta1.ParameterAssignment
wantRunSpecWithHyperParameters *unstructured.Unstructured
wantError error
}{
"Run with valid parameters": {
mockConfigMapGetter: func() *gomock.Call {
return c.EXPECT().GetConfigMap(gomock.Any(), gomock.Any()).Return(
map[string]string{templatePath: trialSpec}, nil,
)
objects: []runtime.Object{
&v1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "config-map-name",
Namespace: "config-map-namespace",
},
Data: map[string]string{
templatePath: trialSpec,
},
},
},
instance: func() *experimentsv1beta1.Experiment {
i := newFakeInstance()
Expand All @@ -249,10 +248,16 @@ spec:
wantRunSpecWithHyperParameters: expectedRunSpec,
},
"Invalid ConfigMap name": {
mockConfigMapGetter: func() *gomock.Call {
return c.EXPECT().GetConfigMap(gomock.Any(), gomock.Any()).Return(
nil, errConfigMapNotFound,
)
objects: []runtime.Object{
&v1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "config-map-name",
Namespace: "config-map-namespace",
},
Data: map[string]string{
templatePath: trialSpec,
},
},
},
instance: func() *experimentsv1beta1.Experiment {
i := newFakeInstance()
Expand All @@ -267,10 +272,16 @@ spec:
wantError: errConfigMapNotFound,
},
"Invalid template path in ConfigMap name": {
mockConfigMapGetter: func() *gomock.Call {
return c.EXPECT().GetConfigMap(gomock.Any(), gomock.Any()).Return(
map[string]string{templatePath: trialSpec}, nil,
)
objects: []runtime.Object{
&v1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "config-map-name",
Namespace: "config-map-namespace",
},
Data: map[string]string{
templatePath: trialSpec, //No templatePath
},
},
},
instance: func() *experimentsv1beta1.Experiment {
i := newFakeInstance()
Expand All @@ -289,10 +300,16 @@ spec:
// Trial template is a string in ConfigMap
// Because of that, user can specify not valid unstructured template
"Invalid trial spec in ConfigMap": {
mockConfigMapGetter: func() *gomock.Call {
return c.EXPECT().GetConfigMap(gomock.Any(), gomock.Any()).Return(
map[string]string{templatePath: invalidTrialSpec}, nil,
)
objects: []runtime.Object{
&v1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "config-map-name",
Namespace: "config-map-namespace",
},
Data: map[string]string{
templatePath: invalidTrialSpec,
},
},
},
instance: func() *experimentsv1beta1.Experiment {
i := newFakeInstance()
Expand All @@ -312,7 +329,13 @@ spec:

for name, tc := range cases {
t.Run(name, func(t *testing.T) {
tc.mockConfigMapGetter()
scheme := runtime.NewScheme()
v1.AddToScheme(scheme)
fakeClient := fake.NewClientBuilder().WithScheme(scheme).WithRuntimeObjects(tc.objects...).Build()
katibClient := katibclientmock.NewFakeClient(fakeClient)
p := &DefaultGenerator{
client: katibClient,
}
got, err := p.GetRunSpecWithHyperParameters(tc.instance, "trial-name", "trial-namespace", tc.parameterAssignments)
if diff := cmp.Diff(tc.wantError, err, cmpopts.EquateErrors()); len(diff) != 0 {
t.Errorf("Unexpected error from GetRunSpecWithHyperParameters (-want,+got):\n%s", diff)
Expand Down
Loading