-
Notifications
You must be signed in to change notification settings - Fork 217
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
293 additions
and
64 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,219 @@ | ||
| package sentrygin_test | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "io" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "strings" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/getsentry/sentry-go" | ||
| sentrygin "github.com/getsentry/sentry-go/gin" | ||
| "github.com/gin-gonic/gin" | ||
| "github.com/google/go-cmp/cmp" | ||
| "github.com/google/go-cmp/cmp/cmpopts" | ||
| ) | ||
|
|
||
| func TestIntegration(t *testing.T) { | ||
| largePayload := strings.Repeat("Large", 3*1024) // 15 KB | ||
|
|
||
| tests := []struct { | ||
| Path string | ||
| Method string | ||
| Body string | ||
| Handler gin.HandlerFunc | ||
|
|
||
| WantEvent *sentry.Event | ||
| }{ | ||
| { | ||
| Path: "/panic", | ||
| Method: "GET", | ||
| Handler: func(c *gin.Context) { | ||
| panic("test") | ||
| }, | ||
|
|
||
| WantEvent: &sentry.Event{ | ||
| Level: sentry.LevelFatal, | ||
| Message: "test", | ||
| Request: &sentry.Request{ | ||
| URL: "/panic", | ||
| Method: "GET", | ||
| Headers: map[string]string{ | ||
| "Accept-Encoding": "gzip", | ||
| "User-Agent": "Go-http-client/1.1", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| Path: "/post", | ||
| Method: "POST", | ||
| Body: "payload", | ||
| Handler: func(c *gin.Context) { | ||
| hub := sentry.GetHubFromContext(c.Request.Context()) | ||
| body, err := io.ReadAll(c.Request.Body) | ||
| if err != nil { | ||
| t.Error(err) | ||
| } | ||
| hub.CaptureMessage("post: " + string(body)) | ||
| }, | ||
| WantEvent: &sentry.Event{ | ||
| Level: sentry.LevelInfo, | ||
| Message: "post: payload", | ||
| Request: &sentry.Request{ | ||
| URL: "/post", | ||
| Method: "POST", | ||
| Data: "payload", | ||
| Headers: map[string]string{ | ||
| "Accept-Encoding": "gzip", | ||
| "Content-Length": "7", | ||
| "User-Agent": "Go-http-client/1.1", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| Path: "/get", | ||
| Method: "GET", | ||
| Handler: func(c *gin.Context) { | ||
| hub := sentry.GetHubFromContext(c.Request.Context()) | ||
| hub.CaptureMessage("get") | ||
| }, | ||
| WantEvent: &sentry.Event{ | ||
| Level: sentry.LevelInfo, | ||
| Message: "get", | ||
| Request: &sentry.Request{ | ||
| URL: "/get", | ||
| Method: "GET", | ||
| Headers: map[string]string{ | ||
| "Accept-Encoding": "gzip", | ||
| "User-Agent": "Go-http-client/1.1", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| Path: "/post/large", | ||
| Method: "POST", | ||
| Body: largePayload, | ||
| Handler: func(c *gin.Context) { | ||
| hub := sentry.GetHubFromContext(c.Request.Context()) | ||
| body, err := io.ReadAll(c.Request.Body) | ||
| if err != nil { | ||
| t.Error(err) | ||
| } | ||
| hub.CaptureMessage(fmt.Sprintf("post: %d KB", len(body)/1024)) | ||
| }, | ||
| WantEvent: &sentry.Event{ | ||
| Level: sentry.LevelInfo, | ||
| Message: "post: 15 KB", | ||
| Request: &sentry.Request{ | ||
| URL: "/post/large", | ||
| Method: "POST", | ||
| // Actual request body omitted because too large. | ||
| Data: "", | ||
| Headers: map[string]string{ | ||
| "Accept-Encoding": "gzip", | ||
| "Content-Length": "15360", | ||
| "User-Agent": "Go-http-client/1.1", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| Path: "/post/body-ignored", | ||
| Method: "POST", | ||
| Body: "client sends, server ignores, SDK doesn't read", | ||
| Handler: func(c *gin.Context) { | ||
| hub := sentry.GetHubFromContext(c.Request.Context()) | ||
| hub.CaptureMessage("body ignored") | ||
| }, | ||
| WantEvent: &sentry.Event{ | ||
| Level: sentry.LevelInfo, | ||
| Message: "body ignored", | ||
| Request: &sentry.Request{ | ||
| URL: "/post/body-ignored", | ||
| Method: "POST", | ||
| // Actual request body omitted because not read. | ||
| Data: "", | ||
| Headers: map[string]string{ | ||
| "Accept-Encoding": "gzip", | ||
| "Content-Length": "46", | ||
| "User-Agent": "Go-http-client/1.1", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| eventsCh := make(chan *sentry.Event, len(tests)) | ||
| err := sentry.Init(sentry.ClientOptions{ | ||
| BeforeSend: func(event *sentry.Event, hint *sentry.EventHint) *sentry.Event { | ||
| eventsCh <- event | ||
| return event | ||
| }, | ||
| }) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| router := gin.New() | ||
| router.Use(sentrygin.New(sentrygin.Options{})) | ||
|
|
||
| for _, tt := range tests { | ||
| router.Handle(tt.Method, tt.Path, tt.Handler) | ||
| } | ||
|
|
||
| srv := httptest.NewServer(router) | ||
| defer srv.Close() | ||
|
|
||
| c := srv.Client() | ||
| c.Timeout = time.Second | ||
|
|
||
| var want []*sentry.Event | ||
| for _, tt := range tests { | ||
| wantRequest := tt.WantEvent.Request | ||
| wantRequest.URL = srv.URL + wantRequest.URL | ||
| wantRequest.Headers["Host"] = srv.Listener.Addr().String() | ||
| want = append(want, tt.WantEvent) | ||
|
|
||
| req, err := http.NewRequest(tt.Method, srv.URL+tt.Path, strings.NewReader(tt.Body)) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| res, err := c.Do(req) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| if res.StatusCode != http.StatusOK { | ||
| t.Errorf("Status code = %d", res.StatusCode) | ||
| } | ||
| res.Body.Close() | ||
| } | ||
|
|
||
| if ok := sentry.Flush(time.Second); !ok { | ||
| t.Fatal("sentry.Flush timed out") | ||
| } | ||
| close(eventsCh) | ||
| var got []*sentry.Event | ||
| for e := range eventsCh { | ||
| got = append(got, e) | ||
| } | ||
| opts := cmp.Options{ | ||
| cmpopts.IgnoreFields( | ||
| sentry.Event{}, | ||
| "Contexts", "EventID", "Extra", "Platform", "Modules", | ||
| "Release", "Sdk", "ServerName", "Tags", "Timestamp", | ||
| "sdkMetaData", | ||
| ), | ||
| cmpopts.IgnoreFields( | ||
| sentry.Request{}, | ||
| "Env", | ||
| ), | ||
| } | ||
| if diff := cmp.Diff(want, got, opts); diff != "" { | ||
| t.Fatalf("Events mismatch (-want +got):\n%s", diff) | ||
| } | ||
| } |
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.