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.

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

Add validation for build and function resoruces #429

Merged
merged 7 commits into from
Nov 22, 2023
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
13 changes: 11 additions & 2 deletions components/serverless/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@ test-local:
CONTROLLER_GEN_VERSION=v0.9.2

.PHONY: manifests
manifests: controller-gen-local generate-local
@make -C ${PROJECT_ROOT} kustomize
manifests: kustomize controller-gen-local generate-local
$(CONTROLLER_GEN) rbac:roleName=serverless crd webhook paths="./..." \
object:headerFile=hack/boilerplate.go.txt \
output:crd:artifacts:config=config/crd/bases \
Expand Down Expand Up @@ -205,3 +204,13 @@ $(ENVTEST): $(LOCALBIN)
.PHONY: test
test: envtest
KUBEBUILDER_CONTROLPLANE_START_TIMEOUT=2m KUBEBUILDER_CONTROLPLANE_STOP_TIMEOUT=2m KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./...

########## Kustomize ###########
KUSTOMIZE ?= $(LOCALBIN)/kustomize
KUSTOMIZE_VERSION ?= v4.5.5
KUSTOMIZE_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh"

.PHONY: kustomize
kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary.
$(KUSTOMIZE): $(LOCALBIN)
test -s $(LOCALBIN)/kustomize || { curl -Ss $(KUSTOMIZE_INSTALL_SCRIPT) | bash -s -- $(subst v,,$(KUSTOMIZE_VERSION)) $(LOCALBIN); }
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ func NewFunctionReconciler(client resource.Client, log *zap.SugaredLogger, confi
gitFactory: gitFactory,
healthCh: healthCh,
statsCollector: statsCollector,
initStateFunction: stateFnInitialize,
initStateFunction: stateFnValidateFunction,
}
}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
package serverless

import (
"context"
serverlessv1alpha2 "github.com/kyma-project/kyma/components/function-controller/pkg/apis/serverless/v1alpha2"
corev1 "k8s.io/api/core/v1"
resource "k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

type validationResult struct {
valid bool
msg string
}

var _ stateFn = stateFnValidateFunction

func stateFnValidateFunction(_ context.Context, r *reconciler, s *systemState) (stateFn, error) {
rc := s.instance.Spec.ResourceConfiguration
vr := validateFunctionResources(rc)
if !vr.valid {
cond := createValidationFailedCondition(vr.msg)
r.result.Requeue = false
return buildStatusUpdateStateFnWithCondition(cond), nil
}

vr = validateBuildResources(rc)
if !vr.valid {
cond := createValidationFailedCondition(vr.msg)
r.result.Requeue = false
return buildStatusUpdateStateFnWithCondition(cond), nil
}
return stateFnInitialize, nil
}

func validateFunctionResources(rc *serverlessv1alpha2.ResourceConfiguration) validationResult {
if rc != nil && rc.Function != nil && rc.Function.Resources != nil {
vr := validateResources(rc.Function.Resources)
return vr
}
return validationResult{valid: true}
}

func validateBuildResources(rc *serverlessv1alpha2.ResourceConfiguration) validationResult {
if rc != nil && rc.Build != nil && rc.Build.Resources != nil {
vr := validateResources(rc.Build.Resources)
return vr
}
return validationResult{valid: true}
}

func validateResources(r *corev1.ResourceRequirements) validationResult {
if isMore(r.Requests.Cpu(), *r.Limits.Cpu()) {
return validationResult{
valid: false,
msg: "Request cpu cannot be bigger than limits cpu"}
}

if isMore(r.Requests.Memory(), *r.Limits.Memory()) {
return validationResult{
valid: false,
msg: "Request memory cannot be bigger than limits memory"}
}
return validationResult{valid: true}
}

func createValidationFailedCondition(msg string) serverlessv1alpha2.Condition {
return serverlessv1alpha2.Condition{
Type: serverlessv1alpha2.ConditionConfigurationReady,
Status: corev1.ConditionFalse,
LastTransitionTime: metav1.Now(),
Reason: serverlessv1alpha2.ConditionReasonFunctionSpec,
Message: msg,
}
}

func isMore(q1 *resource.Quantity, q2 resource.Quantity) bool {
return q1.Cmp(q2) != -1
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
package serverless

import (
"context"
"github.com/kyma-project/kyma/components/function-controller/internal/controllers/serverless/automock"
serverlessResource "github.com/kyma-project/kyma/components/function-controller/internal/resource"
serverlessv1alpha2 "github.com/kyma-project/kyma/components/function-controller/pkg/apis/serverless/v1alpha2"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/mock"
"github.com/stretchr/testify/require"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes/scheme"
"k8s.io/client-go/tools/record"
controllerruntime "sigs.k8s.io/controller-runtime"
ctrlclient "sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/client/fake"
"testing"
)

// TODO: add separate use cases with memory and cpu
func TestValidation(t *testing.T) {
//GIVEN
ctx := context.TODO()

k8sClient := fake.NewClientBuilder().Build()
require.NoError(t, serverlessv1alpha2.AddToScheme(scheme.Scheme))
resourceClient := serverlessResource.New(k8sClient, scheme.Scheme)

statsCollector := &automock.StatsCollector{}
statsCollector.On("UpdateReconcileStats", mock.Anything, mock.Anything).Return()

r := &reconciler{out: out{result: controllerruntime.Result{}},
k8s: k8s{client: resourceClient, recorder: record.NewFakeRecorder(100), statsCollector: statsCollector}}

testCases := map[string]struct {
fn serverlessv1alpha2.Function
}{
"Function requests cpu are bigger than limits": {
fn: serverlessv1alpha2.Function{
ObjectMeta: metav1.ObjectMeta{
GenerateName: "test-fn",
},
Spec: serverlessv1alpha2.FunctionSpec{
ResourceConfiguration: &serverlessv1alpha2.ResourceConfiguration{
Function: &serverlessv1alpha2.ResourceRequirements{Resources: &corev1.ResourceRequirements{
Limits: map[corev1.ResourceName]resource.Quantity{
corev1.ResourceCPU: resource.MustParse("120m"),
corev1.ResourceMemory: resource.MustParse("120m"),
},
Requests: map[corev1.ResourceName]resource.Quantity{
corev1.ResourceCPU: resource.MustParse("150m"),
corev1.ResourceMemory: resource.MustParse("50m"),
}}},
},
},
},
},
"Function requests memory are bigger than limits": {
fn: serverlessv1alpha2.Function{
ObjectMeta: metav1.ObjectMeta{
GenerateName: "test-fn",
},
Spec: serverlessv1alpha2.FunctionSpec{
ResourceConfiguration: &serverlessv1alpha2.ResourceConfiguration{
Function: &serverlessv1alpha2.ResourceRequirements{Resources: &corev1.ResourceRequirements{
Limits: map[corev1.ResourceName]resource.Quantity{
corev1.ResourceCPU: resource.MustParse("120m"),
corev1.ResourceMemory: resource.MustParse("120m"),
},
Requests: map[corev1.ResourceName]resource.Quantity{
corev1.ResourceCPU: resource.MustParse("50m"),
corev1.ResourceMemory: resource.MustParse("150m"),
}}},
},
},
},
},
"Build requests cpu are bigger than limits": {
fn: serverlessv1alpha2.Function{
ObjectMeta: metav1.ObjectMeta{
GenerateName: "test-fn",
},
Spec: serverlessv1alpha2.FunctionSpec{
ResourceConfiguration: &serverlessv1alpha2.ResourceConfiguration{
Build: &serverlessv1alpha2.ResourceRequirements{Resources: &corev1.ResourceRequirements{
Limits: map[corev1.ResourceName]resource.Quantity{
corev1.ResourceCPU: resource.MustParse("120m"),
corev1.ResourceMemory: resource.MustParse("120m"),
},
Requests: map[corev1.ResourceName]resource.Quantity{
corev1.ResourceCPU: resource.MustParse("150m"),
corev1.ResourceMemory: resource.MustParse("50m"),
}}},
},
},
},
},
"Build requests memory are bigger than limits": {
fn: serverlessv1alpha2.Function{
ObjectMeta: metav1.ObjectMeta{
GenerateName: "test-fn",
},
Spec: serverlessv1alpha2.FunctionSpec{
ResourceConfiguration: &serverlessv1alpha2.ResourceConfiguration{
Build: &serverlessv1alpha2.ResourceRequirements{Resources: &corev1.ResourceRequirements{
Limits: map[corev1.ResourceName]resource.Quantity{
corev1.ResourceCPU: resource.MustParse("120m"),
corev1.ResourceMemory: resource.MustParse("120m"),
},
Requests: map[corev1.ResourceName]resource.Quantity{
corev1.ResourceCPU: resource.MustParse("50m"),
corev1.ResourceMemory: resource.MustParse("150m"),
}}},
},
},
},
},
}

//WHEN
for name, tc := range testCases {
t.Run(name, func(t *testing.T) {
require.NoError(t, resourceClient.Create(ctx, &tc.fn))
s := &systemState{instance: tc.fn}
nextFn, err := stateFnValidateFunction(ctx, r, s)
require.NoError(t, err)
_, err = nextFn(context.TODO(), r, s)
//THEN
require.NoError(t, err)
updatedFn := serverlessv1alpha2.Function{}
require.NoError(t, resourceClient.Get(ctx, ctrlclient.ObjectKey{Name: tc.fn.Name}, &updatedFn))
reason := getConditionReason(updatedFn.Status.Conditions, serverlessv1alpha2.ConditionConfigurationReady)
assert.Contains(t, reason, serverlessv1alpha2.ConditionReasonFunctionSpec)
status := getConditionStatus(updatedFn.Status.Conditions, serverlessv1alpha2.ConditionConfigurationReady)
assert.Equal(t, corev1.ConditionFalse, status)
assert.False(t, r.result.Requeue)

})
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,7 @@ const (
type ConditionReason string

const (
ConditionReasonFunctionSpec ConditionReason = "InvalidFunctionSpec"
ConditionReasonConfigMapCreated ConditionReason = "ConfigMapCreated"
ConditionReasonConfigMapUpdated ConditionReason = "ConfigMapUpdated"
ConditionReasonSourceUpdated ConditionReason = "SourceUpdated"
Expand Down
8 changes: 4 additions & 4 deletions config/serverless/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -82,19 +82,19 @@ global:
directory: "prod"
function_controller:
name: "function-controller"
version: "PR-428"
version: "PR-429"
directory: "dev"
function_webhook:
name: "function-webhook"
version: "PR-428"
version: "PR-429"
directory: "dev"
function_build_init:
name: "function-build-init"
version: "PR-428"
version: "PR-429"
directory: "dev"
function_registry_gc:
name: "function-registry-gc"
version: "PR-428"
version: "PR-429"
directory: "dev"
function_runtime_nodejs16:
name: "function-runtime-nodejs16"
Expand Down