-
Notifications
You must be signed in to change notification settings - Fork 104
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update nginx-prometheus-exporter to 1.0.0 (#1347)
Problem: The new version of the NGINX Prometheus Exporter introduces a couple of breaking changes. One of these changes is that the exporter now requires a logger to be passed to the collectors. This logger interface is incompatible with NGF's logger. Solution: Update to version 1.0.0 of the NGINX Prometheus Exporter and fix errors. Wraps the Prometheus exporter logger in an interface so that we can control its log level alongside our base logger.
- Loading branch information
1 parent
51e6109
commit bf87eec
Showing
11 changed files
with
501 additions
and
79 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| package static | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "testing" | ||
|
|
||
| . "github.com/onsi/gomega" | ||
| "k8s.io/apimachinery/pkg/types" | ||
| "k8s.io/client-go/tools/record" | ||
| "sigs.k8s.io/controller-runtime/pkg/log/zap" | ||
|
|
||
| ngfAPI "github.com/nginxinc/nginx-gateway-fabric/apis/v1alpha1" | ||
| "github.com/nginxinc/nginx-gateway-fabric/internal/framework/helpers" | ||
| "github.com/nginxinc/nginx-gateway-fabric/internal/mode/static/staticfakes" | ||
| ) | ||
|
|
||
| func TestUpdateControlPlane(t *testing.T) { | ||
| debugLogCfg := &ngfAPI.NginxGateway{ | ||
| Spec: ngfAPI.NginxGatewaySpec{ | ||
| Logging: &ngfAPI.Logging{ | ||
| Level: helpers.GetPointer(ngfAPI.ControllerLogLevelDebug), | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| invalidLevelConfig := &ngfAPI.NginxGateway{ | ||
| Spec: ngfAPI.NginxGatewaySpec{ | ||
| Logging: &ngfAPI.Logging{ | ||
| Level: helpers.GetPointer[ngfAPI.ControllerLogLevel]("invalid"), | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| logger := zap.New() | ||
| fakeEventRecorder := record.NewFakeRecorder(1) | ||
| nsname := types.NamespacedName{Namespace: "test", Name: "test"} | ||
|
|
||
| tests := []struct { | ||
| setLevelErr error | ||
| nginxGateway *ngfAPI.NginxGateway | ||
| name string | ||
| expErrString string | ||
| expSetLevelCallCount int | ||
| expEvent bool | ||
| }{ | ||
| { | ||
| name: "change log level", | ||
| nginxGateway: debugLogCfg, | ||
| expSetLevelCallCount: 1, | ||
| }, | ||
| { | ||
| name: "invalid log level", | ||
| nginxGateway: invalidLevelConfig, | ||
| expErrString: `Unsupported value: "invalid"`, | ||
| expSetLevelCallCount: 0, | ||
| }, | ||
| { | ||
| name: "nil NginxGateway", | ||
| nginxGateway: nil, | ||
| expEvent: true, | ||
| expSetLevelCallCount: 1, | ||
| }, | ||
| { | ||
| name: "set log level fails", | ||
| nginxGateway: debugLogCfg, | ||
| setLevelErr: errors.New("set level failed"), | ||
| expErrString: "set level failed", | ||
| expSetLevelCallCount: 1, | ||
| }, | ||
| } | ||
|
|
||
| for _, test := range tests { | ||
| t.Run(test.name, func(t *testing.T) { | ||
| g := NewWithT(t) | ||
|
|
||
| fakeLogSetter := &staticfakes.FakeLogLevelSetter{ | ||
| SetLevelStub: func(s string) error { | ||
| return test.setLevelErr | ||
| }, | ||
| } | ||
|
|
||
| err := updateControlPlane(test.nginxGateway, logger, fakeEventRecorder, nsname, fakeLogSetter) | ||
|
|
||
| if test.expErrString != "" { | ||
| g.Expect(err).To(HaveOccurred()) | ||
| g.Expect(err.Error()).To(ContainSubstring(test.expErrString)) | ||
| } else { | ||
| g.Expect(err).ToNot(HaveOccurred()) | ||
| } | ||
|
|
||
| if test.expEvent { | ||
| g.Expect(fakeEventRecorder.Events).To(HaveLen(1)) | ||
| event := <-fakeEventRecorder.Events | ||
| g.Expect(event).To(ContainSubstring("ResourceDeleted")) | ||
| } else { | ||
| g.Expect(fakeEventRecorder.Events).To(BeEmpty()) | ||
| } | ||
|
|
||
| g.Expect(fakeLogSetter.SetLevelCallCount()).To(Equal(test.expSetLevelCallCount)) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestValidateLogLevel(t *testing.T) { | ||
| validLevels := []ngfAPI.ControllerLogLevel{ | ||
| ngfAPI.ControllerLogLevelError, | ||
| ngfAPI.ControllerLogLevelInfo, | ||
| ngfAPI.ControllerLogLevelDebug, | ||
| } | ||
|
|
||
| invalidLevels := []ngfAPI.ControllerLogLevel{ | ||
| ngfAPI.ControllerLogLevel("invalid"), | ||
| ngfAPI.ControllerLogLevel("high"), | ||
| ngfAPI.ControllerLogLevel("warn"), | ||
| } | ||
|
|
||
| for _, level := range validLevels { | ||
| t.Run(fmt.Sprintf("valid level %q", level), func(t *testing.T) { | ||
| g := NewWithT(t) | ||
|
|
||
| g.Expect(validateLogLevel(level)).To(Succeed()) | ||
| }) | ||
| } | ||
|
|
||
| for _, level := range invalidLevels { | ||
| t.Run(fmt.Sprintf("invalid level %q", level), func(t *testing.T) { | ||
| g := NewWithT(t) | ||
|
|
||
| g.Expect(validateLogLevel(level)).ToNot(Succeed()) | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.