Merge pull request #26 - Handle manifest matching and name resolution logic if ref.name in OCI manifest is not in repo:tag format

Author: niravrsynopsys

src/main/java/com/synopsys/integration/blackduck/imageinspector/api/name/ImageNameResolver.java

@@ -7,20 +7,29 @@
  */
 package com.synopsys.integration.blackduck.imageinspector.api.name;
 
-import java.util.Optional;
-
 import com.synopsys.integration.blackduck.imageinspector.image.common.RepoTag;
 import org.apache.commons.lang3.StringUtils;
 import org.jetbrains.annotations.Nullable;
 import org.springframework.stereotype.Component;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 @Component
 public class ImageNameResolver {
+    private final Logger logger = LoggerFactory.getLogger(this.getClass());
 
     public RepoTag resolve(@Nullable String foundImageName, @Nullable String givenRepo, @Nullable String givenTag) {
         if (StringUtils.isBlank(foundImageName)) {
             return new RepoTag(givenRepo, givenTag);
         }
+        if (!foundImageName.contains(":")) {
+            if (givenTag.isBlank()) {
+                givenTag = "latest";
+            }
+            logger.trace(String.format("foundImageName %s in the manifest is not in repo:tag format, hence resolver will not use foundImageName for name resolution. Resolving RepoTag with givenRepo as %s and givenTag as %s", foundImageName, givenRepo, givenTag));
+            return new RepoTag(givenRepo, givenTag);
+        }
         String resolvedImageRepo = givenRepo;
         String resolvedImageTag = givenTag;
         if (StringUtils.isNotBlank(foundImageName)) {

src/main/java/com/synopsys/integration/blackduck/imageinspector/image/common/ManifestRepoTagMatcher.java

@@ -36,13 +36,25 @@ public Optional<String> findMatch(String manifestRepoTag, String targetRepoTag)
     }
 
     private boolean doesMatch(String manifestRepoTag, String targetRepoTag) {
-        logger.trace(String.format("Target repo tag %s; checking %s", targetRepoTag, manifestRepoTag));
+        // targetRepoTag is always passed in the format of repo:tag to be compatible with all image formats
+        // In case the manifestRepoTag is not in the repo:tag format, we check if this value matches the targetRepo or targetTag portion of targetRepoTag
+
+        logger.trace(String.format("targetRepoTag value resolved as %s; comparing this value with manifestRepoTag %s", targetRepoTag, manifestRepoTag));
+        if (!manifestRepoTag.contains(":") && targetRepoTag.contains(":")) {
+            logger.trace(String.format("The manifestRepoTag %s is not in the format repo:tag. Checking if this value matches the targetRepo or targetTag portion of targetRepoTag", manifestRepoTag));
+            String targetTag = StringUtils.substringAfterLast(targetRepoTag, ":");
+            String targetRepo = StringUtils.substringBeforeLast(targetRepoTag, ":");
+            if (StringUtils.compare(manifestRepoTag, targetRepo) == 0 || StringUtils.compare(manifestRepoTag, targetTag) == 0) {
+                logger.trace(String.format("Matched the targetRepo (%s) or targetTag (%s) portion of targetRepoTag (%s) to manifestRepoTag (%s)", targetRepo, targetTag, targetRepoTag, manifestRepoTag));
+                return true;
+            }
+        }
         if (StringUtils.compare(manifestRepoTag, targetRepoTag) == 0) {
-            logger.trace(String.format("Found the targetRepoTag %s", targetRepoTag));
+            logger.trace(String.format("Matched the targetRepoTag %s to manifestRepoTag %s", targetRepoTag, manifestRepoTag));
             return true;
         }
         if (targetRepoTag.endsWith("/" + manifestRepoTag)) {
-            logger.trace(String.format("Matched the targetRepoTag %s to %s by ignoring the repository prefix", targetRepoTag, manifestRepoTag));
+            logger.trace(String.format("Matched the targetRepoTag %s to manifestRepoTag %s by ignoring the repository prefix", targetRepoTag, manifestRepoTag));
             return true;
         }
         return false;

src/main/java/com/synopsys/integration/blackduck/imageinspector/image/oci/OciManifestDescriptorParser.java

@@ -30,32 +30,34 @@ public OciManifestDescriptorParser(ManifestRepoTagMatcher manifestRepoTagMatcher
     }
 
     public OciDescriptor getManifestDescriptor(OciImageIndex ociImageIndex,
-                                               @Nullable String givenRepo, @Nullable String givenTag) throws IntegrationException {
+        @Nullable String givenRepo, @Nullable String givenTag) throws IntegrationException {
         // TODO- Probably also need to select one of multiple based on arch
         List<OciDescriptor> trueManifests =
-                ociImageIndex.getManifests().stream()
-                        .filter(man -> MANIFEST_FILE_MEDIA_TYPE.equals(man.getMediaType()))
-                        .collect(Collectors.toList());
+            ociImageIndex.getManifests().stream()
+                .filter(man -> MANIFEST_FILE_MEDIA_TYPE.equals(man.getMediaType()))
+                .collect(Collectors.toList());
         if (trueManifests.size() == 0) {
             throw new IntegrationException(String.format("No manifest descriptor with media type %s was found in OCI image index", MANIFEST_FILE_MEDIA_TYPE));
         }
-        if ((trueManifests.size() == 1) && StringUtils.isBlank(givenRepo)) {
-            logger.debug(String.format("User did not specify a repo:tag, and there's only one manifest; inspecting that one; digest=%s", trueManifests.get(0).getDigest()));
+        if ((trueManifests.size() == 1)) {
+            logger.debug(String.format("There is only one manifest; inspecting that one; digest=%s", trueManifests.get(0).getDigest()));
             return trueManifests.get(0);
         }
         if ((trueManifests.size() > 1) && StringUtils.isBlank(givenRepo)) {
             throw new IntegrationException("When the image contains multiple manifests, the target image and tag to inspect must be specified");
         }
         if (StringUtils.isNotBlank(givenRepo) && StringUtils.isBlank(givenTag)) {
+            logger.debug("Tag value was not provided; resolving the tag value as \"latest\"");
             givenTag = "latest";
         }
-        // Safe to assume both repo and tag have values
+
+        // Safe to assume both repo and tag have values at this point
         String givenRepoTag = String.format("%s:%s", givenRepo, givenTag);
 
         Optional<OciDescriptor> matchingManifest = trueManifests.stream()
-                                                       .filter(m -> m.getRepoTagString().isPresent())
-                                                       .filter(m -> manifestRepoTagMatcher.findMatch(m.getRepoTagString().get(), givenRepoTag).isPresent())
-                                                       .findFirst();
+            .filter(m -> m.getRepoTagString().isPresent())
+            .filter(m -> manifestRepoTagMatcher.findMatch(m.getRepoTagString().get(), givenRepoTag).isPresent())
+            .findFirst();
         if (!matchingManifest.isPresent()) {
             throw new IntegrationException(String.format("Unable to find manifest matching repo:tag: %s", givenRepoTag));
         }

src/test/java/com/synopsys/integration/blackduck/imageinspector/api/name/ImageNameResolverTest.java

@@ -35,13 +35,6 @@ public void testNullLiterals() {
         assertEquals("givenTag", resolvedRepoTag.getTag().get());
     }
 
-    @Test
-    public void testWithoutTag() {
-        RepoTag resolvedRepoTag = resolver.resolve("alpine", null, null);
-        assertEquals("alpine", resolvedRepoTag.getRepo().get());
-        assertEquals("latest", resolvedRepoTag.getTag().get());
-    }
-
     @Test
     public void testWithUrlPortTag() {
         RepoTag resolvedRepoTag = resolver.resolve("https://artifactory.team.domain.com:5002/repo:tag", null, null);
@@ -85,13 +78,6 @@ public void testNone() {
         assertFalse(resolvedRepoTag.getTag().isPresent());
     }
 
-    @Test
-    public void testRepoOnly() {
-        RepoTag resolvedRepoTag = resolver.resolve("alpine", null, null);
-        assertEquals("alpine", resolvedRepoTag.getRepo().get());
-        assertEquals("latest", resolvedRepoTag.getTag().get());
-    }
-
     @Test
     public void testBoth() {
         RepoTag resolvedRepoTag = resolver.resolve("alpine:1.0", null, null);

src/test/java/com/synopsys/integration/blackduck/imageinspector/image/oci/OciManifestDescriptorParserTest.java

@@ -36,7 +36,8 @@ public void testFindMatchingManifest() throws IntegrationException {
         Assertions.assertEquals(manifest1, parser.getManifestDescriptor(ociImageIndex, "repo", "tag"));
     }
 
-    @Test
+    // Test disabled because if there is only one manifest found, we select that manifest and do not perform matching
+    // @Test
     public void testThrowsExceptionWhenNoMatchingManifests() {
         List<OciDescriptor> manifests = Arrays.asList(
             new OciDescriptor(manifestMediaType, "", "", new HashMap<>())