Power Apps Test Engine YAML format (preview)

Tests are defined in YAML following the same guidelines as Power Fx does. Learn more about the Power Fx YAML formula grammar.

View the PowerApps-TestEngine/samples folder for detailed examples.

YAML schema definitions

testSuite

Used to define one test.

How to identify your application in the test plan

You need set either appLogicalName or appId to identify your application. Which you use depends on whether your app is defined within a solution.

Solution-based apps (recommended)

When you define your apps within solutions your tests remain portable across environments. Set the appLogicalName property to indicate that the app is solution based.

To locate the app's logical name:

1. Open the solution containing your app in Power Apps
2. Use the Name (not Display name) in the list. The name value includes the customization prefix for the solution publisher.

Standalone apps

When your app isn't defined within a solution, you need to use the appId property.

To locate the ID of the app:

1. Locate the app in the Power Apps list
2. Open Details and note the App ID GUID

NetworkRequestMocks

For optional properties, if no value is specified, the routing applies to all. For example, if method is null, we send back the mock response whatever the method is as long as the other properties all match.

For Sharepoint/Dataverse/Connector apps, requestURL and method can be the same for all requests. x-ms-request-method and x-ms-request-url in headers could need to be configured in that case to identify different requests.

TestCases

TestSteps

• TestSteps can use any existing Test Engine Power Fx functions functions or specific test functions defined by this framework.
• The value should start with a pipe symbol (|) to allow for multiline YAML expressions followed by an equals (=) sign to indicate that it's a Power Fx expression
• Functions should be separated by a semicolon (;).
• Comments can be used and should start with double backslash characters (//).

TestSteps example

testCases:
   - testCaseName: Fill in a city name and do the search
   testSteps: |
      = Screenshot("connectorapp_loaded.png");
         SetProperty(TextInput1.Text, "Atlanta");
         Select(Button1);
         Assert(Label4.Text = "You are seeing the mock response", "Validate the output is from the mock");
         Screenshot("connectorapp_end.png");

testSettings

Used to define settings for the tests in the test plan.

extensionModules

Contains data about extensions to enable.

This example shows how to enable the PowerFx Preview namespace:

testSettings:
  extensionModules:
    enable: true
    allowPowerFxNamespaces:
    - Preview

Learn more about preview functions

Region and language considerations

Test Engine supports various language and regional settings such as decimal and list separators. The testSettings.locale property controls these behaviors. For more information, see Global Support in Microsoft Power Fx.

Look at these sample configurations on the PowerApps-TestEngine GitHub repository:

• For regions using semicolons as list separators
• For regions using commas as decimal separators

powerFxTestTypes example

powerFxTestTypes:
 - name: ControlName
   value: |
      {ControlName: Text} 
 - name: Options
   value: |
      [{Name: Text, Value: Number}]   

This example demonstrates how to define custom Power Fx types for use in your test cases. The ControlName type is defined as a record with a single Text field, while the Options type is defined as a table of records, each containing a Name field of type Text and a Value field of type Number. Custom types can be used to create more complex and specific test scenarios, enhancing the flexibility and power of your test definitions.

testFunctions example

testFunctions:
 - description: Wait until control is visible using Document Object Model (DOM) selector
   code: |
    WaitUntilVisible(control: Text): Void = 
      Preview.PlaywrightAction(Concatenate("//div[@data-id='", control, "']"), "wait");
 - description: Get the options for a control using Power Fx control from Model Driven App (MDA)
   code: |
    GetOptions(control: ControlName): Options =
      Preview.GetOptions(control);

These test function examples demonstrate how to define custom Power Fx functions for use in your test cases. The WaitUntilVisible function uses a DOM selector to wait until a specified control is visible, using Playwright actions. The GetOptions function retrieves the options for a specified control from a Model Driven App (MDA), utilizing the Power Fx control. These custom functions enhance the flexibility and power of your test definitions, allowing for more complex and specific test scenarios.

BrowserConfiguration

Every testSettings requires at least one BrowserConfiguration.

environmentVariables

You can store different types of values as environmental values, but the most common case is storing credential information with a list of users.

users

To ensure credentials are stored in secure manner, the test definition references users using a personaName. Storing credentials in test plan files isn't supported.

Example:

environmentVariables:
    - users:
        - personaName: "User1"
          emailKey: "user1Email"
        - personaName: "User2"
          emailKey: "user2Email"

The personaName is used as part of the test definition to indicate what user to run the test as.

Supported credentials storage mechanisms

To store credentials as environment variables, you can set them as follows:

# In PowerShell - replace variableName and variableValue with the correct values
$env:variableName = "variableValue"

In the YAML, two properties need to be defined to indicate that this user's credentials are stored in environment variables:

• emailKey: The environment variable used to store the user's email.

Example YAML:

    - personaName: "User1"
      emailKey: "user1Email"

Example PowerShell to set user credentials based on YAML:

$env:user1Email = "someone@example.com"

See also

Power Apps Test Engine overview (preview)
Power Apps Test Engine Power Fx functions (preview)