enhance: add support for args and aliases to credential tools #433
Conversation
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
g-linville
commented
Jun 4, 2024
| @@ -136,7 +136,7 @@ func isParam(line string, tool *types.Tool) (_ bool, err error) { | |||
| return false, err | |||
| } | |||
| case "credentials", "creds", "credential", "cred": | |||
| tool.Parameters.Credentials = append(tool.Parameters.Credentials, csv(strings.ToLower(value))...) | |||
There was a problem hiding this comment.
There was no need to be converting it to lowercase here.
g-linville
force-pushed
the
credentials-with-args
branch
from
04e1e48 to
2479f1f
Compare
|
Can this be a built-in credential tool, or are we going to publish a basic one to handle this? |
@cloudnautique we're going to have a generic credential tool that will be a separate repo. This PR is just the changes needed to support such a thing, plus a few other enhancements. |
g-linville
force-pushed
the
credentials-with-args
branch
from
2479f1f to
00383b2
Compare
g-linville
requested review from
thedadams,
njhale,
StrongMonkey,
iwilltry42 and
tylerslaton
g-linville
force-pushed
the
credentials-with-args
branch
2 times, most recently
from
f4cb837 to
cb638ce
Compare
Signed-off-by: Grant Linville <[email protected]>
g-linville
force-pushed
the
credentials-with-args
branch
from
cb638ce to
c9e6fea
Compare
njhale
reviewed
Jun 6, 2024
pkg/types/credential_test.go
Outdated
Comment on lines
132
to
150
| originalName, alias, args, err := ParseCredentialArgs(tt.toolName, tt.input) | ||
| if (err != nil) != tt.wantErr { | ||
| t.Errorf("ParseCredentialArgs() error = %v, wantErr %v", err, tt.wantErr) | ||
| return | ||
| } | ||
| if originalName != tt.expectedName { | ||
| t.Errorf("ParseCredentialArgs() originalName = %v, expectedName %v", originalName, tt.expectedName) | ||
| } | ||
| if alias != tt.expectedAlias { | ||
| t.Errorf("ParseCredentialArgs() alias = %v, expectedAlias %v", alias, tt.expectedAlias) | ||
| } | ||
| if len(args) != len(tt.expectedArgs) { | ||
| t.Errorf("ParseCredentialArgs() args = %v, expectedArgs %v", args, tt.expectedArgs) | ||
| } | ||
| for k, v := range tt.expectedArgs { | ||
| if args[k] != v { | ||
| t.Errorf("ParseCredentialArgs() args[%s] = %v, expectedArgs[%s] %v", k, args[k], k, v) | ||
| } | ||
| } |
There was a problem hiding this comment.
Consider using the github.com/stretchr/testify/assert and github.com/stretchr/testify/require packages:
Suggested change
| originalName, alias, args, err := ParseCredentialArgs(tt.toolName, tt.input) | |
| if (err != nil) != tt.wantErr { | |
| t.Errorf("ParseCredentialArgs() error = %v, wantErr %v", err, tt.wantErr) | |
| return | |
| } | |
| if originalName != tt.expectedName { | |
| t.Errorf("ParseCredentialArgs() originalName = %v, expectedName %v", originalName, tt.expectedName) | |
| } | |
| if alias != tt.expectedAlias { | |
| t.Errorf("ParseCredentialArgs() alias = %v, expectedAlias %v", alias, tt.expectedAlias) | |
| } | |
| if len(args) != len(tt.expectedArgs) { | |
| t.Errorf("ParseCredentialArgs() args = %v, expectedArgs %v", args, tt.expectedArgs) | |
| } | |
| for k, v := range tt.expectedArgs { | |
| if args[k] != v { | |
| t.Errorf("ParseCredentialArgs() args[%s] = %v, expectedArgs[%s] %v", k, args[k], k, v) | |
| } | |
| } | |
| originalName, alias, args, err := ParseCredentialArgs(tt.toolName, tt.input) | |
| // Require halts the test immediately when an assertion fails | |
| if tt.wantErr { | |
| require.Error(t, err, "expected an error but got none") | |
| return | |
| } | |
| require.NoError(t, err, "did not expect an error but got one") | |
| require.Equal(t, tt.expectedName, originalName, "unexpected original name") | |
| require.Equal(t, tt.expectedAlias, alias, "unexpected alias") | |
| require.Equal(t, len(tt.expectedArgs), len(args), "unexpected number of args") | |
| for k, v := range tt.expectedArgs { | |
| // Assert marks the test as failed when an assertion fails, but doesn't halt, allowing the test to progress further and identify more potential issues | |
| assert.Equal(t, v, args[k], "unexpected value for args[%s]", k) | |
| } |
There was a problem hiding this comment.
Oh thanks lol. I let Copilot generate basically all of this stuff and did not bother to think how it could be improved. Lazy me.
pkg/runner/runner.go
Outdated
| @@ -838,12 +848,21 @@ func (r *Runner) handleCredentials(callCtx engine.Context, monitor Monitor, env | |||
| return nil, fmt.Errorf("failed to find ID for tool %s", credToolName) | |||
| } | |||
|
|
|||
| subCtx, err := callCtx.SubCall(callCtx.Ctx, "", credToolRefs[0].ToolID, "", engine.CredentialToolCategory) // leaving callID as "" will cause it to be set by the engine | |||
| input := "" | |||
There was a problem hiding this comment.
Suggested change
| input := "" | |
| var input string |
njhale
reviewed
Jun 6, 2024
Signed-off-by: Grant Linville <[email protected]>
Signed-off-by: Grant Linville <[email protected]>
Signed-off-by: Grant Linville <[email protected]>
njhale
approved these changes
Jun 6, 2024
Signed-off-by: Grant Linville <[email protected]>
njhale
reviewed
Jun 6, 2024
Signed-off-by: Grant Linville <[email protected]>
Signed-off-by: Grant Linville <[email protected]>
Signed-off-by: Grant Linville <[email protected]>
Signed-off-by: Grant Linville <[email protected]>
StrongMonkey
approved these changes
Jun 6, 2024
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestParseCredentialArgs(t *testing.T) { |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This adds support for aliases and arguments in credential tools. Read the docs changes in the PR to find out how it works.