Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 83 additions & 42 deletions README.md

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/CommandInput.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# PowerAppsTestEngine.exe Inputs

The exe can take in inputs in the form of `config.json` (or `config.dev.json`) or command line input parameters
The executable can take in inputs defined in `config.dev.json`, or as command line input parameters.

## Parameters

| Parameter | Details |
| -- | -- |
| EnvironmentId | Environment that the Power App you are testing is located in. For more information about environments, please view [this](https://docs.microsoft.com/en-us/power-platform/admin/environments-overview) |
| TenantId | Tenant that the Power App is located in. |
| EnvironmentId | Environment that the Power Apps app you are testing is located in. For more information about environments, please view [this](https://docs.microsoft.com/en-us/power-platform/admin/environments-overview) |
| TenantId | Tenant that the Power Apps app is located in. |
| TestPlanFile | Path to the test plan that you wish to run |
| OutputDirectory | Path to folder the test results will be placed. Optional. If this is not provided, it will be placed in the `TestOutput` folder. |
| LogLevel | Level for logging (Folllows [this](https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.logging.loglevel?view=dotnet-plat-ext-6.0)). Optional. If this is not provided, Information level logs and higher will be logged |
| QueryParams | Specify query parameters to be added to the powerapps URL. |
| QueryParams | Specify query parameters to be added to the Power Apps URL. |

## Config.json

Expand All @@ -21,7 +21,7 @@ Use a `config.dev.json` to prevent accidentally checking in personal info.

### Command line

Command line parameters override anything specified in `config.json`
When provided, command line parameters will override anything specified in `config.dev.json`

| Switch | Parameter |
| -- | -- |
Expand Down
2 changes: 1 addition & 1 deletion docs/PowerFX/Assert.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

`Assert(BooleanExpression, Message)`

The Assert function takes in a Power FX expression that should evaluate to a boolean value. If the value returned is false, the test will fail.
The Assert function takes in a Power Fx expression that should evaluate to a boolean value. If the value returned is false, the test will fail.

## Example
`Assert(Label1.Text = "1");`
Expand Down
4 changes: 2 additions & 2 deletions docs/PowerFX/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Power FX
# Power Fx

Any documented [Power FX](https://docs.microsoft.com/en-us/power-platform/power-fx/overview) functions can be used
Any documented [Power Fx](https://docs.microsoft.com/en-us/power-platform/power-fx/overview) functions can be used

There are several specifically defined functions for the test framework.

Expand Down
2 changes: 1 addition & 1 deletion docs/PowerFX/Screenshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

This will capture a screenshot of the app at the current point in time. The screenshot file will be saved to the test output folder and with the name provided.

Only jpeg and png files are supported.
> **Note:** Only jpeg and png files are supported.

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/PowerFX/Select.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

This is the same functionality as the Power Apps [Select function](https://docs.microsoft.com/en-us/power-apps/maker/canvas-apps/functions/function-select).

In case of nested gallery, use Index() within the select function.
When working with a nested gallery, use [Index()](https://learn.microsoft.com/en-us/power-platform/power-fx/reference/function-first-last) within the select function.

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/PowerFX/SetProperty.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

This is the same functionality as the Power Apps [SetProperty function](https://docs.microsoft.com/en-us/power-apps/maker/canvas-apps/functions/function-setproperty).

In case of nested gallery, use Index() within the SetProperty function.
When working with a nested gallery, use [Index()](https://learn.microsoft.com/en-us/power-platform/power-fx/reference/function-first-last) within the SetProperty function.

## Example

Expand Down
3 changes: 0 additions & 3 deletions docs/PowerFX/Wait.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Wait

> Future intended function is of this format: `Wait(boolean expression)`. This is pending some improvements in Power FX to be available.


`Wait(Control, Property, Value)`

This will wait for the property of the control to equal the specified value.
Expand Down
2 changes: 1 addition & 1 deletion docs/Yaml/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Yaml Format

Tests are defined in YAML following the same guidelines as Power FX does. To find out more about the Power Fx YAML formula grammar, view [this](https://docs.microsoft.com/en-us/power-platform/power-fx/yaml-formula-grammar).
Tests are defined in YAML following the same guidelines as Power Fx does. To find out more about the Power Fx YAML formula grammar, view [this](https://docs.microsoft.com/en-us/power-platform/power-fx/yaml-formula-grammar).

View the [samples](../../samples/) folder for detailed examples.

Expand Down
12 changes: 7 additions & 5 deletions docs/Yaml/Users.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Users

To ensure credentials are stored in secure manner, users are referenced by a persona name in the test definition. User email addresses and passwords should NEVER show up in any of the test definition files.
To ensure credentials are stored in secure manner, users are referenced by a persona name in the test definition. Storing credentials in test plan files is not supported.

References to the user credentials are located under the `environmentVariables` section as a list of `users`
References to the user credentials are located under the `environmentVariables` section as a list of `users`

Example:
```
Expand All @@ -21,10 +21,12 @@ The `personaName` will be used as part of the test definition to indicate what u

## Supported credentials storage mechanisms

> **Note:** Multi-factor authentication is not supported.

### Environment variables

To store credentials as environment variables, you can set it as follows:
```
```powershell
# In PowerShell - replace variableName and variableValue with the correct values
$env:variableName = "variableValue"
```
Expand All @@ -34,14 +36,14 @@ In the YAML, two properties need to be defined to indicate that this user's cred
- passwordKey: The environment variable used to store the user's password.

Example YAML:
```
```yaml
- personaName: "User1"
emailKey: "user1Email"
passwordKey: "user1Password"
```

Example powershell to set user credentials based on YAML:
```
```powershell
$env:user1Email = "someone@example.com"
$env:user1Password = "fake password"
```
4 changes: 2 additions & 2 deletions docs/Yaml/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ For Sharepoint/Dataverse/Connector apps, requestURL and Method can be the same f

### TestSteps

- This can use any existing [Power FX](https://docs.microsoft.com/en-us/power-platform/power-fx/overview) functions or [specific test functions](../PowerFX/README.md) defined by this framework.
- It should start with a | to allow for multiline YAML expressions followed by an = sign to indicate that it is a Power FX expression
- This can use any existing [Power Fx](https://docs.microsoft.com/en-us/power-platform/power-fx/overview) functions or [specific test functions](../PowerFX/README.md) defined by this framework.
- It should start with a | to allow for multiline YAML expressions followed by an = sign to indicate that it is a Power Fx expression
- Functions should be separated by a ;
- Comments can be used and should start with //
2 changes: 1 addition & 1 deletion docs/Yaml/testSettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This is used to define settings for the tests in the test plan

| Property | Required | Description |
| -- | -- | -- |
| browser | Yes | The browser to be launched when testing. This should match the [browsers supported by Playwright(https://playwright.dev/dotnet/docs/browsers)]. |
| browser | Yes | The browser to be launched when testing. This should match the [browsers supported by Playwright](https://playwright.dev/dotnet/docs/browsers). |
| device | No | The device to emulate when launching the browser. This should match the [devices supported by Playwright](https://playwright.dev/dotnet/docs/api/class-playwright#playwright-devices)
| screenHeight | No | The height of the screen to use when launching the browser. If specified, screenWidth must also be specified. |
| screenWidth | No | The width of the screen to use when launching the browser. If specified, screenHeight must also be specified.|
Binary file added docs/images/findenvironment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.