Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
2 changes: 1 addition & 1 deletion pkg/events/emit.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ func (e *EventEmitter) SetLogger(logger *zap.SugaredLogger) {
}

func (e *EventEmitter) EmitMessage(repo *v1alpha1.Repository, loggerLevel zapcore.Level, reason, message string) {
if repo != nil {
if repo != nil && e.client != nil {
event := makeEvent(repo, loggerLevel, reason, message)
if _, err := e.client.CoreV1().Events(event.Namespace).Create(context.Background(), event, metav1.CreateOptions{}); err != nil {
if e.logger != nil {
Expand Down
29 changes: 27 additions & 2 deletions pkg/events/emit_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (
"gotest.tools/v3/assert"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes"
rtesting "knative.dev/pkg/reconciler/testing"
)

Expand All @@ -28,6 +29,7 @@ func TestEventEmitter_EmitMessage(t *testing.T) {
expectEvent bool
expectedType string
useNilLogger bool
useNilClient bool
}{
{
name: "repo exists",
Expand Down Expand Up @@ -82,6 +84,21 @@ func TestEventEmitter_EmitMessage(t *testing.T) {
expectedType: v1.EventTypeWarning,
useNilLogger: true,
},
{
name: "nil client doesn't cause panic",
repo: &v1alpha1.Repository{
ObjectMeta: metav1.ObjectMeta{
Name: "test-repo",
Namespace: "test-ns",
},
Spec: v1alpha1.RepositorySpec{},
},
message: "info-message",
logLevel: zap.InfoLevel,
expectEvent: false,
expectedType: v1.EventTypeNormal,
useNilClient: true,
},
Comment on lines +87 to +101

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This test case correctly verifies that a nil client doesn't cause a panic and that no Kubernetes event is emitted. However, the EmitMessage function is also expected to log the message regardless of whether an event is emitted. To make this test more comprehensive, consider asserting that the message is indeed logged using the zapobserver.

}

for _, tt := range tests {
Expand All @@ -97,8 +114,16 @@ func TestEventEmitter_EmitMessage(t *testing.T) {
logger = fakelogger
}

// emit event - this should not panic even with nil logger
NewEventEmitter(stdata.Kube, logger).EmitMessage(tt.repo, tt.logLevel, tt.reason, tt.message)
// Use nil client for specific test case
var client kubernetes.Interface
if tt.useNilClient {
client = nil
} else {
client = stdata.Kube
}

// emit event - this should not panic even with nil logger or nil client
NewEventEmitter(client, logger).EmitMessage(tt.repo, tt.logLevel, tt.reason, tt.message)

if tt.expectEvent {
events, err := stdata.Kube.CoreV1().Events(tt.repo.Namespace).List(context.Background(), metav1.ListOptions{})
Expand Down
Loading