Skip to content

explicitly return a string for String method instead of panic #112

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.

Sign up for GitHub

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
acornett21 merged 1 commit into from
Mar 19, 2026
Merged

explicitly return a string for String method instead of panic #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions pkg/imagename/imagename.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,14 @@ const (
ExplicitNamespace
)

const (
// invalidImageNameString used in Stringer method to represent invalid ImageName
invalidImageNameString = "<invalid>"
)

var (
// DefaultGetStringOptions is the default set of options
DefaultGetStringOptions FormatOption = Registry | Tag
DefaultGetStringOptions = Registry | Tag

// ErrNoImageRepository returns when there is there is no image repository
ErrNoImageRepository = errors.New("No image repository specified")
Expand Down Expand Up @@ -121,10 +126,14 @@ func (imageName *ImageName) Enclose(organization string) {
// String returns the string representation of the image using
// the registry and tag formatting.
func (imageName *ImageName) String() string {
result, err := imageName.ToString(Registry | Tag)
// Guard against nil receiver; Stringer implementations should not panic.
if imageName == nil {
return invalidImageNameString
}
result, err := imageName.ToString(DefaultGetStringOptions)

if err != nil {
panic(err)
return invalidImageNameString
}

return result
Expand Down
13 changes: 13 additions & 0 deletions pkg/imagename/imagename_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,19 @@ var _ = Describe("ImageNameParse", func() {
),
)

DescribeTable("String() returns <invalid> for invalid ImageNames",
func(imageName *ImageName, expectedString string) {
// String() should never panic, even for invalid ImageNames
Expect(imageName.String()).To(Equal(expectedString))
},
Entry("nil ImageName", (*ImageName)(nil), invalidImageNameString),
Entry("empty ImageName", &ImageName{}, invalidImageNameString),
Entry("missing repo", &ImageName{Registry: "example.com", Namespace: "namespace", Repo: "", Tag: "latest"}, invalidImageNameString),
Entry("only registry", &ImageName{Registry: "example.com"}, invalidImageNameString),
Entry("only namespace", &ImageName{Namespace: "namespace"}, invalidImageNameString),
Entry("only tag", &ImageName{Tag: "latest"}, invalidImageNameString),
)

DescribeTable("encloses",
func(repo, organization, enclosedRepo, registry, tag string) {
reference := repo
Expand Down
Loading