Robotframework-FlaUI Library

License
Python Builds (x86)
Python Builds (x64)
Tests
Python
Robotframework
PyPi

Introduction

Robotframework-FlaUI is a keyword based user interface automation testing library for Windows applications like Win32, WinForms, WPF or Store Apps. It's based on the FlaUI user interface automation library.

Installation

Install the latest stable release:

pip install --upgrade robotframework-flaui

Dependencies and python support

The robot framework FlaUI is supposed to support the current Python 3 versions.

Required dependencies

See dependencies from Documentation

Python.Net Wrapper Issues

Robotframework-Flaui 1.x

• With the release of Python.Net version 2.5.2, Python 3.9 support was implemented for the first time.
• However, no official support for Python 3.9 has been released yet.
  • For more information see the issue #1389
• If there are problems installing the Python.Net library, please use Python 3.8 instead.
• This is only a potential problem by all robotframework-flaui 1.x versions which are implemented by Python.Net 2.5.2

Robotframework-Flaui 2.x

• Sometimes an AccessViolationException wil be occure on latest Python.Net Version v3.0.1
  • For more information see the issue #1977
  • A workaround is to set Python's memory allocation environment variable "PYTHONMALLOC=malloc"

Documentation

• Keyword documentation
• XPath explanation

RFHUB2

RFHUB2 is an opensource project aimed to provide nice and easy way of collecting, browsing and sharing documentation of existing keywords written in RobotFramework and python. Built with Material-UI and FastAPI, served by Uvicorn.

Under docs/keywords are the necessary .XML files to import the keywords.

These can be imported separately according to their version with the RFHUB2-CLI tool or all versions.

rfhub2-cli .\docs\keywords\
rfhub2-cli .\docs\keywords\<VERSION>

GUI Inspector Tools

There are various tools around which help inspecting application that should be ui tested or automated.

Some of them are:

• FlaUI Inspect
• Alternatively FlaUInspectStable more stable version
• Microsoft Accessibility Insights For Windows
• VisualUIAVerify
• Inspect
• UISpy

Examples

Examples of use can be found in the atests folder.

Development

Preconditions

• Install Python, if not already installed.
• Only Python 3 is supported.
• Install Robotframework and Python.Net

Dependency installation by Keen.bat

.\keen.bat dependency

Test-Applications

Two test projects were used for the UI automation:

• FlaUI WPF Test App 'Standard application that contains all common UI elements'
• Notifier Test App 'Application which closes automatically after a time'

Testing locally TLDR

python -m venv .venv
.venv/Scripts/pip install -r requirements-dev.txt

cd ./atests
../.venv/Scripts/robot -v UIA:UIA3 -d ../result -P ../src -t "Element Should Be Offscreen" Element.robot

Building and testing locally

Use the provided 'Commander Keen' file:

python .\keen.py test

The script automatically builds the:

• Library as a wheel file stored in the Dist folder
• Test documentation located in the Docs folder
• Automatically installs and runs the robot tests of the library and saves the test results in the Result folder

Following arguments are supported:

python .\keen.py <argument>

• cleanup - Removes all build folders
• dependency - Install all python dependencies
• build - Build wheel file
• install - Install wheel file
• test - Test robotframework-flaui (UIA2 and UIA3)
• test_uia2 - Test UIA2 interface usage
• test_uia3 - Test UIA3 interface usage
• pylint - Static code analysis for python code
• robocop - Static code analysis for robotframework code
• tidy - Formatter for robotframework code

Releasing a new version - Frequent tasks

• add or update keywords in folders
  • src/FlaUILibrary/flaui/module
  • src/FlaUILibrary/keywords
• add or update tests in folder atests
• update version in src/FlaUILibrary/version.py
• update CHANGELOG.md
  • add a release near the top
  • add the links at the bottom in section ### Added

Acknowledgements

FlaUI

• Thanks to @Roemer for the passion to create and maintain the FlaUI project.
• Thanks to FlaUI developers and maintainers for this project.