Address copilot PR comments. And add new tests for DockerReferenceUtility

Co-authored-by: Copilot <copilot@github.com>

Author: jpinz

docs/detectors/README.md

@@ -20,9 +20,9 @@
 
 - [Docker Compose](dockercompose.md)
 
-| Detector                        | Status     |
-| ------------------------------- | ---------- |
-| DockerComposeComponentDetector  | DefaultOff |
+| Detector                       | Status     |
+| ------------------------------ | ---------- |
+| DockerComposeComponentDetector | DefaultOff |
 
 - [Dockerfile](dockerfile.md)
 

src/Microsoft.ComponentDetection.Detectors/dockerfile/DockerfileComponentDetector.cs

@@ -86,23 +86,12 @@ private Task ParseDockerFileAsync(string fileContents, string fileLocation, ISin
     {
         try
         {
-            var instructionKeyword = construct.Type;
-            DockerReference? baseImage = null;
-            if (instructionKeyword == ConstructType.Instruction)
+            var baseImage = construct switch
             {
-                var constructType = construct.GetType().Name;
-                switch (constructType)
-                {
-                    case "FromInstruction":
-                        baseImage = this.ParseFromInstruction(construct, escapeChar, stageNameMap);
-                        break;
-                    case "CopyInstruction":
-                        baseImage = this.ParseCopyInstruction(construct, escapeChar, stageNameMap);
-                        break;
-                    default:
-                        break;
-                }
-            }
+                FromInstruction => this.ParseFromInstruction(construct, escapeChar, stageNameMap),
+                CopyInstruction => this.ParseCopyInstruction(construct, escapeChar, stageNameMap),
+                _ => null,
+            };
 
             return baseImage;
         }

test/Microsoft.ComponentDetection.Common.Tests/DockerReferenceUtilityTests.cs

@@ -4,7 +4,9 @@ namespace Microsoft.ComponentDetection.Common.Tests;
 using System;
 using AwesomeAssertions;
 using Microsoft.ComponentDetection.Contracts;
+using Microsoft.ComponentDetection.Contracts.BcdeModels;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
+using Moq;
 
 [TestClass]
 [TestCategory("Governance/All")]
@@ -268,4 +270,97 @@ public void ParseAll_ParsesFamiliarNames()
         result.Should().NotBeNull();
         result.Should().BeAssignableTo<RepositoryReference>();
     }
+
+    [TestMethod]
+    public void HasUnresolvedVariables_ReturnsTrueForDollarSign()
+    {
+        DockerReferenceUtility.HasUnresolvedVariables("${MY_IMAGE}:latest").Should().BeTrue();
+    }
+
+    [TestMethod]
+    public void HasUnresolvedVariables_ReturnsTrueForBraces()
+    {
+        DockerReferenceUtility.HasUnresolvedVariables("{{ .Values.image }}").Should().BeTrue();
+    }
+
+    [TestMethod]
+    public void HasUnresolvedVariables_ReturnsFalseForPlainReference()
+    {
+        DockerReferenceUtility.HasUnresolvedVariables("docker.io/library/nginx:latest").Should().BeFalse();
+    }
+
+    [TestMethod]
+    public void TryParseImageReference_ReturnsNullForUnresolvedVariables()
+    {
+        DockerReferenceUtility.TryParseImageReference("${IMAGE}:latest").Should().BeNull();
+    }
+
+    [TestMethod]
+    public void TryParseImageReference_ReturnsNullForInvalidReference()
+    {
+        DockerReferenceUtility.TryParseImageReference("docker.io/library/Nginx").Should().BeNull();
+    }
+
+    [TestMethod]
+    public void TryParseImageReference_ReturnsParsedReferenceForValidInput()
+    {
+        var result = DockerReferenceUtility.TryParseImageReference("nginx:latest");
+
+        result.Should().NotBeNull();
+        result.Should().BeAssignableTo<TaggedReference>();
+    }
+
+    [TestMethod]
+    public void TryParseImageReference_ReturnsParsedReferenceForDigest()
+    {
+        var digest = $"sha256:{new string('a', 64)}";
+        var result = DockerReferenceUtility.TryParseImageReference($"nginx@{digest}");
+
+        result.Should().NotBeNull();
+        result.Should().BeAssignableTo<CanonicalReference>();
+        ((CanonicalReference)result).Digest.Should().Be(digest);
+    }
+
+    [TestMethod]
+    public void TryParseImageReference_ReturnsParsedReferenceForTagAndDigest()
+    {
+        var digest = $"sha256:{new string('a', 64)}";
+        var result = DockerReferenceUtility.TryParseImageReference($"nginx:latest@{digest}");
+
+        result.Should().NotBeNull();
+        result.Should().BeAssignableTo<DualReference>();
+        var dualRef = (DualReference)result;
+        dualRef.Tag.Should().Be("latest");
+        dualRef.Digest.Should().Be(digest);
+    }
+
+    [TestMethod]
+    public void TryRegisterImageReference_RegistersValidReference()
+    {
+        var recorder = new Mock<ISingleFileComponentRecorder>();
+
+        DockerReferenceUtility.TryRegisterImageReference("nginx:latest", recorder.Object);
+
+        recorder.Verify(r => r.RegisterUsage(It.IsAny<DetectedComponent>(), It.IsAny<bool>(), It.IsAny<string>(), It.IsAny<bool?>(), It.IsAny<DependencyScope?>(), It.IsAny<string>()), Times.Once);
+    }
+
+    [TestMethod]
+    public void TryRegisterImageReference_SkipsUnresolvedVariables()
+    {
+        var recorder = new Mock<ISingleFileComponentRecorder>();
+
+        DockerReferenceUtility.TryRegisterImageReference("${IMAGE}", recorder.Object);
+
+        recorder.Verify(r => r.RegisterUsage(It.IsAny<DetectedComponent>(), It.IsAny<bool>(), It.IsAny<string>(), It.IsAny<bool?>(), It.IsAny<DependencyScope?>(), It.IsAny<string>()), Times.Never);
+    }
+
+    [TestMethod]
+    public void TryRegisterImageReference_SkipsInvalidReference()
+    {
+        var recorder = new Mock<ISingleFileComponentRecorder>();
+
+        DockerReferenceUtility.TryRegisterImageReference("docker.io/library/Nginx", recorder.Object);
+
+        recorder.Verify(r => r.RegisterUsage(It.IsAny<DetectedComponent>(), It.IsAny<bool>(), It.IsAny<string>(), It.IsAny<bool?>(), It.IsAny<DependencyScope?>(), It.IsAny<string>()), Times.Never);
+    }
 }