add ability to specify single or multiple tags, verified exclsivity of each, and added test

baronfel · baronfel · commit 3a1f60198d43 · 2022-08-29T14:12:10.000-05:00
diff --git a/Microsoft.NET.Build.Containers/ParseContainerProperties.cs b/Microsoft.NET.Build.Containers/ParseContainerProperties.cs
@@ -26,8 +26,11 @@ public class ParseContainerProperties : Microsoft.Build.Utilities.Task
     /// <summary>
     /// The tag for the container to be created.
     /// </summary>
-    [Required]
-    public string[] ContainerImageTag { get; set; }
+    public string ContainerImageTag { get; set; }
+    /// <summary>
+    /// The tags for the container to be created.
+    /// </summary>
+    public string[] ContainerImageTags { get; set; }
 
     [Output]
     public string ParsedContainerRegistry { get; private set; }
@@ -52,7 +55,8 @@ public ParseContainerProperties()
         FullyQualifiedBaseImageName = "";
         ContainerRegistry = "";
         ContainerImageName = "";
-        ContainerImageTag = Array.Empty<string>();
+        ContainerImageTag = "";
+        ContainerImageTags = Array.Empty<string>();
         ParsedContainerRegistry = "";
         ParsedContainerImage = "";
         ParsedContainerTag = "";
@@ -61,13 +65,18 @@ public ParseContainerProperties()
         NewContainerTags = Array.Empty<string>();
     }
 
-    private static bool TryValidateTags(string[] inputTags, out string[] validTags, out string[] invalidTags) {
+    private static bool TryValidateTags(string[] inputTags, out string[] validTags, out string[] invalidTags)
+    {
         var v = new List<string>();
         var i = new List<string>();
-        foreach (var tag in inputTags) {
-            if (ContainerHelpers.IsValidImageTag(tag)) {
+        foreach (var tag in inputTags)
+        {
+            if (ContainerHelpers.IsValidImageTag(tag))
+            {
                 v.Add(tag);
-            } else {
+            }
+            else
+            {
                 i.Add(tag);
             }
         }
@@ -79,18 +88,40 @@ private static bool TryValidateTags(string[] inputTags, out string[] validTags,
     public override bool Execute()
     {
         string[] validTags;
-        if (ContainerImageTag.Length != 0 && !TryValidateTags(ContainerImageTag, out var valids, out var invalids))
+        if (!String.IsNullOrEmpty(ContainerImageTag) && ContainerImageTags.Length >= 1)
+        {
+            Log.LogError(null, "CONTAINER005", "Container.AmbiguousTags", null, 0, 0, 0, 0, $"Both {nameof(ContainerImageTag)} and {nameof(ContainerImageTags)} were provided, but only one or the other is allowed.");
+            return !Log.HasLoggedErrors;
+        }
+
+        if (!String.IsNullOrEmpty(ContainerImageTag))
+        {
+            if (ContainerHelpers.IsValidImageTag(ContainerImageTag))
+            {
+                validTags = new[] { ContainerImageTag };
+            }
+            else
+            {
+                validTags = Array.Empty<string>();
+                Log.LogError(null, "CONTAINER003", "Container.InvalidTag", null, 0, 0, 0, 0, $"Invalid {nameof(ContainerImageTag)} provided: {{0}}. Image tags must be alphanumeric, underscore, hyphen, or period.", ContainerImageTag);
+            }
+        }
+        else if (ContainerImageTags.Length != 0 && !TryValidateTags(ContainerImageTags, out var valids, out var invalids))
         {
             validTags = valids;
-            if (invalids.Any()) {
-                (string message, string args) = invalids switch {
-                    { Length: 1 } => ($"Invalid {nameof(ContainerImageTag)} provided: {{0}}. {nameof(ContainerImageTag)} must be a semicolon-delimited list of valid image tags. Image tags must be alphanumeric, underscore, hyphen, or period.", invalids[0]),
-                    _ => ($"Invalid {nameof(ContainerImageTag)}s provided: {{0}}. {nameof(ContainerImageTag)} must be a semicolon-delimited list of valid image tags. Image tags must be alphanumeric, underscore, hyphen, or period.", String.Join(", ", invalids))
+            if (invalids.Any())
+            {
+                (string message, string args) = invalids switch
+                {
+                    { Length: 1 } => ($"Invalid {nameof(ContainerImageTags)} provided: {{0}}. {nameof(ContainerImageTags)} must be a semicolon-delimited list of valid image tags. Image tags must be alphanumeric, underscore, hyphen, or period.", invalids[0]),
+                    _ => ($"Invalid {nameof(ContainerImageTags)} provided: {{0}}. {nameof(ContainerImageTags)} must be a semicolon-delimited list of valid image tags. Image tags must be alphanumeric, underscore, hyphen, or period.", String.Join(", ", invalids))
                 };
                 Log.LogError(null, "CONTAINER003", "Container.InvalidTag", null, 0, 0, 0, 0, message, args);
                 return !Log.HasLoggedErrors;
             }
-        } else {
+        }
+        else
+        {
             validTags = Array.Empty<string>();
         }
 
diff --git a/Microsoft.NET.Build.Containers/build/Microsoft.NET.Build.Containers.targets b/Microsoft.NET.Build.Containers/build/Microsoft.NET.Build.Containers.targets
@@ -21,7 +21,8 @@
             <ContainerRegistry Condition="'$(ContainerRegistry)' == ''">docker://</ContainerRegistry>
             <!-- Note: spaces will be replaced with '-' in ContainerImageName and ContainerImageTag -->
             <ContainerImageName Condition="'$(ContainerImageName)' == ''">$(AssemblyName)</ContainerImageName>
-            <ContainerImageTag Condition="'$(ContainerImageTag)' == ''">$(Version)</ContainerImageTag>
+            <!-- Only default a tag name if no tag names at all are provided -->
+            <ContainerImageTag Condition="'$(ContainerImageTag)' == '' and '$(ContainerImageTags)' == ''">$(Version)</ContainerImageTag>
             <ContainerWorkingDirectory Condition="'$(ContainerWorkingDirectory)' == ''">/app</ContainerWorkingDirectory>
             <!-- Could be semicolon-delimited -->
         </PropertyGroup>
@@ -48,7 +49,8 @@
         <ParseContainerProperties FullyQualifiedBaseImageName="$(ContainerBaseImage)"
                                   ContainerRegistry="$(ContainerRegistry)"
                                   ContainerImageName="$(ContainerImageName)"
-                                  ContainerImageTag="$(ContainerImageTag)">
+                                  ContainerImageTag="$(ContainerImageTag)"
+                                  ContainerImageTags="$(ContainerImageTags)">
 
             <Output TaskParameter="ParsedContainerRegistry" PropertyName="ContainerBaseRegistry" />
             <Output TaskParameter="ParsedContainerImage" PropertyName="ContainerBaseName" />
diff --git a/Test.Microsoft.NET.Build.Containers.Filesystem/CreateNewImageTests.cs b/Test.Microsoft.NET.Build.Containers.Filesystem/CreateNewImageTests.cs
@@ -93,7 +93,7 @@ public void ParseContainerProperties_EndToEnd()
         pcp.FullyQualifiedBaseImageName = "https://mcr.microsoft.com/dotnet/runtime:6.0";
         pcp.ContainerRegistry = "http://localhost:5010";
         pcp.ContainerImageName = "dotnet/testimage";
-        pcp.ContainerImageTag = new [] {"5.0", "latest"};
+        pcp.ContainerImageTags = new [] {"5.0", "latest"};
 
         Assert.IsTrue(pcp.Execute());
         Assert.AreEqual("https://mcr.microsoft.com", pcp.ParsedContainerRegistry);
diff --git a/Test.Microsoft.NET.Build.Containers.Filesystem/ParseContainerPropertiesTests.cs b/Test.Microsoft.NET.Build.Containers.Filesystem/ParseContainerPropertiesTests.cs
@@ -15,7 +15,7 @@ public void Baseline()
             task.FullyQualifiedBaseImageName = "https://mcr.microsoft.com/dotnet/runtime:6.0";
             task.ContainerRegistry = "http://localhost:5010";
             task.ContainerImageName = "dotnet/testimage";
-            task.ContainerImageTag = new[] { "5.0" };
+            task.ContainerImageTags = new[] { "5.0" };
 
             Assert.IsTrue(task.Execute());
             Assert.AreEqual("https://mcr.microsoft.com", task.ParsedContainerRegistry);
@@ -33,7 +33,7 @@ public void BaseRegistriesWithNoSchemeGetHttps()
             task.FullyQualifiedBaseImageName = "mcr.microsoft.com/dotnet/runtime:6.0";
             task.ContainerRegistry = "http://localhost:5010";
             task.ContainerImageName = "dotnet/testimage";
-            task.ContainerImageTag = new[] { "5.0" };
+            task.ContainerImageTags = new[] { "5.0" };
 
             Assert.IsTrue(task.Execute());
             Assert.AreEqual("https://mcr.microsoft.com", task.ParsedContainerRegistry);
@@ -52,7 +52,7 @@ public void UserRegistriesWithNoSchemeGetHttps()
             task.FullyQualifiedBaseImageName = "mcr.microsoft.com/dotnet/runtime:6.0";
             task.ContainerRegistry = "localhost:5010";
             task.ContainerImageName = "dotnet/testimage";
-            task.ContainerImageTag = new[] { "5.0" };
+            task.ContainerImageTags = new[] { "5.0" };
 
             Assert.IsTrue(task.Execute());
             Assert.AreEqual("https://mcr.microsoft.com", task.ParsedContainerRegistry);
@@ -73,7 +73,7 @@ public void SpacesGetReplacedWithDashes()
 
             // Spaces in the "new" container info don't pass the regex.
             task.ContainerImageName = "dotnet/testimage";
-            task.ContainerImageTag = new[] { "5.0" };
+            task.ContainerImageTags = new[] { "5.0" };
 
             Assert.IsTrue(task.Execute());
             Assert.AreEqual("https://mcr-microsoft-com", task.ParsedContainerRegistry);
@@ -94,7 +94,7 @@ public void RegexCatchesInvalidContainerNames()
 
             // Spaces in the "new" container info don't pass the regex.
             task.ContainerImageName = "dotnet testimage";
-            task.ContainerImageTag = new[] { "5.0" };
+            task.ContainerImageTags = new[] { "5.0" };
 
             Assert.IsFalse(task.Execute());
             // To do: Verify output contains expected error
@@ -109,7 +109,23 @@ public void RegexCatchesInvalidContainerTags()
             task.ContainerRegistry = "http://localhost:5010";
             // Spaces in the "new" container info don't pass the regex.
             task.ContainerImageName = "dotnet/testimage";
-            task.ContainerImageTag = new[] { "5.0" };
+            task.ContainerImageTags = new[] { "5.0" };
+
+            Assert.IsFalse(task.Execute());
+            // To do: Verify output contains expected error
+        }
+
+        [TestMethod]
+        [Ignore("Task logging in tests unsupported.")]
+        public void CanOnlySupplyOneOfTagAndTags()
+        {
+            ParseContainerProperties task = new ParseContainerProperties();
+            task.FullyQualifiedBaseImageName = "mcr.microsoft.com/dotnet/runtime:6 0";
+            task.ContainerRegistry = "http://localhost:5010";
+            // Spaces in the "new" container info don't pass the regex.
+            task.ContainerImageName = "dotnet/testimage";
+            task.ContainerImageTag = "a.b";
+            task.ContainerImageTags = new[] { "5.0" };
 
             Assert.IsFalse(task.Execute());
             // To do: Verify output contains expected error
diff --git a/docs/ContainerCustomization.md b/docs/ContainerCustomization.md
@@ -51,16 +51,21 @@ By default, the value used will be the `AssemblyName` of the project.
 > **Note**
 > Image names can only contain lowercase alphanumeric characters, periods, underscores, and dashes, and must start with a letter or number - any other characters will result in an error being thrown.
 
-## ContainerImageTag
+## ContainerImageTag(s)
 
-This property controls the tag that is generated for the image. Tags are often used to refer to different versions of an application, but they can also refer to different operating system distributions, or even just different baked-in configuration.
+This property controls the tag that is generated for the image. Tags are often used to refer to different versions of an application, but they can also refer to different operating system distributions, or even just different baked-in configuration. This property also can be used to push multiple tags - simply use a semicolon-delimited set of tags in the `ContainerImageTags` property, similar to setting multiple `TargetFrameworks`.
 
 By default, the value used will be the `Version` of the project.
 
 ```xml
 <ContainerImageTag>1.2.3-alpha2</ContainerImageTag>
 ```
 
+```xml
+<ContainerImageTags>1.2.3-alpha2;latest</ContainerImageTags>
+```
+
+
 > **Note**
 > Tags can only contain up to 127 alphanumeric characters, periods, underscores, and dashes. They must start with an alphanumeric character or an underscore. Any other form will result in an error being thrown.
 
