Skip to content
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

Add extra checks to handle unsupported imageID formats #32

Merged
merged 2 commits into from
Mar 25, 2020
+116 −29
Merged

Add extra checks to handle unsupported imageID formats #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aef4454
Add extra checks to handle unsupported imageID formats
kleesc Mar 25, 2020
031887c
Fix broken tests due to function name change
kleesc Mar 25, 2020
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
37 changes: 29 additions & 8 deletions image/image.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ func ParseImageID(imageID string) (*Image, error) {
// https://github.com/kubernetes/kubernetes/issues/46255
imageIDTokens := strings.SplitN(imageID, "://", 2)
if len(imageIDTokens) > 2 {
return nil, fmt.Errorf("Invalid imageID format")
return nil, fmt.Errorf("Invalid imageID format: %s", imageID)
}
if len(imageIDTokens) == 2 {
if imageIDTokens[0] != "docker-pullable" {
Expand All @@ -144,9 +144,13 @@ func ParseImageID(imageID string) (*Image, error) {

i := strings.IndexRune(img, '/')
if i == -1 {
repoDigest := strings.SplitN(img, "@", 2)
if len(repoDigest) != 2 {
return nil, fmt.Errorf("Invalid imageID format: %s", imageID)
}

// Dockerhub top-level namespace
// Format: {repo}@{digest}
repoDigest := strings.SplitN(img, "@", 2)
host = dockerhub
namespace = dockerhubNamespace
repository = repoDigest[0]
Expand All @@ -156,20 +160,37 @@ func ParseImageID(imageID string) (*Image, error) {
// Format: {namespace}/{repo}@{digest}
namespaceRepoDigest := strings.Split(img, "/")
repoDigest := strings.SplitN(namespaceRepoDigest[1], "@", 2)
if len(repoDigest) != 2 {
return nil, fmt.Errorf("Invalid imageID format: %s", imageID)
}

host = dockerhub
namespace = namespaceRepoDigest[0]
repository = repoDigest[0]
digest = repoDigest[1]
} else {
// Full registry path
// Format: {host}/{namespace}/{repo}@{digest}
host = strings.SplitN(img, "/", 2)[0]
imagePath := strings.SplitN(img, "/", 2)[1]
hostRepopath := strings.SplitN(img, "/", 2)
if len(hostRepopath) != 2 {
return nil, fmt.Errorf("Invalid imageID format: %s", imageID)
}

host = hostRepopath[0]
imagePath := hostRepopath[1]
splitImagePath := strings.Split(imagePath, "/")
if len(splitImagePath) <= 1 {
return nil, fmt.Errorf("Invalid imageID format: %s", imageID)
}

repoAndDigest := splitImagePath[len(splitImagePath)-1]
splitRepoDigest := strings.Split(repoAndDigest, "@")
if len(splitRepoDigest) != 2 {
return nil, fmt.Errorf("Invalid imageID format: %s", imageID)
}

imageDigest := splitImagePath[len(splitImagePath)-1]
repository = strings.Split(imageDigest, "@")[0]
digest = strings.Split(imageDigest, "@")[1]
repository = splitRepoDigest[0]
digest = splitRepoDigest[1]
namespace = strings.Join(splitImagePath[:len(splitImagePath)-1], "/")
}

Expand All @@ -188,7 +209,7 @@ func ParseImageID(imageID string) (*Image, error) {
"validRepository": validRepository,
"validDigest": validDigest,
}).Error("Invalid imageID format")
return nil, fmt.Errorf("Invalid imageID format")
return nil, fmt.Errorf("Invalid imageID format: %s", imageID)
}

image := &Image{
Expand Down
87 changes: 77 additions & 10 deletions image/image_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package image

import (
"fmt"
"reflect"
"strings"
"testing"
Expand All @@ -25,48 +26,64 @@ var imageTable = []struct {
expectedNamespace string
expectedRepository string
expectedDigest string

expectedError error
}{
{
"docker-pullable://quay.io/quay/redis@sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",
"quay.io",
"quay",
"redis",
"sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",
nil,
},
{
"docker-pullable://nginx@sha256:0d71ff22db29a08ac7399d1b35b0311c5b0cbe68d878993718275758811f652a",
"docker.io",
"library",
"nginx",
"sha256:0d71ff22db29a08ac7399d1b35b0311c5b0cbe68d878993718275758811f652a",
nil,
},
{
"docker-pullable://quay/redis@sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",
"docker.io",
"quay",
"redis",
"sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",
nil,
},
{
"docker-pullable://quay/redis--test@sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",
"docker.io",
"quay",
"redis--test",
"sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",
nil,
},
{
"quay/redis--test@sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",
"docker.io",
"quay",
"redis--test",
"sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",
nil,
},
{
"docker-pullable://quay.io/alecmerdler/bbb@sha256:24c6258b99cd427d0c3003e2878159de269f96c4ffbdeceaf9373ea3a31866b3",
"quay.io",
"alecmerdler",
"bbb",
"sha256:24c6258b99cd427d0c3003e2878159de269f96c4ffbdeceaf9373ea3a31866b3",
nil,
},
{
"sha256:24c6258b99cd427d0c3003e2878159de269f96c4ffbdeceaf9373ea3a31866b3",
"",
"",
"",
"",
fmt.Errorf("Invalid imageID format: %s", "sha256:24c6258b99cd427d0c3003e2878159de269f96c4ffbdeceaf9373ea3a31866b3"),
},
}

Expand All @@ -79,7 +96,10 @@ func TestParseImageID(t *testing.T) {
Digest: tt.expectedDigest,
}
parsedImageID, err := ParseImageID(tt.imageID)
if !reflect.DeepEqual(image, parsedImageID) {
if tt.expectedError != nil {
assert.Error(t, err)
assert.Equal(t, tt.expectedError, err)
} else if !reflect.DeepEqual(image, parsedImageID) {
t.Errorf("Incorrectly parsed %s as %+v: %s", tt.imageID, parsedImageID, err)
}
}
Expand All @@ -98,6 +118,8 @@ var containerStatusTable = []struct {
repository string
digest string
tag string

expectedError error
}{
{
"redis",
Expand All @@ -110,6 +132,8 @@ var containerStatusTable = []struct {
"redis",
"sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",
"latest",

nil,
},
{
"nginx",
Expand All @@ -122,6 +146,8 @@ var containerStatusTable = []struct {
"nginx",
"sha256:0d71ff22db29a08ac7399d1b35b0311c5b0cbe68d878993718275758811f652a",
"latest",

nil,
},
{
"redis",
Expand All @@ -134,6 +160,8 @@ var containerStatusTable = []struct {
"redis",
"sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",
"latest",

nil,
},
{
"redis",
Expand All @@ -146,6 +174,8 @@ var containerStatusTable = []struct {
"redis--test",
"sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",
"latest",

nil,
},
{
"bbb",
Expand All @@ -158,6 +188,8 @@ var containerStatusTable = []struct {
"bbb",
"sha256:24c6258b99cd427d0c3003e2878159de269f96c4ffbdeceaf9373ea3a31866b3",
"scrape",

nil,
},
{
"redis",
Expand All @@ -170,6 +202,22 @@ var containerStatusTable = []struct {
"redis",
"sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",
"",

nil,
},
{
"redis",
"quay.io/redis:sometag",
"sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",

"",
"",
"",
"",
"",
"",

fmt.Errorf("Invalid imageID format: %s", "sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e"),
},
}

Expand All @@ -186,10 +234,10 @@ func TestParseContainerStatus(t *testing.T) {
}

parsedContainerStatus, err := ParseContainerStatus(containerStatus)
if err != nil {
t.Errorf("%s", err)
}
if !reflect.DeepEqual(image, parsedContainerStatus) {
if tt.expectedError != nil {
assert.Error(t, err)
assert.Equal(t, tt.expectedError, err)
} else if !reflect.DeepEqual(image, parsedContainerStatus) {
t.Errorf("Incorrectly parsed %+v as %+v", containerStatus, parsedContainerStatus)
}
}
Expand All @@ -199,50 +247,69 @@ var imageIDTable = []struct {
imageID string
tag string
expectedString string
expectedError error
}{
{
imageID: "docker-pullable://quay.io/quay/redis@sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",
tag: "testTag",
expectedString: "quay.io/quay/redis:testTag",
expectedError: nil,
},
{
imageID: "docker-pullable://nginx@sha256:0d71ff22db29a08ac7399d1b35b0311c5b0cbe68d878993718275758811f652a",
tag: "testTag",
expectedString: "nginx:testTag",
expectedError: nil,
},
{
imageID: "docker-pullable://quay/redis@sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",
tag: "testTag",
expectedString: "quay/redis:testTag",
expectedError: nil,
},
{
imageID: "docker-pullable://quay/redis--test@sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",
tag: "testTag",
expectedString: "quay/redis--test:testTag",
expectedError: nil,
},
{
imageID: "quay.io/quay/redis@sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",
tag: "testTag",
expectedString: "quay.io/quay/redis:testTag",
expectedError: nil,
},
{
imageID: "docker-pullable://quay.io/alecmerdler/bbb@sha256:24c6258b99cd427d0c3003e2878159de269f96c4ffbdeceaf9373ea3a31866b3",
tag: "scrape",
expectedString: "quay.io/alecmerdler/bbb:scrape",
expectedError: nil,
},
{
imageID: "quay.io/quay/redis@sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",
tag: "",
expectedString: "quay.io/quay/redis@sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",
expectedError: nil,
},
{
imageID: "sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e",
tag: "",
expectedString: "",
expectedError: fmt.Errorf("Invalid imageID format: %s", "sha256:94033a42da840b970fd9d2b04dae5fec56add2714ca674a758d030ce5acba27e"),
},
}

func TestStringIDRepresentations(t *testing.T) {
for _, tt := range imageIDTable {
image, _ := ParseImageID(tt.imageID)
image.Tag = tt.tag
expectedImageID := strings.TrimPrefix(tt.imageID, "docker-pullable://")
assert.Equal(t, expectedImageID, image.IDString())
assert.Equal(t, tt.expectedString, image.String())
image, err := ParseImageID(tt.imageID)
if tt.expectedError != nil {
assert.Error(t, err)
assert.Equal(t, tt.expectedError, err)
} else {
image.Tag = tt.tag
expectedImageID := strings.TrimPrefix(tt.imageID, "docker-pullable://")
assert.Equal(t, expectedImageID, image.IDString())
assert.Equal(t, tt.expectedString, image.String())
}
}
}
Loading