This repository has been archived by the owner on Jul 30, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Skipping Admin-only tests instead of failing them (#766)
* Skipping admin-only tests when run as non-admin gracefully instead of failing them. * Made non-admin test skip conditional on the presence of `ENABLE_NONADMIN_TEST_SKIP` environment variable so that there would be no way to skip those in CI by accident.
- Loading branch information
Showing
14 changed files
with
236 additions
and
74 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| // Copyright (c) .NET Foundation. All rights reserved. | ||
| // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. | ||
|
|
||
| using System; | ||
| using Xunit; | ||
| using Xunit.Sdk; | ||
|
|
||
| namespace TestUtil | ||
| { | ||
| /// <summary> | ||
| /// Indicates a test that can be set up to be skipped when run as non-Admin user if environment | ||
| /// is set up appropriately. See <see cref="UserHelper.EnableSkipVariableName"/> for more details. | ||
| /// </summary> | ||
| [AttributeUsage(AttributeTargets.Method, AllowMultiple = false)] | ||
| [XunitTestCaseDiscoverer("Xunit.Sdk.FactDiscoverer", "xunit.execution.{Platform}")] | ||
| public class AdminOnlyFactAttribute : FactAttribute | ||
| { | ||
| public AdminOnlyFactAttribute() | ||
| { | ||
| UserHelper.SetupFactSkipIfAdmin(this); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| // Copyright (c) .NET Foundation. All rights reserved. | ||
| // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. | ||
|
|
||
| using System; | ||
| using Xunit; | ||
| using Xunit.Sdk; | ||
|
|
||
| namespace TestUtil | ||
| { | ||
| /// <summary> | ||
| /// Indicates a test set that can be set up to be skipped when run as non-Admin user if environment | ||
| /// is set up appropriately. See <see cref="UserHelper.EnableSkipVariableName"/> for more details. | ||
| /// </summary> | ||
| [AttributeUsage(AttributeTargets.Method, AllowMultiple = false)] | ||
| [XunitTestCaseDiscoverer("Xunit.Sdk.TheoryDiscoverer", "xunit.execution.{Platform}")] | ||
| public class AdminOnlyTheoryAttribute : TheoryAttribute | ||
| { | ||
| public AdminOnlyTheoryAttribute() | ||
| { | ||
| UserHelper.SetupFactSkipIfAdmin(this); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| using System.Reflection; | ||
| using System.Runtime.InteropServices; | ||
|
|
||
| [assembly: AssemblyTitle("TestUtil")] | ||
| [assembly: AssemblyDescription("Shared test code")] | ||
| [assembly: AssemblyCompany(".NET Foundation")] | ||
| [assembly: AssemblyProduct("TestUtil")] | ||
| [assembly: AssemblyCopyright("Copyright © .NET Foundation 2017")] | ||
| [assembly: ComVisible(false)] | ||
| [assembly: Guid("c3f84bad-acfa-4ae3-8286-d12f5a5bbc62")] | ||
| [assembly: AssemblyVersion("1.0.0.0")] | ||
| [assembly: AssemblyFileVersion("1.0.0.0")] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> | ||
| <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" /> | ||
| <PropertyGroup> | ||
| <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration> | ||
| <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform> | ||
| <ProjectGuid>{C3F84BAD-ACFA-4AE3-8286-D12F5A5BBC62}</ProjectGuid> | ||
| <OutputType>Library</OutputType> | ||
| <AppDesignerFolder>Properties</AppDesignerFolder> | ||
| <RootNamespace>TestUtil</RootNamespace> | ||
| <AssemblyName>TestUtil</AssemblyName> | ||
| <TargetFrameworkVersion>v4.6.2</TargetFrameworkVersion> | ||
| <FileAlignment>512</FileAlignment> | ||
| <Deterministic>true</Deterministic> | ||
| </PropertyGroup> | ||
| <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' "> | ||
| <DebugSymbols>true</DebugSymbols> | ||
| <DebugType>full</DebugType> | ||
| <Optimize>false</Optimize> | ||
| <OutputPath>bin\Debug\</OutputPath> | ||
| <DefineConstants>DEBUG;TRACE</DefineConstants> | ||
| <ErrorReport>prompt</ErrorReport> | ||
| <WarningLevel>4</WarningLevel> | ||
| </PropertyGroup> | ||
| <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' "> | ||
| <DebugType>pdbonly</DebugType> | ||
| <Optimize>true</Optimize> | ||
| <OutputPath>bin\Release\</OutputPath> | ||
| <DefineConstants>TRACE</DefineConstants> | ||
| <ErrorReport>prompt</ErrorReport> | ||
| <WarningLevel>4</WarningLevel> | ||
| </PropertyGroup> | ||
| <ItemGroup> | ||
| <Reference Include="System" /> | ||
| <Reference Include="System.Core" /> | ||
| <Reference Include="System.Xml.Linq" /> | ||
| <Reference Include="System.Data.DataSetExtensions" /> | ||
| <Reference Include="Microsoft.CSharp" /> | ||
| <Reference Include="System.Data" /> | ||
| <Reference Include="System.Net.Http" /> | ||
| <Reference Include="System.Xml" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Compile Include="AdminOnlyFactAttribute.cs" /> | ||
| <Compile Include="Properties\AssemblyInfo.cs" /> | ||
| <Compile Include="AdminOnlyTheoryAttribute.cs" /> | ||
| <Compile Include="UserHelper.cs" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <PackageReference Include="xunit"> | ||
| <Version>2.3.1</Version> | ||
| </PackageReference> | ||
| </ItemGroup> | ||
| <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" /> | ||
| </Project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| // Copyright (c) .NET Foundation. All rights reserved. | ||
| // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. | ||
|
|
||
| using System; | ||
| using System.Security.Principal; | ||
| using Xunit; | ||
|
|
||
| namespace TestUtil | ||
| { | ||
| public static class UserHelper | ||
| { | ||
| /// <summary> | ||
| /// Certain tests fail when run as a non-Administrator user. Adding the environment | ||
| /// variable with the name specified below and any value will enable skipping those | ||
| /// tests when run as non-Administrator. They will still run if executed as Admin. | ||
| /// </summary> | ||
| public const string EnableSkipVariableName = "ENABLE_NONADMIN_TEST_SKIP"; | ||
|
|
||
| /// <summary> | ||
| /// Source: https://stackoverflow.com/a/11660205 | ||
| /// </summary> | ||
| public static bool IsAdministrator() | ||
| { | ||
| var identity = WindowsIdentity.GetCurrent(); | ||
| var principal = new WindowsPrincipal(identity); | ||
| return principal.IsInRole(WindowsBuiltInRole.Administrator); | ||
| } | ||
|
|
||
| public static void SetupFactSkipIfAdmin(FactAttribute attribute) | ||
| { | ||
| if (!UserHelper.IsAdministrator() && Environment.GetEnvironmentVariable(EnableSkipVariableName) != null) | ||
| { | ||
| attribute.Skip = "Test will not run unless executed as Administrator"; | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.