ZipDirectory task supports CompressionLevel (#11975)

Author: drewnoakes

src/MSBuild/MSBuild/Microsoft.Build.CommonTypes.xsd

@@ -6287,9 +6287,24 @@ elementFormDefault="qualified">
         <xs:complexType>
             <xs:complexContent>
                 <xs:extension base="msb:TaskType">
+                    <xs:attribute name="CompressionLevel">
+                        <xs:annotation>
+                            <xs:documentation>
+                                <!-- _locID_text="CompressionLevel" _locComment="" -->Specify the compression level to apply. Possible values are Optimal, Fastest, NoCompression and SmallestSize. In the .NET Framework version of MSBuild, the SmallestSize option is unavailable. Using it will on .NET Framework will log warning MSB3945 and use the default compression level instead.
+                            </xs:documentation>
+                        </xs:annotation>
+                        <xs:simpleType>
+                            <xs:restriction base="xs:string">
+                                <xs:enumeration value="Optimal" />
+                                <xs:enumeration value="Fastest" />
+                                <xs:enumeration value="NoCompression" />
+                                <xs:enumeration value="SmallestSize" />
+                            </xs:restriction>
+                        </xs:simpleType>
+                    </xs:attribute>
                     <xs:attribute name="DestinationFile" use="required" />
                     <xs:attribute name="Overwrite" type="msb:boolean" />
-                    <xs:attribute name="SourceDirectory" type="msb:boolean" />
+                    <xs:attribute name="SourceDirectory" use="required" />
                 </xs:extension>
             </xs:complexContent>
         </xs:complexType>

src/Tasks.UnitTests/ZipDirectory_Tests.cs

@@ -11,16 +11,31 @@
 using Shouldly;
 using Xunit;
 
-#nullable disable
-
 namespace Microsoft.Build.Tasks.UnitTests
 {
     public class ZipDirectory_Tests
     {
         private readonly MockEngine _mockEngine = new MockEngine();
 
-        [Fact]
-        public void CanZipDirectory()
+        public enum CompressionSupportKind
+        {
+            NotSupported,
+            NotSupportedOnNetFramework,
+            Supported,
+        }
+
+        [Theory]
+        [InlineData(null, CompressionSupportKind.Supported)]
+        [InlineData("Optimal", CompressionSupportKind.Supported)]
+        [InlineData("Fastest", CompressionSupportKind.Supported)]
+        [InlineData("NoCompression", CompressionSupportKind.Supported)]
+#if NET
+        [InlineData("SmallestSize", CompressionSupportKind.Supported)]
+#elif NETFRAMEWORK
+        [InlineData("SmallestSize", CompressionSupportKind.NotSupportedOnNetFramework)]
+#endif
+        [InlineData("RandomUnsupportedValue", CompressionSupportKind.NotSupported)]
+        public void CanZipDirectory(string? compressionLevel, CompressionSupportKind compressionSupportKind)
         {
             using (TestEnvironment testEnvironment = TestEnvironment.Create())
             {
@@ -34,34 +49,51 @@ public void CanZipDirectory()
                 ZipDirectory zipDirectory = new ZipDirectory
                 {
                     BuildEngine = _mockEngine,
+                    CompressionLevel = compressionLevel,
                     DestinationFile = new TaskItem(zipFilePath),
-                    SourceDirectory = new TaskItem(sourceFolder.Path)
+                    SourceDirectory = new TaskItem(sourceFolder.Path),
                 };
 
                 zipDirectory.Execute().ShouldBeTrue(_mockEngine.Log);
 
                 _mockEngine.Log.ShouldContain(sourceFolder.Path, customMessage: _mockEngine.Log);
                 _mockEngine.Log.ShouldContain(zipFilePath, customMessage: _mockEngine.Log);
 
+                if (compressionSupportKind == CompressionSupportKind.NotSupported)
+                {
+                    _mockEngine.Log.ShouldContain("MSB3944", customMessage: _mockEngine.Log);
+                }
+                else if (compressionSupportKind == CompressionSupportKind.NotSupportedOnNetFramework)
+                {
+                    _mockEngine.Log.ShouldContain("MSB3945", customMessage: _mockEngine.Log);
+                }
+                else
+                {
+                    Assert.Equal(CompressionSupportKind.Supported, compressionSupportKind);
+
+                    // Should not contain any warnings between MSB3941 - MSB3950
+                    _mockEngine.Log.ShouldNotContain("MSB394", customMessage: _mockEngine.Log); // Prefix
+                    _mockEngine.Log.ShouldNotContain("MSB3950", customMessage: _mockEngine.Log);
+                }
+
                 using (FileStream stream = new FileStream(zipFilePath, FileMode.Open, FileAccess.Read, FileShare.Read))
                 using (ZipArchive archive = new ZipArchive(stream, ZipArchiveMode.Read))
                 {
                     archive.Entries
                         .Select(i => i.FullName)
                         .ToList()
                         .ShouldBe(
-                            new List<string>
-                            {
+                            [
                                 "6DE6060259C44DB6B145159376751C22.txt",
                                 "CDA3DD8C25A54A7CAC638A444CB1EAD0.txt"
-                            },
+                            ],
                             ignoreOrder: true);
                 }
             }
         }
 
         [Fact]
-        public void CanOvewriteExistingFile()
+        public void CanOverwriteExistingFile()
         {
             using (TestEnvironment testEnvironment = TestEnvironment.Create())
             {
@@ -92,11 +124,10 @@ public void CanOvewriteExistingFile()
                         .Select(i => i.FullName)
                         .ToList()
                         .ShouldBe(
-                            new List<string>
-                            {
+                            [
                                 "F1C22D660B0D4DAAA296C1B980320B03.txt",
                                 "AA825D1CB154492BAA58E1002CE1DFEB.txt"
-                            },
+                            ],
                             ignoreOrder: true);
                 }
             }

src/Tasks/Resources/Strings.resx

@@ -2923,6 +2923,14 @@
     <value>MSB3943: Failed to zip directory "{0}" to file "{1}".  {2} {3}</value>
     <comment>{StrBegin="MSB3943: "}</comment>
   </data>
+  <data name="ZipDirectory.ErrorInvalidCompressionLevel">
+    <value>MSB3944: Unsupported compression level '{0}'. Using default compression level instead.</value>
+    <comment>{StrBegin="MSB3944: "}</comment>
+  </data>
+  <data name="ZipDirectory.WarningCompressionLevelUnsupportedOnFramework">
+    <value>MSB3945: Compression level '{0}' is not supported on the .NET Framework version of MSBuild. Using default compression level instead.</value>
+    <comment>{StrBegin="MSB3945: "}</comment>
+  </data>
   <data name="ZipDirectory.Comment">
     <value>Zipping directory "{0}" to "{1}".</value>
   </data>