Add FrontDoorTestRunner to replace TestController (#18126)

v-yuzhichen · web-flow · commit 1da21110dfe8 · 2022-05-13T11:36:28.000+08:00
diff --git a/src/FrontDoor/FrontDoor.Test/ScenarioTests/FrontDoorTestRunner.cs b/src/FrontDoor/FrontDoor.Test/ScenarioTests/FrontDoorTestRunner.cs
@@ -0,0 +1,56 @@
+﻿// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed 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.
+// ----------------------------------------------------------------------------------
+
+using System.Collections.Generic;
+using Xunit.Abstractions;
+using Microsoft.Azure.Commands.TestFx;
+
+namespace Microsoft.Azure.Commands.FrontDoor.Test.ScenarioTests.ScenarioTest
+{
+    public class FrontDoorTestRunner
+    {
+        protected readonly ITestRunner TestRunner;
+
+        protected FrontDoorTestRunner(ITestOutputHelper output)
+        {
+            TestRunner = TestManager.CreateInstance(output)
+                .WithNewPsScriptFilename($"{GetType().Name}.ps1")
+                .WithProjectSubfolderForTests("ScenarioTests")
+                .WithCommonPsScripts(new[]
+                {
+                    @"Common.ps1",
+                    @"../AzureRM.Resources.ps1"
+                })
+                .WithNewRmModules(helper => new[]
+                {
+                    helper.RMProfileModule,
+                    helper.GetRMModulePath(@"Az.FrontDoor.psd1")
+                })
+                .WithNewRecordMatcherArguments(
+                    userAgentsToIgnore: new Dictionary<string, string>
+                    {
+                        {"Microsoft.Azure.Management.Resources.ResourceManagementClient", "2016-02-01"}
+                    },
+                    resourceProviders: new Dictionary<string, string>
+                    {
+                        {"Microsoft.Resources", null},
+                        {"Microsoft.Features", null},
+                        {"Microsoft.Authorization", null},
+                        {"Microsoft.Compute", null}
+                    }
+                )
+                .Build();
+        }
+    }
+}
diff --git a/src/FrontDoor/FrontDoor.Test/ScenarioTests/FrontDoorTests.cs b/src/FrontDoor/FrontDoor.Test/ScenarioTests/FrontDoorTests.cs
@@ -17,42 +17,38 @@
 
 namespace Microsoft.Azure.Commands.FrontDoor.Test.ScenarioTests.ScenarioTest
 {
-    public class FrontDoorTests
+    public class FrontDoorTests : FrontDoorTestRunner
     {
-        private readonly ServiceManagement.Common.Models.XunitTracingInterceptor _logger;
-
-        public FrontDoorTests(Xunit.Abstractions.ITestOutputHelper output)
+        public FrontDoorTests(Xunit.Abstractions.ITestOutputHelper output) : base(output)
         {
-            _logger = new ServiceManagement.Common.Models.XunitTracingInterceptor(output);
-            ServiceManagement.Common.Models.XunitTracingInterceptor.AddToContext(_logger);
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestFrontDoorCrud()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Test-FrontDoorCrud");
+            TestRunner.RunTestScript("Test-FrontDoorCrud");
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestFrontDoorCrudDefaults()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Test-FrontDoorCrudDefaults");
+            TestRunner.RunTestScript("Test-FrontDoorCrudDefaults");
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestFrontDoorCrudWithPiping()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Test-FrontDoorCrudWithPiping");
+            TestRunner.RunTestScript("Test-FrontDoorCrudWithPiping");
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestFrontDoorRulesEngineCrud()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Test-FrontDoorRulesEngineCrud");
+            TestRunner.RunTestScript("Test-FrontDoorRulesEngineCrud");
         }
 
         //[Fact]
@@ -66,28 +62,28 @@ public void TestFrontDoorRulesEngineCrud()
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestFrontDoorEndpointCustomDomainHTTPSByocSpecificVersion()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Test-FrontDoorEndpointCustomDomainHTTPS-BYOC-SpecificVersion");
+            TestRunner.RunTestScript("Test-FrontDoorEndpointCustomDomainHTTPS-BYOC-SpecificVersion");
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestFrontDoorEndpointCustomDomainHTTPSByocLatestVersion()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Test-FrontDoorEndpointCustomDomainHTTPS-BYOC-LatestVersion");
+            TestRunner.RunTestScript("Test-FrontDoorEndpointCustomDomainHTTPS-BYOC-LatestVersion");
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestFrontDoorCrudRedirect()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Test-FrontDoorCrudRedirect");
+            TestRunner.RunTestScript("Test-FrontDoorCrudRedirect");
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestFrontDoorCrudPrivateLink()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Test-FrontDoorCrudPrivateLink");
+            TestRunner.RunTestScript("Test-FrontDoorCrudPrivateLink");
         }
     }
 }
diff --git a/src/FrontDoor/FrontDoor.Test/ScenarioTests/TestController.cs b/src/FrontDoor/FrontDoor.Test/ScenarioTests/TestController.cs
diff --git a/src/FrontDoor/FrontDoor.Test/ScenarioTests/WebApplicationFireWallPolicyTests.cs b/src/FrontDoor/FrontDoor.Test/ScenarioTests/WebApplicationFireWallPolicyTests.cs
@@ -12,48 +12,43 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
-using Microsoft.Azure.Commands.FrontDoor.Test.ScenarioTests.ScenarioTest;
 using Microsoft.WindowsAzure.Commands.ScenarioTest;
 using Xunit;
 
 namespace Microsoft.Azure.Commands.FrontDoor.Test.ScenarioTests.ScenarioTest
 {
-    public class WebApplicationFireWallPolicyTests
+    public class WebApplicationFireWallPolicyTests : FrontDoorTestRunner
     {
-        private ServiceManagement.Common.Models.XunitTracingInterceptor _logger;
-
-        public WebApplicationFireWallPolicyTests(Xunit.Abstractions.ITestOutputHelper output)
+        public WebApplicationFireWallPolicyTests(Xunit.Abstractions.ITestOutputHelper output) : base(output)
         {
-            _logger = new ServiceManagement.Common.Models.XunitTracingInterceptor(output);
-            ServiceManagement.Common.Models.XunitTracingInterceptor.AddToContext(_logger);
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestPolicyCrud()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Test-PolicyCrud");
+            TestRunner.RunTestScript("Test-PolicyCrud");
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestPolicyCrudWithPiping()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Test-PolicyCrudWithPiping");
+            TestRunner.RunTestScript("Test-PolicyCrudWithPiping");
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestManagedRuleSetDefinitions()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Test-ManagedRuleSetDefinition");
+            TestRunner.RunTestScript("Test-ManagedRuleSetDefinition");
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestPolicyAction()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Test-PolicyAction");
+            TestRunner.RunTestScript("Test-PolicyAction");
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -17,42 +17,38 @@`
`17`	`17`
`18`	`18`	`namespace Microsoft.Azure.Commands.FrontDoor.Test.ScenarioTests.ScenarioTest`
`19`	`19`	`{`
`20`		`- public class FrontDoorTests`
	`20`	`+ public class FrontDoorTests : FrontDoorTestRunner`
`21`	`21`	`{`
`22`		`- private readonly ServiceManagement.Common.Models.XunitTracingInterceptor _logger;`
`23`		`-`
`24`		`- public FrontDoorTests(Xunit.Abstractions.ITestOutputHelper output)`
	`22`	`+ public FrontDoorTests(Xunit.Abstractions.ITestOutputHelper output) : base(output)`
`25`	`23`	`{`
`26`		`- _logger = new ServiceManagement.Common.Models.XunitTracingInterceptor(output);`
`27`		`- ServiceManagement.Common.Models.XunitTracingInterceptor.AddToContext(_logger);`
`28`	`24`	`}`
`29`	`25`
`30`	`26`	`[Fact]`
`31`	`27`	`[Trait(Category.AcceptanceType, Category.CheckIn)]`
`32`	`28`	`public void TestFrontDoorCrud()`
`33`	`29`	`{`
`34`		`- TestController.NewInstance.RunPowerShellTest(_logger, "Test-FrontDoorCrud");`
	`30`	`+ TestRunner.RunTestScript("Test-FrontDoorCrud");`
`35`	`31`	`}`
`36`	`32`
`37`	`33`	`[Fact]`
`38`	`34`	`[Trait(Category.AcceptanceType, Category.CheckIn)]`
`39`	`35`	`public void TestFrontDoorCrudDefaults()`
`40`	`36`	`{`
`41`		`- TestController.NewInstance.RunPowerShellTest(_logger, "Test-FrontDoorCrudDefaults");`
	`37`	`+ TestRunner.RunTestScript("Test-FrontDoorCrudDefaults");`
`42`	`38`	`}`
`43`	`39`
`44`	`40`	`[Fact]`
`45`	`41`	`[Trait(Category.AcceptanceType, Category.CheckIn)]`
`46`	`42`	`public void TestFrontDoorCrudWithPiping()`
`47`	`43`	`{`
`48`		`- TestController.NewInstance.RunPowerShellTest(_logger, "Test-FrontDoorCrudWithPiping");`
	`44`	`+ TestRunner.RunTestScript("Test-FrontDoorCrudWithPiping");`
`49`	`45`	`}`
`50`	`46`
`51`	`47`	`[Fact]`
`52`	`48`	`[Trait(Category.AcceptanceType, Category.CheckIn)]`
`53`	`49`	`public void TestFrontDoorRulesEngineCrud()`
`54`	`50`	`{`
`55`		`- TestController.NewInstance.RunPowerShellTest(_logger, "Test-FrontDoorRulesEngineCrud");`
	`51`	`+ TestRunner.RunTestScript("Test-FrontDoorRulesEngineCrud");`
`56`	`52`	`}`
`57`	`53`
`58`	`54`	`//[Fact]`
`@@ -66,28 +62,28 @@ public void TestFrontDoorRulesEngineCrud()`
`66`	`62`	`[Trait(Category.AcceptanceType, Category.CheckIn)]`
`67`	`63`	`public void TestFrontDoorEndpointCustomDomainHTTPSByocSpecificVersion()`
`68`	`64`	`{`
`69`		`- TestController.NewInstance.RunPowerShellTest(_logger, "Test-FrontDoorEndpointCustomDomainHTTPS-BYOC-SpecificVersion");`
	`65`	`+ TestRunner.RunTestScript("Test-FrontDoorEndpointCustomDomainHTTPS-BYOC-SpecificVersion");`
`70`	`66`	`}`
`71`	`67`
`72`	`68`	`[Fact]`
`73`	`69`	`[Trait(Category.AcceptanceType, Category.CheckIn)]`
`74`	`70`	`public void TestFrontDoorEndpointCustomDomainHTTPSByocLatestVersion()`
`75`	`71`	`{`
`76`		`- TestController.NewInstance.RunPowerShellTest(_logger, "Test-FrontDoorEndpointCustomDomainHTTPS-BYOC-LatestVersion");`
	`72`	`+ TestRunner.RunTestScript("Test-FrontDoorEndpointCustomDomainHTTPS-BYOC-LatestVersion");`
`77`	`73`	`}`
`78`	`74`
`79`	`75`	`[Fact]`
`80`	`76`	`[Trait(Category.AcceptanceType, Category.CheckIn)]`
`81`	`77`	`public void TestFrontDoorCrudRedirect()`
`82`	`78`	`{`
`83`		`- TestController.NewInstance.RunPowerShellTest(_logger, "Test-FrontDoorCrudRedirect");`
	`79`	`+ TestRunner.RunTestScript("Test-FrontDoorCrudRedirect");`
`84`	`80`	`}`
`85`	`81`
`86`	`82`	`[Fact]`
`87`	`83`	`[Trait(Category.AcceptanceType, Category.CheckIn)]`
`88`	`84`	`public void TestFrontDoorCrudPrivateLink()`
`89`	`85`	`{`
`90`		`- TestController.NewInstance.RunPowerShellTest(_logger, "Test-FrontDoorCrudPrivateLink");`
	`86`	`+ TestRunner.RunTestScript("Test-FrontDoorCrudPrivateLink");`
`91`	`87`	`}`
`92`	`88`	`}`
`93`	`89`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,48 +12,43 @@`
`12`	`12`	`// limitations under the License.`
`13`	`13`	`// ----------------------------------------------------------------------------------`
`14`	`14`
`15`		`-using Microsoft.Azure.Commands.FrontDoor.Test.ScenarioTests.ScenarioTest;`
`16`	`15`	`using Microsoft.WindowsAzure.Commands.ScenarioTest;`
`17`	`16`	`using Xunit;`
`18`	`17`
`19`	`18`	`namespace Microsoft.Azure.Commands.FrontDoor.Test.ScenarioTests.ScenarioTest`
`20`	`19`	`{`
`21`		`- public class WebApplicationFireWallPolicyTests`
	`20`	`+ public class WebApplicationFireWallPolicyTests : FrontDoorTestRunner`
`22`	`21`	`{`
`23`		`- private ServiceManagement.Common.Models.XunitTracingInterceptor _logger;`
`24`		`-`
`25`		`- public WebApplicationFireWallPolicyTests(Xunit.Abstractions.ITestOutputHelper output)`
	`22`	`+ public WebApplicationFireWallPolicyTests(Xunit.Abstractions.ITestOutputHelper output) : base(output)`
`26`	`23`	`{`
`27`		`- _logger = new ServiceManagement.Common.Models.XunitTracingInterceptor(output);`
`28`		`- ServiceManagement.Common.Models.XunitTracingInterceptor.AddToContext(_logger);`
`29`	`24`	`}`
`30`	`25`
`31`	`26`	`[Fact]`
`32`	`27`	`[Trait(Category.AcceptanceType, Category.CheckIn)]`
`33`	`28`	`public void TestPolicyCrud()`
`34`	`29`	`{`
`35`		`- TestController.NewInstance.RunPowerShellTest(_logger, "Test-PolicyCrud");`
	`30`	`+ TestRunner.RunTestScript("Test-PolicyCrud");`
`36`	`31`	`}`
`37`	`32`
`38`	`33`	`[Fact]`
`39`	`34`	`[Trait(Category.AcceptanceType, Category.CheckIn)]`
`40`	`35`	`public void TestPolicyCrudWithPiping()`
`41`	`36`	`{`
`42`		`- TestController.NewInstance.RunPowerShellTest(_logger, "Test-PolicyCrudWithPiping");`
	`37`	`+ TestRunner.RunTestScript("Test-PolicyCrudWithPiping");`
`43`	`38`	`}`
`44`	`39`
`45`	`40`	`[Fact]`
`46`	`41`	`[Trait(Category.AcceptanceType, Category.CheckIn)]`
`47`	`42`	`public void TestManagedRuleSetDefinitions()`
`48`	`43`	`{`
`49`		`- TestController.NewInstance.RunPowerShellTest(_logger, "Test-ManagedRuleSetDefinition");`
	`44`	`+ TestRunner.RunTestScript("Test-ManagedRuleSetDefinition");`
`50`	`45`	`}`
`51`	`46`
`52`	`47`	`[Fact]`
`53`	`48`	`[Trait(Category.AcceptanceType, Category.CheckIn)]`
`54`	`49`	`public void TestPolicyAction()`
`55`	`50`	`{`
`56`		`- TestController.NewInstance.RunPowerShellTest(_logger, "Test-PolicyAction");`
	`51`	`+ TestRunner.RunTestScript("Test-PolicyAction");`
`57`	`52`	`}`
`58`	`53`	`}`
`59`	`54`	`}`