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

Automated cherry pick of #113133: Fix DeleteCollection API decode DeleteOptions fail #113234

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 5 additions & 3 deletions staging/src/k8s.io/apiserver/pkg/endpoints/handlers/delete.go
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@ func DeleteResource(r rest.GracefulDeleter, allowsOptions bool, scope *RequestSc

options := &metav1.DeleteOptions{}
if allowsOptions {
body, err := limitedReadBody(req, scope.MaxRequestBodyBytes)
body, err := limitedReadBodyWithRecordMetric(ctx, req, scope.MaxRequestBodyBytes, scope.Resource.GroupResource().String(), requestmetrics.Delete)
trace.Step("limitedReadBody done", utiltrace.Field{"len", len(body)}, utiltrace.Field{"err", err})
if err != nil {
scope.err(err, w, req)
return
Expand Down Expand Up @@ -225,13 +226,14 @@ func DeleteCollection(r rest.CollectionDeleter, checkBody bool, scope *RequestSc

options := &metav1.DeleteOptions{}
if checkBody {
body, err := limitedReadBody(req, scope.MaxRequestBodyBytes)
body, err := limitedReadBodyWithRecordMetric(ctx, req, scope.MaxRequestBodyBytes, scope.Resource.GroupResource().String(), requestmetrics.DeleteCollection)
trace.Step("limitedReadBody done", utiltrace.Field{"len", len(body)}, utiltrace.Field{"err", err})
if err != nil {
scope.err(err, w, req)
return
}
if len(body) > 0 {
s, err := negotiation.NegotiateInputSerializer(req, false, scope.Serializer)
s, err := negotiation.NegotiateInputSerializer(req, false, metainternalversionscheme.Codecs)
if err != nil {
scope.err(err, w, req)
return
Expand Down
72 changes: 72 additions & 0 deletions staging/src/k8s.io/apiserver/pkg/endpoints/handlers/delete_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ package handlers
import (
"context"
"io"
"net/http"
"strings"
"testing"

metainternalversionscheme "k8s.io/apimachinery/pkg/apis/meta/internalversion/scheme"
Expand All @@ -28,6 +30,7 @@ import (
"k8s.io/apimachinery/pkg/runtime/serializer"
auditapis "k8s.io/apiserver/pkg/apis/audit"
"k8s.io/apiserver/pkg/audit"
"k8s.io/apiserver/pkg/endpoints/handlers/negotiation"
"k8s.io/utils/pointer"
)

Expand Down Expand Up @@ -132,3 +135,72 @@ func TestDeleteResourceAuditLogRequestObject(t *testing.T) {
})
}
}

func TestDeleteCollection(t *testing.T) {
req := &http.Request{
Header: http.Header{},
}
req.Header.Set("Content-Type", "application/json")

fakeCorev1GroupVersion := schema.GroupVersion{
Group: "",
Version: "v1",
}
fakeCorev1Scheme := runtime.NewScheme()
fakeCorev1Scheme.AddKnownTypes(fakeCorev1GroupVersion, &metav1.DeleteOptions{})
fakeCorev1Codec := serializer.NewCodecFactory(fakeCorev1Scheme)

tests := []struct {
name string
codecFactory serializer.CodecFactory
data []byte
expectErr string
}{
// for issue: https://github.com/kubernetes/kubernetes/issues/111985
{
name: "decode '{}' to metav1.DeleteOptions with fakeCorev1Codecs",
codecFactory: fakeCorev1Codec,
data: []byte("{}"),
expectErr: "no kind \"DeleteOptions\" is registered",
},
{
name: "decode '{}' to metav1.DeleteOptions with metainternalversionscheme.Codecs",
codecFactory: metainternalversionscheme.Codecs,
data: []byte("{}"),
expectErr: "",
},
{
name: "decode versioned (corev1) DeleteOptions with metainternalversionscheme.Codecs",
codecFactory: metainternalversionscheme.Codecs,
data: []byte(`{"apiVersion":"v1","kind":"DeleteOptions","gracePeriodSeconds":123}`),
expectErr: "",
},
{
name: "decode versioned (foo) DeleteOptions with metainternalversionscheme.Codecs",
codecFactory: metainternalversionscheme.Codecs,
data: []byte(`{"apiVersion":"foo/v1","kind":"DeleteOptions","gracePeriodSeconds":123}`),
expectErr: "",
},
}

defaultGVK := metav1.SchemeGroupVersion.WithKind("DeleteOptions")
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
s, err := negotiation.NegotiateInputSerializer(req, false, test.codecFactory)
if err != nil {
t.Fatal(err)
}

options := &metav1.DeleteOptions{}
_, _, err = metainternalversionscheme.Codecs.DecoderToVersion(s.Serializer, defaultGVK.GroupVersion()).Decode(test.data, &defaultGVK, options)
if test.expectErr != "" {
if err == nil {
t.Fatalf("expect %s but got nil", test.expectErr)
}
if !strings.Contains(err.Error(), test.expectErr) {
t.Fatalf("expect %s but got %s", test.expectErr, err.Error())
}
}
})
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
/*
Copyright 2022 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package metrics

import (
"context"
"k8s.io/component-base/metrics"
)

type RequestBodyVerb string

const (
Patch RequestBodyVerb = "patch"
Delete RequestBodyVerb = "delete"
Update RequestBodyVerb = "update"
Create RequestBodyVerb = "create"
DeleteCollection RequestBodyVerb = "delete_collection"
)

var (
RequestBodySizes = metrics.NewHistogramVec(
&metrics.HistogramOpts{
Subsystem: "apiserver",
Name: "request_body_sizes",
Help: "Apiserver request body sizes broken out by size.",
// we use 0.05 KB as the smallest bucket with 0.1 KB increments up to the
// apiserver limit.
Buckets: metrics.LinearBuckets(50000, 100000, 31),
StabilityLevel: metrics.ALPHA,
},
[]string{"resource", "verb"},
)
)

func RecordRequestBodySize(ctx context.Context, resource string, verb RequestBodyVerb, size int) {
RequestBodySizes.WithContext(ctx).WithLabelValues(resource, string(verb)).Observe(float64(size))
}