Contract Update to allow deserialization of DockerReference (#163)

* Contract Update to allow deserialization of DockerReference

* Updates To allow deserialization

* remove Typed Component change

Author: FernandoRojo

src/Microsoft.ComponentDetection.Common/DockerReference/DockerReferenceUtility.cs

@@ -169,59 +169,7 @@ public static DockerReference ParseAll(string name)
 
         private static DockerReference CreateDockerReference(Reference options)
         {
-            if (!string.IsNullOrEmpty(options.Repository) && string.IsNullOrEmpty(options.Domain))
-            {
-                if (!string.IsNullOrEmpty(options.Digest))
-                {
-                    return new DigestReference
-                    {
-                        Digest = options.Digest,
-                    };
-                }
-                else
-                {
-                    throw new ReferenceNameEmptyException(string.Empty);
-                }
-            }
-            else if (string.IsNullOrEmpty(options.Tag))
-            {
-                if (string.IsNullOrEmpty(options.Digest))
-                {
-                    return new CanonicalReference
-                    {
-                        Domain = options.Domain,
-                        Repository = options.Repository,
-                        Digest = options.Digest,
-                    };
-                }
-                else
-                {
-                    return new RepositoryReference
-                    {
-                        Domain = options.Domain,
-                        Repository = options.Repository,
-                    };
-                }
-            }
-            else if (string.IsNullOrEmpty(options.Digest))
-            {
-                return new TaggedReference
-                {
-                    Domain = options.Domain,
-                    Repository = options.Repository,
-                    Tag = options.Tag,
-                };
-            }
-            else
-            {
-                return new DualReference
-                {
-                    Domain = options.Domain,
-                    Repository = options.Repository,
-                    Tag = options.Tag,
-                    Digest = options.Digest,
-                };
-            }
+            return DockerReference.CreateDockerReference(options.Repository, options.Domain, options.Digest, options.Tag);
         }
     }
 }

src/Microsoft.ComponentDetection.Contracts/DockerReference.cs

@@ -1,11 +1,71 @@
 namespace Microsoft.ComponentDetection.Contracts
 {
 #pragma warning disable SA1402
-    public abstract class DockerReference
+    public class DockerReference
     {
-        public abstract DockerReferenceKind Kind { get; }
+        public virtual DockerReferenceKind Kind { get; }
 
-        public abstract TypedComponent.DockerReferenceComponent ToTypedDockerReferenceComponent();
+        public virtual TypedComponent.DockerReferenceComponent ToTypedDockerReferenceComponent()
+        {
+            throw new System.NotImplementedException();
+        }
+
+        public static DockerReference CreateDockerReference(string repository, string domain, string digest, string tag)
+        {
+            if (!string.IsNullOrEmpty(repository) && string.IsNullOrEmpty(domain))
+            {
+                if (!string.IsNullOrEmpty(digest))
+                {
+                    return new DigestReference
+                    {
+                        Digest = digest,
+                    };
+                }
+                else
+                {
+                    throw new System.InvalidOperationException("Repository name must have at least one component");
+                }
+            }
+            else if (string.IsNullOrEmpty(tag))
+            {
+                if (string.IsNullOrEmpty(digest))
+                {
+                    return new CanonicalReference
+                    {
+                        Domain = domain,
+                        Repository = repository,
+                        Digest = digest,
+                    };
+                }
+                else
+                {
+                    return new RepositoryReference
+                    {
+                        Domain = domain,
+                        Repository = repository,
+                    };
+                }
+            }
+            else if (string.IsNullOrEmpty(digest))
+            {
+                return new TaggedReference
+                {
+                    Domain = domain,
+                    Repository = repository,
+                    Tag = tag,
+                };
+            }
+            else
+            {
+                return new DualReference
+                {
+                    Domain = domain,
+                    Repository = repository,
+                    Tag = tag,
+                    Digest = digest,
+                };
+            }
+        }
     }
 
     public enum DockerReferenceKind
@@ -20,19 +80,19 @@ public enum DockerReferenceKind
     public class Reference
     {
         public string Tag { get; set; }
-        
+
         public string Digest { get; set; }
-        
+
         public string Repository { get; set; }
-        
+
         public string Domain { get; set; }
     }
 
     // sha256:abc123...
     public class DigestReference : DockerReference
     {
         public override DockerReferenceKind Kind { get; } = DockerReferenceKind.Digest;
-        
+
         public string Digest;
 
         public override string ToString()
@@ -53,11 +113,11 @@ public override TypedComponent.DockerReferenceComponent ToTypedDockerReferenceCo
     public class CanonicalReference : DockerReference
     {
         public override DockerReferenceKind Kind { get; } = DockerReferenceKind.Canonical;
-        
+
         public string Domain;
-        
+
         public string Repository;
-        
+
         public string Digest;
 
         public override string ToString()
@@ -80,11 +140,11 @@ public override TypedComponent.DockerReferenceComponent ToTypedDockerReferenceCo
     public class RepositoryReference : DockerReference
     {
         public override DockerReferenceKind Kind { get; } = DockerReferenceKind.Repository;
-        
+
         public string Domain;
-        
+
         public string Repository;
-        
+
         public override string ToString()
         {
             return $"{Repository}";
@@ -104,13 +164,13 @@ public override TypedComponent.DockerReferenceComponent ToTypedDockerReferenceCo
     public class TaggedReference : DockerReference
     {
         public override DockerReferenceKind Kind { get; } = DockerReferenceKind.Tagged;
-        
+
         public string Domain;
-        
+
         public string Repository;
-        
+
         public string Tag;
-        
+
         public override string ToString()
         {
             return $"{Domain}/{Repository}:${Tag}";
@@ -131,13 +191,13 @@ public override TypedComponent.DockerReferenceComponent ToTypedDockerReferenceCo
     public class DualReference : DockerReference
     {
         public override DockerReferenceKind Kind { get; } = DockerReferenceKind.Dual;
-        
+
         public string Domain;
-        
+
         public string Repository;
-        
+
         public string Tag;
-        
+
         public string Digest;
 
         public override string ToString()

src/Microsoft.ComponentDetection.Contracts/TypedComponent/DockerReferenceComponent.cs

@@ -12,12 +12,11 @@ public DockerReferenceComponent(string hash, string name = null, string tag = nu
             Digest = ValidateRequiredInput(hash, nameof(Digest), nameof(ComponentType.DockerReference));
             Name = name;
             Tag = tag;
-        }  
+        }
 
         public DockerReferenceComponent(DockerReference reference)
         {
-            FullReference = reference;
-        }      
+        }
 
         public string Name { get; set; }
 
@@ -29,7 +28,13 @@ public DockerReferenceComponent(DockerReference reference)
 
         public override ComponentType Type => ComponentType.DockerReference;
 
-        public DockerReference FullReference { get; set; }
+        public DockerReference FullReference
+        {
+            get
+            {
+                return DockerReference.CreateDockerReference(Name, Domain, Digest, Tag);
+            }
+        }
 
         public override string Id => $"{Name} {Tag} {Digest}";
     }