Skip to content

Commit

Permalink
fix(events): do not derefence nil pointer
Browse files Browse the repository at this point in the history
Before checking if an owner reference is set as controller we check
that the field is not nil before dereferencing it.

Signed-off-by: Aldo Lacuku <[email protected]>
  • Loading branch information
alacuku authored and poiana committed Jun 5, 2024
1 parent 82bc192 commit 5af9aab
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 2 deletions.
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ require (
github.com/prometheus/client_golang v1.17.0
github.com/spf13/cobra v1.7.0
github.com/spf13/pflag v1.0.5
github.com/stretchr/testify v1.8.4
google.golang.org/grpc v1.61.0
google.golang.org/protobuf v1.31.0
k8s.io/api v0.28.4
Expand Down Expand Up @@ -69,7 +70,6 @@ require (
github.com/prometheus/common v0.44.0 // indirect
github.com/prometheus/procfs v0.12.0 // indirect
github.com/russross/blackfriday/v2 v2.1.0 // indirect
github.com/stretchr/testify v1.8.4 // indirect
github.com/urfave/cli v1.22.2 // indirect
go.uber.org/multierr v1.11.0 // indirect
go.uber.org/zap v1.26.0 // indirect
Expand Down
2 changes: 1 addition & 1 deletion pkg/events/owner.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import (
// ManagingOwner returns the controller owner of the resource if present.
func ManagingOwner(owners []v1.OwnerReference) *v1.OwnerReference {
for _, o := range owners {
if *o.Controller {
if o.Controller != nil && *o.Controller {
return &o
}
}
Expand Down
69 changes: 69 additions & 0 deletions pkg/events/owner_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright 2024 The Falco 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 events

import (
"testing"

"github.com/stretchr/testify/require"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/utils/ptr"
)

func TestManagingOwner(t *testing.T) {

tests := []struct {
name string
references []v1.OwnerReference
expected bool
}{
{
name: "Controller is set to true",
references: []v1.OwnerReference{{
Controller: ptr.To(true),
}},
expected: true,
},
{
name: "Controller is set to false",
references: []v1.OwnerReference{{
Controller: ptr.To(false),
}},
expected: false,
},
{
name: "Controller is set to nil",
references: []v1.OwnerReference{{
Controller: nil,
}},
expected: false,
},
}

for _, test := range tests {
test := test

t.Run(test.name, func(t *testing.T) {
t.Parallel()

if ManagingOwner(test.references) == nil {
require.False(t, test.expected)
} else {
require.True(t, test.expected)
}
})
}
}

0 comments on commit 5af9aab

Please sign in to comment.