File: xunit\MinimumOsVersionAttribute.cs
Web Access
Project: src\src\Testing\src\Microsoft.AspNetCore.InternalTesting.csproj (Microsoft.AspNetCore.InternalTesting)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System;
using System.Runtime.InteropServices;
 
namespace Microsoft.AspNetCore.InternalTesting;
 
/// <summary>
/// Skips a test if the OS is the given type (Windows) and the OS version is less than specified.
/// E.g. Specifying Window 10.0 skips on Win 8, but not on Linux. Combine with OSSkipConditionAttribute as needed.
/// </summary>
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class | AttributeTargets.Assembly, AllowMultiple = true)]
public class MinimumOSVersionAttribute : Attribute, ITestCondition
{
    private readonly OperatingSystems _targetOS;
    private readonly Version _minVersion;
    private readonly OperatingSystems _currentOS;
    private readonly Version _currentVersion;
    private readonly bool _skip;
 
    public MinimumOSVersionAttribute(OperatingSystems operatingSystem, string minVersion) :
        this(operatingSystem, Version.Parse(minVersion), GetCurrentOS(), GetCurrentOSVersion())
    {
    }
 
    // to enable unit testing
    internal MinimumOSVersionAttribute(OperatingSystems targetOS, Version minVersion, OperatingSystems currentOS, Version currentVersion)
    {
        if (targetOS != OperatingSystems.Windows)
        {
            throw new NotImplementedException("Min version support is only implemented for Windows.");
        }
        _targetOS = targetOS;
        _minVersion = minVersion;
        _currentOS = currentOS;
        _currentVersion = currentVersion;
 
        // Do not skip other OS's, Use OSSkipConditionAttribute or a separate MinimumOSVersionAttribute for that.
        _skip = _targetOS == _currentOS && _minVersion > _currentVersion;
        SkipReason = $"This test requires {_targetOS} {_minVersion} or later.";
    }
 
    // Since a test would be executed only if 'IsMet' is true, return false if we want to skip
    public bool IsMet => !_skip;
 
    public string SkipReason { get; set; }
 
    private static OperatingSystems GetCurrentOS()
    {
        if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
        {
            return OperatingSystems.Windows;
        }
        else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
        {
            return OperatingSystems.Linux;
        }
        else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
        {
            return OperatingSystems.MacOSX;
        }
        throw new PlatformNotSupportedException();
    }
 
    private static Version GetCurrentOSVersion()
    {
        if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
        {
            return Environment.OSVersion.Version;
        }
        else
        {
            // Not implemented, but this will still be called before the OS check happens so don't throw.
            return new Version(0, 0);
        }
    }
}