Sunday, April 26, 2015

Coded UI Test : How to automate a WPF application using Code First approach

Now a days Microsoft Visual Studio Coded UI test is becoming popular as it is supporting basic windows UI object as well as WPF and Silverlight UI object. Coded UI test framework has its own search algorithm to search UI object from the WPF window. In our previous post we have shown on how to automate a WPF application using record and playback approach. Here I will explain how we can automate a WPF application using code first approach. We do not record any steps here. We write code for every steps here.

Our example application is the sample WPF calculator application downloaded from Microsoft site. Note that you need to crate a solution with the downloaded project and then build it. Go to bin folder of your solution and create a shortcut of the exe file and pin it to task bar.

Step One : Writing Test cases
At first we write the test cases that we have to automate.

Test Case : Verify addition of two numbers in calculator application.
  • Open the Calculator application.
  • Click on 7 (seven) button.
  • Click (+) plus button.
  • Click 3 (three) button.
  • Click (=) equals button.
  • Verify the result.
Step Two: Create a Coded UI test Project
  • Open Visual Studio (In my case it is visual studio 2013)
  • Navigate to File>New>Project at File Menu.
  • New Project window is displayed.
  • Select “Test” from left side Project Template category under visual C#.
  • Select “Coded UI Test Project”. Note that in my case .Net Framework 4.5.1 is selected.
  • Enter Project name as “CalculatorUITest”.
  • Select Location.
  • Enter solution name. In my case this is the same as project name.
  • Check “Create directory for solution” option
  • Click on Ok button
  • A new coded UI test project is created and Recorder window (Title : Generate Code for Coded UI test) is displayed. Since we write code for every steps, we do not need recorder. Click Cancel button to close the recorder window.
Step Three: Write codes for every step
  • Go to Visual studio editor and see that there is a namespace names “CalculatorUITest” as same with the project name.
  • Under this namespace there is a class “CodedUITest1”.
  • Under this class there is a method named “CodedUITestMethod1”. Note that there is an attribute “[TestMethod]”.
  • We will write separate method for every test cases and multiple methods can be write in a single class.
  • Generally all the test cases for single feature writes in a single class.
  • Method name should be similar to Test case title so that we can understand about the test cases by the method name.
  • Also we write the test case title as comment before the method name.
  • Here we write the Test case title as comment before the method name.
 //Verify addition of two numbers in calculator application.
  • Here we rename the method name as
    public void VerifyAddTwoNumber()
  • Now start Writing the codes.
  • At first we have to run the calculator application. Code will be
// Open the Calculator application. 
string ApplicationPath = "C:\\Cal\\csharp\\bin\\Debug\\AvalonCalculator2.exe";
ApplicationUnderTest application = ApplicationUnderTest.Launch(ApplicationPath);
Note that we define a variable  “ApplicationPath” to assign the calculator application with path. Also we run the application by using the method “Launch()” under “ApplicationUnderTest”  class that takes application name with path as argument.
  • Now we need to define the Calculator parent window which will help us to search objects on Parent window.
//Define Calculator Main window
WpfWindow mainWindow = new WpfWindow();
mainWindow.SearchProperties.Add(WpfWindow.PropertyNames.Name, "WPF Calculator");
mainWindow.WindowTitles.Add("WPF Calculator");
Note that we declare an object called “mainWindow” under WpfWindow class. WpfWindow is the window class for all basic WPF application. Every time we need to have a Parent window object so that we can use it as reference of other objects on that window. Coded UI test has its own algorithm to search an object. Parent window helps search an object on that window. Note that we use WpfWindow class in stead of WinWindow class as this is a WPF application and coded UI test has a separate set of classes for WPF UI objects.
We add a search properties on of that window and that is “Name”. In this way we can add multiple properties. We have taken help the coded UI test builder tool to determine the properties of an object. I will discuss it on my later post on how we can determine the properties of an object by using coded UI test builder tool. Now for this task, we just need to right click on  Visual studio editor and select “Generate Code for Coded UI test” and click “Use Coded UI Test Builder” like the following.


Coded UI Test builder window is displayed and now just drag the UI spy button (Crosshair) and drop it to Calculator window.
Now property list window is displayed. It has a list of properties and you can use any property as search properties.

Common Syntax to add a search property of an object.
UIObject.SearchProperties.Add(UIClass.PropertyNames.propertyName, porpertyValue);
UIObject : It is UI object that needs to be operated to automate the application. It is declared under respective UI class.
UIClass : It is the class of UI object. Coded UI test has a set of classes to handle all basic windows UI.
propertyName : It is the list of available property list of that UI object.
porpertyValue : It is the available property value.
Note that we add the window title name of that UI object by the following statement.
mainWindow.WindowTitles.Add("WPF Calculator");
Here we add title name with so that system can search the object of that window that has given title name.
  • Now we need to click on 7 (seven) button.
//Click on 7 (seven) button. 
WpfButton btnSeven = new WpfButton(mainWindow);
btnSeven.SearchProperties.Add(WpfButton.PropertyNames.Name, "7");
btnSeven.SearchProperties.Add(WpfButton.PropertyNames.AutomationId, "B7");
btnSeven.WindowTitles.Add("WPF Calculator");
Note that we have declared a variable called “btnSeven” for clicking seven button. For WPF application, all buttons are generally under WpfButton class. Also we add a search property “Name” as “7” so that system can search it. 
Note that we add another search properties “AutomationId” that is specially for automation of WPF UI object. Make sure that this property value is unique. At the time of UI design we need to assign this property value so that at the time of automation tester can use this properties as a search property to detect UI objects. Coded UI test search algorithm works faster to detect UI object using Automation ID. 
We use mainWindow object as an argument so that system search this btnSeven object under WPF Calculator window. In this way we define the range of search area and helps search algorithm to take minimum time to search.
Also we add the window title here. 
For click on 7 (seven) button we add Click() method under Mouse class.
  • Click (+) plus button
//Click (+) plus button. 
WpfButton btnPlus = new WpfButton(mainWindow);
btnPlus.SearchProperties.Add(WpfButton.PropertyNames.Name, "+");
btnPlus.SearchProperties.Add(WpfButton.PropertyNames.AutomationId, "BPlus");
btnPlus.WindowTitles.Add("WPF Calculator");
  • Click 3 (three) button
//Click 3 (three) button.
WpfButton btnThree = new WpfButton(mainWindow);
btnThree.SearchProperties.Add(WpfButton.PropertyNames.Name, "3");
btnThree.SearchProperties.Add(WpfButton.PropertyNames.AutomationId, "B3");
btnThree.WindowTitles.Add("WPF Calculator");
  • Click (=) equals button
//Click (=) equals button. 
WpfButton btnEquals = new WpfButton(mainWindow);
btnEquals.SearchProperties.Add(WpfButton.PropertyNames.Name, "=");
btnEquals.SearchProperties.Add(WpfButton.PropertyNames.AutomationId, "BEqual");
btnEquals.WindowTitles.Add("WPF Calculator");
  • Verify the result.
//Verify the result. 
WpfEdit txtResult = new WpfEdit(mainWindow);
txtResult.WindowTitles.Add("WPF Calculator");
Assert.AreEqual("10", txtResult.Text);
Note that we add  AreEqual() under Assert class which is a built in class under Visual Studio Test Framework used for verifying the result. It has two argument as “Expected” and “Actual” result.
  • Now VerifyAddTwoNumber() method looks like the following:


Step Four: Playback the test
  • Go to Build menu and click on Build Solution option.

  • Go to Test menu and click on Windows>Test Explorer.
  • In the Test Explorer, Test Name “VerifyAddTwoNumber” is displayed.
  • Right click on the Test Name and click on “Run Selected Test”.

  • Test will run and Test result is displayed at the Test Explorer.
Here we see how we can write the test steps by using C# code and run it. We use the full infrastructure of Coded UI test but we write the code that is in our control and we can reuse it for different purposes. It is more maintainable.

That’s all for now….

Happy Coded UI testing!!!