A framework for speeding up the development of automated UI tests for Windows, Android, iOS, and Web with Appium/Selenium on .NET
Home Page: https://made-apps.github.io/legerity/
License: MIT License
![dependabot-preview[bot] avatar](https://avatars.githubusercontent.com/in/2141?v=4 "dependabot-preview[bot]")
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
To improve the quality of the documentation and structure, the content needs an overhaul.
The documentation for Legerity, while providing a lot of information, is difficult to follow based on the current structure. It's not entirely clear how to get started, and how to take advantage of the features.
No response
The evolution of the docs is being tracked in the feature/docs branch.
Button is a commonly used core Android control that supports the ability to cause an action when clicked.
The implementation should provide the following functionality:
Based on the available HTML element wrappers, there should be capabilities to generate page objects based on a set of Vue files provided.
To improve the usability of the page object generation tool to support Vue files
No response
No response
Add support for the Windows Community Toolkit TextToolbar element.
The implementation should support the ability to:
In a UI test project using NUnit and Legerity, it's possible to get the test runner to continue to run forever (or pipeline timeout when run in CI) if the maximise function fails in the StartApp method.
This occurs due to the app driver having been started but it can't be disposed of as it isn't returned if it fails.
If the driver launches but fails to correctly configure, it should be disposed of and an exception thrown up to the calling method.
Core
No response
Add support for the WinUI TabView element.
Support available for:
Introduce the TokenizingTextBox from the Windows Community Toolkit.
There should be the capability to input a suggestion, select from the available items, select a token, and remove a token.
CheckBox is a commonly used core Android control that supports the ability to make one or multiple selections.
The implementation should provide the following functionality:
DatePicker is a commonly used core Android control that supports the ability to select a date value.
The implementation should provide the following functionality:
Simply, upgrading the current support for Selenium from 3 to 4.
Noticed in the latest PR build (aab3633#annotation_7550536556)
Selenium NuGet packages are now a major version up with 4.7.0 and appears that this has been available since late 2021.
Adoption appears relatively high so we should look to upgrade and support the latest version.
No response
No response
Should provide the capability to interact with a <input type="file" /> element.
As the file input takes advantage of a button that activates a native OS experience for uploading a file, this would need to be handled in a different way.
The suggestion is to allow an automated test to input an absolute file path using the SendKeys method.
Would suggest the naming convention follows other web elements, FileInput
Retrieving web table data rows using the DataRows property takes a long time to resolve as it requires a check on every row to determine whether it has header elements in it.
Should data rows in a reasonable amount of time for the size of table data.
Should expect sub 10 seconds (current baseline is 24 seconds for a table of 6 data rows)
Web
No response
Based on the <table> element and the supporting table row, header, and cell tags, create an element wrappers for this web component.
The element wrapper would expose the columns and rows of the table in an easy to query format.
Hi, first thanks for your effort with this project it really seems like I can optimize my UI tests with it. Second, I'm trying to test sample MAUI app and unfortunately my basic test is failing on Windows, but running fine on Android and I'm yet to try iOS.
Message:
OpenQA.Selenium.WebDriverException : An element could not be located on the page using the given search parameters.
Stack Trace:
RemoteWebDriver.UnpackAndThrowOnError(Response errorResponse)
RemoteWebDriver.Execute(String driverCommandToExecute, Dictionary`2 parameters)
AppiumDriver`1.Execute(String driverCommandToExecute, Dictionary`2 parameters)
RemoteWebDriver.FindElement(String mechanism, String value)
RemoteWebDriver.FindElementByXPath(String xpath)
<>c__DisplayClass19_0.<XPath>b__0(ISearchContext context)
By.FindElement(ISearchContext context)
RemoteWebDriver.FindElement(By by)
<>c__DisplayClass32_0.<AttemptWaitForDriverElement>b__0(IWebDriver driver)
DefaultWait`1.Until[TResult](Func`2 condition)
BasePage.AttemptWaitForDriverElement(By locator, TimeSpan timeout, IWebDriver appDriver)
BasePage.VerifyPageShown(Nullable`1 timeout)
BasePage.ctor(RemoteWebDriver app, Nullable`1 traitTimeout)
BasePage.ctor()
MainPageBase.ctor()
WinMainPage.ctor()
MainPageTest.ctor(UiTestFixture fixtureBase) line 9
I've looked at the samples and figured I have to use different methods for constructing the test page depending on a platform, so I did this
public class MainPage : MainPageBase
{
protected override By GetBy(string id) => By.Id(id);
protected override IWebElement GetElement(string id) => FindElement(By.Id(id));
}
public class WinMainPage : MainPageBase
{
protected override By GetBy(string id) => WindowsByExtras.AutomationId(id);
protected override IWebElement GetElement(string id) => this.WindowsApp.FindElement(GetBy(id));
}
public abstract class MainPageBase : BasePage
{
protected override By Trait => GetBy("MainPage");
public IWebElement Button => GetElement("button");
protected abstract By GetBy(string id);
protected abstract IWebElement GetElement(string id) ;
}
Test is able to discover an element using its AutomationId across multiple platforms using a single method e.g. By.Id(automationId)
No response
You can find repro here https://github.com/anpin/maui_ui_tests
Add support for the Windows Community Toolkit BladeView element.
The implementation should support the collection of BladeItem children with the ability to close them or expand/collapse them depending on the features.
InfoBar is currently moving towards preview as indicated by this PR.
This will make it easier to deal with the PagerControl in testing.
Add support for the Windows Community Toolkit OrbitView element.
The implementation should support the collection of child items with the ability to click them.
The OrbitView is based on an ItemsControl so the implementation for this may be similar to GridView or ListView which currently exist in this framework.
PagerControl is currently moving towards preview as indicated by this PR.
This will make it easier to deal with the PagerControl in testing.
As can be seen by searching the web,
There is a need to "Wait For" a windows application to start (Especially in CPU resource limited CI build machines)
I have found the ms:waitForAppLaunch but that is more like a Pause and not a wait / retry for app start.
What I need is either a way to use WindowsAppManagerOptions to attach to an already running instance (So thread wait / repeat until style code) can be done
Or for the WindowsAppManagerOptions to take a parameter, so when it is performing the attach, it is waiting for the app window to become available
Nuget package is stating a new version of 0.6.3
The element returned by a Find query in the RemoteWebDriver is an IWebElement. There should be a default constructor for all web elements that allow this element as a parameter.
This will allow the element wrappers to be constructed as follows:
TextInput text = new TextInput(AppManager.WebApp.FindElementByTagName("input"));An aspirational feature that would allow a developer to right-click on a Windows XAML file within Visual Studio and generate a UI test page object using Legerity wrapper elements.
This extension would scan the file, pulling out relevant detail to build up the C# class for the page including queries and potential interactions.
Add support for the Windows Community Toolkit Carousel element.
The implementation should support the collection of child items with the ability to select items.
Add support for the Windows Community Toolkit GridSplitter element.
The implementation should support the ability to select a GridSplitter, hold it, and change the width/height of the elements.
To improve the use of the setup for running an application under a UI test, changes need to be made to decouple the static AppManager.App instance usage across the Legerity page objects and elements.
For elements, the WrappedDriver property should instead be used for referencing to get additional sub-UI elements.
The AppManager will need updating to provide capabilities to retrieve an instance of the driver that is initialized. This implementation needs to reduce the impact of breaking changes to existing test projects using Legerity while providing the capability to be expanded on in the future.
To improve maintenance, scalability, and overall testability of UI test projects using Legerity.
Must - Decouple the AppManager.App instance from core Legerity code
No response
No response
ToggleButton is a commonly used core Android control which supports the ability to toggle the on/off state, similar to a Switch.
The implementation should provide the following functionality:
TimePicker is a commonly used core Android control that supports the ability to select a time.
The implementation should provide the following functionality:
Add support for the UWP MediaPlayerElement element.
The implementation should support the transport controls:
This change would move the CI/CD pipeline away from using Azure Pipelines in favor of GitHub actions.
CI changes could be deployed to packages in the project, releases could be automated, and publishes to NuGet could be controlled using release branches/tags.
Add support for the Windows Community Toolkit RadialGauge element.
The implementation should support the ability to interact with the gauge if in the interactive state.
Add support for the Windows Community Toolkit InAppNotification element.
The implementation should support the ability to interact with in-app notifications, selecting button options, and dismissing.
To introduce a Legerity page object to interact with the authentication flow for Google accounts.
In Legerity 0.12, a new Legerity.Web.Authentication library was introduced to make it easier to interact with login pages across common identity platforms.
The Azure AD login page was introduced as part of the release. Let's expand that to include others too!
| Capability | Priority |
|---|---|
| Ability to login with Google username and password | Must |
No response
Should provide the capability to interact with a <img /> element.
The solution should provide the capability of retrieving the image source, the element's size, and alt text.
Would suggest the naming of the element be Image
Should provide the capability to interact with a <select /> element.
This addition will include 2 new elements, one for the <select /> element and another for the child <option /> element.
The element should have the ability to select an item by value, get whether the select is in a multi state, and get the selected value(s).
Would suggest the naming Select and Option to match the web element name.
Add improvements to the current NavigationView implementation from the WinUI components.
Add support for:
Currently, if you want to get started with Legerity, you would install the main NuGet package.
This package contains all of the core Legerity functionality, plus the additional per platform core elements for Windows, Android, iOS, and Web.
When writing tests, this can make it confusing to know which elements are for which platform without knowing the element or knowing what namespace they are in.
The proposal is to split out the core into a Core package and then split out each individual platform core into their own package. This will allow developers to pick and choose the components they need for their applications.
The Legerity package will become a meta-package that installs all of the core components as the package currently exists today.
Add support for the UWP ContentDialog element.
The implementation should support the Primary, Secondary, and Close buttons.
A user would have the ability to create a new Legerity UI test project for a specific platform which would scaffold the required components to start building out UI tests quickly for their applications.
This feature is designed to improve the speed of adoption for creating UI tests by reducing the barrier to entry setting up and configuring a .NET test project and the boilerplate logic required for Legerity.
dotnet new <template> that will scaffold, initially, an NUnit configured test project with:
BaseTestClass created implementing the LegerityTestClass with default configuration setup for running against the platform associated with the template (e.g. configurations for Windows, Android, iOS, Web, Cross Platform)No response
No response
Add support for the Windows Community Toolkit Expander element.
The implementation should support the ability to expand and collapse the content.
Based on the available HTML element wrappers, there should be capabilities to generate page objects based on a set of HTML files provided.
To improve the usability of the page object generation tool to support HTML files
No response
No response
EditText is a commonly used core Android control which supports the input of text.
The implementation should provide the following functionality:
Should provide the capability to interact with a <textarea /> element.
Should follow similar capabilities as the existing TextInput element with the additional options for max length, rows, and columns.
Add support for the WinUI DropDownButton element.
The implementation should support the collection of MenuFlyoutItem children with the ability to click them.
Switch is a commonly used core Android control that supports the ability to toggle a state on or off.
The implementation should provide the following functionality:
Add support for the WinUI NumberBox element.
Should provide support for:
ProgressBar is a commonly used core Android control that supports the ability to track the progress of actions as a percentage.
The implementation should provide the following functionality:
Slider is a commonly used core Android control that supports the ability to select a value from a range slider.
The implementation should provide the following functionality:
RadioButton is a commonly used core Android control that supports the ability to make a single selection from multiple.
The implementation should provide the following functionality:
To introduce a Legerity page object to interact with the authentication flow for Facebook accounts.
In Legerity 0.12, a new Legerity.Web.Authentication library was introduced to make it easier to interact with login pages across common identity platforms.
The Azure AD login page was introduced as part of the release. Let's expand that to include others too!
| Capability | Priority |
|---|---|
| Ability to login with Facebook username and password | Must |
No response
No response
Add support for the WinUI MenuBar element.
The implementation should support the collection of MenuBarItem children with the ability to click them.
Support should also be available for MenuFlyoutItem and MenuFlyoutSubItem child elements.
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.