Simplify attribute

Former-commit-id: e51cf7cc63

FFMpegCore.Test/AudioTest.cs

@@ -66,8 +66,7 @@ public void Audio_Add()
             Assert.IsTrue(File.Exists(outputFile));
         }
 
-        [TestMethodWithIgnoreIfSupport]
+        [WindowsOnlyTestMethod]
-        [IgnoreIf(nameof(OperatingSystemUtils.NotWindows))]
         public void Image_AddAudio()
         {
             using var outputFile = new TemporaryFile("out.mp4");

FFMpegCore.Test/Utilities/IgnoreIfAttribute.cs

@@ -1,39 +0,0 @@
-using System;
-using System.Reflection;
-using Microsoft.VisualStudio.TestTools.UnitTesting;
-
-namespace FFMpegCore.Test.Utilities;
-
-// https://matt.kotsenas.com/posts/ignoreif-mstest
-/// <summary>
-/// An extension to the [Ignore] attribute. Instead of using test lists / test categories to conditionally
-/// skip tests, allow a [TestClass] or [TestMethod] to specify a method to run. If the method returns
-/// `true` the test method will be skipped. The "ignore criteria" method must be `static`, return a single
-/// `bool` value, and not accept any parameters. By default, it is named "IgnoreIf".
-/// </summary>
-[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
-public class IgnoreIfAttribute : Attribute
-{
-    public string IgnoreCriteriaMethodName { get; set; }
-
-    public IgnoreIfAttribute(string ignoreCriteriaMethodName = "IgnoreIf")
-    {
-        IgnoreCriteriaMethodName = ignoreCriteriaMethodName;
-    }
-
-    internal bool ShouldIgnore(ITestMethod testMethod)
-    {
-        try
-        {
-            // Search for the method specified by name in this class or any parent classes.
-            var searchFlags = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.FlattenHierarchy | BindingFlags.Static;
-            var method = testMethod.MethodInfo.DeclaringType!.GetMethod(IgnoreCriteriaMethodName, searchFlags);
-            return (bool) method?.Invoke(null, null)!;
-        }
-        catch (Exception e)
-        {
-            var message = $"Conditional ignore method {IgnoreCriteriaMethodName} not found. Ensure the method is in the same class as the test method, marked as `static`, returns a `bool`, and doesn't accept any parameters.";
-            throw new ArgumentException(message, e);
-        }
-    }
-}

FFMpegCore.Test/Utilities/OperatingSystemUtils.cs

@@ -1,11 +0,0 @@
-using System.Runtime.InteropServices;
-
-namespace FFMpegCore.Test.Utilities;
-
-public static class OperatingSystemUtils
-{
-    public static bool NotWindows()
-    {
-        return !RuntimeInformation.IsOSPlatform(OSPlatform.Windows);
-    }
-}

FFMpegCore.Test/Utilities/TestMethodWithIgnoreIfSupportAttribute.cs

@@ -1,75 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Reflection;
-using Microsoft.VisualStudio.TestTools.UnitTesting;
-
-namespace FFMpegCore.Test.Utilities;
-
-// https://matt.kotsenas.com/posts/ignoreif-mstest
-/// <summary>
-/// An extension to the [TestMethod] attribute. It walks the method and class hierarchy looking
-/// for an [IgnoreIf] attribute. If one or more are found, they are each evaluated, if the attribute
-/// returns `true`, evaluation is short-circuited, and the test method is skipped.
-/// </summary>
-public class TestMethodWithIgnoreIfSupportAttribute : TestMethodAttribute
-{
-    public override TestResult[] Execute(ITestMethod testMethod)
-    {
-        var ignoreResults = TestMethodUtils.GetIgnoreResults(testMethod);
-        return ignoreResults.Any() 
-            ? ignoreResults 
-            : base.Execute(testMethod);
-    }
-}
-public class DataTestMethodWithIgnoreIfSupportAttribute : DataTestMethodAttribute
-{
-    public override TestResult[] Execute(ITestMethod testMethod)
-    {
-        var ignoreResults = TestMethodUtils.GetIgnoreResults(testMethod);
-        return ignoreResults.Any() 
-            ? ignoreResults 
-            : base.Execute(testMethod);
-    }
-}
-
-internal class TestMethodUtils
-{
-    internal static TestResult[] GetIgnoreResults(ITestMethod testMethod)
-    {
-        var ignoreAttributes = FindAttributes(testMethod);
-
-        // Evaluate each attribute, and skip if one returns `true`
-        foreach (var ignoreAttribute in ignoreAttributes)
-        {
-            if (ignoreAttribute.ShouldIgnore(testMethod))
-            {
-                var message = $"Test not executed. Conditional ignore method '{ignoreAttribute.IgnoreCriteriaMethodName}' evaluated to 'true'.";
-                {
-                    return new[]
-                    {
-                        new TestResult { Outcome = UnitTestOutcome.Inconclusive, TestFailureException = new AssertInconclusiveException(message) }
-                    };
-                }
-            }
-        }
-
-        return Array.Empty<TestResult>();
-    }
-
-    private static IEnumerable<IgnoreIfAttribute> FindAttributes(ITestMethod testMethod)
-    {
-        // Look for an [IgnoreIf] on the method, including any virtuals this method overrides
-        var ignoreAttributes = new List<IgnoreIfAttribute>();
-        ignoreAttributes.AddRange(testMethod.GetAttributes<IgnoreIfAttribute>(inherit: true));
-
-        // Walk the class hierarchy looking for an [IgnoreIf] attribute
-        var type = testMethod.MethodInfo.DeclaringType;
-        while (type != null)
-        {
-            ignoreAttributes.AddRange(type.GetCustomAttributes<IgnoreIfAttribute>(inherit: true));
-            type = type.DeclaringType;
-        }
-        return ignoreAttributes;
-    }
-}

FFMpegCore.Test/Utilities/WindowsOnlyDataTestMethod.cs

@@ -0,0 +1,23 @@
+using System.Runtime.InteropServices;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+namespace FFMpegCore.Test.Utilities;
+
+public class WindowsOnlyDataTestMethod : DataTestMethodAttribute
+{
+    public override TestResult[] Execute(ITestMethod testMethod)
+    {
+        if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+        {
+            var message = $"Test not executed on other platforms than Windows";
+            {
+                return new[]
+                {
+                    new TestResult { Outcome = UnitTestOutcome.Inconclusive, TestFailureException = new AssertInconclusiveException(message) }
+                };
+            }
+        }
+        
+        return base.Execute(testMethod);
+    }
+}

FFMpegCore.Test/Utilities/WindowsOnlyTestMethod.cs

@@ -0,0 +1,23 @@
+using System.Runtime.InteropServices;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+namespace FFMpegCore.Test.Utilities;
+
+public class WindowsOnlyTestMethod : TestMethodAttribute
+{
+    public override TestResult[] Execute(ITestMethod testMethod)
+    {
+        if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+        {
+            var message = $"Test not executed on other platforms than Windows";
+            {
+                return new[]
+                {
+                    new TestResult { Outcome = UnitTestOutcome.Inconclusive, TestFailureException = new AssertInconclusiveException(message) }
+                };
+            }
+        }
+        
+        return base.Execute(testMethod);
+    }
+}

FFMpegCore.Test/VideoTest.cs

@@ -89,8 +89,7 @@ public void Video_ToH265_MKV_Args()
         }
 
         [SupportedOSPlatform("windows")]
-        [DataTestMethodWithIgnoreIfSupport, Timeout(10000)]
+        [WindowsOnlyDataTestMethod, Timeout(10000)]
-        [IgnoreIf(nameof(OperatingSystemUtils.NotWindows))]
         [DataRow(System.Drawing.Imaging.PixelFormat.Format24bppRgb)]
         [DataRow(System.Drawing.Imaging.PixelFormat.Format32bppArgb)]
         public void Video_ToMP4_Args_Pipe(System.Drawing.Imaging.PixelFormat pixelFormat)
@@ -107,8 +106,7 @@ public void Video_ToMP4_Args_Pipe(System.Drawing.Imaging.PixelFormat pixelFormat
         }
 
         [SupportedOSPlatform("windows")]
-        [TestMethodWithIgnoreIfSupport, Timeout(10000)]
+        [WindowsOnlyTestMethod, Timeout(10000)]
-        [IgnoreIf(nameof(OperatingSystemUtils.NotWindows))]
         public void Video_ToMP4_Args_Pipe_DifferentImageSizes()
         {
             using var outputFile = new TemporaryFile($"out{VideoType.Mp4.Extension}");
@@ -128,8 +126,7 @@ public void Video_ToMP4_Args_Pipe_DifferentImageSizes()
         }
 
         [SupportedOSPlatform("windows")]
-        [TestMethodWithIgnoreIfSupport, Timeout(10000)][SupportedOSPlatform("windows")]
+        [WindowsOnlyTestMethod, Timeout(10000)]
-        [IgnoreIf(nameof(OperatingSystemUtils.NotWindows))]
         public async Task Video_ToMP4_Args_Pipe_DifferentImageSizes_Async()
         {
             using var outputFile = new TemporaryFile($"out{VideoType.Mp4.Extension}");
@@ -149,8 +146,7 @@ public async Task Video_ToMP4_Args_Pipe_DifferentImageSizes_Async()
         }
 
         [SupportedOSPlatform("windows")]
-        [TestMethodWithIgnoreIfSupport, Timeout(10000)]
+        [WindowsOnlyTestMethod, Timeout(10000)]
-        [IgnoreIf(nameof(OperatingSystemUtils.NotWindows))]
         public void Video_ToMP4_Args_Pipe_DifferentPixelFormats()
         {
             using var outputFile = new TemporaryFile($"out{VideoType.Mp4.Extension}");
@@ -170,8 +166,7 @@ public void Video_ToMP4_Args_Pipe_DifferentPixelFormats()
         }
         
         [SupportedOSPlatform("windows")]
-        [TestMethodWithIgnoreIfSupport, Timeout(10000)]
+        [WindowsOnlyTestMethod, Timeout(10000)]
-        [IgnoreIf(nameof(OperatingSystemUtils.NotWindows))]
         public async Task Video_ToMP4_Args_Pipe_DifferentPixelFormats_Async()
         {
             using var outputFile = new TemporaryFile($"out{VideoType.Mp4.Extension}");
@@ -326,8 +321,7 @@ public void Video_ToTS_Args()
         }
 
         [SupportedOSPlatform("windows")]
-        [DataTestMethodWithIgnoreIfSupport, Timeout(10000)]
+        [WindowsOnlyDataTestMethod, Timeout(10000)]
-        [IgnoreIf(nameof(OperatingSystemUtils.NotWindows))]
         [DataRow(System.Drawing.Imaging.PixelFormat.Format24bppRgb)]
         [DataRow(System.Drawing.Imaging.PixelFormat.Format32bppArgb)]
         public async Task Video_ToTS_Args_Pipe(System.Drawing.Imaging.PixelFormat pixelFormat)
@@ -360,8 +354,7 @@ public async Task Video_ToOGV_Resize()
         }
 
         [SupportedOSPlatform("windows")]
-        [DataTestMethodWithIgnoreIfSupport, Timeout(10000)]
+        [WindowsOnlyDataTestMethod, Timeout(10000)]
-        [IgnoreIf(nameof(OperatingSystemUtils.NotWindows))]
         [DataRow(System.Drawing.Imaging.PixelFormat.Format24bppRgb)]
         [DataRow(System.Drawing.Imaging.PixelFormat.Format32bppArgb)]
         // [DataRow(PixelFormat.Format48bppRgb)]
@@ -397,8 +390,7 @@ public void Scale_Mp4_Multithreaded()
         }
 
         [SupportedOSPlatform("windows")]
-        [DataTestMethodWithIgnoreIfSupport, Timeout(10000)]
+        [WindowsOnlyDataTestMethod, Timeout(10000)]
-        [IgnoreIf(nameof(OperatingSystemUtils.NotWindows))]
         [DataRow(System.Drawing.Imaging.PixelFormat.Format24bppRgb)]
         [DataRow(System.Drawing.Imaging.PixelFormat.Format32bppArgb)]
         // [DataRow(PixelFormat.Format48bppRgb)]
@@ -416,8 +408,7 @@ public void Video_ToMP4_Resize_Args_Pipe(System.Drawing.Imaging.PixelFormat pixe
         }
 
         [SupportedOSPlatform("windows")]
-        [TestMethodWithIgnoreIfSupport, Timeout(10000)]
+        [WindowsOnlyTestMethod, Timeout(10000)]
-        [IgnoreIf(nameof(OperatingSystemUtils.NotWindows))]
         public void Video_Snapshot_InMemory()
         {
             var input = FFProbe.Analyse(TestResources.Mp4Video);
@@ -429,8 +420,7 @@ public void Video_Snapshot_InMemory()
         }
 
         [SupportedOSPlatform("windows")]
-        [TestMethodWithIgnoreIfSupport, Timeout(10000)]
+        [WindowsOnlyTestMethod, Timeout(10000)]
-        [IgnoreIf(nameof(OperatingSystemUtils.NotWindows))]
         public void Video_Snapshot_PersistSnapshot()
         {
             var outputPath = new TemporaryFile("out.png");
@@ -466,8 +456,7 @@ public void Video_Join()
             Assert.AreEqual(input.PrimaryVideoStream.Width, result.PrimaryVideoStream.Width);
         }
 
-        [TestMethodWithIgnoreIfSupport, Timeout(10000)]
+        [WindowsOnlyTestMethod, Timeout(10000)]
-        [IgnoreIf(nameof(OperatingSystemUtils.NotWindows))]
         public void Video_Join_Image_Sequence()
         {
             var imageSet = new List<ImageInfo>();
@@ -577,8 +566,7 @@ public void Video_OutputsData()
         }
 
         [SupportedOSPlatform("windows")]
-        [TestMethodWithIgnoreIfSupport, Timeout(10000)]
+        [WindowsOnlyTestMethod, Timeout(10000)]
-        [IgnoreIf(nameof(OperatingSystemUtils.NotWindows))]
         public void Video_TranscodeInMemory()
         {
             using var resStream = new MemoryStream();