[release/8.0.4xx] [Containers] Fix parsing and error reporting of ports that lack port type metadata (#43934)

github-actions[bot] · baronfel · web-flow · commit bd78418f613d · 2024-10-06T19:04:03.000-05:00
Co-authored-by: Chet Husk &lt;chusk3@gmail.com&gt;
diff --git a/src/Containers/Microsoft.NET.Build.Containers/ContainerHelpers.cs b/src/Containers/Microsoft.NET.Build.Containers/ContainerHelpers.cs
@@ -41,10 +41,10 @@ public static class ContainerHelpers
     [Flags]
     public enum ParsePortError
     {
-        MissingPortNumber,
-        InvalidPortNumber,
-        InvalidPortType,
-        UnknownPortFormat
+        MissingPortNumber = 1,
+        InvalidPortNumber = 2,
+        InvalidPortType = 4,
+        UnknownPortFormat = 8
     }
 
     /// <summary>
@@ -68,9 +68,9 @@ public static bool TryParsePort(string? portNumber, string? portType, [NotNullWh
             error = ParsePortError.InvalidPortNumber;
         }
 
-        if (!Enum.TryParse<PortType>(portType, out PortType t))
+        if (!Enum.TryParse(portType, out PortType t))
         {
-            if (portType is not null)
+            if (!string.IsNullOrEmpty(portType))
             {
                 error = (error ?? ParsePortError.InvalidPortType) | ParsePortError.InvalidPortType;
             }
diff --git a/src/Containers/Microsoft.NET.Build.Containers/PublicAPI/net472/PublicAPI.Unshipped.txt b/src/Containers/Microsoft.NET.Build.Containers/PublicAPI/net472/PublicAPI.Unshipped.txt
@@ -1,9 +1,9 @@
 ﻿Microsoft.NET.Build.Containers.ContainerHelpers
 Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError
-Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.InvalidPortNumber = 1 -> Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError
-Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.InvalidPortType = 2 -> Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError
-Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.MissingPortNumber = 0 -> Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError
-Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.UnknownPortFormat = Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.InvalidPortNumber | Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.InvalidPortType -> Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError
+Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.InvalidPortNumber = 2 -> Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError
+Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.InvalidPortType = 4 -> Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError
+Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.MissingPortNumber = 1 -> Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError
+Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.UnknownPortFormat = 8 -> Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError
 Microsoft.NET.Build.Containers.Port
 Microsoft.NET.Build.Containers.Port.Deconstruct(out int Number, out Microsoft.NET.Build.Containers.PortType Type) -> void
 Microsoft.NET.Build.Containers.Port.Equals(Microsoft.NET.Build.Containers.Port other) -> bool
diff --git a/src/Containers/Microsoft.NET.Build.Containers/PublicAPI/net8.0/PublicAPI.Unshipped.txt b/src/Containers/Microsoft.NET.Build.Containers/PublicAPI/net8.0/PublicAPI.Unshipped.txt
@@ -21,10 +21,10 @@ Microsoft.NET.Build.Containers.Tasks.ComputeDotnetBaseImageAndTag.UsesInvariantG
 static readonly Microsoft.NET.Build.Containers.Constants.Version -> string!
 Microsoft.NET.Build.Containers.ContainerHelpers
 Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError
-Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.InvalidPortNumber = 1 -> Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError
-Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.InvalidPortType = 2 -> Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError
-Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.MissingPortNumber = 0 -> Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError
-Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.UnknownPortFormat = Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.InvalidPortNumber | Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.InvalidPortType -> Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError
+Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.InvalidPortNumber = 2 -> Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError
+Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.InvalidPortType = 4 -> Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError
+Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.MissingPortNumber = 1 -> Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError
+Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError.UnknownPortFormat = 8 -> Microsoft.NET.Build.Containers.ContainerHelpers.ParsePortError
 Microsoft.NET.Build.Containers.Descriptor
 Microsoft.NET.Build.Containers.Descriptor.Annotations.get -> System.Collections.Generic.Dictionary<string!, string?>?
 Microsoft.NET.Build.Containers.Descriptor.Annotations.init -> void
diff --git a/src/Tests/Microsoft.NET.Build.Containers.UnitTests/ContainerHelpersTests.cs b/src/Tests/Microsoft.NET.Build.Containers.UnitTests/ContainerHelpersTests.cs
@@ -109,7 +109,7 @@ public void IsValidImageTag_InvalidLength()
     [InlineData("80", true, 80, PortType.tcp, null)]
     [InlineData("125/dup", false, 125, PortType.tcp, ContainerHelpers.ParsePortError.InvalidPortType)]
     [InlineData("invalidNumber", false, null, null, ContainerHelpers.ParsePortError.InvalidPortNumber)]
-    [InlineData("welp/unknowntype", false, null, null, (ContainerHelpers.ParsePortError)3)]
+    [InlineData("welp/unknowntype", false, null, null, (ContainerHelpers.ParsePortError)6)]
     [InlineData("a/b/c", false, null, null, ContainerHelpers.ParsePortError.UnknownPortFormat)]
     [InlineData("/tcp", false, null, null, ContainerHelpers.ParsePortError.MissingPortNumber)]
     public void CanParsePort(string input, bool shouldParse, int? expectedPortNumber, PortType? expectedType, ContainerHelpers.ParsePortError? expectedError) {
diff --git a/src/Tests/containerize.UnitTests/ParserTests.cs b/src/Tests/containerize.UnitTests/ParserTests.cs
@@ -204,9 +204,9 @@ public void CanParsePorts()
     }
 
     [Theory]
-    [InlineData("1501/smth", "(MissingPortNumber, InvalidPortType)")]
-    [InlineData("1501\\tcp", "(MissingPortNumber, InvalidPortNumber)")]
-    [InlineData("not-a-number", "(MissingPortNumber, InvalidPortNumber)")]
+    [InlineData("1501/smth", "(InvalidPortType)")]
+    [InlineData("1501\\tcp", "(InvalidPortNumber)")]
+    [InlineData("not-a-number", "(InvalidPortNumber)")]
     public void CanHandleInvalidPorts(string portStr, string reason)
     {
         string errorMessage = $"Incorrectly formatted ports:{Environment.NewLine}\t{portStr}:\t{reason}{Environment.NewLine}";

Original file line number	Diff line number	Diff line change
`@@ -41,10 +41,10 @@ public static class ContainerHelpers`
`41`	`41`	`[Flags]`
`42`	`42`	`public enum ParsePortError`
`43`	`43`	`{`
`44`		`- MissingPortNumber,`
`45`		`- InvalidPortNumber,`
`46`		`- InvalidPortType,`
`47`		`- UnknownPortFormat`
	`44`	`+ MissingPortNumber = 1,`
	`45`	`+ InvalidPortNumber = 2,`
	`46`	`+ InvalidPortType = 4,`
	`47`	`+ UnknownPortFormat = 8`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`/// <summary>`
`@@ -68,9 +68,9 @@ public static bool TryParsePort(string? portNumber, string? portType, [NotNullWh`
`68`	`68`	`error = ParsePortError.InvalidPortNumber;`
`69`	`69`	`}`
`70`	`70`
`71`		`- if (!Enum.TryParse<PortType>(portType, out PortType t))`
	`71`	`+ if (!Enum.TryParse(portType, out PortType t))`
`72`	`72`	`{`
`73`		`- if (portType is not null)`
	`73`	`+ if (!string.IsNullOrEmpty(portType))`
`74`	`74`	`{`
`75`	`75`	`error = (error ?? ParsePortError.InvalidPortType) \| ParsePortError.InvalidPortType;`
`76`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -204,9 +204,9 @@ public void CanParsePorts()`
`204`	`204`	`}`
`205`	`205`
`206`	`206`	`[Theory]`
`207`		`- [InlineData("1501/smth", "(MissingPortNumber, InvalidPortType)")]`
`208`		`- [InlineData("1501\\tcp", "(MissingPortNumber, InvalidPortNumber)")]`
`209`		`- [InlineData("not-a-number", "(MissingPortNumber, InvalidPortNumber)")]`
	`207`	`+ [InlineData("1501/smth", "(InvalidPortType)")]`
	`208`	`+ [InlineData("1501\\tcp", "(InvalidPortNumber)")]`
	`209`	`+ [InlineData("not-a-number", "(InvalidPortNumber)")]`
`210`	`210`	`public void CanHandleInvalidPorts(string portStr, string reason)`
`211`	`211`	`{`
`212`	`212`	`string errorMessage = $"Incorrectly formatted ports:{Environment.NewLine}\t{portStr}:\t{reason}{Environment.NewLine}";`