Skip to content

Commit

Permalink
Enhance Fix fabric8io#541: Allow @sha256 digest for tags in FROM
Browse files Browse the repository at this point in the history 
ImageName.java and respective test class adjusted to be able to handle
image names with tag AND sha256 digest like:
image_name:image_tag@sha256<digest>

Signed-off-by: Marcus Konrad <M.M.Konrad@web.de>
  • Loading branch information
@mmkonrad
mmkonrad committed Mar 18, 2019
1 parent 55f7697 commit 926363d
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 35 deletions.
65 changes: 41 additions & 24 deletions src/main/java/io/fabric8/maven/docker/util/ImageName.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,25 +64,35 @@ public ImageName(String fullName, String givenTag) {
throw new NullPointerException("Image name must not be null");
}

// set digest to null as default
digest = null;
// check if digest is part of fullName, if so -> extract it
if(fullName.contains("@sha256")) { // Of it contains digest
String[] digestParts = fullName.split("@");
digest = digestParts[1];
parseComponentsBeforeTag(digestParts[0]);
} else {
digest = null;
Pattern tagPattern = Pattern.compile("^(.+?)(?::([^:/]+))?$");
Matcher matcher = tagPattern.matcher(fullName);
if (!matcher.matches()) {
throw new IllegalArgumentException(fullName + " is not a proper image name ([registry/][repo][:port]");
}
tag = givenTag != null ? givenTag : matcher.group(2);
String rest = matcher.group(1);

parseComponentsBeforeTag(rest);
fullName = digestParts[0];
}

if (tag == null) {
tag = "latest";
}
// check for tag
Pattern tagPattern = Pattern.compile("^(.+?)(?::([^:/]+))?$");
Matcher matcher = tagPattern.matcher(fullName);
if (!matcher.matches()) {
throw new IllegalArgumentException(fullName + " is not a proper image name ([registry/][repo][:port]");
}
// extract tag if it exists
tag = givenTag != null ? givenTag : matcher.group(2);
String rest = matcher.group(1);

// extract registry, repository, user
parseComponentsBeforeTag(rest);

/*
* set tag to latest if tag AND digest are null
* if digest is not null but tag is -> leave it!
* -> in case of "image_name@sha256" it is not required to get resolved to "latest"
*/
if (tag == null && digest == null) {
tag = "latest";
}

doValidate();
Expand Down Expand Up @@ -172,10 +182,15 @@ public String getFullName() {
* @return full name with original registry (if set) or optional registry (if not <code>null</code>).
*/
public String getFullName(String optionalRegistry) {

String fullName = getNameWithoutTag(optionalRegistry);
if (tag != null) {
fullName = fullName + ":" + tag;
}
if(digest != null) {
return getNameWithoutTag(optionalRegistry) + "@" + digest;
fullName = fullName + "@" + digest;
}
return getNameWithoutTag(optionalRegistry) + ":" + tag;
return fullName;
}

/**
Expand Down Expand Up @@ -214,20 +229,22 @@ private void doValidate() {
List<String> errors = new ArrayList<>();
// Strip off user from repository name
String image = user != null ? repository.substring(user.length() + 1) : repository;

Object[] checks = new Object[] {
"registry", DOMAIN_REGEXP, registry,
"image", IMAGE_NAME_REGEXP, image,
"user", NAME_COMP_REGEXP, user,
"tag", TAG_REGEXP, tag,
"digest", DIGEST_REGEXP, digest
"registry", DOMAIN_REGEXP, registry,
"image", IMAGE_NAME_REGEXP, image,
"user", NAME_COMP_REGEXP, user,
"tag", TAG_REGEXP, tag,
"digest", DIGEST_REGEXP, digest
};

for (int i = 0; i < checks.length; i +=3) {
String value = (String) checks[i + 2];
Pattern checkPattern = (Pattern) checks[i + 1];
if (value != null &&
!checkPattern.matcher(value).matches()) {
!checkPattern.matcher(value).matches()) {
errors.add(String.format("%s part '%s' doesn't match allowed pattern '%s'",
checks[i], value, checkPattern.pattern()));
checks[i], value, checkPattern.pattern()));
}
}
if (errors.size() > 0) {
Expand Down
38 changes: 27 additions & 11 deletions src/test/java/io/fabric8/maven/docker/util/ImageNameTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public void simple() {
Object[] data = {
"jolokia/jolokia_demo",
r().repository("jolokia/jolokia_demo")
.fullName("jolokia/jolokia_demo").fullNameWithTag("jolokia/jolokia_demo:latest").simpleName("jolokia_demo").tag("latest"),
.fullName("jolokia/jolokia_demo").fullNameWithTag("jolokia/jolokia_demo:latest").simpleName("jolokia_demo").tag("latest"),

"jolokia/jolokia_demo:0.9.6",
r().repository("jolokia/jolokia_demo").tag("0.9.6")
Expand Down Expand Up @@ -102,15 +102,15 @@ private void verifyData(Object[] data) {
@Test
public void testRegistryNaming() throws Exception {
assertEquals("docker.jolokia.org/jolokia/jolokia_demo:0.18",
new ImageName("jolokia/jolokia_demo:0.18").getFullName("docker.jolokia.org"));
new ImageName("jolokia/jolokia_demo:0.18").getFullName("docker.jolokia.org"));
assertEquals("docker.jolokia.org/jolokia/jolokia_demo:latest",
new ImageName("jolokia/jolokia_demo").getFullName("docker.jolokia.org"));
new ImageName("jolokia/jolokia_demo").getFullName("docker.jolokia.org"));
assertEquals("jolokia/jolokia_demo:latest",
new ImageName("jolokia/jolokia_demo").getFullName(null));
new ImageName("jolokia/jolokia_demo").getFullName(null));
assertEquals("docker.jolokia.org/jolokia/jolokia_demo:latest",
new ImageName("docker.jolokia.org/jolokia/jolokia_demo").getFullName("another.registry.org"));
new ImageName("docker.jolokia.org/jolokia/jolokia_demo").getFullName("another.registry.org"));
assertEquals("docker.jolokia.org/jolokia/jolokia_demo:latest",
new ImageName("docker.jolokia.org/jolokia/jolokia_demo").getFullName(null));
new ImageName("docker.jolokia.org/jolokia/jolokia_demo").getFullName(null));
}

@Test
Expand All @@ -129,6 +129,22 @@ public void testRegistryNamingExtended() throws Exception {
new ImageName("docker.jolokia.org/org/jolokia/jolokia_demo@sha256:2781907cc3ae9bb732076f14392128d4b84ff3ebb66379d268e563b10fbfb9da").getFullName(null));
assertEquals("docker.jolokia.org",
new ImageName("docker.jolokia.org/org/jolokia/jolokia_demo@sha256:2781907cc3ae9bb732076f14392128d4b84ff3ebb66379d268e563b10fbfb9da").getRegistry());
assertEquals("docker.jolokia.org",
new ImageName("docker.jolokia.org/org/jolokia/jolokia_demo:alpine").getRegistry());
assertEquals("docker.jolokia.org/org/jolokia/jolokia_demo:alpine",
new ImageName("org/jolokia/jolokia_demo:alpine").getFullName("docker.jolokia.org"));
assertEquals("docker.jolokia.org",
new ImageName("docker.jolokia.org/org/jolokia/jolokia_demo:alpine").getRegistry());
assertEquals("docker.jolokia.org/org/jolokia/jolokia_demo:1.2.3.4-alpine",
new ImageName("org/jolokia/jolokia_demo:1.2.3.4-alpine").getFullName("docker.jolokia.org"));
assertEquals("docker.jolokia.org",
new ImageName("docker.jolokia.org/org/jolokia/jolokia_demo:alpine@sha256:2781907cc3ae9bb732076f14392128d4b84ff3ebb66379d268e563b10fbfb9da").getRegistry());
assertEquals("docker.jolokia.org/org/jolokia/jolokia_demo:alpine@sha256:2781907cc3ae9bb732076f14392128d4b84ff3ebb66379d268e563b10fbfb9da",
new ImageName("org/jolokia/jolokia_demo:alpine@sha256:2781907cc3ae9bb732076f14392128d4b84ff3ebb66379d268e563b10fbfb9da").getFullName("docker.jolokia.org"));
assertEquals("docker.jolokia.org",
new ImageName("docker.jolokia.org/org/jolokia/jolokia_demo:1.2.3.4-alpine@sha256:2781907cc3ae9bb732076f14392128d4b84ff3ebb66379d268e563b10fbfb9da").getRegistry());
assertEquals("docker.jolokia.org/org/jolokia/jolokia_demo:1.2.3.4-alpine@sha256:2781907cc3ae9bb732076f14392128d4b84ff3ebb66379d268e563b10fbfb9da",
new ImageName("org/jolokia/jolokia_demo:1.2.3.4-alpine@sha256:2781907cc3ae9bb732076f14392128d4b84ff3ebb66379d268e563b10fbfb9da").getFullName("docker.jolokia.org"));
}


Expand All @@ -144,10 +160,10 @@ public void namesUsedByDockerTests() {
longTag.append("a");
}
String[] illegal = {
"fo$z$", "Foo@3cc", "Foo$3", "Foo*3", "Fo^3", "Foo!3", "F)xcz(", "fo%asd", "FOO/bar",
"repo:fo$z$", "repo:Foo@3cc", "repo:Foo$3", "repo:Foo*3", "repo:Fo^3", "repo:Foo!3",
"repo:%goodbye", "repo:#hashtagit", "repo:F)xcz(", "repo:-foo", "repo:..","repo:" + longTag.toString(),
"-busybox:test", "-test/busybox:test", "-index:5000/busybox:test"
"fo$z$", "Foo@3cc", "Foo$3", "Foo*3", "Fo^3", "Foo!3", "F)xcz(", "fo%asd", "FOO/bar",
"repo:fo$z$", "repo:Foo@3cc", "repo:Foo$3", "repo:Foo*3", "repo:Fo^3", "repo:Foo!3",
"repo:%goodbye", "repo:#hashtagit", "repo:F)xcz(", "repo:-foo", "repo:..","repo:" + longTag.toString(),
"-busybox:test", "-test/busybox:test", "-index:5000/busybox:test"

};

Expand All @@ -159,7 +175,7 @@ public void namesUsedByDockerTests() {
}

String[] legal = {
"fooo/bar", "fooaa/test", "foooo:t", "HOSTNAME.DOMAIN.COM:443/foo/bar"
"fooo/bar", "fooaa/test", "foooo:t", "HOSTNAME.DOMAIN.COM:443/foo/bar"
};

for (String l : legal) {
Expand Down

0 comments on commit 926363d

Please sign in to comment.