Skip to content

Commit

Permalink
feat: option to disable writing k8s events
Browse files Browse the repository at this point in the history
fix unit test
- application_test
- applicationset_test
- project_test
- appcontroller_tes
- audit_logger_test

Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com>
  • Loading branch information
Jack-R-lantern committed Jun 4, 2024
1 parent 6d11506 commit 04e885c
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 12 deletions.
2 changes: 1 addition & 1 deletion controller/appcontroller_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ import (
"github.com/argoproj/argo-cd/v2/util/settings"
)

var testEnableEventLog map[string](bool) = argo.TestEnableEventLog()
var testEnableEventLog []string = argo.TestEnableEvent()

type namespacedResource struct {
v1alpha1.ResourceNode
Expand Down
4 changes: 2 additions & 2 deletions server/application/application_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ func newTestAppServerWithEnforcerConfigure(f func(*rbac.Enforcer), t *testing.T,
settingsMgr,
projInformer,
[]string{},
argo.TestEnableEventLog(),
argo.TestEnableEvent(),
)
return server.(*Server)
}
Expand Down Expand Up @@ -487,7 +487,7 @@ func newTestAppServerWithEnforcerConfigureWithBenchmark(f func(*rbac.Enforcer),
settingsMgr,
projInformer,
[]string{},
argo.TestEnableEventLog(),
argo.TestEnableEvent(),
)
return server.(*Server)
}
Expand Down
2 changes: 1 addition & 1 deletion server/applicationset/applicationset_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ func newTestAppSetServerWithEnforcerConfigure(f func(*rbac.Enforcer), namespace
testNamespace,
sync.NewKeyLock(),
[]string{testNamespace, "external-namespace"},
argo.TestEnableEventLog(),
argo.TestEnableEvent(),
)
return server.(*Server)
}
Expand Down
2 changes: 1 addition & 1 deletion server/project/project_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ import (

const testNamespace = "default"

var testEnableEventLog map[string](bool) = argo.TestEnableEventLog()
var testEnableEventLog []string = argo.TestEnableEvent()

func TestProjectServer(t *testing.T) {
kubeclientset := fake.NewSimpleClientset(&corev1.ConfigMap{
Expand Down
47 changes: 40 additions & 7 deletions util/argo/audit_logger_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ import (
argoappv1 "github.com/argoproj/argo-cd/v2/pkg/apis/application/v1alpha1"
)

const (
_somecomponent = "somecomponent"
_test = "test"
)

var testEnableEventLog []string = []string{_somecomponent, _test}

// Helper to capture log entries generated by the logger and return it as string
func captureLogEntries(run func()) string {
f := log.StandardLogger().Formatter
Expand All @@ -29,13 +36,13 @@ func captureLogEntries(run func()) string {
}

func TestNewAuditLogger(t *testing.T) {
logger := NewAuditLogger("default", fake.NewSimpleClientset(), "somecomponent", TestEnableEventLog())
logger := NewAuditLogger("default", fake.NewSimpleClientset(), _somecomponent, testEnableEventLog)
assert.NotNil(t, logger)
}

func TestLogAppProjEvent(t *testing.T) {

logger := NewAuditLogger("default", fake.NewSimpleClientset(), "somecomponent", TestEnableEventLog())
logger := NewAuditLogger("default", fake.NewSimpleClientset(), _somecomponent, testEnableEventLog)
assert.NotNil(t, logger)

proj := argoappv1.AppProject{
Expand All @@ -51,7 +58,7 @@ func TestLogAppProjEvent(t *testing.T) {
}

ei := EventInfo{
Reason: "test",
Reason: _test,
Type: "info",
}

Expand All @@ -64,10 +71,19 @@ func TestLogAppProjEvent(t *testing.T) {
assert.Contains(t, output, "reason=test")
assert.Contains(t, output, "type=info")
assert.Contains(t, output, "msg=\"This is a test message\"")

ei.Reason = "Unknown"

// If K8s Event Disable Log
output = captureLogEntries(func() {
logger.LogAppProjEvent(&proj, ei, "This is a test message", "")
})

assert.Empty(t, output)
}

func TestLogAppEvent(t *testing.T) {
logger := NewAuditLogger("default", fake.NewSimpleClientset(), "somecomponent", TestEnableEventLog())
logger := NewAuditLogger("default", fake.NewSimpleClientset(), _somecomponent, testEnableEventLog)
assert.NotNil(t, logger)

app := argoappv1.Application{
Expand All @@ -86,7 +102,7 @@ func TestLogAppEvent(t *testing.T) {
}

ei := EventInfo{
Reason: "test",
Reason: _test,
Type: "info",
}

Expand All @@ -102,10 +118,18 @@ func TestLogAppEvent(t *testing.T) {
assert.Contains(t, output, "type=info")
assert.Contains(t, output, "msg=\"This is a test message\"")

ei.Reason = "Unknown"

// If K8s Event Disable Log
output = captureLogEntries(func() {
logger.LogAppEvent(&app, ei, "This is a test message", "")
})

assert.Empty(t, output)
}

func TestLogResourceEvent(t *testing.T) {
logger := NewAuditLogger("default", fake.NewSimpleClientset(), "somecomponent", TestEnableEventLog())
logger := NewAuditLogger("default", fake.NewSimpleClientset(), _somecomponent, testEnableEventLog)
assert.NotNil(t, logger)

res := argoappv1.ResourceNode{
Expand All @@ -120,7 +144,7 @@ func TestLogResourceEvent(t *testing.T) {
}

ei := EventInfo{
Reason: "test",
Reason: _test,
Type: "info",
}

Expand All @@ -133,4 +157,13 @@ func TestLogResourceEvent(t *testing.T) {
assert.Contains(t, output, "reason=test")
assert.Contains(t, output, "type=info")
assert.Contains(t, output, "msg=\"This is a test message\"")

ei.Reason = "Unknown"

// If K8s Event Disable Log
output = captureLogEntries(func() {
logger.LogResourceEvent(&res, ei, "This is a test message", "")
})

assert.Empty(t, output)
}

0 comments on commit 04e885c

Please sign in to comment.