Futile.Specflow.Actions.FlaUI 1.0.3

Futile.SpecFlow.Actions.FlaUI

This SpecFlow.Action will help you use FlaUI together with SpecFlow.

Futile?

Work on Specflow has been discontinued and the successor is reqnroll (status May 2024). This nuget package is an addition to a fork.

Included Features

• Lifetime handling of the application being tested
• Configuration via specflow.actions.json
• Launch of executables and Windows Store Apps (e.g. Calculator)
• Appium-like interactions

Configuration

You can configure this plugin via the specflow.actions.json.

{
  "flaui": {
    "settings": {
      "uia": "UIA2"
    },
    "profiles": {
      "Calculator.exe with Hello FlaUI": {
        "app": "[path]\Calculator.exe",
        "arguments": "Hello FlaUI",
        "launch": "Exe"
      },
      "Windows 11 Calculator": {
        "app": "Microsoft.WindowsCalculator_8wekyb3d8bbwe!App",
        "launch": "StoreApp"
      }
    }
  }
}

uia

Supported values:

• UIA2
• UIA3

app

filename of the executable or the name of the Windows App. The Windows App names can be found in folder %userprofile%\AppData\Local\Packages.

arguments

Optional list of arguments.

launch

Supported values:

• Exe
• StoreApp

How to use it

The application is started automatically when you try to use it for the first time. It is closed after the scenario ends. You can use constructor and/or parameter injection to inject dependencies into your classes, this way the class instances are managed automatically.

Elements object

Wraps the FlaUI access to the application.

public class CalculatorMainWindowElements
{
  private readonly FlaUIDriver _driver;

  public CalculatorMainWindowElements(FlaUIDriver driver)
  {
    _driver = driver;
  }

  public TextBox FirstNumberTextBox => _driver.Current.FindFirstDescendant("TextBoxFirst").AsTextBox();
  public TextBox SecondNumberTextBox => _driver.Current.FindFirstDescendant("TextBoxSecond").AsTextBox();
  public TextBox ResultTextBox => _driver.Current.FindFirstDescendant("TextBoxResult").AsTextBox();

  public Button AddButton => _driver.Current.FindFirstDescendant("ButtonAdd").AsButton();
}

Proxy object

Represents the application under test.

public class CalculatorProxy
{
  private readonly FlaUIDriver _driver;
  private readonly CalculatorMainWindowElements _elements;

  public CalculatorProxy(FlaUIDriver driver)
  {
    _driver = driver;
    _elements = new CalculatorMainWindowElements(driver);        
  }

  public void EnterFirstNumber(string number)
  {
    _elements.FirstNumberTextBox.Text += number;
  }

  public void EnterSecondNumber(string number)
  {
    _elements.SecondNumberTextBox.Text += number;
  }

  public void ClickAdd()
  {
    _elements.AddButton.Click();
  }

  public string GetResult()
  {
    return _elements.ResultTextBox.Text;
  }
}

Step definitions

[Binding]
public sealed class CalculatorStepDefinitions
{
  private readonly CalculatorProxy _proxy;

  public CalculatorStepDefinitions(CalculatorProxy proxy)
  {
    _proxy = proxy;
  }

  [Given("the first number is (.*)")]
  public void GivenTheFirstNumberIs(int number)
  {
    _proxy.EnterFirstNumber(number.ToString());
  }
}

FlaUI Interactions

FlaUIDriver.Current returns the automation element of the application's main window. Some common operations to get descendants or children without automation id are "ByName" or "ByClassName":

• var okButton = _driver.Current.FindFirstDescendant(_driver.Get.ByName("OK"));
• var otherWindow = _driver.Current.FindFirstDescendant(_driver.Get.ByClassName("Configuration"));

Examples can be found on the FlaUI website.

Appium-like Interactions

The class AppiumLikeInteractions is for convenience if you are familiar with Appium or if you migrate a project based on the SpecFlow.Actions.WindowsAppDriver .

public class CalculatorMainWindowElements
{
  private readonly AppiumLikeInteractions _interactions;

  public CalculatorMainWindowElements(FlaUIDriver driver)
  {
    _interactions = new AppiumLikeInteractions(driver);
  }

  public TextBox FirstNumberTextBox => _interactions.FindElementByAccessibilityId("TextBoxFirst").AsTextBox();
  public TextBox SecondNumberTextBox => _interactions.FindElementByAccessibilityId("TextBoxSecond").AsTextBox();
  public TextBox ResultTextBox => _interactions.FindElementByAccessibilityId("TextBoxResult").AsTextBox();

  public Button AddButton => _interactions.FindElementByAccessibilityId("ButtonAdd").AsButton();
}

The class CalculatorMainWindowElements from the example above with Appium-like interactions

How to get it

Add the latest version of the Futile.SpecFlow.Actions.FlaUI NuGet Package to your project.

Latest version: