- Notifications
You must be signed in to change notification settings - Fork914
chore: improve testing coverage on ExtractProvisionerDaemonAuthenticated middleware#15622
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
8 commits Select commitHold shift + click to select a range
1bfbf46 work-on-testing-cases
defelmnqd9ab576 improve testing coverage
defelmnqe26f5e1 improve testing coverage
defelmnq13d6dd9 improve testing coverage
defelmnqa6afc33 move middlewar
defelmnq66bd65e move middlewar
defelmnq5eafd6d improve testing coverage
defelmnq711eeee improve testing coverage
defelmnqFile 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
3 changes: 3 additions & 0 deletionscoderd/httpmw/provisionerdaemon.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
5 changes: 5 additions & 0 deletionsenterprise/coderd/httpmw/doc.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,5 @@ | ||
| // Package httpmw contains middleware for HTTP handlers. | ||
| // Currently, the tested middleware is inside the AGPL package. | ||
| // As the middleware also contains enterprise-only logic, tests had to be | ||
| // moved here. | ||
| package httpmw |
290 changes: 290 additions & 0 deletionsenterprise/coderd/httpmw/provisionerdaemon_test.go
defelmnq marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. |
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,290 @@ | ||
| package httpmw_test | ||
| import ( | ||
| "context" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "testing" | ||
| "github.com/go-chi/chi/v5" | ||
| "github.com/google/uuid" | ||
| "github.com/stretchr/testify/require" | ||
| "go.uber.org/mock/gomock" | ||
| "golang.org/x/xerrors" | ||
| "github.com/coder/coder/v2/coderd/database" | ||
| "github.com/coder/coder/v2/coderd/database/dbmock" | ||
| "github.com/coder/coder/v2/coderd/httpmw" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| "github.com/coder/coder/v2/enterprise/coderd/coderdenttest" | ||
| "github.com/coder/coder/v2/enterprise/coderd/license" | ||
| "github.com/coder/coder/v2/testutil" | ||
| ) | ||
| func TestExtractProvisionerDaemonAuthenticated(t *testing.T) { | ||
| const ( | ||
| //nolint:gosec // test key generated by test | ||
| functionalKey = "5Hl2Qw9kX3nM7vB4jR8pY6tA1cF0eD5uI2oL9gN3mZ4" | ||
| ) | ||
| t.Parallel() | ||
| tests := []struct { | ||
| name string | ||
| opts httpmw.ExtractProvisionerAuthConfig | ||
| expectedStatusCode int | ||
| expectedResponseMessage string | ||
| provisionerKey string | ||
| provisionerPSK string | ||
| }{ | ||
| { | ||
| name: "NoKeyProvided_Optional", | ||
| opts: httpmw.ExtractProvisionerAuthConfig{ | ||
| DB: nil, | ||
| Optional: true, | ||
| }, | ||
| expectedStatusCode: http.StatusOK, | ||
| }, | ||
| { | ||
| name: "NoKeyProvided_NotOptional", | ||
| opts: httpmw.ExtractProvisionerAuthConfig{ | ||
| DB: nil, | ||
| Optional: false, | ||
| }, | ||
| expectedStatusCode: http.StatusUnauthorized, | ||
| expectedResponseMessage: "provisioner daemon key required", | ||
| }, | ||
| { | ||
| name: "ProvisionerKeyAndPSKProvided_NotOptional", | ||
| opts: httpmw.ExtractProvisionerAuthConfig{ | ||
| DB: nil, | ||
| Optional: false, | ||
| }, | ||
| provisionerKey: "key", | ||
| provisionerPSK: "psk", | ||
| expectedStatusCode: http.StatusBadRequest, | ||
| expectedResponseMessage: "provisioner daemon key and psk provided, but only one is allowed", | ||
| }, | ||
| { | ||
| name: "ProvisionerKeyAndPSKProvided_Optional", | ||
| opts: httpmw.ExtractProvisionerAuthConfig{ | ||
| DB: nil, | ||
| Optional: true, | ||
| }, | ||
| provisionerKey: "key", | ||
| expectedStatusCode: http.StatusOK, | ||
| }, | ||
| { | ||
| name: "InvalidProvisionerKey_NotOptional", | ||
| opts: httpmw.ExtractProvisionerAuthConfig{ | ||
| DB: nil, | ||
| Optional: false, | ||
| }, | ||
| provisionerKey: "invalid", | ||
| expectedStatusCode: http.StatusBadRequest, | ||
| expectedResponseMessage: "provisioner daemon key invalid", | ||
| }, | ||
| { | ||
| name: "InvalidProvisionerKey_Optional", | ||
| opts: httpmw.ExtractProvisionerAuthConfig{ | ||
| DB: nil, | ||
| Optional: true, | ||
| }, | ||
| provisionerKey: "invalid", | ||
| expectedStatusCode: http.StatusOK, | ||
| }, | ||
| { | ||
| name: "InvalidProvisionerPSK_NotOptional", | ||
| opts: httpmw.ExtractProvisionerAuthConfig{ | ||
| DB: nil, | ||
| Optional: false, | ||
| PSK: "psk", | ||
| }, | ||
| provisionerPSK: "invalid", | ||
| expectedStatusCode: http.StatusUnauthorized, | ||
| expectedResponseMessage: "provisioner daemon psk invalid", | ||
| }, | ||
| { | ||
| name: "InvalidProvisionerPSK_Optional", | ||
| opts: httpmw.ExtractProvisionerAuthConfig{ | ||
| DB: nil, | ||
| Optional: true, | ||
| PSK: "psk", | ||
| }, | ||
| provisionerPSK: "invalid", | ||
| expectedStatusCode: http.StatusOK, | ||
| }, | ||
| { | ||
| name: "ValidProvisionerPSK_NotOptional", | ||
| opts: httpmw.ExtractProvisionerAuthConfig{ | ||
| DB: nil, | ||
| Optional: false, | ||
| PSK: "ThisIsAValidPSK", | ||
| }, | ||
| provisionerPSK: "ThisIsAValidPSK", | ||
| expectedStatusCode: http.StatusOK, | ||
| }, | ||
| } | ||
| for _, test := range tests { | ||
| test := test | ||
| t.Run(test.name, func(t *testing.T) { | ||
| t.Parallel() | ||
| routeCtx := chi.NewRouteContext() | ||
| r := httptest.NewRequest(http.MethodGet, "/", nil) | ||
| r = r.WithContext(context.WithValue(r.Context(), chi.RouteCtxKey, routeCtx)) | ||
| res := httptest.NewRecorder() | ||
| if test.provisionerKey != "" { | ||
| r.Header.Set(codersdk.ProvisionerDaemonKey, test.provisionerKey) | ||
| } | ||
| if test.provisionerPSK != "" { | ||
| r.Header.Set(codersdk.ProvisionerDaemonPSK, test.provisionerPSK) | ||
| } | ||
| httpmw.ExtractProvisionerDaemonAuthenticated(test.opts)(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { | ||
| w.WriteHeader(http.StatusOK) | ||
| })).ServeHTTP(res, r) | ||
| //nolint:bodyclose | ||
| require.Equal(t, test.expectedStatusCode, res.Result().StatusCode) | ||
| if test.expectedResponseMessage != "" { | ||
| require.Contains(t, res.Body.String(), test.expectedResponseMessage) | ||
| } | ||
| }) | ||
| } | ||
| t.Run("ProvisionerKey", func(t *testing.T) { | ||
| t.Parallel() | ||
| ctx := testutil.Context(t, testutil.WaitShort) | ||
| client, db, user := coderdenttest.NewWithDatabase(t, &coderdenttest.Options{ | ||
| LicenseOptions: &coderdenttest.LicenseOptions{ | ||
| Features: license.Features{ | ||
| codersdk.FeatureExternalProvisionerDaemons: 1, | ||
| }, | ||
| }, | ||
| }) | ||
| // nolint:gocritic // test | ||
| key, err := client.CreateProvisionerKey(ctx, user.OrganizationID, codersdk.CreateProvisionerKeyRequest{ | ||
| Name: "dont-TEST-me", | ||
| }) | ||
| require.NoError(t, err) | ||
| routeCtx := chi.NewRouteContext() | ||
| r := httptest.NewRequest(http.MethodGet, "/", nil) | ||
| r = r.WithContext(context.WithValue(r.Context(), chi.RouteCtxKey, routeCtx)) | ||
| res := httptest.NewRecorder() | ||
| r.Header.Set(codersdk.ProvisionerDaemonKey, key.Key) | ||
| httpmw.ExtractProvisionerDaemonAuthenticated(httpmw.ExtractProvisionerAuthConfig{ | ||
| DB: db, | ||
| Optional: false, | ||
| })(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { | ||
| w.WriteHeader(http.StatusOK) | ||
| })).ServeHTTP(res, r) | ||
| //nolint:bodyclose | ||
| require.Equal(t, http.StatusOK, res.Result().StatusCode) | ||
| }) | ||
| t.Run("ProvisionerKey_NotFound", func(t *testing.T) { | ||
| t.Parallel() | ||
| ctx := testutil.Context(t, testutil.WaitShort) | ||
| client, db, user := coderdenttest.NewWithDatabase(t, &coderdenttest.Options{ | ||
| LicenseOptions: &coderdenttest.LicenseOptions{ | ||
| Features: license.Features{ | ||
| codersdk.FeatureExternalProvisionerDaemons: 1, | ||
| }, | ||
| }, | ||
| }) | ||
| // nolint:gocritic // test | ||
| _, err := client.CreateProvisionerKey(ctx, user.OrganizationID, codersdk.CreateProvisionerKeyRequest{ | ||
| Name: "dont-TEST-me", | ||
| }) | ||
| require.NoError(t, err) | ||
| routeCtx := chi.NewRouteContext() | ||
| r := httptest.NewRequest(http.MethodGet, "/", nil) | ||
| r = r.WithContext(context.WithValue(r.Context(), chi.RouteCtxKey, routeCtx)) | ||
| res := httptest.NewRecorder() | ||
| //nolint:gosec // test key generated by test | ||
| pkey := "5Hl2Qw9kX3nM7vB4jR8pY6tA1cF0eD5uI2oL9gN3mZ4" | ||
| r.Header.Set(codersdk.ProvisionerDaemonKey, pkey) | ||
| httpmw.ExtractProvisionerDaemonAuthenticated(httpmw.ExtractProvisionerAuthConfig{ | ||
| DB: db, | ||
| Optional: false, | ||
| })(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { | ||
| w.WriteHeader(http.StatusOK) | ||
| })).ServeHTTP(res, r) | ||
| //nolint:bodyclose | ||
| require.Equal(t, http.StatusUnauthorized, res.Result().StatusCode) | ||
| require.Contains(t, res.Body.String(), "provisioner daemon key invalid") | ||
| }) | ||
| t.Run("ProvisionerKey_CompareFail", func(t *testing.T) { | ||
| t.Parallel() | ||
| ctrl := gomock.NewController(t) | ||
| mockDB := dbmock.NewMockStore(ctrl) | ||
| gomock.InOrder( | ||
| mockDB.EXPECT().GetProvisionerKeyByHashedSecret(gomock.Any(), gomock.Any()).Times(1).Return(database.ProvisionerKey{ | ||
| ID: uuid.New(), | ||
| HashedSecret: []byte("hashedSecret"), | ||
| }, nil), | ||
| ) | ||
| routeCtx := chi.NewRouteContext() | ||
| r := httptest.NewRequest(http.MethodGet, "/", nil) | ||
| r = r.WithContext(context.WithValue(r.Context(), chi.RouteCtxKey, routeCtx)) | ||
| res := httptest.NewRecorder() | ||
| r.Header.Set(codersdk.ProvisionerDaemonKey, functionalKey) | ||
| httpmw.ExtractProvisionerDaemonAuthenticated(httpmw.ExtractProvisionerAuthConfig{ | ||
| DB: mockDB, | ||
| Optional: false, | ||
| })(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { | ||
| w.WriteHeader(http.StatusOK) | ||
| })).ServeHTTP(res, r) | ||
| //nolint:bodyclose | ||
| require.Equal(t, http.StatusUnauthorized, res.Result().StatusCode) | ||
| require.Contains(t, res.Body.String(), "provisioner daemon key invalid") | ||
| }) | ||
| t.Run("ProvisionerKey_DBError", func(t *testing.T) { | ||
| t.Parallel() | ||
| ctrl := gomock.NewController(t) | ||
| mockDB := dbmock.NewMockStore(ctrl) | ||
| gomock.InOrder( | ||
| mockDB.EXPECT().GetProvisionerKeyByHashedSecret(gomock.Any(), gomock.Any()).Times(1).Return(database.ProvisionerKey{}, xerrors.New("error")), | ||
| ) | ||
| routeCtx := chi.NewRouteContext() | ||
| r := httptest.NewRequest(http.MethodGet, "/", nil) | ||
| r = r.WithContext(context.WithValue(r.Context(), chi.RouteCtxKey, routeCtx)) | ||
| res := httptest.NewRecorder() | ||
| //nolint:gosec // test key generated by test | ||
| r.Header.Set(codersdk.ProvisionerDaemonKey, functionalKey) | ||
| httpmw.ExtractProvisionerDaemonAuthenticated(httpmw.ExtractProvisionerAuthConfig{ | ||
| DB: mockDB, | ||
| Optional: false, | ||
| })(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { | ||
| w.WriteHeader(http.StatusOK) | ||
| })).ServeHTTP(res, r) | ||
| //nolint:bodyclose | ||
| require.Equal(t, http.StatusInternalServerError, res.Result().StatusCode) | ||
| require.Contains(t, res.Body.String(), "get provisioner daemon key") | ||
| }) | ||
| } |
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.