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

adaptation: return nil as no-op adjustment. #118

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

adaptation: return nil as no-op adjustment. #118

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions pkg/adaptation/adaptation_suite_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@ import (
"context"
"os"
"path/filepath"
"reflect"
"strconv"
"strings"
"time"
"unsafe"

"sigs.k8s.io/yaml"

Expand Down Expand Up @@ -439,6 +441,23 @@ var _ = Describe("Plugin container creation adjustments", func() {
plugin := p.idx + "-" + p.name
a := &api.ContainerAdjustment{}
switch subject {
case "all-nil-adjustment":
return nil, nil, nil

case "00-nil-adjustment":
if p.idx == "00" {
return nil, nil, nil
} else {
a.AddAnnotation("non-nil-adjustment", p.idx+"-"+p.name)
}

case "10-nil-adjustment":
if p.idx == "10" {
return nil, nil, nil
} else {
a.AddAnnotation("non-nil-adjustment", p.idx+"-"+p.name)
}

case "annotation":
if overwrite {
a.RemoveAnnotation("key")
Expand Down Expand Up @@ -592,6 +611,9 @@ var _ = Describe("Plugin container creation adjustments", func() {
Expect(stripAdjustment(reply.Adjust)).Should(Equal(stripAdjustment(expected)))
},

Entry("nil adjustment", "all-nil-adjustment",
nil,
),
Entry("adjust annotations", "annotation",
&api.ContainerAdjustment{
Annotations: map[string]string{
Expand Down Expand Up @@ -807,6 +829,24 @@ var _ = Describe("Plugin container creation adjustments", func() {
}
},

Entry("all nil adjustment", "all-nil-adjustment", false, false,
nil,
),

Entry("00 nil adjustment", "00-nil-adjustment", false, false,
&api.ContainerAdjustment{
Annotations: map[string]string{
"non-nil-adjustment": "10-foo",
},
},
),
Entry("10 nil adjustment", "10-nil-adjustment", false, false,
&api.ContainerAdjustment{
Annotations: map[string]string{
"non-nil-adjustment": "00-bar",
},
},
),
Entry("adjust annotations (conflicts)", "annotation", false, true, nil),
Entry("adjust annotations", "annotation", true, false,
&api.ContainerAdjustment{
Expand Down Expand Up @@ -1946,13 +1986,28 @@ var _ = Describe("Plugin configuration request", func() {
// around we marshal then unmarshal compared objects in offending test cases to
// clear those unexported fields.
func strip(obj interface{}, ptr interface{}) interface{} {
if isNil(obj) {
return nilPtrFor(ptr)
}
bytes, err := yaml.Marshal(obj)
Expect(err).To(BeNil())
Expect(yaml.Unmarshal(bytes, ptr)).To(Succeed())
return ptr
}

func isNil(obj interface{}) bool {
return (*[2]uintptr)(unsafe.Pointer(&obj))[1] == 0
}

func nilPtrFor(ptr interface{}) interface{} {
t := reflect.TypeOf(ptr)
return reflect.Zero(t).Interface()
}

func stripAdjustment(a *api.ContainerAdjustment) *api.ContainerAdjustment {
if a == nil {
return nil
}
stripAnnotations(a)
stripMounts(a)
stripEnv(a)
Expand Down
111 changes: 92 additions & 19 deletions pkg/adaptation/result.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,25 +84,7 @@ func collectCreateContainerResult(request *CreateContainerRequest) *result {
request: resultRequest{
create: request,
},
reply: resultReply{
adjust: &ContainerAdjustment{
Annotations: map[string]string{},
Mounts: []*Mount{},
Env: []*KeyValue{},
Hooks: &Hooks{},
Rlimits: []*POSIXRlimit{},
CDIDevices: []*CDIDevice{},
Linux: &LinuxContainerAdjustment{
Devices: []*LinuxDevice{},
Resources: &LinuxResources{
Memory: &LinuxMemory{},
Cpu: &LinuxCPU{},
HugepageLimits: []*HugepageLimit{},
Unified: map[string]string{},
},
},
},
},
reply: resultReply{},
updates: map[string]*ContainerUpdate{},
owners: resultOwners{},
}
Expand Down Expand Up @@ -249,6 +231,8 @@ func (r *result) adjustAnnotations(annotations map[string]string, plugin string)
return nil
}

r.initAdjustAnnotations()

create, id := r.request.create, r.request.create.Container.Id
del := map[string]struct{}{}
for k := range annotations {
Expand Down Expand Up @@ -284,6 +268,8 @@ func (r *result) adjustMounts(mounts []*Mount, plugin string) error {
return nil
}

r.initAdjustMounts()

create, id := r.request.create, r.request.create.Container.Id

// first split removals from the rest of adjustments
Expand Down Expand Up @@ -349,6 +335,8 @@ func (r *result) adjustDevices(devices []*LinuxDevice, plugin string) error {
return nil
}

r.initAdjustDevices()

create, id := r.request.create, r.request.create.Container.Id

// first split removals from the rest of adjustments
Expand Down Expand Up @@ -407,6 +395,8 @@ func (r *result) adjustCDIDevices(devices []*CDIDevice, plugin string) error {
return nil
}

r.initAdjustCDIDevices()

// Notes:
// CDI devices are opaque references, typically to vendor specific
// devices. They get resolved to actual devices and potential related
Expand Down Expand Up @@ -437,6 +427,8 @@ func (r *result) adjustEnv(env []*KeyValue, plugin string) error {
return nil
}

r.initAdjustEnv()

create, id := r.request.create, r.request.create.Container.Id

// first split removals from the rest of adjustments
Expand Down Expand Up @@ -509,6 +501,8 @@ func (r *result) adjustHooks(hooks *Hooks) error {
return nil
}

r.initAdjustHooks()

reply := r.reply.adjust
container := r.request.create.Container

Expand Down Expand Up @@ -545,6 +539,8 @@ func (r *result) adjustResources(resources *LinuxResources, plugin string) error
return nil
}

r.initAdjustResources()

create, id := r.request.create, r.request.create.Container.Id
container := create.Container.Linux.Resources
reply := r.reply.adjust.Linux.Resources
Expand Down Expand Up @@ -709,6 +705,8 @@ func (r *result) adjustCgroupsPath(path, plugin string) error {
return nil
}

r.initAdjustCgroupsPath()

create, id := r.request.create, r.request.create.Container.Id

if err := r.owners.claimCgroupsPath(id, plugin); err != nil {
Expand All @@ -726,6 +724,8 @@ func (r *result) adjustOomScoreAdj(OomScoreAdj *OptionalInt, plugin string) erro
return nil
}

r.initAdjustOomScoreAdj()

create, id := r.request.create, r.request.create.Container.Id

if err := r.owners.claimOomScoreAdj(id, plugin); err != nil {
Expand All @@ -739,6 +739,12 @@ func (r *result) adjustOomScoreAdj(OomScoreAdj *OptionalInt, plugin string) erro
}

func (r *result) adjustRlimits(rlimits []*POSIXRlimit, plugin string) error {
if len(rlimits) == 0 {
return nil
}

r.initAdjustRlimits()

create, id, adjust := r.request.create, r.request.create.Container.Id, r.reply.adjust
for _, l := range rlimits {
if err := r.owners.claimRlimits(id, l.Type, plugin); err != nil {
Expand All @@ -751,6 +757,73 @@ func (r *result) adjustRlimits(rlimits []*POSIXRlimit, plugin string) error {
return nil
}

func (r *result) initAdjust() {
if r.reply.adjust == nil {
r.reply.adjust = &ContainerAdjustment{}
}
}

func (r *result) initAdjustAnnotations() {
r.initAdjust()
if r.reply.adjust.Annotations == nil {
r.reply.adjust.Annotations = map[string]string{}
}
}

func (r *result) initAdjustMounts() {
r.initAdjust()
}

func (r *result) initAdjustEnv() {
r.initAdjust()
}

func (r *result) initAdjustHooks() {
r.initAdjust()
if r.reply.adjust.Hooks == nil {
r.reply.adjust.Hooks = &Hooks{}
}
}

func (r *result) initAdjustLinux() {
r.initAdjust()
if r.reply.adjust.Linux == nil {
r.reply.adjust.Linux = &LinuxContainerAdjustment{}
}
}

func (r *result) initAdjustDevices() {
r.initAdjustLinux()
}

func (r *result) initAdjustResources() {
r.initAdjustLinux()
if r.reply.adjust.Linux.Resources == nil {
r.reply.adjust.Linux.Resources = &LinuxResources{
Memory: &LinuxMemory{},
Cpu: &LinuxCPU{},
HugepageLimits: []*HugepageLimit{},
Unified: map[string]string{},
klihub marked this conversation as resolved.
Show resolved Hide resolved
}
}
}

func (r *result) initAdjustCgroupsPath() {
r.initAdjustLinux()
}

func (r *result) initAdjustOomScoreAdj() {
r.initAdjustLinux()
}

func (r *result) initAdjustRlimits() {
r.initAdjustLinux()
}

func (r *result) initAdjustCDIDevices() {
r.initAdjust()
}

func (r *result) updateResources(reply, u *ContainerUpdate, plugin string) error {
if u.Linux == nil || u.Linux.Resources == nil {
return nil
Expand Down
Loading