buildctl: fix tlsdir handling logic for cert-manager.io #5950
+114
−27
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
tonistiigi
requested changes
Apr 28, 2025
cmd/buildctl/common/common.go
Outdated
| @@ -18,6 +18,30 @@ import ( | |||
| "go.opentelemetry.io/otel/trace" | |||
| ) | |||
|
|
|||
| // ResolveTLSFilesFromDir scans a TLS directory for known cert/key filenames. | |||
| func ResolveTLSFilesFromDir(tlsDir string) (caCert, cert, key string, err error) { | |||
There was a problem hiding this comment.
Keep this helper function private as seems to be only used internally.
cmd/buildctl/common/common.go
Outdated
| return fpath, nil | ||
| } | ||
| } | ||
| return "", errors.Errorf("directory did not contain one of the needed files: %s or %s", either, or) |
There was a problem hiding this comment.
Might be better to capture actual error if the error was not IsNotExist(). Eg. could be that the file exists but is returning eperm.
GoodOwl
reviewed
Apr 28, 2025
cmd/buildctl/common/common_test.go
Outdated
| caOut, certOut, keyOut, err := resolveTLSFilesFromDir(dir) | ||
| require.Equal(t, ca, caOut) | ||
| require.Empty(t, cert, certOut) | ||
| require.Empty(t, key, keyOut) |
There was a problem hiding this comment.
There is a typo here, should be:
require.Equal(t, cert, certOut)
require.Equal(t, key, keyOut)`tldir` flag handling now properly handles the old logic and the new logic for cert-manager.io without failing. Improved error message when files are missing. Co-authored-by: Gleb Nebolyubov <gleb.nebo@gmail.com> Signed-off-by: Jonathan A. Sternberg <jonathan.sternberg@docker.com>
tonistiigi
approved these changes
Apr 28, 2025
|
|
||
| // resolveTLSFilesFromDir scans a TLS directory for known cert/key filenames. | ||
| func resolveTLSFilesFromDir(tlsDir string) (caCert, cert, key string, err error) { | ||
| oneOf := func(either, or string) (string, error) { |
There was a problem hiding this comment.
nit: simpler if just func(names ...string)
There was a problem hiding this comment.
It made the error message more difficult to write because then I'd have to check the number of arguments for the correct pattern of "X, Y, or Z" or just "X" or "X or Y". Since it's only ever called with two parameters, I just did it this way.
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.
tldirflag handling now properly handles the old logic and the newlogic for cert-manager.io without failing.
Improved error message when files are missing.
Fixes #5931.
Replaces #5935.
Co-authored-by: Gleb Nebolyubov gleb.nebo@gmail.com
Signed-off-by: Jonathan A. Sternberg jonathan.sternberg@docker.com