-
Notifications
You must be signed in to change notification settings - Fork 23
refactor: enhance validation for authenticating with console #1235
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
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
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
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,187 @@ | ||
| /********************************************************************* | ||
| * Copyright (c) Intel Corporation 2024 | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| **********************************************************************/ | ||
|
|
||
| package commands | ||
|
|
||
| import ( | ||
| "context" | ||
| "net/http" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestServerAuthFlags_Validate(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| flags ServerAuthFlags | ||
| wantErr string | ||
| }{ | ||
| { | ||
| name: "no endpoint — no validation", | ||
| flags: ServerAuthFlags{}, | ||
| }, | ||
| { | ||
| name: "endpoint with token — ok", | ||
| flags: ServerAuthFlags{ | ||
| AuthEndpoint: "/api/v1/authorize", | ||
| AuthToken: "tok", | ||
| }, | ||
| }, | ||
| { | ||
| name: "endpoint with username and password — ok", | ||
| flags: ServerAuthFlags{ | ||
| AuthEndpoint: "/api/v1/authorize", | ||
| AuthUsername: "user", | ||
| AuthPassword: "pass", | ||
| }, | ||
| }, | ||
| { | ||
| name: "endpoint with no credentials — error", | ||
| flags: ServerAuthFlags{ | ||
| AuthEndpoint: "/api/v1/authorize", | ||
| }, | ||
| wantErr: "--auth-endpoint requires --auth-token or both --auth-username and --auth-password", | ||
| }, | ||
| { | ||
| name: "endpoint with username only — error", | ||
| flags: ServerAuthFlags{ | ||
| AuthEndpoint: "/api/v1/authorize", | ||
| AuthUsername: "user", | ||
| }, | ||
| wantErr: "--auth-username requires --auth-password", | ||
| }, | ||
| { | ||
| name: "endpoint with password only — error", | ||
| flags: ServerAuthFlags{ | ||
| AuthEndpoint: "/api/v1/authorize", | ||
| AuthPassword: "pass", | ||
| }, | ||
| wantErr: "--auth-password requires --auth-username", | ||
| }, | ||
| { | ||
| name: "username only without endpoint — error", | ||
| flags: ServerAuthFlags{ | ||
| AuthUsername: "user", | ||
| }, | ||
| wantErr: "--auth-username requires --auth-password", | ||
| }, | ||
| { | ||
| name: "password only without endpoint — error", | ||
| flags: ServerAuthFlags{ | ||
| AuthPassword: "pass", | ||
| }, | ||
| wantErr: "--auth-password requires --auth-username", | ||
| }, | ||
| { | ||
| name: "endpoint with token and username/password — token wins, ok", | ||
| flags: ServerAuthFlags{ | ||
| AuthEndpoint: "/api/v1/authorize", | ||
| AuthToken: "tok", | ||
| AuthUsername: "user", | ||
| AuthPassword: "pass", | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| err := tt.flags.Validate() | ||
| if tt.wantErr != "" { | ||
| require.Error(t, err) | ||
| assert.Contains(t, err.Error(), tt.wantErr) | ||
| } else { | ||
| assert.NoError(t, err) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestServerAuthFlags_ValidateRequired(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| flags ServerAuthFlags | ||
| required bool | ||
| wantErr bool | ||
| }{ | ||
| { | ||
| name: "not required — always ok", | ||
| flags: ServerAuthFlags{}, | ||
| required: false, | ||
| }, | ||
| { | ||
| name: "required with token", | ||
| flags: ServerAuthFlags{AuthToken: "tok"}, | ||
| required: true, | ||
| }, | ||
| { | ||
| name: "required with username and password", | ||
| flags: ServerAuthFlags{AuthUsername: "user", AuthPassword: "pass"}, | ||
| required: true, | ||
| }, | ||
| { | ||
| name: "required with nothing", | ||
| flags: ServerAuthFlags{}, | ||
| required: true, | ||
| wantErr: true, | ||
| }, | ||
| { | ||
| name: "required with username only", | ||
| flags: ServerAuthFlags{AuthUsername: "user"}, | ||
| required: true, | ||
| wantErr: true, | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| err := tt.flags.ValidateRequired(tt.required) | ||
| if tt.wantErr { | ||
| assert.Error(t, err) | ||
| } else { | ||
| assert.NoError(t, err) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestServerAuthFlags_ApplyToRequest(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| flags ServerAuthFlags | ||
| wantHeader string | ||
| }{ | ||
| { | ||
| name: "token sets bearer", | ||
| flags: ServerAuthFlags{AuthToken: "my-token"}, | ||
| wantHeader: "Bearer my-token", | ||
| }, | ||
| { | ||
| name: "username/password sets basic", | ||
| flags: ServerAuthFlags{AuthUsername: "user", AuthPassword: "pass"}, | ||
| wantHeader: "Basic dXNlcjpwYXNz", | ||
| }, | ||
| { | ||
| name: "token takes precedence over basic", | ||
| flags: ServerAuthFlags{AuthToken: "tok", AuthUsername: "user", AuthPassword: "pass"}, | ||
| wantHeader: "Bearer tok", | ||
| }, | ||
| { | ||
| name: "no credentials — no header", | ||
| flags: ServerAuthFlags{}, | ||
| wantHeader: "", | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| req, _ := http.NewRequestWithContext(context.Background(), "GET", "http://example.com", nil) | ||
| tt.flags.ApplyToRequest(req) | ||
|
|
||
| assert.Equal(t, tt.wantHeader, req.Header.Get("Authorization")) | ||
| }) | ||
| } | ||
| } |
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.
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.
Uh oh!
There was an error while loading. Please reload this page.