Pause Changes

Author: v-raghulraja

samples/pause/Pause_testPlan.fx.yaml

@@ -0,0 +1,31 @@
+testSuite:
+  testSuiteName: Pause Function Tests
+  testSuiteDescription: Verifies that the Pause function works correctly
+  persona: User1
+  appLogicalName: mda_input_controls_app
+
+  testCases:   
+    - testCaseName: Test Pause Function - Non-Headless Mode
+      testCaseDescription: Tests that Pause function works when headless is false
+      testSteps: |
+        = 
+        Screenshot("before_pause.png");
+        Pause();
+        Screenshot("after_pause.png");
+        Assert(true, "Test continued after Pause function");
+
+testSettings:
+  headless: false  
+  browserConfigurations:
+    - browser: Chromium
+      channel: msedge
+  extensionModules:
+    enable: true
+    parameters:
+      enableCorePause: true  
+
+environmentVariables:
+  users:
+    - personaName: User1
+      emailKey: user1Email
+      passwordKey: NotNeeded

src/Microsoft.PowerApps.TestEngine/PowerFx/Functions/PauseFunction.cs

@@ -0,0 +1,62 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+using Microsoft.Extensions.Logging;
+using Microsoft.PowerApps.TestEngine.Config;
+using Microsoft.PowerApps.TestEngine.TestInfra;
+using Microsoft.PowerFx;
+using Microsoft.PowerFx.Types;
+
+namespace Microsoft.PowerApps.TestEngine.PowerFx.Functions
+{
+    /// <summary>
+    /// This will pause the current test and allow the user to interact with the browser and inspect state when headless mode is false
+    /// </summary>
+    public class PauseFunction : ReflectionFunction
+    {
+        private readonly ITestInfraFunctions _testInfraFunctions;
+        private readonly ITestState _testState;
+        private readonly ILogger _logger;
+
+        public PauseFunction(ITestInfraFunctions testInfraFunctions, ITestState testState, ILogger logger)
+            : base("Pause", FormulaType.Blank)
+        {
+            _testInfraFunctions = testInfraFunctions;
+            _testState = testState;
+            _logger = logger;
+        }
+
+        public BlankValue Execute()
+        {
+            _logger.LogInformation("------------------------------\n\n" +
+                 "Executing Pause function.");
+
+            var testSettings = _testState.GetTestSettings();
+
+            if (!IsPreviewEnabledInOriginalConfig(testSettings))
+            {
+                _logger.LogInformation("Pause function is disabled - Preview namespace not explicitly enabled in YAML configuration.");
+                return FormulaValue.NewBlank();
+            }
+
+            if (!testSettings.Headless)
+            {
+                var page = _testInfraFunctions.GetContext().Pages.First();
+                page.PauseAsync().Wait();
+                _logger.LogInformation("Successfully finished executing Pause function.");
+            }
+            else
+            {
+                _logger.LogInformation("Skip Pause function as in headless mode.");
+            }
+
+            return FormulaValue.NewBlank();
+        }
+
+        private bool IsPreviewEnabledInOriginalConfig(TestSettings testSettings)
+        {
+            return testSettings?.ExtensionModules?.Parameters?.ContainsKey("enableCorePause") == true &&
+                   testSettings.ExtensionModules.Parameters["enableCorePause"]?.ToString().ToLower() == "true";
+        }
+    }
+}

src/Microsoft.PowerApps.TestEngine/PowerFx/PowerFxEngine.cs

@@ -102,6 +102,7 @@ public void Setup(TestSettings settings)
             powerFxConfig.AddFunction(new AssertNotErrorFunction(Logger));
             powerFxConfig.AddFunction(new SetPropertyFunction(_testWebProvider, Logger));
             powerFxConfig.AddFunction(new IsMatchFunction(Logger));
+            powerFxConfig.AddFunction(new PauseFunction(TestInfraFunctions, TestState, Logger));
 
             if (settings != null && settings.ExtensionModules != null && settings.ExtensionModules.Enable)
             {
@@ -112,6 +113,11 @@ public void Setup(TestSettings settings)
                 }
                 foreach (var module in modules)
                 {
+                    if (module.GetType().Name.Contains("Pause"))
+                    {
+                        Logger.LogInformation("Skipping pause module as core Pause function is enabled");
+                        continue;
+                    }
                     module.RegisterPowerFxFunction(powerFxConfig, TestInfraFunctions, _testWebProvider, SingleTestInstanceState, TestState, _fileSystem);
                 }
             }