dotnet/test/testing.nunit/IgnorePlatformAttribute.cs

// <copyright file="IgnorePlatformAttribute.cs" company="Selenium Committers">
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.
// </copyright>

using System.Runtime.InteropServices;
using NUnit.Framework.Interfaces;
using NUnit.Framework.Internal;
using OpenQA.Selenium.Testing.NUnit.Environment;
using OSPlatform = System.Runtime.InteropServices.OSPlatform;

namespace OpenQA.Selenium.Testing.NUnit;

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = true)]
public class IgnorePlatformAttribute(string platform) : NUnitAttribute, IApplyToTest
{
    public IgnorePlatformAttribute(string platform, string reason)
        : this(platform)
    {
        Reason = reason;
    }

    public string Value { get; } = platform;

    public string Reason { get; } = string.Empty;

    public void ApplyToTest(Test test)
    {
        if (test.RunState != RunState.NotRunnable)
        {
            IgnorePlatformAttribute[] ignoreAttributes;
            if (test.IsSuite)
            {
                ignoreAttributes = test.TypeInfo.GetCustomAttributes<IgnorePlatformAttribute>(true);
            }
            else
            {
                ignoreAttributes = test.Method.GetCustomAttributes<IgnorePlatformAttribute>(true);
            }

            foreach (IgnorePlatformAttribute platformToIgnoreAttr in ignoreAttributes)
            {
                if (IgnoreTestForPlatform(platformToIgnoreAttr.Value))
                {
                    string ignoreReason = "Ignoring platform " + EnvironmentManager.Instance.Browser.ToString() + ".";
                    if (!string.IsNullOrEmpty(platformToIgnoreAttr.Reason))
                    {
                        ignoreReason = ignoreReason + " " + platformToIgnoreAttr.Reason;
                    }

                    test.RunState = RunState.Ignored;
                    test.Properties.Set(PropertyNames.SkipReason, ignoreReason);
                }
            }
        }
    }

    private bool IgnoreTestForPlatform(string platformToIgnore)
    {
        return platformToIgnore.Equals(CurrentPlatform(), StringComparison.OrdinalIgnoreCase);
    }

    private string CurrentPlatform()
    {
        if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
        {
            return "windows";
        }
        else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
        {
            return "linux";
        }
        else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
        {
            return "mac";
        }
        else
        {
            throw new WebDriverException("Selenium Manager did not find supported operating system");
        }
    }
}