-
Notifications
You must be signed in to change notification settings - Fork 3
ci: improve sysdig client test coverage #81
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.
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
Open
tembleking
wants to merge
1
commit into
main
Choose a base branch
from
test/improve-sysdig-client-coverage
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -12,21 +12,26 @@ import ( | |||||||||||
| "github.com/sysdiglabs/sysdig-mcp-server/internal/infra/sysdig" | ||||||||||||
| ) | ||||||||||||
|
|
||||||||||||
| func permissionsHandler(captureHeaders func(http.Header)) http.Handler { | ||||||||||||
| return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||||||||||||
| if captureHeaders != nil { | ||||||||||||
| captureHeaders(r.Header) | ||||||||||||
| } | ||||||||||||
| if r.URL.Path == "/api/users/me/permissions" { | ||||||||||||
| w.Header().Set("Content-Type", "application/json") | ||||||||||||
| w.WriteHeader(http.StatusOK) | ||||||||||||
| _, _ = w.Write([]byte(`{"permissions":[]}`)) | ||||||||||||
| return | ||||||||||||
| } | ||||||||||||
| w.WriteHeader(http.StatusNotFound) | ||||||||||||
| }) | ||||||||||||
| } | ||||||||||||
|
|
||||||||||||
| var _ = Describe("Client TLS", func() { | ||||||||||||
| var ts *httptest.Server | ||||||||||||
|
|
||||||||||||
| BeforeEach(func() { | ||||||||||||
| // Start a TLS server with a self-signed certificate | ||||||||||||
| ts = httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||||||||||||
| if r.URL.Path == "/api/users/me/permissions" { | ||||||||||||
| w.Header().Set("Content-Type", "application/json") | ||||||||||||
| w.WriteHeader(http.StatusOK) | ||||||||||||
| _, _ = w.Write([]byte(`{"permissions":[]}`)) | ||||||||||||
| return | ||||||||||||
| } | ||||||||||||
| w.WriteHeader(http.StatusNotFound) | ||||||||||||
| })) | ||||||||||||
| // Redirect server logs to GinkgoWriter to avoid noise in test output | ||||||||||||
| ts = httptest.NewTLSServer(permissionsHandler(nil)) | ||||||||||||
| ts.Config.ErrorLog = log.New(GinkgoWriter, "", 0) | ||||||||||||
| }) | ||||||||||||
|
|
||||||||||||
|
|
@@ -35,35 +40,153 @@ var _ = Describe("Client TLS", func() { | |||||||||||
| }) | ||||||||||||
|
|
||||||||||||
| It("should fail request with self-signed cert by default", func() { | ||||||||||||
| // Create client pointing to the TLS server without custom transport | ||||||||||||
| client, err := sysdig.NewSysdigClient( | ||||||||||||
| sysdig.WithFixedHostAndToken(ts.URL, "dummy-token"), | ||||||||||||
| ) | ||||||||||||
| Expect(err).NotTo(HaveOccurred()) | ||||||||||||
|
|
||||||||||||
| // Attempt request | ||||||||||||
| _, err = client.GetMyPermissionsWithResponse(context.Background()) | ||||||||||||
| Expect(err).To(HaveOccurred()) | ||||||||||||
| // Verification that it failed due to certificate issues | ||||||||||||
| Expect(err.Error()).To(Or(ContainSubstring("certificate"), ContainSubstring("unknown authority"))) | ||||||||||||
| }) | ||||||||||||
|
|
||||||||||||
| It("should succeed request when using custom HTTP client with InsecureSkipVerify", func() { | ||||||||||||
| // Create custom HTTP client that skips verification | ||||||||||||
| transport := http.DefaultTransport.(*http.Transport).Clone() | ||||||||||||
| transport.TLSClientConfig = &tls.Config{InsecureSkipVerify: true} | ||||||||||||
| httpClient := &http.Client{Transport: transport} | ||||||||||||
|
|
||||||||||||
| // Create client using the custom HTTP client | ||||||||||||
| client, err := sysdig.NewSysdigClient( | ||||||||||||
| sysdig.WithFixedHostAndToken(ts.URL, "dummy-token"), | ||||||||||||
| sysdig.WithHTTPClient(httpClient), | ||||||||||||
| ) | ||||||||||||
| Expect(err).NotTo(HaveOccurred()) | ||||||||||||
|
|
||||||||||||
| // Attempt request | ||||||||||||
| resp, err := client.GetMyPermissionsWithResponse(context.Background()) | ||||||||||||
| Expect(err).NotTo(HaveOccurred()) | ||||||||||||
| Expect(resp.HTTPResponse.StatusCode).To(Equal(http.StatusOK)) | ||||||||||||
| }) | ||||||||||||
| }) | ||||||||||||
|
|
||||||||||||
| var _ = Describe("Context helpers", func() { | ||||||||||||
| It("roundtrips token through context", func() { | ||||||||||||
| ctx := sysdig.WrapContextWithToken(context.Background(), "my-token") | ||||||||||||
| Expect(sysdig.GetTokenFromContext(ctx)).To(Equal("my-token")) | ||||||||||||
| }) | ||||||||||||
|
|
||||||||||||
| It("roundtrips host through context", func() { | ||||||||||||
| ctx := sysdig.WrapContextWithHost(context.Background(), "https://example.com") | ||||||||||||
| Expect(sysdig.GetHostFromContext(ctx)).To(Equal("https://example.com")) | ||||||||||||
| }) | ||||||||||||
|
|
||||||||||||
| It("panics when token is missing from context", func() { | ||||||||||||
| Expect(func() { | ||||||||||||
| sysdig.GetTokenFromContext(context.Background()) | ||||||||||||
| }).To(Panic()) | ||||||||||||
| }) | ||||||||||||
|
|
||||||||||||
| It("panics when host is missing from context", func() { | ||||||||||||
| Expect(func() { | ||||||||||||
| sysdig.GetHostFromContext(context.Background()) | ||||||||||||
| }).To(Panic()) | ||||||||||||
| }) | ||||||||||||
| }) | ||||||||||||
|
|
||||||||||||
| var _ = Describe("Client authentication", func() { | ||||||||||||
| var ts *httptest.Server | ||||||||||||
| var lastHeaders http.Header | ||||||||||||
|
|
||||||||||||
| BeforeEach(func() { | ||||||||||||
| ts = httptest.NewServer(permissionsHandler(func(h http.Header) { | ||||||||||||
| lastHeaders = h.Clone() | ||||||||||||
| })) | ||||||||||||
| }) | ||||||||||||
|
|
||||||||||||
| AfterEach(func() { | ||||||||||||
| ts.Close() | ||||||||||||
| }) | ||||||||||||
|
|
||||||||||||
| Describe("WithHostAndTokenFromContext", func() { | ||||||||||||
| It("authenticates using context values", func() { | ||||||||||||
| client, err := sysdig.NewSysdigClient(sysdig.WithHostAndTokenFromContext()) | ||||||||||||
| Expect(err).NotTo(HaveOccurred()) | ||||||||||||
|
|
||||||||||||
| ctx := sysdig.WrapContextWithHost(context.Background(), ts.URL) | ||||||||||||
| ctx = sysdig.WrapContextWithToken(ctx, "ctx-token") | ||||||||||||
|
|
||||||||||||
| resp, err := client.GetMyPermissionsWithResponse(ctx) | ||||||||||||
| Expect(err).NotTo(HaveOccurred()) | ||||||||||||
| Expect(resp.HTTPResponse.StatusCode).To(Equal(http.StatusOK)) | ||||||||||||
| Expect(lastHeaders.Get("Authorization")).To(Equal("Bearer ctx-token")) | ||||||||||||
| }) | ||||||||||||
|
|
||||||||||||
| It("fails when token is missing from context", func() { | ||||||||||||
| client, err := sysdig.NewSysdigClient(sysdig.WithHostAndTokenFromContext()) | ||||||||||||
| Expect(err).NotTo(HaveOccurred()) | ||||||||||||
|
|
||||||||||||
| ctx := sysdig.WrapContextWithHost(context.Background(), ts.URL) | ||||||||||||
|
|
||||||||||||
| _, err = client.GetMyPermissionsWithResponse(ctx) | ||||||||||||
| Expect(err).To(MatchError(ContainSubstring("authorization token not present"))) | ||||||||||||
| }) | ||||||||||||
| }) | ||||||||||||
|
|
||||||||||||
| Describe("WithFallbackAuthentication", func() { | ||||||||||||
| It("uses first auth when it succeeds", func() { | ||||||||||||
| client, err := sysdig.NewSysdigClient( | ||||||||||||
| sysdig.WithFallbackAuthentication( | ||||||||||||
| sysdig.WithFixedHostAndToken(ts.URL, "primary-token"), | ||||||||||||
| sysdig.WithFixedHostAndToken(ts.URL, "fallback-token"), | ||||||||||||
| ), | ||||||||||||
| ) | ||||||||||||
| Expect(err).NotTo(HaveOccurred()) | ||||||||||||
|
|
||||||||||||
| resp, err := client.GetMyPermissionsWithResponse(context.Background()) | ||||||||||||
| Expect(err).NotTo(HaveOccurred()) | ||||||||||||
| Expect(resp.HTTPResponse.StatusCode).To(Equal(http.StatusOK)) | ||||||||||||
| Expect(lastHeaders.Get("Authorization")).To(Equal("Bearer primary-token")) | ||||||||||||
| }) | ||||||||||||
|
|
||||||||||||
| It("falls back to second auth when first fails", func() { | ||||||||||||
| client, err := sysdig.NewSysdigClient( | ||||||||||||
| sysdig.WithFallbackAuthentication( | ||||||||||||
| sysdig.WithHostAndTokenFromContext(), | ||||||||||||
| sysdig.WithFixedHostAndToken(ts.URL, "fallback-token"), | ||||||||||||
| ), | ||||||||||||
| ) | ||||||||||||
| Expect(err).NotTo(HaveOccurred()) | ||||||||||||
|
|
||||||||||||
| resp, err := client.GetMyPermissionsWithResponse(context.Background()) | ||||||||||||
| Expect(err).NotTo(HaveOccurred()) | ||||||||||||
| Expect(resp.HTTPResponse.StatusCode).To(Equal(http.StatusOK)) | ||||||||||||
| Expect(lastHeaders.Get("Authorization")).To(Equal("Bearer fallback-token")) | ||||||||||||
| }) | ||||||||||||
|
|
||||||||||||
| It("fails when all auth methods fail", func() { | ||||||||||||
| client, err := sysdig.NewSysdigClient( | ||||||||||||
| sysdig.WithFallbackAuthentication( | ||||||||||||
| sysdig.WithHostAndTokenFromContext(), | ||||||||||||
| sysdig.WithHostAndTokenFromContext(), | ||||||||||||
| ), | ||||||||||||
| ) | ||||||||||||
| Expect(err).NotTo(HaveOccurred()) | ||||||||||||
|
|
||||||||||||
| _, err = client.GetMyPermissionsWithResponse(context.Background()) | ||||||||||||
| Expect(err).To(MatchError(ContainSubstring("unable to authenticate"))) | ||||||||||||
|
Comment on lines
+173
to
+174
|
||||||||||||
| _, err = client.GetMyPermissionsWithResponse(context.Background()) | |
| Expect(err).To(MatchError(ContainSubstring("unable to authenticate"))) | |
| resp, err := client.GetMyPermissionsWithResponse(context.Background()) | |
| Expect(err).To(MatchError(ContainSubstring("unable to authenticate"))) | |
| Expect(resp).To(BeNil()) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this error-path test you’re discarding the response value. Consider capturing the response and asserting it is nil (as in internal/infra/sysdig/client_permissions_integration_test.go:59-61) so the test also verifies the client doesn’t perform an HTTP call / doesn’t return a partial response when authentication fails.