Add AlertsManagementTestRunner and replace TestController (Azure#18039)

CaptainFanZzz · Ziyue Zheng · web-flow · commit 3510359c7952 · 2022-05-05T17:55:42.000+08:00
* Add AlertsManagementTestRunner and replace TestController

* Add AlertsManagementTestRunner and replace TestController

Co-authored-by: Ziyue Zheng &lt;v-ziyzhe@microsoft.com&gt;
diff --git a/src/AlertsManagement/AlertsManagement.Test/ScenarioTests/AlertPRuleTests.cs b/src/AlertsManagement/AlertsManagement.Test/ScenarioTests/AlertPRuleTests.cs
@@ -12,45 +12,36 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
-using System;
 using Microsoft.WindowsAzure.Commands.ScenarioTest;
-using Microsoft.WindowsAzure.Commands.Test.Utilities.Common;
 using Xunit;
-using Microsoft.Azure.ServiceManagement.Common.Models;
-using Xunit.Abstractions;
 
 namespace Microsoft.Azure.Commands.AlertsManagement.Test.ScenarioTests
 {
-    public class AlertPRuleTests : RMTestBase
+    public class AlertPRuleTests : AlertsManagementTestRunner
     {
-        public XunitTracingInterceptor _logger;
-
-        public AlertPRuleTests(Xunit.Abstractions.ITestOutputHelper output)
+        public AlertPRuleTests(Xunit.Abstractions.ITestOutputHelper output) : base(output)
         {
-            _logger = new XunitTracingInterceptor(output);
-            XunitTracingInterceptor.AddToContext(_logger);
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestGetAlertProcessingRulesByResourceGroupName()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Test-GetAlertProcessingRulesByResourceGroupName");
+            TestRunner.RunTestScript("Test-GetAlertProcessingRulesByResourceGroupName");
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestCreateUpdateAndDeleteSuppressionRule()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Test-CreateUpdateAndDeleteSuppressionRule");
+            TestRunner.RunTestScript("Test-CreateUpdateAndDeleteSuppressionRule");
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestCreateUpdateAndDeleteActionGroupRule()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Test-CreateUpdateAndDeleteActionGroupRule");
+            TestRunner.RunTestScript("Test-CreateUpdateAndDeleteActionGroupRule");
         }
-
     }
 }
diff --git a/src/AlertsManagement/AlertsManagement.Test/ScenarioTests/AlertTests.cs b/src/AlertsManagement/AlertsManagement.Test/ScenarioTests/AlertTests.cs
@@ -12,43 +12,36 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
-using System;
 using Microsoft.WindowsAzure.Commands.ScenarioTest;
-using Microsoft.WindowsAzure.Commands.Test.Utilities.Common;
 using Xunit;
-using Microsoft.Azure.ServiceManagement.Common.Models;
 
 namespace Microsoft.Azure.Commands.AlertsManagement.Test.ScenarioTests
 {
-    public class AlertTests : RMTestBase
+    public class AlertTests : AlertsManagementTestRunner
     {
-        public XunitTracingInterceptor _logger;
-
-        public AlertTests(Xunit.Abstractions.ITestOutputHelper output)
+        public AlertTests(Xunit.Abstractions.ITestOutputHelper output) : base(output)
         {
-            _logger = new XunitTracingInterceptor(output);
-            XunitTracingInterceptor.AddToContext(_logger);
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestAlertChangeState()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Test-AlertChangeState");
+            TestRunner.RunTestScript("Test-AlertChangeState");
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestGetAlertsFilteredByParameters()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Test-GetAlertsFilteredByParameters");
+            TestRunner.RunTestScript("Test-GetAlertsFilteredByParameters");
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestAlertsSummary()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Test-AlertsSummary");
+            TestRunner.RunTestScript("Test-AlertsSummary");
         }
     }
 }
diff --git a/src/AlertsManagement/AlertsManagement.Test/ScenarioTests/AlertsManagementTestRunner.cs b/src/AlertsManagement/AlertsManagement.Test/ScenarioTests/AlertsManagementTestRunner.cs
@@ -0,0 +1,53 @@
+﻿// ----------------------------------------------------------------------------------
+//
+// 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 Microsoft.Azure.Commands.TestFx;
+using Xunit.Abstractions;
+
+namespace Microsoft.Azure.Commands.AlertsManagement.Test.ScenarioTests
+{
+    public class AlertsManagementTestRunner
+    {
+        protected readonly ITestRunner TestRunner;
+
+        protected AlertsManagementTestRunner(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.AlertsManagement.psd1")
+                })
+                .WithNewRecordMatcherArguments(
+                    userAgentsToIgnore: new Dictionary<string, string>
+                    {
+                        {"Microsoft.Azure.Management.Resources.ResourceManagementClient", "2016-02-01"},
+                    },
+                    resourceProviders: new Dictionary<string, string>
+                    {
+                        {"Microsoft.AlertsManagement", null}
+                    }
+                )
+                .Build();
+        }
+    }
+}
diff --git a/src/AlertsManagement/AlertsManagement.Test/ScenarioTests/SmartGroupTests.cs b/src/AlertsManagement/AlertsManagement.Test/ScenarioTests/SmartGroupTests.cs
@@ -12,29 +12,22 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
-using System;
 using Microsoft.WindowsAzure.Commands.ScenarioTest;
-using Microsoft.WindowsAzure.Commands.Test.Utilities.Common;
 using Xunit;
-using Microsoft.Azure.ServiceManagement.Common.Models;
 
 namespace Microsoft.Azure.Commands.AlertsManagement.Test.ScenarioTests
 {
-    public class SmartGroupTests : RMTestBase
+    public class SmartGroupTests : AlertsManagementTestRunner
     {
-        public XunitTracingInterceptor _logger;
-
-        public SmartGroupTests(Xunit.Abstractions.ITestOutputHelper output)
+        public SmartGroupTests(Xunit.Abstractions.ITestOutputHelper output) : base(output)
         {
-            _logger = new XunitTracingInterceptor(output);
-            XunitTracingInterceptor.AddToContext(_logger);
         }
 
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void TestSmartGroupChangeState()
         {
-            TestController.NewInstance.RunPowerShellTest(_logger, "Test-SmartGroupChangeState");
+            TestRunner.RunTestScript("Test-SmartGroupChangeState");
         }
     }
 }
diff --git a/src/AlertsManagement/AlertsManagement.Test/ScenarioTests/TestController.cs b/src/AlertsManagement/AlertsManagement.Test/ScenarioTests/TestController.cs

Original file line number	Diff line number	Diff line change
`@@ -12,45 +12,36 @@`
`12`	`12`	`// limitations under the License.`
`13`	`13`	`// ----------------------------------------------------------------------------------`
`14`	`14`
`15`		`-using System;`
`16`	`15`	`using Microsoft.WindowsAzure.Commands.ScenarioTest;`
`17`		`-using Microsoft.WindowsAzure.Commands.Test.Utilities.Common;`
`18`	`16`	`using Xunit;`
`19`		`-using Microsoft.Azure.ServiceManagement.Common.Models;`
`20`		`-using Xunit.Abstractions;`
`21`	`17`
`22`	`18`	`namespace Microsoft.Azure.Commands.AlertsManagement.Test.ScenarioTests`
`23`	`19`	`{`
`24`		`- public class AlertPRuleTests : RMTestBase`
	`20`	`+ public class AlertPRuleTests : AlertsManagementTestRunner`
`25`	`21`	`{`
`26`		`- public XunitTracingInterceptor _logger;`
`27`		`-`
`28`		`- public AlertPRuleTests(Xunit.Abstractions.ITestOutputHelper output)`
	`22`	`+ public AlertPRuleTests(Xunit.Abstractions.ITestOutputHelper output) : base(output)`
`29`	`23`	`{`
`30`		`- _logger = new XunitTracingInterceptor(output);`
`31`		`- XunitTracingInterceptor.AddToContext(_logger);`
`32`	`24`	`}`
`33`	`25`
`34`	`26`	`[Fact]`
`35`	`27`	`[Trait(Category.AcceptanceType, Category.CheckIn)]`
`36`	`28`	`public void TestGetAlertProcessingRulesByResourceGroupName()`
`37`	`29`	`{`
`38`		`- TestController.NewInstance.RunPowerShellTest(_logger, "Test-GetAlertProcessingRulesByResourceGroupName");`
	`30`	`+ TestRunner.RunTestScript("Test-GetAlertProcessingRulesByResourceGroupName");`
`39`	`31`	`}`
`40`	`32`
`41`	`33`	`[Fact]`
`42`	`34`	`[Trait(Category.AcceptanceType, Category.CheckIn)]`
`43`	`35`	`public void TestCreateUpdateAndDeleteSuppressionRule()`
`44`	`36`	`{`
`45`		`- TestController.NewInstance.RunPowerShellTest(_logger, "Test-CreateUpdateAndDeleteSuppressionRule");`
	`37`	`+ TestRunner.RunTestScript("Test-CreateUpdateAndDeleteSuppressionRule");`
`46`	`38`	`}`
`47`	`39`
`48`	`40`	`[Fact]`
`49`	`41`	`[Trait(Category.AcceptanceType, Category.CheckIn)]`
`50`	`42`	`public void TestCreateUpdateAndDeleteActionGroupRule()`
`51`	`43`	`{`
`52`		`- TestController.NewInstance.RunPowerShellTest(_logger, "Test-CreateUpdateAndDeleteActionGroupRule");`
	`44`	`+ TestRunner.RunTestScript("Test-CreateUpdateAndDeleteActionGroupRule");`
`53`	`45`	`}`
`54`		`-`
`55`	`46`	`}`
`56`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,43 +12,36 @@`
`12`	`12`	`// limitations under the License.`
`13`	`13`	`// ----------------------------------------------------------------------------------`
`14`	`14`
`15`		`-using System;`
`16`	`15`	`using Microsoft.WindowsAzure.Commands.ScenarioTest;`
`17`		`-using Microsoft.WindowsAzure.Commands.Test.Utilities.Common;`
`18`	`16`	`using Xunit;`
`19`		`-using Microsoft.Azure.ServiceManagement.Common.Models;`
`20`	`17`
`21`	`18`	`namespace Microsoft.Azure.Commands.AlertsManagement.Test.ScenarioTests`
`22`	`19`	`{`
`23`		`- public class AlertTests : RMTestBase`
	`20`	`+ public class AlertTests : AlertsManagementTestRunner`
`24`	`21`	`{`
`25`		`- public XunitTracingInterceptor _logger;`
`26`		`-`
`27`		`- public AlertTests(Xunit.Abstractions.ITestOutputHelper output)`
	`22`	`+ public AlertTests(Xunit.Abstractions.ITestOutputHelper output) : base(output)`
`28`	`23`	`{`
`29`		`- _logger = new XunitTracingInterceptor(output);`
`30`		`- XunitTracingInterceptor.AddToContext(_logger);`
`31`	`24`	`}`
`32`	`25`
`33`	`26`	`[Fact]`
`34`	`27`	`[Trait(Category.AcceptanceType, Category.CheckIn)]`
`35`	`28`	`public void TestAlertChangeState()`
`36`	`29`	`{`
`37`		`- TestController.NewInstance.RunPowerShellTest(_logger, "Test-AlertChangeState");`
	`30`	`+ TestRunner.RunTestScript("Test-AlertChangeState");`
`38`	`31`	`}`
`39`	`32`
`40`	`33`	`[Fact]`
`41`	`34`	`[Trait(Category.AcceptanceType, Category.CheckIn)]`
`42`	`35`	`public void TestGetAlertsFilteredByParameters()`
`43`	`36`	`{`
`44`		`- TestController.NewInstance.RunPowerShellTest(_logger, "Test-GetAlertsFilteredByParameters");`
	`37`	`+ TestRunner.RunTestScript("Test-GetAlertsFilteredByParameters");`
`45`	`38`	`}`
`46`	`39`
`47`	`40`	`[Fact]`
`48`	`41`	`[Trait(Category.AcceptanceType, Category.CheckIn)]`
`49`	`42`	`public void TestAlertsSummary()`
`50`	`43`	`{`
`51`		`- TestController.NewInstance.RunPowerShellTest(_logger, "Test-AlertsSummary");`
	`44`	`+ TestRunner.RunTestScript("Test-AlertsSummary");`
`52`	`45`	`}`
`53`	`46`	`}`
`54`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,29 +12,22 @@`
`12`	`12`	`// limitations under the License.`
`13`	`13`	`// ----------------------------------------------------------------------------------`
`14`	`14`
`15`		`-using System;`
`16`	`15`	`using Microsoft.WindowsAzure.Commands.ScenarioTest;`
`17`		`-using Microsoft.WindowsAzure.Commands.Test.Utilities.Common;`
`18`	`16`	`using Xunit;`
`19`		`-using Microsoft.Azure.ServiceManagement.Common.Models;`
`20`	`17`
`21`	`18`	`namespace Microsoft.Azure.Commands.AlertsManagement.Test.ScenarioTests`
`22`	`19`	`{`
`23`		`- public class SmartGroupTests : RMTestBase`
	`20`	`+ public class SmartGroupTests : AlertsManagementTestRunner`
`24`	`21`	`{`
`25`		`- public XunitTracingInterceptor _logger;`
`26`		`-`
`27`		`- public SmartGroupTests(Xunit.Abstractions.ITestOutputHelper output)`
	`22`	`+ public SmartGroupTests(Xunit.Abstractions.ITestOutputHelper output) : base(output)`
`28`	`23`	`{`
`29`		`- _logger = new XunitTracingInterceptor(output);`
`30`		`- XunitTracingInterceptor.AddToContext(_logger);`
`31`	`24`	`}`
`32`	`25`
`33`	`26`	`[Fact]`
`34`	`27`	`[Trait(Category.AcceptanceType, Category.CheckIn)]`
`35`	`28`	`public void TestSmartGroupChangeState()`
`36`	`29`	`{`
`37`		`- TestController.NewInstance.RunPowerShellTest(_logger, "Test-SmartGroupChangeState");`
	`30`	`+ TestRunner.RunTestScript("Test-SmartGroupChangeState");`
`38`	`31`	`}`
`39`	`32`	`}`
`40`	`33`	`}`