Cleanup to skip/flaky attributes (dotnet/extensions#2186)

jkotalik · web-flow · commit c717230b1350 · 2019-08-15T09:12:53.000-07:00
\n\nCommit migrated from dotnet/extensions@cfef5e0
diff --git a/src/Testing/src/TestPlatformHelper.cs b/src/Testing/src/TestPlatformHelper.cs
@@ -20,4 +20,4 @@ public static class TestPlatformHelper
         public static bool IsMac =>
             RuntimeInformation.IsOSPlatform(OSPlatform.OSX);
     }
-}
+}
diff --git a/src/Testing/src/xunit/ConditionalFactAttribute.cs b/src/Testing/src/xunit/ConditionalFactAttribute.cs
@@ -5,7 +5,7 @@
 using Xunit;
 using Xunit.Sdk;
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     [AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]
     [XunitTestCaseDiscoverer("Microsoft.AspNetCore.Testing.xunit." + nameof(ConditionalFactDiscoverer), "Microsoft.AspNetCore.Testing")]
diff --git a/src/Testing/src/xunit/ConditionalFactDiscoverer.cs b/src/Testing/src/xunit/ConditionalFactDiscoverer.cs
@@ -4,7 +4,7 @@
 using Xunit.Abstractions;
 using Xunit.Sdk;
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     internal class ConditionalFactDiscoverer : FactDiscoverer
     {
diff --git a/src/Testing/src/xunit/ConditionalTheoryAttribute.cs b/src/Testing/src/xunit/ConditionalTheoryAttribute.cs
@@ -5,7 +5,7 @@
 using Xunit;
 using Xunit.Sdk;
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     [AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]
     [XunitTestCaseDiscoverer("Microsoft.AspNetCore.Testing.xunit." + nameof(ConditionalTheoryDiscoverer), "Microsoft.AspNetCore.Testing")]
diff --git a/src/Testing/src/xunit/ConditionalTheoryDiscoverer.cs b/src/Testing/src/xunit/ConditionalTheoryDiscoverer.cs
@@ -5,7 +5,7 @@
 using Xunit.Abstractions;
 using Xunit.Sdk;
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     internal class ConditionalTheoryDiscoverer : TheoryDiscoverer
     {
diff --git a/src/Testing/src/xunit/DockerOnlyAttribute.cs b/src/Testing/src/xunit/DockerOnlyAttribute.cs
@@ -6,7 +6,7 @@
 using System.Linq;
 using System.Runtime.InteropServices;
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     [AttributeUsage(AttributeTargets.Method, Inherited = true, AllowMultiple = false)]
     public sealed class DockerOnlyAttribute : Attribute, ITestCondition
diff --git a/src/Testing/src/xunit/EnvironmentVariableSkipConditionAttribute.cs b/src/Testing/src/xunit/EnvironmentVariableSkipConditionAttribute.cs
@@ -4,7 +4,7 @@
 using System;
 using System.Linq;
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     /// <summary>
     /// Skips a test when the value of an environment variable matches any of the supplied values.
diff --git a/src/Testing/src/xunit/FlakyAttribute.cs b/src/Testing/src/xunit/FlakyAttribute.cs
@@ -2,7 +2,7 @@
 using System.Collections.Generic;
 using Xunit.Sdk;
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     /// <summary>
     /// Marks a test as "Flaky" so that the build will sequester it and ignore failures.
diff --git a/src/Testing/src/xunit/FlakyTestDiscoverer.cs b/src/Testing/src/xunit/FlakyTestDiscoverer.cs
@@ -4,7 +4,7 @@
 using Xunit.Abstractions;
 using Xunit.Sdk;
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     public class FlakyTestDiscoverer : ITraitDiscoverer
     {
diff --git a/src/Testing/src/xunit/FrameworkSkipConditionAttribute.cs b/src/Testing/src/xunit/FrameworkSkipConditionAttribute.cs
@@ -3,7 +3,7 @@
 
 using System;
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     [AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]
     public class FrameworkSkipConditionAttribute : Attribute, ITestCondition
diff --git a/src/Testing/src/xunit/IEnvironmentVariable.cs b/src/Testing/src/xunit/IEnvironmentVariable.cs
@@ -1,7 +1,7 @@
 ﻿// 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.
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     internal interface IEnvironmentVariable
     {
diff --git a/src/Testing/src/xunit/ITestCondition.cs b/src/Testing/src/xunit/ITestCondition.cs
@@ -1,7 +1,7 @@
 // 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.
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     public interface ITestCondition
     {
diff --git a/src/Testing/src/xunit/MinimumOsVersionAttribute.cs b/src/Testing/src/xunit/MinimumOsVersionAttribute.cs
@@ -5,7 +5,7 @@
 using System.Runtime.InteropServices;
 using Microsoft.Win32;
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     /// <summary>
     /// Skips a test if the OS is the given type (Windows) and the OS version is less than specified.
diff --git a/src/Testing/src/xunit/OSSkipConditionAttribute.cs b/src/Testing/src/xunit/OSSkipConditionAttribute.cs
@@ -6,7 +6,7 @@
 using System.Linq;
 using System.Runtime.InteropServices;
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class | AttributeTargets.Assembly, AllowMultiple = true)]
     public class OSSkipConditionAttribute : Attribute, ITestCondition
diff --git a/src/Testing/src/xunit/OperatingSystems.cs b/src/Testing/src/xunit/OperatingSystems.cs
@@ -3,7 +3,7 @@
 
 using System;
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     [Flags]
     public enum OperatingSystems
diff --git a/src/Testing/src/xunit/RuntimeFrameworks.cs b/src/Testing/src/xunit/RuntimeFrameworks.cs
@@ -3,7 +3,7 @@
 
 using System;
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     [Flags]
     public enum RuntimeFrameworks
diff --git a/src/Testing/src/xunit/SkipOnCIAttribute.cs b/src/Testing/src/xunit/SkipOnCIAttribute.cs
@@ -0,0 +1,43 @@
+// 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;
+
+namespace Microsoft.AspNetCore.Testing
+{
+    /// <summary>
+    /// Skip test if running on CI
+    /// </summary>
+    [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = false)]
+    public class SkipOnCIAttribute : Attribute, ITestCondition
+    {
+        public SkipOnCIAttribute(string issueUrl = "")
+        {
+            IssueUrl = issueUrl;
+        }
+
+        public string IssueUrl { get; }
+
+        public bool IsMet
+        {
+            get
+            {
+                return !OnCI();
+            }
+        }
+
+        public string SkipReason
+        {
+            get
+            {
+                return $"This test is skipped on CI";
+            }
+        }
+
+        public static bool OnCI() => OnHelix() || OnAzdo();
+        public static bool OnHelix() => !string.IsNullOrEmpty(GetTargetHelixQueue());
+        public static string GetTargetHelixQueue() => Environment.GetEnvironmentVariable("helix");
+        public static bool OnAzdo() => !string.IsNullOrEmpty(GetIfOnAzdo());
+        public static string GetIfOnAzdo() => Environment.GetEnvironmentVariable("AGENT_OS");
+    }
+}
diff --git a/src/Testing/src/xunit/SkipOnHelixAttribute.cs b/src/Testing/src/xunit/SkipOnHelixAttribute.cs
@@ -0,0 +1,50 @@
+// 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.Linq;
+
+namespace Microsoft.AspNetCore.Testing
+{
+    /// <summary>
+    /// Skip test if running on helix (or a particular helix queue).
+    /// </summary>
+    [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = false)]
+    public class SkipOnHelixAttribute : Attribute, ITestCondition
+    {
+        public SkipOnHelixAttribute(string issueUrl)
+        {
+            if (string.IsNullOrEmpty(issueUrl))
+            {
+                throw new ArgumentException();
+            }
+            IssueUrl = issueUrl;
+        }
+
+        public string IssueUrl { get; }
+
+        public bool IsMet
+        {
+            get
+            {
+                var skip = OnHelix() && (Queues == null || Queues.ToLowerInvariant().Split(';').Contains(GetTargetHelixQueue().ToLowerInvariant()));
+                return !skip;
+            }
+        }
+
+        // Queues that should be skipped on, i.e. "Windows.10.Amd64.ClientRS4.VS2017.Open;OSX.1012.Amd64.Open"
+        public string Queues { get; set; }
+
+        public string SkipReason
+        {
+            get
+            {
+                return $"This test is skipped on helix";
+            }
+        }
+
+        public static bool OnHelix() => !string.IsNullOrEmpty(GetTargetHelixQueue());
+
+        public static string GetTargetHelixQueue() => Environment.GetEnvironmentVariable("helix");
+    }
+}
diff --git a/src/Testing/src/xunit/SkippedTestCase.cs b/src/Testing/src/xunit/SkippedTestCase.cs
@@ -5,7 +5,7 @@
 using Xunit.Abstractions;
 using Xunit.Sdk;
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     public class SkippedTestCase : XunitTestCase
     {
diff --git a/src/Testing/src/xunit/TestMethodExtensions.cs b/src/Testing/src/xunit/TestMethodExtensions.cs
@@ -5,7 +5,7 @@
 using Xunit.Abstractions;
 using Xunit.Sdk;
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     public static class TestMethodExtensions
     {
diff --git a/src/Testing/src/xunit/WindowsVersions.cs b/src/Testing/src/xunit/WindowsVersions.cs
@@ -1,7 +1,7 @@
 // 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.
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     public static class WindowsVersions
     {
diff --git a/src/Testing/test/ConditionalFactTest.cs b/src/Testing/test/ConditionalFactTest.cs
@@ -2,7 +2,7 @@
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
-using Microsoft.AspNetCore.Testing.xunit;
+using Microsoft.AspNetCore.Testing;
 using Xunit;
 
 namespace Microsoft.AspNetCore.Testing
diff --git a/src/Testing/test/ConditionalTheoryTest.cs b/src/Testing/test/ConditionalTheoryTest.cs
@@ -2,7 +2,7 @@
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
-using Microsoft.AspNetCore.Testing.xunit;
+using Microsoft.AspNetCore.Testing;
 using Xunit;
 using Xunit.Abstractions;
 
diff --git a/src/Testing/test/DockerTests.cs b/src/Testing/test/DockerTests.cs
@@ -3,7 +3,7 @@
 
 using System;
 using System.Runtime.InteropServices;
-using Microsoft.AspNetCore.Testing.xunit;
+using Microsoft.AspNetCore.Testing;
 using Xunit;
 
 namespace Microsoft.AspNetCore.Testing
diff --git a/src/Testing/test/EnvironmentVariableSkipConditionTest.cs b/src/Testing/test/EnvironmentVariableSkipConditionTest.cs
@@ -3,7 +3,7 @@
 
 using Xunit;
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     public class EnvironmentVariableSkipConditionTest
     {
diff --git a/src/Testing/test/FlakyAttributeTest.cs b/src/Testing/test/FlakyAttributeTest.cs
@@ -1,4 +1,6 @@
-using Microsoft.AspNetCore.Testing.xunit;
+// 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.Collections.Generic;
 using Xunit;
diff --git a/src/Testing/test/OSSkipConditionAttributeTest.cs b/src/Testing/test/OSSkipConditionAttributeTest.cs
@@ -5,7 +5,7 @@
 using System.Runtime.InteropServices;
 using Xunit;
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     public class OSSkipConditionAttributeTest
     {
diff --git a/src/Testing/test/OSSkipConditionTest.cs b/src/Testing/test/OSSkipConditionTest.cs
@@ -5,7 +5,7 @@
 using System.Runtime.InteropServices;
 using Xunit;
 
-namespace Microsoft.AspNetCore.Testing.xunit
+namespace Microsoft.AspNetCore.Testing
 {
     public class OSSkipConditionTest
     {
diff --git a/src/Testing/test/SkipOnCITests.cs b/src/Testing/test/SkipOnCITests.cs
@@ -0,0 +1,22 @@
+// 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 Microsoft.AspNetCore.Testing;
+using Xunit;
+
+namespace Microsoft.AspNetCore.Testing.Tests
+{
+    public class SkipOnCITests
+    {
+        [ConditionalFact]
+        [SkipOnCI]
+        public void AlwaysSkipOnCI()
+        {
+            if (!string.IsNullOrEmpty(Environment.GetEnvironmentVariable("HELIX")) || !string.IsNullOrEmpty(Environment.GetEnvironmentVariable("AGENT_OS")))
+            {
+                throw new Exception("Flaky!");
+            }
+        }
+    }
+}
diff --git a/src/Testing/test/TestPlatformHelperTest.cs b/src/Testing/test/TestPlatformHelperTest.cs
@@ -1,7 +1,7 @@
 // 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 Microsoft.AspNetCore.Testing.xunit;
+using Microsoft.AspNetCore.Testing;
 using Xunit;
 
 namespace Microsoft.AspNetCore.Testing

Original file line number	Diff line number	Diff line change
`@@ -20,4 +20,4 @@ public static class TestPlatformHelper`
`20`	`20`	`public static bool IsMac =>`
`21`	`21`	`RuntimeInformation.IsOSPlatform(OSPlatform.OSX);`
`22`	`22`	`}`
`23`		`-}`
	`23`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`using Xunit;`
`6`	`6`	`using Xunit.Sdk;`
`7`	`7`
`8`		`-namespace Microsoft.AspNetCore.Testing.xunit`
	`8`	`+namespace Microsoft.AspNetCore.Testing`
`9`	`9`	`{`
`10`	`10`	`[AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]`
`11`	`11`	`[XunitTestCaseDiscoverer("Microsoft.AspNetCore.Testing.xunit." + nameof(ConditionalFactDiscoverer), "Microsoft.AspNetCore.Testing")]`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`using Xunit.Abstractions;`
`5`	`5`	`using Xunit.Sdk;`
`6`	`6`
`7`		`-namespace Microsoft.AspNetCore.Testing.xunit`
	`7`	`+namespace Microsoft.AspNetCore.Testing`
`8`	`8`	`{`
`9`	`9`	`internal class ConditionalFactDiscoverer : FactDiscoverer`
`10`	`10`	`{`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`using System.Linq;`
`7`	`7`	`using System.Runtime.InteropServices;`
`8`	`8`
`9`		`-namespace Microsoft.AspNetCore.Testing.xunit`
	`9`	`+namespace Microsoft.AspNetCore.Testing`
`10`	`10`	`{`
`11`	`11`	`[AttributeUsage(AttributeTargets.Method, Inherited = true, AllowMultiple = false)]`
`12`	`12`	`public sealed class DockerOnlyAttribute : Attribute, ITestCondition`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`using System;`
`5`	`5`	`using System.Linq;`
`6`	`6`
`7`		`-namespace Microsoft.AspNetCore.Testing.xunit`
	`7`	`+namespace Microsoft.AspNetCore.Testing`
`8`	`8`	`{`
`9`	`9`	`/// <summary>`
`10`	`10`	`/// Skips a test when the value of an environment variable matches any of the supplied values.`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`using System.Collections.Generic;`
`3`	`3`	`using Xunit.Sdk;`
`4`	`4`
`5`		`-namespace Microsoft.AspNetCore.Testing.xunit`
	`5`	`+namespace Microsoft.AspNetCore.Testing`
`6`	`6`	`{`
`7`	`7`	`/// <summary>`
`8`	`8`	`/// Marks a test as "Flaky" so that the build will sequester it and ignore failures.`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`
`4`	`4`	`using System;`
`5`	`5`
`6`		`-namespace Microsoft.AspNetCore.Testing.xunit`
	`6`	`+namespace Microsoft.AspNetCore.Testing`
`7`	`7`	`{`
`8`	`8`	`[AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]`
`9`	`9`	`public class FrameworkSkipConditionAttribute : Attribute, ITestCondition`