- Notifications
You must be signed in to change notification settings - Fork1.1k
feat(healthcheck): add accessurl check#7193
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
2 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
22 changes: 22 additions & 0 deletionscoderd/apidoc/docs.go
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
22 changes: 22 additions & 0 deletionscoderd/apidoc/swagger.json
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
63 changes: 63 additions & 0 deletionscoderd/healthcheck/accessurl.go
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 |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| package healthcheck | ||
| import ( | ||
| "context" | ||
| "io" | ||
| "net/http" | ||
| "net/url" | ||
| "time" | ||
| "golang.org/x/xerrors" | ||
| ) | ||
| type AccessURLReport struct { | ||
| Healthy bool | ||
| Reachable bool | ||
| StatusCode int | ||
| HealthzResponse string | ||
| Err error | ||
| } | ||
| type AccessURLOptions struct { | ||
| AccessURL *url.URL | ||
| Client *http.Client | ||
| } | ||
| func (r *AccessURLReport) Run(ctx context.Context, opts *AccessURLOptions) { | ||
| ctx, cancel := context.WithTimeout(ctx, 5*time.Second) | ||
| defer cancel() | ||
| if opts.Client == nil { | ||
| opts.Client = http.DefaultClient | ||
| } | ||
| accessURL, err := opts.AccessURL.Parse("/healthz") | ||
| if err != nil { | ||
| r.Err = xerrors.Errorf("parse healthz endpoint: %w", err) | ||
| return | ||
| } | ||
| req, err := http.NewRequestWithContext(ctx, "GET", accessURL.String(), nil) | ||
| if err != nil { | ||
| r.Err = xerrors.Errorf("create healthz request: %w", err) | ||
| return | ||
| } | ||
| res, err := opts.Client.Do(req) | ||
| if err != nil { | ||
| r.Err = xerrors.Errorf("get healthz endpoint: %w", err) | ||
| return | ||
| } | ||
| defer res.Body.Close() | ||
| body, err := io.ReadAll(res.Body) | ||
| if err != nil { | ||
| r.Err = xerrors.Errorf("read healthz response: %w", err) | ||
| return | ||
| } | ||
| r.Reachable = true | ||
| r.Healthy = res.StatusCode == http.StatusOK | ||
| r.StatusCode = res.StatusCode | ||
| r.HealthzResponse = string(body) | ||
| } |
113 changes: 113 additions & 0 deletionscoderd/healthcheck/accessurl_test.go
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 |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| package healthcheck_test | ||
| import ( | ||
| "context" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "net/url" | ||
| "testing" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| "golang.org/x/xerrors" | ||
| "github.com/coder/coder/coderd/coderdtest" | ||
| "github.com/coder/coder/coderd/healthcheck" | ||
| ) | ||
| func TestAccessURL(t *testing.T) { | ||
| t.Parallel() | ||
| t.Run("OK", func(t *testing.T) { | ||
| t.Parallel() | ||
| var ( | ||
| ctx, cancel = context.WithCancel(context.Background()) | ||
| report healthcheck.AccessURLReport | ||
| client = coderdtest.New(t, nil) | ||
| ) | ||
| defer cancel() | ||
| report.Run(ctx, &healthcheck.AccessURLOptions{ | ||
| AccessURL: client.URL, | ||
| }) | ||
| assert.True(t, report.Healthy) | ||
| assert.True(t, report.Reachable) | ||
| assert.Equal(t, http.StatusOK, report.StatusCode) | ||
| assert.Equal(t, "OK", report.HealthzResponse) | ||
| assert.NoError(t, report.Err) | ||
| }) | ||
| t.Run("404", func(t *testing.T) { | ||
| t.Parallel() | ||
| var ( | ||
| ctx, cancel = context.WithCancel(context.Background()) | ||
| report healthcheck.AccessURLReport | ||
| resp = []byte("NOT OK") | ||
| srv = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| w.WriteHeader(http.StatusNotFound) | ||
| w.Write(resp) | ||
| })) | ||
| ) | ||
| defer cancel() | ||
| defer srv.Close() | ||
| u, err := url.Parse(srv.URL) | ||
| require.NoError(t, err) | ||
| report.Run(ctx, &healthcheck.AccessURLOptions{ | ||
| Client: srv.Client(), | ||
| AccessURL: u, | ||
| }) | ||
| assert.False(t, report.Healthy) | ||
| assert.True(t, report.Reachable) | ||
| assert.Equal(t, http.StatusNotFound, report.StatusCode) | ||
| assert.Equal(t, string(resp), report.HealthzResponse) | ||
| assert.NoError(t, report.Err) | ||
| }) | ||
| t.Run("ClientErr", func(t *testing.T) { | ||
| t.Parallel() | ||
| var ( | ||
| ctx, cancel = context.WithCancel(context.Background()) | ||
| report healthcheck.AccessURLReport | ||
| resp = []byte("OK") | ||
| srv = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| w.WriteHeader(http.StatusOK) | ||
| w.Write(resp) | ||
| })) | ||
| client = srv.Client() | ||
| ) | ||
| defer cancel() | ||
| defer srv.Close() | ||
| expErr := xerrors.New("client error") | ||
| client.Transport = roundTripFunc(func(r *http.Request) (*http.Response, error) { | ||
| return nil, expErr | ||
| }) | ||
| u, err := url.Parse(srv.URL) | ||
| require.NoError(t, err) | ||
| report.Run(ctx, &healthcheck.AccessURLOptions{ | ||
| Client: client, | ||
| AccessURL: u, | ||
| }) | ||
| assert.False(t, report.Healthy) | ||
| assert.False(t, report.Reachable) | ||
| assert.Equal(t, 0, report.StatusCode) | ||
| assert.Equal(t, "", report.HealthzResponse) | ||
| assert.ErrorIs(t, report.Err, expErr) | ||
| }) | ||
| } | ||
| type roundTripFunc func(r *http.Request) (*http.Response, error) | ||
| func (rt roundTripFunc) RoundTrip(r *http.Request) (*http.Response, error) { | ||
| return rt(r) | ||
| } |
48 changes: 21 additions & 27 deletionscoderd/healthcheck/derp.go
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
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.